Compare commits
No commits in common. "master" and "v1.0.12" have entirely different histories.
@ -1,66 +0,0 @@
|
|||||||
name: Default (not tags)
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
tags-ignore:
|
|
||||||
- '**'
|
|
||||||
|
|
||||||
env:
|
|
||||||
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
|
||||||
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
|
|
||||||
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
|
|
||||||
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
|
|
||||||
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
|
|
||||||
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
security:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
continue-on-error: true
|
|
||||||
container:
|
|
||||||
image: ${{ env.IMAGE }}
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
|
|
||||||
- name: Install pnpm and npmci
|
|
||||||
run: |
|
|
||||||
pnpm install -g pnpm
|
|
||||||
pnpm install -g @shipzone/npmci
|
|
||||||
|
|
||||||
- name: Run npm prepare
|
|
||||||
run: npmci npm prepare
|
|
||||||
|
|
||||||
- name: Audit production dependencies
|
|
||||||
run: |
|
|
||||||
npmci command npm config set registry https://registry.npmjs.org
|
|
||||||
npmci command pnpm audit --audit-level=high --prod
|
|
||||||
continue-on-error: true
|
|
||||||
|
|
||||||
- name: Audit development dependencies
|
|
||||||
run: |
|
|
||||||
npmci command npm config set registry https://registry.npmjs.org
|
|
||||||
npmci command pnpm audit --audit-level=high --dev
|
|
||||||
continue-on-error: true
|
|
||||||
|
|
||||||
test:
|
|
||||||
if: ${{ always() }}
|
|
||||||
needs: security
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
container:
|
|
||||||
image: ${{ env.IMAGE }}
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
|
|
||||||
- name: Test stable
|
|
||||||
run: |
|
|
||||||
npmci node install stable
|
|
||||||
npmci npm install
|
|
||||||
npmci npm test
|
|
||||||
|
|
||||||
- name: Test build
|
|
||||||
run: |
|
|
||||||
npmci node install stable
|
|
||||||
npmci npm install
|
|
||||||
npmci npm build
|
|
||||||
@ -1,124 +0,0 @@
|
|||||||
name: Default (tags)
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
tags:
|
|
||||||
- '*'
|
|
||||||
|
|
||||||
env:
|
|
||||||
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
|
||||||
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
|
|
||||||
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
|
|
||||||
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
|
|
||||||
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
|
|
||||||
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
security:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
continue-on-error: true
|
|
||||||
container:
|
|
||||||
image: ${{ env.IMAGE }}
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
|
|
||||||
- name: Prepare
|
|
||||||
run: |
|
|
||||||
pnpm install -g pnpm
|
|
||||||
pnpm install -g @shipzone/npmci
|
|
||||||
npmci npm prepare
|
|
||||||
|
|
||||||
- name: Audit production dependencies
|
|
||||||
run: |
|
|
||||||
npmci command npm config set registry https://registry.npmjs.org
|
|
||||||
npmci command pnpm audit --audit-level=high --prod
|
|
||||||
continue-on-error: true
|
|
||||||
|
|
||||||
- name: Audit development dependencies
|
|
||||||
run: |
|
|
||||||
npmci command npm config set registry https://registry.npmjs.org
|
|
||||||
npmci command pnpm audit --audit-level=high --dev
|
|
||||||
continue-on-error: true
|
|
||||||
|
|
||||||
test:
|
|
||||||
if: ${{ always() }}
|
|
||||||
needs: security
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
container:
|
|
||||||
image: ${{ env.IMAGE }}
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
|
|
||||||
- name: Prepare
|
|
||||||
run: |
|
|
||||||
pnpm install -g pnpm
|
|
||||||
pnpm install -g @shipzone/npmci
|
|
||||||
npmci npm prepare
|
|
||||||
|
|
||||||
- name: Test stable
|
|
||||||
run: |
|
|
||||||
npmci node install stable
|
|
||||||
npmci npm install
|
|
||||||
npmci npm test
|
|
||||||
|
|
||||||
- name: Test build
|
|
||||||
run: |
|
|
||||||
npmci node install stable
|
|
||||||
npmci npm install
|
|
||||||
npmci npm build
|
|
||||||
|
|
||||||
release:
|
|
||||||
needs: test
|
|
||||||
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
container:
|
|
||||||
image: ${{ env.IMAGE }}
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
|
|
||||||
- name: Prepare
|
|
||||||
run: |
|
|
||||||
pnpm install -g pnpm
|
|
||||||
pnpm install -g @shipzone/npmci
|
|
||||||
npmci npm prepare
|
|
||||||
|
|
||||||
- name: Release
|
|
||||||
run: |
|
|
||||||
npmci node install stable
|
|
||||||
npmci npm publish
|
|
||||||
|
|
||||||
metadata:
|
|
||||||
needs: test
|
|
||||||
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
container:
|
|
||||||
image: ${{ env.IMAGE }}
|
|
||||||
continue-on-error: true
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
|
|
||||||
- name: Prepare
|
|
||||||
run: |
|
|
||||||
pnpm install -g pnpm
|
|
||||||
pnpm install -g @shipzone/npmci
|
|
||||||
npmci npm prepare
|
|
||||||
|
|
||||||
- name: Code quality
|
|
||||||
run: |
|
|
||||||
npmci command npm install -g typescript
|
|
||||||
npmci npm install
|
|
||||||
|
|
||||||
- name: Trigger
|
|
||||||
run: npmci trigger
|
|
||||||
|
|
||||||
- name: Build docs and upload artifacts
|
|
||||||
run: |
|
|
||||||
npmci node install stable
|
|
||||||
npmci npm install
|
|
||||||
pnpm install -g @git.zone/tsdoc
|
|
||||||
npmci command tsdoc
|
|
||||||
continue-on-error: true
|
|
||||||
141
.gitlab-ci.yml
Normal file
141
.gitlab-ci.yml
Normal file
@ -0,0 +1,141 @@
|
|||||||
|
# gitzone ci_default
|
||||||
|
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
|
|
||||||
|
cache:
|
||||||
|
paths:
|
||||||
|
- .npmci_cache/
|
||||||
|
key: '$CI_BUILD_STAGE'
|
||||||
|
|
||||||
|
stages:
|
||||||
|
- security
|
||||||
|
- test
|
||||||
|
- release
|
||||||
|
- metadata
|
||||||
|
|
||||||
|
before_script:
|
||||||
|
- npm install -g @shipzone/npmci
|
||||||
|
|
||||||
|
# ====================
|
||||||
|
# security stage
|
||||||
|
# ====================
|
||||||
|
mirror:
|
||||||
|
stage: security
|
||||||
|
script:
|
||||||
|
- npmci git mirror
|
||||||
|
only:
|
||||||
|
- tags
|
||||||
|
tags:
|
||||||
|
- lossless
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
|
auditProductionDependencies:
|
||||||
|
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
|
stage: security
|
||||||
|
script:
|
||||||
|
- npmci npm prepare
|
||||||
|
- npmci command npm install --production --ignore-scripts
|
||||||
|
- npmci command npm config set registry https://registry.npmjs.org
|
||||||
|
- npmci command npm audit --audit-level=high --only=prod --production
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
allow_failure: true
|
||||||
|
|
||||||
|
auditDevDependencies:
|
||||||
|
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
|
stage: security
|
||||||
|
script:
|
||||||
|
- npmci npm prepare
|
||||||
|
- npmci command npm install --ignore-scripts
|
||||||
|
- npmci command npm config set registry https://registry.npmjs.org
|
||||||
|
- npmci command npm audit --audit-level=high --only=dev
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
allow_failure: true
|
||||||
|
|
||||||
|
# ====================
|
||||||
|
# test stage
|
||||||
|
# ====================
|
||||||
|
|
||||||
|
testStable:
|
||||||
|
stage: test
|
||||||
|
script:
|
||||||
|
- npmci npm prepare
|
||||||
|
- npmci node install stable
|
||||||
|
- npmci npm install
|
||||||
|
- npmci npm test
|
||||||
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
|
||||||
|
testBuild:
|
||||||
|
stage: test
|
||||||
|
script:
|
||||||
|
- npmci npm prepare
|
||||||
|
- npmci node install stable
|
||||||
|
- npmci npm install
|
||||||
|
- npmci command npm run build
|
||||||
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
|
||||||
|
release:
|
||||||
|
stage: release
|
||||||
|
script:
|
||||||
|
- npmci node install stable
|
||||||
|
- npmci npm publish
|
||||||
|
only:
|
||||||
|
- tags
|
||||||
|
tags:
|
||||||
|
- lossless
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
|
# ====================
|
||||||
|
# metadata stage
|
||||||
|
# ====================
|
||||||
|
codequality:
|
||||||
|
stage: metadata
|
||||||
|
allow_failure: true
|
||||||
|
only:
|
||||||
|
- tags
|
||||||
|
script:
|
||||||
|
- npmci command npm install -g tslint typescript
|
||||||
|
- npmci npm prepare
|
||||||
|
- npmci npm install
|
||||||
|
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
|
||||||
|
tags:
|
||||||
|
- lossless
|
||||||
|
- docker
|
||||||
|
- priv
|
||||||
|
|
||||||
|
trigger:
|
||||||
|
stage: metadata
|
||||||
|
script:
|
||||||
|
- npmci trigger
|
||||||
|
only:
|
||||||
|
- tags
|
||||||
|
tags:
|
||||||
|
- lossless
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
|
pages:
|
||||||
|
stage: metadata
|
||||||
|
script:
|
||||||
|
- npmci node install lts
|
||||||
|
- npmci command npm install -g @gitzone/tsdoc
|
||||||
|
- npmci npm prepare
|
||||||
|
- npmci npm install
|
||||||
|
- npmci command tsdoc
|
||||||
|
tags:
|
||||||
|
- lossless
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
only:
|
||||||
|
- tags
|
||||||
|
artifacts:
|
||||||
|
expire_in: 1 week
|
||||||
|
paths:
|
||||||
|
- public
|
||||||
|
allow_failure: true
|
||||||
96
changelog.md
96
changelog.md
@ -1,96 +0,0 @@
|
|||||||
# Changelog
|
|
||||||
|
|
||||||
## 2025-04-28 - 2.0.0 - BREAKING CHANGE(docs)
|
|
||||||
Update documentation and examples to unify async and sync assertions, add custom matcher guides, and update package configuration
|
|
||||||
|
|
||||||
- Added packageManager field in package.json
|
|
||||||
- Revised documentation in readme.md to use .resolves/.rejects instead of expectAsync
|
|
||||||
- Included detailed examples for custom matchers and updated API usage
|
|
||||||
- Added readme.plan.md outlining the future roadmap
|
|
||||||
- Updated tests to import the built library from dist_ts
|
|
||||||
|
|
||||||
## 2025-03-04 - 1.6.1 - fix(build)
|
|
||||||
Corrected package.json and workflow dependencies and resolved formatting issues in tests.
|
|
||||||
|
|
||||||
- Fixed incorrect global npm package reference for tsdoc installation in workflow file.
|
|
||||||
- Updated dependencies in package.json for consistency in package naming.
|
|
||||||
- Resolved inconsistent formatting and spacing in test files.
|
|
||||||
|
|
||||||
## 2025-03-04 - 1.6.0 - feat(assertion)
|
|
||||||
Enhanced the assertion error messaging and added new test cases.
|
|
||||||
|
|
||||||
- Improved error messages by incorporating path and value/placeholders in assertions.
|
|
||||||
- Added detailed testing of new assertion functionalities.
|
|
||||||
- Additional test cases for comprehensive coverage of new features.
|
|
||||||
|
|
||||||
## 2025-03-04 - 1.5.0 - feat(Assertion)
|
|
||||||
Add toBeTypeOf assertion method
|
|
||||||
|
|
||||||
- Introduced a new assertion method `toBeTypeOf` allowing checks for expected data types.
|
|
||||||
- Updated devDependencies and dependencies to their latest versions.
|
|
||||||
|
|
||||||
## 2024-12-30 - 1.4.0 - feat(Assertion)
|
|
||||||
Add log method to Assertion class
|
|
||||||
|
|
||||||
- Introduced a log method in the Assertion class to output assertion context.
|
|
||||||
|
|
||||||
## 2024-12-30 - 1.3.0 - feat(Assertion)
|
|
||||||
Refactor Assertion class for better error handling and code clarity
|
|
||||||
|
|
||||||
- Improved method runCheck to better handle async and sync execution
|
|
||||||
- Enhanced getObjectToTestReference to handle undefined or null values gracefully
|
|
||||||
- Refactored error message logic for clarity and added more descriptive fail messages
|
|
||||||
- Added arrayItem method for better handling of array index access
|
|
||||||
- Improved structure by integrating consistent error handling in assertion methods
|
|
||||||
|
|
||||||
## 2024-08-24 - 1.2.1 - fix(Assertion)
|
|
||||||
Refactor methods for setting failure and success messages
|
|
||||||
|
|
||||||
- Renamed 'withFailMessage' to 'setFailMessage' for better readability and consistency.
|
|
||||||
- Renamed 'withSuccessMessage' to 'setSuccessMessage' to align with the naming convention.
|
|
||||||
|
|
||||||
## 2024-08-24 - 1.2.0 - feat(assertions)
|
|
||||||
Add custom fail and success messages for assertions
|
|
||||||
|
|
||||||
- Implemented withFailMessage method in Assertion class to customize fail messages
|
|
||||||
- Implemented withSuccessMessage method in Assertion class to customize success messages
|
|
||||||
- Enhanced error messages to use custom fail messages when provided
|
|
||||||
|
|
||||||
## 2024-08-17 - 1.1.0 - feat(assertion)
|
|
||||||
Add toBeDefined assertion method
|
|
||||||
|
|
||||||
- Added the toBeDefined method to the Assertion class for checking if an object is defined
|
|
||||||
|
|
||||||
## 2024-05-29 - 1.0.21 - General Updates
|
|
||||||
General updates and maintenance.
|
|
||||||
|
|
||||||
- Updated description
|
|
||||||
- Updated tsconfig
|
|
||||||
- Updated npmextra.json: githost
|
|
||||||
|
|
||||||
## 2023-08-12 - 1.0.20 to 1.0.21 - General Fixes
|
|
||||||
General fixes and update.
|
|
||||||
|
|
||||||
- Fixed core updates (multiple instances)
|
|
||||||
- 1.0.21 release
|
|
||||||
|
|
||||||
## 2023-07-10 - 1.0.15 - Organization Update
|
|
||||||
- Switched to new org scheme
|
|
||||||
|
|
||||||
## 2023-06-22 - 1.0.14 to 1.0.19 - General Updates
|
|
||||||
General fixes and updates.
|
|
||||||
|
|
||||||
- Fixed core updates (multiple instances)
|
|
||||||
- 1.0.18 to 1.0.16 releases
|
|
||||||
|
|
||||||
## 2022-02-02 - 1.0.8 to 1.0.13 - General Fixes
|
|
||||||
General fixes and update.
|
|
||||||
|
|
||||||
- Fixed core updates (multiple instances)
|
|
||||||
- 1.0.14 release
|
|
||||||
|
|
||||||
## 2022-01-20 - 1.0.1 to 1.0.7 - Initial Releases
|
|
||||||
Initial core updates and fixes.
|
|
||||||
|
|
||||||
- Fixed core updates (multiple instances)
|
|
||||||
- 1.0.7 release
|
|
||||||
@ -2,32 +2,17 @@
|
|||||||
"gitzone": {
|
"gitzone": {
|
||||||
"projectType": "npm",
|
"projectType": "npm",
|
||||||
"module": {
|
"module": {
|
||||||
"githost": "code.foss.global",
|
"githost": "gitlab.com",
|
||||||
"gitscope": "push.rocks",
|
"gitscope": "pushrocks",
|
||||||
"gitrepo": "smartexpect",
|
"gitrepo": "smartexpect",
|
||||||
"description": "A testing library to manage expectations in code, offering both synchronous and asynchronous assertion methods.",
|
"description": "manage expectations in code",
|
||||||
"npmPackagename": "@push.rocks/smartexpect",
|
"npmPackagename": "@pushrocks/smartexpect",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"projectDomain": "push.rocks",
|
"projectDomain": "push.rocks"
|
||||||
"keywords": [
|
|
||||||
"testing",
|
|
||||||
"assertions",
|
|
||||||
"code quality",
|
|
||||||
"unit testing",
|
|
||||||
"test driven development",
|
|
||||||
"synchronous testing",
|
|
||||||
"asynchronous testing",
|
|
||||||
"expectations",
|
|
||||||
"validation",
|
|
||||||
"development tools"
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"npmci": {
|
"npmci": {
|
||||||
"npmGlobalTools": [],
|
"npmGlobalTools": [],
|
||||||
"npmAccessLevel": "public"
|
"npmAccessLevel": "public"
|
||||||
},
|
|
||||||
"tsdoc": {
|
|
||||||
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
27557
package-lock.json
generated
Normal file
27557
package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
50
package.json
50
package.json
@ -1,29 +1,28 @@
|
|||||||
{
|
{
|
||||||
"name": "@push.rocks/smartexpect",
|
"name": "@pushrocks/smartexpect",
|
||||||
"version": "2.0.0",
|
"version": "1.0.12",
|
||||||
"private": false,
|
"private": false,
|
||||||
"description": "A testing library to manage expectations in code, offering both synchronous and asynchronous assertion methods.",
|
"description": "manage expectations in code",
|
||||||
"main": "dist_ts/index.js",
|
"main": "dist_ts/index.js",
|
||||||
"typings": "dist_ts/index.d.ts",
|
"typings": "dist_ts/index.d.ts",
|
||||||
"type": "module",
|
|
||||||
"author": "Lossless GmbH",
|
"author": "Lossless GmbH",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "(tstest test/ --web)",
|
"test": "(tstest test/ --web)",
|
||||||
"build": "(tsbuild tsfolders)",
|
"build": "(tsbuild --web)"
|
||||||
"buildDocs": "tsdoc"
|
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@git.zone/tsbuild": "^2.2.1",
|
"@gitzone/tsbuild": "^2.1.25",
|
||||||
"@git.zone/tsbundle": "^2.2.5",
|
"@gitzone/tsbundle": "^1.0.89",
|
||||||
"@git.zone/tsrun": "^1.3.3",
|
"@gitzone/tstest": "^1.0.44",
|
||||||
"@git.zone/tstest": "^1.0.96",
|
"@pushrocks/tapbundle": "^4.0.0",
|
||||||
"@push.rocks/tapbundle": "^5.5.6",
|
"@types/node": "^17.0.14",
|
||||||
"@types/node": "^22.13.9"
|
"tslint": "^6.1.3",
|
||||||
|
"tslint-config-prettier": "^1.15.0"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@push.rocks/smartdelay": "^3.0.5",
|
"@pushrocks/smartdelay": "^2.0.13",
|
||||||
"@push.rocks/smartpromise": "^4.2.3",
|
"@pushrocks/smartpromise": "^3.1.6",
|
||||||
"fast-deep-equal": "^3.1.3"
|
"fast-deep-equal": "^3.1.3"
|
||||||
},
|
},
|
||||||
"browserslist": [
|
"browserslist": [
|
||||||
@ -40,28 +39,5 @@
|
|||||||
"cli.js",
|
"cli.js",
|
||||||
"npmextra.json",
|
"npmextra.json",
|
||||||
"readme.md"
|
"readme.md"
|
||||||
],
|
|
||||||
"keywords": [
|
|
||||||
"testing",
|
|
||||||
"assertions",
|
|
||||||
"code quality",
|
|
||||||
"unit testing",
|
|
||||||
"test driven development",
|
|
||||||
"synchronous testing",
|
|
||||||
"asynchronous testing",
|
|
||||||
"expectations",
|
|
||||||
"validation",
|
|
||||||
"development tools"
|
|
||||||
],
|
|
||||||
"homepage": "https://code.foss.global/push.rocks/smartexpect",
|
|
||||||
"repository": {
|
|
||||||
"type": "git",
|
|
||||||
"url": "https://code.foss.global/push.rocks/smartexpect.git"
|
|
||||||
},
|
|
||||||
"pnpm": {
|
|
||||||
"onlyBuiltDependencies": [
|
|
||||||
"mongodb-memory-server"
|
|
||||||
]
|
]
|
||||||
},
|
|
||||||
"packageManager": "pnpm@10.7.0+sha512.6b865ad4b62a1d9842b61d674a393903b871d9244954f652b8842c2b553c72176b278f64c463e52d40fff8aba385c235c8c9ecf5cc7de4fd78b8bb6d49633ab6"
|
|
||||||
}
|
}
|
||||||
|
|||||||
9923
pnpm-lock.yaml
generated
9923
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
@ -1 +0,0 @@
|
|||||||
|
|
||||||
303
readme.md
303
readme.md
@ -1,286 +1,39 @@
|
|||||||
# @push.rocks/smartexpect
|
# @pushrocks/smartexpect
|
||||||
Manage expectations in code with precise, readable assertions
|
manage expectations in code
|
||||||
|
|
||||||
## Install
|
## Availabililty and Links
|
||||||
|
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartexpect)
|
||||||
|
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartexpect)
|
||||||
|
* [github.com (source mirror)](https://github.com/pushrocks/smartexpect)
|
||||||
|
* [docs (typedoc)](https://pushrocks.gitlab.io/smartexpect/)
|
||||||
|
|
||||||
To install `@push.rocks/smartexpect`, use the following command in your terminal:
|
## Status for master
|
||||||
|
|
||||||
```bash
|
Status Category | Status Badge
|
||||||
npm install @push.rocks/smartexpect --save
|
-- | --
|
||||||
```
|
GitLab Pipelines | [](https://lossless.cloud)
|
||||||
|
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||||
This will add `@push.rocks/smartexpect` to your project's dependencies. Make sure you're inside your project directory before running this command.
|
npm | [](https://lossless.cloud)
|
||||||
|
Snyk | [](https://lossless.cloud)
|
||||||
|
TypeScript Support | [](https://lossless.cloud)
|
||||||
|
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||||
|
Code Style | [](https://lossless.cloud)
|
||||||
|
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||||
|
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||||
|
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||||
|
Platform support | [](https://lossless.cloud) [](https://lossless.cloud)
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
`@push.rocks/smartexpect` is a TypeScript library designed to manage expectations in your code effectively, improving testing readability and maintainability. Below are various scenarios showcasing how to use this library effectively across both synchronous and asynchronous code paths.
|
Use TypeScript for best in class intellisense
|
||||||
|
|
||||||
### Getting Started
|
## Contribution
|
||||||
|
|
||||||
First, import `@push.rocks/smartexpect` into your TypeScript file:
|
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
||||||
|
|
||||||
```typescript
|
For further information read the linked docs at the top of this readme.
|
||||||
import { expect, expectAsync } from '@push.rocks/smartexpect';
|
|
||||||
```
|
|
||||||
|
|
||||||
### Synchronous Expectations
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||||
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||||||
|
|
||||||
You can employ `expect` to create synchronous assertions:
|
[](https://maintainedby.lossless.com)
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { expect } from '@push.rocks/smartexpect';
|
|
||||||
|
|
||||||
// Type assertions
|
|
||||||
expect('hello').toBeTypeofString();
|
|
||||||
expect(42).toBeTypeofNumber();
|
|
||||||
expect(true).toBeTypeofBoolean();
|
|
||||||
expect(() => {}).toBeTypeOf('function');
|
|
||||||
expect({}).toBeTypeOf('object');
|
|
||||||
|
|
||||||
// Negated assertions
|
|
||||||
expect(1).not.toBeTypeofString();
|
|
||||||
expect('string').not.toBeTypeofNumber();
|
|
||||||
|
|
||||||
// Equality assertion
|
|
||||||
expect('hithere').toEqual('hithere');
|
|
||||||
|
|
||||||
// Deep equality assertion
|
|
||||||
expect({ key: 'value' }).toEqual({ key: 'value' });
|
|
||||||
|
|
||||||
// Regular expression matching
|
|
||||||
expect('hithere').toMatch(/hi/);
|
|
||||||
```
|
|
||||||
|
|
||||||
### Asynchronous Expectations
|
|
||||||
|
|
||||||
For asynchronous code, use the same `expect` function with the `.resolves` or `.rejects` modifier:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { expect } from '@push.rocks/smartexpect';
|
|
||||||
|
|
||||||
const asyncStringFetcher = async (): Promise<string> => {
|
|
||||||
return 'async string';
|
|
||||||
};
|
|
||||||
|
|
||||||
const asyncTest = async () => {
|
|
||||||
// Add a timeout to prevent hanging tests
|
|
||||||
await expect(asyncStringFetcher()).resolves.withTimeout(5000).type.toBeTypeofString();
|
|
||||||
await expect(asyncStringFetcher()).resolves.toEqual('async string');
|
|
||||||
};
|
|
||||||
|
|
||||||
asyncTest();
|
|
||||||
```
|
|
||||||
|
|
||||||
### Navigating Complex Objects
|
|
||||||
|
|
||||||
You can navigate complex objects using the `property()` and `arrayItem()` methods:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
const complexObject = {
|
|
||||||
users: [
|
|
||||||
{ id: 1, name: 'Alice', permissions: { admin: true } },
|
|
||||||
{ id: 2, name: 'Bob', permissions: { admin: false } }
|
|
||||||
]
|
|
||||||
};
|
|
||||||
|
|
||||||
// Navigate to a nested property
|
|
||||||
expect(complexObject)
|
|
||||||
.property('users')
|
|
||||||
.arrayItem(0)
|
|
||||||
.property('name')
|
|
||||||
.toEqual('Alice');
|
|
||||||
|
|
||||||
// Check nested permission
|
|
||||||
expect(complexObject)
|
|
||||||
.property('users')
|
|
||||||
.arrayItem(0)
|
|
||||||
.property('permissions')
|
|
||||||
.property('admin')
|
|
||||||
.toBeTrue();
|
|
||||||
```
|
|
||||||
|
|
||||||
### Advanced Assertions
|
|
||||||
|
|
||||||
#### Properties and Deep Properties
|
|
||||||
|
|
||||||
Assert the existence of properties and their values:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
const testObject = { level1: { level2: 'value' } };
|
|
||||||
|
|
||||||
// Property existence
|
|
||||||
expect(testObject).toHaveProperty('level1');
|
|
||||||
|
|
||||||
// Property with specific value
|
|
||||||
expect(testObject).toHaveProperty('level1.level2', 'value');
|
|
||||||
|
|
||||||
// Deep Property existence
|
|
||||||
expect(testObject).toHaveDeepProperty(['level1', 'level2']);
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Conditions and Comparisons
|
|
||||||
|
|
||||||
Perform more intricate assertions:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
// Numeric comparisons
|
|
||||||
expect(5).toBeGreaterThan(3);
|
|
||||||
expect(3).toBeLessThan(5);
|
|
||||||
expect(5).toBeGreaterThanOrEqual(5);
|
|
||||||
expect(5).toBeLessThanOrEqual(5);
|
|
||||||
expect(0.1 + 0.2).toBeCloseTo(0.3, 10); // Floating point comparison with precision
|
|
||||||
|
|
||||||
// Truthiness checks
|
|
||||||
expect(true).toBeTrue();
|
|
||||||
expect(false).toBeFalse();
|
|
||||||
expect('non-empty').toBeTruthy();
|
|
||||||
expect(0).toBeFalsy();
|
|
||||||
|
|
||||||
// Null/Undefined checks
|
|
||||||
expect(null).toBeNull();
|
|
||||||
expect(undefined).toBeUndefined();
|
|
||||||
expect(null).toBeNullOrUndefined();
|
|
||||||
|
|
||||||
// Custom conditions
|
|
||||||
expect(7).customAssertion(value => value % 2 === 1, 'Value is not odd');
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Arrays and Collections
|
|
||||||
|
|
||||||
Work seamlessly with arrays and collections:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
const testArray = [1, 2, 3];
|
|
||||||
|
|
||||||
// Array checks
|
|
||||||
expect(testArray).toBeArray();
|
|
||||||
expect(testArray).toHaveLength(3);
|
|
||||||
expect(testArray).toContain(2);
|
|
||||||
expect(testArray).toContainAll([1, 3]);
|
|
||||||
expect(testArray).toExclude(4);
|
|
||||||
expect([]).toBeEmptyArray();
|
|
||||||
expect(testArray).toHaveLengthGreaterThan(2);
|
|
||||||
expect(testArray).toHaveLengthLessThan(4);
|
|
||||||
|
|
||||||
// Deep equality in arrays
|
|
||||||
expect([{ id: 1 }, { id: 2 }]).toContainEqual({ id: 1 });
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Strings
|
|
||||||
|
|
||||||
String-specific checks:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
expect('hello world').toStartWith('hello');
|
|
||||||
expect('hello world').toEndWith('world');
|
|
||||||
expect('hello world').toInclude('lo wo');
|
|
||||||
expect('options').toBeOneOf(['choices', 'options', 'alternatives']);
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Functions and Exceptions
|
|
||||||
|
|
||||||
Test function behavior and exceptions:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
const throwingFn = () => { throw new Error('test error'); };
|
|
||||||
expect(throwingFn).toThrow();
|
|
||||||
expect(throwingFn).toThrow(Error);
|
|
||||||
|
|
||||||
const safeFn = () => 'result';
|
|
||||||
expect(safeFn).not.toThrow();
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Date Assertions
|
|
||||||
|
|
||||||
Work with dates:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
const now = new Date();
|
|
||||||
const past = new Date(Date.now() - 10000);
|
|
||||||
const future = new Date(Date.now() + 10000);
|
|
||||||
|
|
||||||
expect(now).toBeDate();
|
|
||||||
expect(now).toBeAfterDate(past);
|
|
||||||
expect(now).toBeBeforeDate(future);
|
|
||||||
```
|
|
||||||
|
|
||||||
### Debugging Assertions
|
|
||||||
|
|
||||||
The `log()` method is useful for debugging complex assertions:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
expect(complexObject)
|
|
||||||
.property('users')
|
|
||||||
.log() // Logs the current value in the assertion chain
|
|
||||||
.arrayItem(0)
|
|
||||||
.log() // Logs the first user
|
|
||||||
.property('permissions')
|
|
||||||
.log() // Logs the permissions object
|
|
||||||
.property('admin')
|
|
||||||
.toBeTrue();
|
|
||||||
```
|
|
||||||
|
|
||||||
### Customizing Error Messages
|
|
||||||
|
|
||||||
You can provide custom error messages for more meaningful test failures:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
expect(user.age)
|
|
||||||
.setFailMessage('User age must be at least 18 for adult content')
|
|
||||||
.toBeGreaterThanOrEqual(18);
|
|
||||||
```
|
|
||||||
|
|
||||||
### Custom Matchers
|
|
||||||
|
|
||||||
You can define your own matchers via `expect.extend()`:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
expect.extend({
|
|
||||||
toBeOdd(received: number) {
|
|
||||||
const pass = received % 2 === 1;
|
|
||||||
return {
|
|
||||||
pass,
|
|
||||||
message: () =>
|
|
||||||
`Expected ${received} ${pass ? 'not ' : ''}to be odd`,
|
|
||||||
};
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
// Then use your custom matcher in tests:
|
|
||||||
expect(3).toBeOdd();
|
|
||||||
expect(4).not.toBeOdd();
|
|
||||||
```
|
|
||||||
|
|
||||||
- Matcher functions receive the value under test (`received`) plus any arguments.
|
|
||||||
- Must return an object with `pass` (boolean) and `message` (string or function) for failure messages.
|
|
||||||
|
|
||||||
## Best Practices
|
|
||||||
|
|
||||||
- **Human-readable assertions**: The fluent API is designed to create tests that read like natural language sentences.
|
|
||||||
|
|
||||||
- **Precise error messages**: When tests fail, the error messages provide detailed information about what went wrong, including expected vs. actual values.
|
|
||||||
|
|
||||||
- **Property path navigation**: Use the property path methods to navigate complex objects without creating temporary variables.
|
|
||||||
|
|
||||||
- **Comprehensive testing**: Take advantage of the wide range of assertion methods to test various aspects of your code.
|
|
||||||
|
|
||||||
- **Debugging with log()**: Use the `log()` method to see intermediate values in the assertion chain during test development.
|
|
||||||
|
|
||||||
## License and Legal Information
|
|
||||||
|
|
||||||
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
|
|
||||||
|
|
||||||
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
|
||||||
|
|
||||||
### Trademarks
|
|
||||||
|
|
||||||
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
|
|
||||||
|
|
||||||
### Company Information
|
|
||||||
|
|
||||||
Task Venture Capital GmbH
|
|
||||||
Registered at District court Bremen HRB 35230 HB, Germany
|
|
||||||
|
|
||||||
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
|
|
||||||
|
|
||||||
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|
|
||||||
|
|||||||
@ -1,37 +0,0 @@
|
|||||||
# Plan for Improving @push.rocks/smartexpect API
|
|
||||||
|
|
||||||
This document captures the roadmap for evolving the `expect` / `expectAsync` API.
|
|
||||||
|
|
||||||
## Phase 1: Unify Sync + Async
|
|
||||||
- [x] Consolidate `expect` and `expectAsync` into a single `expect()` entry point.
|
|
||||||
- [x] Introduce `.resolves` and `.rejects` chainable helpers for Promises.
|
|
||||||
- [x] Deprecate `expectAsync`, provide migration guidance.
|
|
||||||
|
|
||||||
## Phase 2: Timeout Helper
|
|
||||||
- [x] Rename or wrap the existing `.timeout(ms)` to a more intuitive `.withTimeout(ms)`.
|
|
||||||
|
|
||||||
## Phase 3: Custom Matchers
|
|
||||||
- [x] Implement `expect.extend()` API for user-defined matchers.
|
|
||||||
|
|
||||||
## Phase 4: TypeScript Typings
|
|
||||||
- [ ] Enhance generic matcher types to infer narrow types after `.property()` / `.arrayItem()`.
|
|
||||||
- [ ] Provide matcher overloads for primitive categories (string, number, array, etc.).
|
|
||||||
|
|
||||||
## Phase 5: Namespaced Matchers
|
|
||||||
- [ ] Group matchers under `.string`, `.array`, `.number`, etc. for discoverability.
|
|
||||||
|
|
||||||
## Phase 6: Jest-Style Convenience
|
|
||||||
- [ ] Add `.toMatchObject()`, `.toMatchSnapshot()`, `expect.any()`, `expect.anything()`, etc.
|
|
||||||
|
|
||||||
## Phase 7: Error Messages & Diffs
|
|
||||||
- [ ] Integrate a diffing library for clear failure output with colorized diffs.
|
|
||||||
|
|
||||||
## Phase 8: Nested Access Chaining
|
|
||||||
- [ ] Provide `.at(path)` or lens-based API for deep property assertions in one go.
|
|
||||||
|
|
||||||
## Phase 9: Pluggable Reporters
|
|
||||||
- [ ] Allow consumers to swap output format: JSON, TAP, HTML, etc.
|
|
||||||
|
|
||||||
## Phase 10: API Cleanup
|
|
||||||
- [ ] Audit and remove legacy aliases and redundant methods.
|
|
||||||
- [ ] Finalize deprecations and bump to a major version.
|
|
||||||
@ -1,221 +0,0 @@
|
|||||||
import { tap } from '@push.rocks/tapbundle';
|
|
||||||
// Import the built library (dist_ts) so all matcher implementations are available
|
|
||||||
import * as smartexpect from '../dist_ts/index.js';
|
|
||||||
|
|
||||||
tap.test('basic type assertions', async () => {
|
|
||||||
// String type checks
|
|
||||||
smartexpect.expect('hello').type.toBeTypeofString();
|
|
||||||
smartexpect.expect(1).not.type.toBeTypeofString();
|
|
||||||
|
|
||||||
// Boolean type checks
|
|
||||||
smartexpect.expect(true).type.toBeTypeofBoolean();
|
|
||||||
smartexpect.expect(false).type.toBeTypeofBoolean();
|
|
||||||
smartexpect.expect(1).not.type.toBeTypeofBoolean();
|
|
||||||
|
|
||||||
// Number type checks
|
|
||||||
smartexpect.expect(42).type.toBeTypeofNumber();
|
|
||||||
smartexpect.expect(true).not.type.toBeTypeofNumber();
|
|
||||||
|
|
||||||
// Generic type checks with new method
|
|
||||||
smartexpect.expect(() => {}).type.toBeTypeOf('function');
|
|
||||||
smartexpect.expect(class Test {}).type.toBeTypeOf('function');
|
|
||||||
smartexpect.expect({}).type.toBeTypeOf('object');
|
|
||||||
smartexpect.expect(Symbol('test')).type.toBeTypeOf('symbol');
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('async tests', async (toolsArg) => {
|
|
||||||
const deferred = toolsArg.defer();
|
|
||||||
toolsArg.delayFor(1000).then(() => {
|
|
||||||
deferred.resolve('hello');
|
|
||||||
});
|
|
||||||
// Using .resolves to test promise resolution with timeout
|
|
||||||
await smartexpect.expect(deferred.promise).resolves.withTimeout(2000).type.toBeTypeofString();
|
|
||||||
await smartexpect.expect(deferred.promise).resolves.not.type.toBeTypeofBoolean();
|
|
||||||
|
|
||||||
// Test async timeout handling
|
|
||||||
const longOperation = toolsArg.defer();
|
|
||||||
toolsArg.delayFor(3000).then(() => {
|
|
||||||
longOperation.resolve('completed');
|
|
||||||
});
|
|
||||||
try {
|
|
||||||
// Assert that resolution must occur within timeout
|
|
||||||
await smartexpect.expect(longOperation.promise).resolves.withTimeout(1000).toBeDefined();
|
|
||||||
throw new Error('Should have timed out');
|
|
||||||
} catch (err) {
|
|
||||||
// Successfully caught timeout error from .withTimeout
|
|
||||||
console.log('Successfully caught timeout:', err.message);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('equality and matching assertions', async () => {
|
|
||||||
// Basic equality
|
|
||||||
smartexpect.expect('hithere').object.toEqual('hithere');
|
|
||||||
smartexpect.expect('hithere').not.object.toEqual('hithere2');
|
|
||||||
|
|
||||||
// Object equality
|
|
||||||
const obj1 = { a: 1, b: { c: true } };
|
|
||||||
const obj2 = { a: 1, b: { c: true } };
|
|
||||||
const obj3 = { a: 1, b: { c: false } };
|
|
||||||
smartexpect.expect(obj1).object.toEqual(obj2);
|
|
||||||
smartexpect.expect(obj1).not.object.toEqual(obj3);
|
|
||||||
|
|
||||||
// RegExp matching
|
|
||||||
smartexpect.expect('hithere').string.toMatch(/hi/);
|
|
||||||
smartexpect.expect('hithere').string.toMatch(/^hithere$/);
|
|
||||||
smartexpect.expect('hithere').not.string.toMatch(/ho/);
|
|
||||||
|
|
||||||
// String inclusion
|
|
||||||
smartexpect.expect('hithere').string.toInclude('hit');
|
|
||||||
smartexpect.expect('hithere').not.string.toInclude('missing');
|
|
||||||
|
|
||||||
// String start/end
|
|
||||||
smartexpect.expect('hithere').string.toStartWith('hi');
|
|
||||||
smartexpect.expect('hithere').string.toEndWith('ere');
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('object property assertions', async () => {
|
|
||||||
const testObject = {
|
|
||||||
topLevel: 'hello',
|
|
||||||
nested: {
|
|
||||||
prop: 42,
|
|
||||||
deeplyNested: {
|
|
||||||
array: [1, 2, 3],
|
|
||||||
},
|
|
||||||
},
|
|
||||||
};
|
|
||||||
|
|
||||||
// Basic property checks
|
|
||||||
smartexpect.expect(testObject).object.toHaveProperty('topLevel');
|
|
||||||
smartexpect.expect(testObject).object.toHaveProperty('topLevel', 'hello');
|
|
||||||
smartexpect.expect(testObject).not.object.toHaveProperty('missing');
|
|
||||||
|
|
||||||
// Drill-down property navigation
|
|
||||||
smartexpect.expect(testObject).property('nested').object.toHaveProperty('prop', 42);
|
|
||||||
smartexpect
|
|
||||||
.expect(testObject)
|
|
||||||
.property('nested')
|
|
||||||
.property('deeplyNested')
|
|
||||||
.property('array')
|
|
||||||
.array.toBeArray();
|
|
||||||
|
|
||||||
// Deep property checks
|
|
||||||
smartexpect.expect(testObject).object.toHaveDeepProperty(['nested', 'deeplyNested', 'array']);
|
|
||||||
|
|
||||||
// Array item navigation
|
|
||||||
smartexpect
|
|
||||||
.expect(testObject)
|
|
||||||
.property('nested')
|
|
||||||
.property('deeplyNested')
|
|
||||||
.property('array')
|
|
||||||
.arrayItem(0)
|
|
||||||
.number.toEqual(1); // numeric equality via number namespace
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('numeric comparison assertions', async () => {
|
|
||||||
// Greater/less than
|
|
||||||
smartexpect.expect(4).number.toBeGreaterThan(3);
|
|
||||||
smartexpect.expect(4).number.toBeLessThan(5);
|
|
||||||
smartexpect.expect(4).number.toBeGreaterThanOrEqual(4);
|
|
||||||
smartexpect.expect(4).number.toBeLessThanOrEqual(4);
|
|
||||||
|
|
||||||
// Approximate equality
|
|
||||||
smartexpect.expect(0.1 + 0.2).number.toBeCloseTo(0.3, 10);
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('array assertions', async () => {
|
|
||||||
const obj1 = { id: 1 };
|
|
||||||
const obj2 = { id: 2 };
|
|
||||||
const testArray = [1, 'two', obj1, true];
|
|
||||||
|
|
||||||
// Basic array checks
|
|
||||||
smartexpect.expect(testArray).array.toBeArray();
|
|
||||||
smartexpect.expect(testArray).array.toHaveLength(4);
|
|
||||||
|
|
||||||
// Content checks
|
|
||||||
smartexpect.expect(testArray).array.toContain('two');
|
|
||||||
smartexpect.expect(testArray).array.toContain(obj1);
|
|
||||||
smartexpect.expect(testArray).not.array.toContain(obj2);
|
|
||||||
|
|
||||||
// Array with equal items (not same reference)
|
|
||||||
smartexpect.expect([{ a: 1 }, { b: 2 }]).array.toContainEqual({ a: 1 });
|
|
||||||
|
|
||||||
// Multiple values
|
|
||||||
smartexpect.expect(testArray).array.toContainAll([1, 'two']);
|
|
||||||
smartexpect.expect(testArray).array.toExclude('missing');
|
|
||||||
|
|
||||||
// Empty array
|
|
||||||
smartexpect.expect([]).array.toBeEmptyArray();
|
|
||||||
|
|
||||||
// Length comparisons
|
|
||||||
smartexpect.expect(testArray).array.toHaveLengthGreaterThan(3);
|
|
||||||
smartexpect.expect(testArray).array.toHaveLengthLessThan(5);
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('boolean assertions', async () => {
|
|
||||||
// True/False
|
|
||||||
smartexpect.expect(true).boolean.toBeTrue();
|
|
||||||
smartexpect.expect(false).boolean.toBeFalse();
|
|
||||||
|
|
||||||
// Truthy/Falsy
|
|
||||||
smartexpect.expect('something').boolean.toBeTruthy();
|
|
||||||
smartexpect.expect(0).boolean.toBeFalsy();
|
|
||||||
|
|
||||||
// Null/Undefined
|
|
||||||
smartexpect.expect(null).object.toBeNull();
|
|
||||||
smartexpect.expect(undefined).object.toBeUndefined();
|
|
||||||
smartexpect.expect(null).object.toBeNullOrUndefined();
|
|
||||||
smartexpect.expect(undefined).object.toBeNullOrUndefined();
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('function assertions', async () => {
|
|
||||||
// Function that throws
|
|
||||||
const throwingFn = () => {
|
|
||||||
throw new Error('test error');
|
|
||||||
};
|
|
||||||
smartexpect.expect(throwingFn).function.toThrow();
|
|
||||||
smartexpect.expect(throwingFn).function.toThrow(Error);
|
|
||||||
|
|
||||||
// Function that doesn't throw
|
|
||||||
const nonThrowingFn = () => 'safe';
|
|
||||||
smartexpect.expect(nonThrowingFn).not.function.toThrow();
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('date assertions', async () => {
|
|
||||||
const now = new Date();
|
|
||||||
const past = new Date(Date.now() - 10000);
|
|
||||||
const future = new Date(Date.now() + 10000);
|
|
||||||
|
|
||||||
smartexpect.expect(now).date.toBeDate();
|
|
||||||
smartexpect.expect(now).date.toBeAfterDate(past);
|
|
||||||
smartexpect.expect(now).date.toBeBeforeDate(future);
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('custom assertions', async () => {
|
|
||||||
// Custom validation logic
|
|
||||||
smartexpect.expect(42).customAssertion((value) => value % 2 === 0, 'Expected number to be even');
|
|
||||||
|
|
||||||
// With fail message
|
|
||||||
smartexpect.expect('test').setFailMessage('Custom fail message for assertion').string.toHaveLength(4);
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('logging and debugging', async () => {
|
|
||||||
// Using log() for debugging
|
|
||||||
const complexObject = {
|
|
||||||
level1: {
|
|
||||||
level2: {
|
|
||||||
value: 'nested value',
|
|
||||||
},
|
|
||||||
},
|
|
||||||
};
|
|
||||||
|
|
||||||
// This logs the current value in the chain for debugging
|
|
||||||
smartexpect
|
|
||||||
.expect(complexObject)
|
|
||||||
.property('level1')
|
|
||||||
.property('level2')
|
|
||||||
.log()
|
|
||||||
.property('value')
|
|
||||||
.object.toEqual('nested value');
|
|
||||||
});
|
|
||||||
|
|
||||||
export default tap.start();
|
|
||||||
47
test/test.ts
Normal file
47
test/test.ts
Normal file
@ -0,0 +1,47 @@
|
|||||||
|
import { tap } from '@pushrocks/tapbundle';
|
||||||
|
import * as smartexpect from '../ts/index';
|
||||||
|
|
||||||
|
tap.test('sync tests', async () => {
|
||||||
|
smartexpect.expect('hello').toBeTypeofString();
|
||||||
|
smartexpect.expect(1).not.toBeTypeofString();
|
||||||
|
smartexpect.expect(true).toBeTypeofBoolean();
|
||||||
|
smartexpect.expect(true).not.toBeTypeofNumber();
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('async tests', async (toolsArg) => {
|
||||||
|
const deferred = toolsArg.defer();
|
||||||
|
toolsArg.delayFor(4000).then(() => {
|
||||||
|
deferred.resolve('hello');
|
||||||
|
});
|
||||||
|
await smartexpect.expectAsync(deferred.promise).timeout(5000).toBeTypeofString();
|
||||||
|
await smartexpect.expectAsync(deferred.promise).not.toBeTypeofBoolean();
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should check equality', async () => {
|
||||||
|
smartexpect.expect('hithere').toEqual('hithere');
|
||||||
|
smartexpect.expect('hithere').not.toEqual('hithere2');
|
||||||
|
})
|
||||||
|
|
||||||
|
tap.test('should correctly state property presence', async () => {
|
||||||
|
const testObject = {
|
||||||
|
aprop: 'hello'
|
||||||
|
};
|
||||||
|
|
||||||
|
smartexpect.expect(testObject).toHaveProperty('aprop');
|
||||||
|
smartexpect.expect(testObject).not.toHaveProperty('aprop2');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should be greater than', async () => {
|
||||||
|
smartexpect.expect(4).toBeGreaterThan(3);
|
||||||
|
smartexpect.expect(4).toBeLessThan(5);
|
||||||
|
})
|
||||||
|
|
||||||
|
tap.test('should correctly determine toContain', async () => {
|
||||||
|
const hello = {
|
||||||
|
socool: 'yes'
|
||||||
|
};
|
||||||
|
const testArray = [hello];
|
||||||
|
smartexpect.expect(testArray).toContain(hello);
|
||||||
|
})
|
||||||
|
|
||||||
|
tap.start();
|
||||||
@ -1,8 +0,0 @@
|
|||||||
/**
|
|
||||||
* autocreated commitinfo by @push.rocks/commitinfo
|
|
||||||
*/
|
|
||||||
export const commitinfo = {
|
|
||||||
name: '@push.rocks/smartexpect',
|
|
||||||
version: '2.0.0',
|
|
||||||
description: 'A testing library to manage expectations in code, offering both synchronous and asynchronous assertion methods.'
|
|
||||||
}
|
|
||||||
48
ts/index.ts
48
ts/index.ts
@ -1,43 +1,13 @@
|
|||||||
import { Assertion } from './smartexpect.classes.assertion.js';
|
import * as plugins from './smartexpect.plugins';
|
||||||
// import type { TMatcher } from './smartexpect.classes.assertion.js'; // unused
|
|
||||||
|
|
||||||
/**
|
import { Assertion } from './smartexpect.classes.assertion';
|
||||||
* Primary entry point for assertions.
|
|
||||||
* Automatically detects Promises to support async assertions.
|
export const expect = (baseArg: any) => {
|
||||||
*/
|
const assertion = new Assertion(baseArg, 'sync');
|
||||||
/**
|
return assertion;
|
||||||
* The `expect` function interface. Supports custom matchers via .extend.
|
|
||||||
*/
|
|
||||||
/**
|
|
||||||
* Entry point for assertions.
|
|
||||||
* Automatically detects Promises to support async assertions.
|
|
||||||
*/
|
|
||||||
export function expect<T>(value: Promise<T>): Assertion<T>;
|
|
||||||
export function expect<T>(value: T): Assertion<T>;
|
|
||||||
export function expect<T>(value: any): Assertion<T> {
|
|
||||||
const isThenable = value != null && typeof (value as any).then === 'function';
|
|
||||||
const mode: 'sync' | 'async' = isThenable ? 'async' : 'sync';
|
|
||||||
return new Assertion<T>(value, mode);
|
|
||||||
}
|
|
||||||
/**
|
|
||||||
* Register custom matchers.
|
|
||||||
*/
|
|
||||||
export namespace expect {
|
|
||||||
export const extend = Assertion.extend;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* @deprecated Use `expect(...)` with `.resolves` or `.rejects` instead.
|
|
||||||
*/
|
|
||||||
/**
|
|
||||||
* @deprecated Use `expect(...)` with `.resolves` or `.rejects` instead.
|
|
||||||
*/
|
|
||||||
/**
|
|
||||||
* @deprecated Use `expect(...)` with `.resolves` or `.rejects` instead.
|
|
||||||
*/
|
|
||||||
export const expectAsync = (baseArg: any) => {
|
export const expectAsync = (baseArg: any) => {
|
||||||
// eslint-disable-next-line no-console
|
const assertion = new Assertion(baseArg, 'async');
|
||||||
console.warn('[DEPRECATED] expectAsync() is deprecated. Use expect(...).resolves / .rejects');
|
return assertion;
|
||||||
return new Assertion<any>(baseArg, 'async');
|
}
|
||||||
};
|
|
||||||
|
|
||||||
@ -1,44 +0,0 @@
|
|||||||
import { Assertion } from '../smartexpect.classes.assertion.js';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Namespace for array-specific matchers
|
|
||||||
*/
|
|
||||||
export class ArrayMatchers<T> {
|
|
||||||
constructor(private assertion: Assertion<T[]>) {}
|
|
||||||
|
|
||||||
toBeArray() {
|
|
||||||
return this.assertion.toBeArray();
|
|
||||||
}
|
|
||||||
|
|
||||||
toHaveLength(length: number) {
|
|
||||||
return this.assertion.toHaveLength(length);
|
|
||||||
}
|
|
||||||
|
|
||||||
toContain(item: T) {
|
|
||||||
return this.assertion.toContain(item);
|
|
||||||
}
|
|
||||||
|
|
||||||
toContainEqual(item: T) {
|
|
||||||
return this.assertion.toContainEqual(item);
|
|
||||||
}
|
|
||||||
|
|
||||||
toContainAll(items: T[]) {
|
|
||||||
return this.assertion.toContainAll(items);
|
|
||||||
}
|
|
||||||
|
|
||||||
toExclude(item: T) {
|
|
||||||
return this.assertion.toExclude(item);
|
|
||||||
}
|
|
||||||
|
|
||||||
toBeEmptyArray() {
|
|
||||||
return this.assertion.toBeEmptyArray();
|
|
||||||
}
|
|
||||||
|
|
||||||
toHaveLengthGreaterThan(length: number) {
|
|
||||||
return this.assertion.toHaveLengthGreaterThan(length);
|
|
||||||
}
|
|
||||||
|
|
||||||
toHaveLengthLessThan(length: number) {
|
|
||||||
return this.assertion.toHaveLengthLessThan(length);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,24 +0,0 @@
|
|||||||
import { Assertion } from '../smartexpect.classes.assertion.js';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Namespace for boolean-specific matchers
|
|
||||||
*/
|
|
||||||
export class BooleanMatchers {
|
|
||||||
constructor(private assertion: Assertion<boolean>) {}
|
|
||||||
|
|
||||||
toBeTrue() {
|
|
||||||
return this.assertion.toBeTrue();
|
|
||||||
}
|
|
||||||
|
|
||||||
toBeFalse() {
|
|
||||||
return this.assertion.toBeFalse();
|
|
||||||
}
|
|
||||||
|
|
||||||
toBeTruthy() {
|
|
||||||
return this.assertion.toBeTruthy();
|
|
||||||
}
|
|
||||||
|
|
||||||
toBeFalsy() {
|
|
||||||
return this.assertion.toBeFalsy();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,20 +0,0 @@
|
|||||||
import { Assertion } from '../smartexpect.classes.assertion.js';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Namespace for date-specific matchers
|
|
||||||
*/
|
|
||||||
export class DateMatchers {
|
|
||||||
constructor(private assertion: Assertion<Date>) {}
|
|
||||||
|
|
||||||
toBeDate() {
|
|
||||||
return this.assertion.toBeDate();
|
|
||||||
}
|
|
||||||
|
|
||||||
toBeBeforeDate(date: Date) {
|
|
||||||
return this.assertion.toBeBeforeDate(date);
|
|
||||||
}
|
|
||||||
|
|
||||||
toBeAfterDate(date: Date) {
|
|
||||||
return this.assertion.toBeAfterDate(date);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,12 +0,0 @@
|
|||||||
import { Assertion } from '../smartexpect.classes.assertion.js';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Namespace for function-specific matchers
|
|
||||||
*/
|
|
||||||
export class FunctionMatchers {
|
|
||||||
constructor(private assertion: Assertion<Function>) {}
|
|
||||||
|
|
||||||
toThrow(expectedError?: any) {
|
|
||||||
return this.assertion.toThrow(expectedError);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,8 +0,0 @@
|
|||||||
export { StringMatchers } from './string.js';
|
|
||||||
export { ArrayMatchers } from './array.js';
|
|
||||||
export { NumberMatchers } from './number.js';
|
|
||||||
export { BooleanMatchers } from './boolean.js';
|
|
||||||
export { ObjectMatchers } from './object.js';
|
|
||||||
export { FunctionMatchers } from './function.js';
|
|
||||||
export { DateMatchers } from './date.js';
|
|
||||||
export { TypeMatchers } from './type.js';
|
|
||||||
@ -1,32 +0,0 @@
|
|||||||
import { Assertion } from '../smartexpect.classes.assertion.js';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Namespace for number-specific matchers
|
|
||||||
*/
|
|
||||||
export class NumberMatchers {
|
|
||||||
constructor(private assertion: Assertion<number>) {}
|
|
||||||
|
|
||||||
toBeGreaterThan(value: number) {
|
|
||||||
return this.assertion.toBeGreaterThan(value);
|
|
||||||
}
|
|
||||||
|
|
||||||
toBeLessThan(value: number) {
|
|
||||||
return this.assertion.toBeLessThan(value);
|
|
||||||
}
|
|
||||||
|
|
||||||
toBeGreaterThanOrEqual(value: number) {
|
|
||||||
return this.assertion.toBeGreaterThanOrEqual(value);
|
|
||||||
}
|
|
||||||
|
|
||||||
toBeLessThanOrEqual(value: number) {
|
|
||||||
return this.assertion.toBeLessThanOrEqual(value);
|
|
||||||
}
|
|
||||||
|
|
||||||
toBeCloseTo(value: number, precision?: number) {
|
|
||||||
return this.assertion.toBeCloseTo(value, precision);
|
|
||||||
}
|
|
||||||
/** Equality check for numbers */
|
|
||||||
toEqual(value: number) {
|
|
||||||
return this.assertion.toEqual(value);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,39 +0,0 @@
|
|||||||
import { Assertion } from '../smartexpect.classes.assertion.js';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Namespace for object-specific matchers
|
|
||||||
*/
|
|
||||||
export class ObjectMatchers<T extends object> {
|
|
||||||
constructor(private assertion: Assertion<T>) {}
|
|
||||||
|
|
||||||
toEqual(expected: any) {
|
|
||||||
return this.assertion.toEqual(expected);
|
|
||||||
}
|
|
||||||
|
|
||||||
toMatchObject(expected: object) {
|
|
||||||
return this.assertion.toMatchObject(expected);
|
|
||||||
}
|
|
||||||
|
|
||||||
toBeInstanceOf(constructor: any) {
|
|
||||||
return this.assertion.toBeInstanceOf(constructor);
|
|
||||||
}
|
|
||||||
|
|
||||||
toHaveProperty(property: string, value?: any) {
|
|
||||||
return this.assertion.toHaveProperty(property, value);
|
|
||||||
}
|
|
||||||
|
|
||||||
toHaveDeepProperty(path: string[]) {
|
|
||||||
return this.assertion.toHaveDeepProperty(path);
|
|
||||||
}
|
|
||||||
toBeNull() {
|
|
||||||
return this.assertion.toBeNull();
|
|
||||||
}
|
|
||||||
|
|
||||||
toBeUndefined() {
|
|
||||||
return this.assertion.toBeUndefined();
|
|
||||||
}
|
|
||||||
|
|
||||||
toBeNullOrUndefined() {
|
|
||||||
return this.assertion.toBeNullOrUndefined();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,32 +0,0 @@
|
|||||||
import { Assertion } from '../smartexpect.classes.assertion.js';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Namespace for string-specific matchers
|
|
||||||
*/
|
|
||||||
export class StringMatchers {
|
|
||||||
constructor(private assertion: Assertion<string>) {}
|
|
||||||
|
|
||||||
toStartWith(prefix: string) {
|
|
||||||
return this.assertion.toStartWith(prefix);
|
|
||||||
}
|
|
||||||
|
|
||||||
toEndWith(suffix: string) {
|
|
||||||
return this.assertion.toEndWith(suffix);
|
|
||||||
}
|
|
||||||
|
|
||||||
toInclude(substring: string) {
|
|
||||||
return this.assertion.toInclude(substring);
|
|
||||||
}
|
|
||||||
|
|
||||||
toMatch(regex: RegExp) {
|
|
||||||
return this.assertion.toMatch(regex);
|
|
||||||
}
|
|
||||||
|
|
||||||
toBeOneOf(values: string[]) {
|
|
||||||
return this.assertion.toBeOneOf(values);
|
|
||||||
}
|
|
||||||
/** Length check for strings */
|
|
||||||
toHaveLength(length: number) {
|
|
||||||
return this.assertion.toHaveLength(length);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,28 +0,0 @@
|
|||||||
import { Assertion } from '../smartexpect.classes.assertion.js';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Namespace for type-based matchers
|
|
||||||
*/
|
|
||||||
export class TypeMatchers {
|
|
||||||
constructor(private assertion: Assertion<any>) {}
|
|
||||||
|
|
||||||
toBeTypeofString() {
|
|
||||||
return this.assertion.toBeTypeofString();
|
|
||||||
}
|
|
||||||
|
|
||||||
toBeTypeofNumber() {
|
|
||||||
return this.assertion.toBeTypeofNumber();
|
|
||||||
}
|
|
||||||
|
|
||||||
toBeTypeofBoolean() {
|
|
||||||
return this.assertion.toBeTypeofBoolean();
|
|
||||||
}
|
|
||||||
|
|
||||||
toBeTypeOf(typeName: string) {
|
|
||||||
return this.assertion.toBeTypeOf(typeName);
|
|
||||||
}
|
|
||||||
|
|
||||||
toBeDefined() {
|
|
||||||
return this.assertion.toBeDefined();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,7 +0,0 @@
|
|||||||
import * as smartdelay from '@push.rocks/smartdelay';
|
|
||||||
import * as smartpromise from '@push.rocks/smartpromise';
|
|
||||||
export { smartdelay, smartpromise };
|
|
||||||
|
|
||||||
// third party utilities
|
|
||||||
import fastDeepEqual from 'fast-deep-equal';
|
|
||||||
export { fastDeepEqual };
|
|
||||||
@ -1,187 +1,35 @@
|
|||||||
import * as plugins from './plugins.js';
|
import * as plugins from './smartexpect.plugins';
|
||||||
import {
|
|
||||||
StringMatchers,
|
|
||||||
ArrayMatchers,
|
|
||||||
NumberMatchers,
|
|
||||||
BooleanMatchers,
|
|
||||||
ObjectMatchers,
|
|
||||||
FunctionMatchers,
|
|
||||||
DateMatchers,
|
|
||||||
TypeMatchers,
|
|
||||||
} from './namespaces/index.js';
|
|
||||||
/**
|
|
||||||
* Definition of a custom matcher function.
|
|
||||||
* Should return an object with `pass` and optional `message`.
|
|
||||||
*/
|
|
||||||
import type { TMatcher, TExecutionType } from './types.js';
|
|
||||||
|
|
||||||
/**
|
export type TExecutionType = 'sync' | 'async';
|
||||||
* Core assertion class. Generic over the current value type T.
|
|
||||||
*/
|
export class Assertion {
|
||||||
export class Assertion<T = unknown> {
|
|
||||||
executionMode: TExecutionType;
|
executionMode: TExecutionType;
|
||||||
baseReference: any;
|
baseReference: any;
|
||||||
propertyDrillDown: Array<string | number> = [];
|
propertyDrillDown: string[] = [];
|
||||||
|
|
||||||
private notSetting = false;
|
private notSetting = false;
|
||||||
private timeoutSetting = 0;
|
private timeoutSetting = 0;
|
||||||
/** Registry of user-defined custom matchers */
|
|
||||||
private static customMatchers: Record<string, TMatcher> = {};
|
|
||||||
/** Flag for Promise rejection assertions */
|
|
||||||
private isRejects = false;
|
|
||||||
/** Flag for Promise resolution assertions (default for async) */
|
|
||||||
private isResolves = false;
|
|
||||||
private failMessage: string;
|
|
||||||
private successMessage: string;
|
|
||||||
|
|
||||||
constructor(baseReferenceArg: any, executionModeArg: TExecutionType) {
|
constructor(baseReferenceArg: any, executionModeArg: TExecutionType) {
|
||||||
this.baseReference = baseReferenceArg;
|
this.baseReference = baseReferenceArg;
|
||||||
this.executionMode = executionModeArg;
|
this.executionMode = executionModeArg;
|
||||||
}
|
}
|
||||||
/**
|
|
||||||
* Register custom matchers to be available on all assertions.
|
|
||||||
* @param matchers An object whose keys are matcher names and values are matcher functions.
|
|
||||||
*/
|
|
||||||
public static extend(matchers: Record<string, TMatcher>): void {
|
|
||||||
for (const [name, fn] of Object.entries(matchers)) {
|
|
||||||
if ((Assertion.prototype as any)[name]) {
|
|
||||||
throw new Error(`Cannot extend. Matcher '${name}' already exists on Assertion.`);
|
|
||||||
}
|
|
||||||
// store in registry
|
|
||||||
Assertion.customMatchers[name] = fn;
|
|
||||||
// add method to prototype
|
|
||||||
(Assertion.prototype as any)[name] = function (...args: any[]) {
|
|
||||||
return this.runCheck(() => {
|
|
||||||
const received = this.getObjectToTestReference();
|
|
||||||
const result = fn(received, ...args);
|
|
||||||
const pass = result.pass;
|
|
||||||
const msg = result.message;
|
|
||||||
if (!pass) {
|
|
||||||
const message = typeof msg === 'function' ? msg() : msg;
|
|
||||||
throw new Error(message || `Custom matcher '${name}' failed`);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
};
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
private getObjectToTestReference() {
|
private getObjectToTestReference() {
|
||||||
let returnObjectToTestReference = this.baseReference;
|
let returnObjectToTestReference = this.baseReference;
|
||||||
for (const property of this.propertyDrillDown) {
|
for (const property of this.propertyDrillDown) {
|
||||||
if (returnObjectToTestReference == null) {
|
|
||||||
// if it's null or undefined, stop
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
|
|
||||||
// We just directly access with bracket notation.
|
|
||||||
// If property is a string, it's like obj["someProp"];
|
|
||||||
// If property is a number, it's like obj[0].
|
|
||||||
returnObjectToTestReference = returnObjectToTestReference[property];
|
returnObjectToTestReference = returnObjectToTestReference[property];
|
||||||
}
|
}
|
||||||
return returnObjectToTestReference;
|
return returnObjectToTestReference;
|
||||||
}
|
}
|
||||||
|
|
||||||
private formatDrillDown(): string {
|
|
||||||
if (!this.propertyDrillDown || this.propertyDrillDown.length === 0) {
|
|
||||||
return '';
|
|
||||||
}
|
|
||||||
|
|
||||||
const path = this.propertyDrillDown.map(prop => {
|
|
||||||
if (typeof prop === 'number') {
|
|
||||||
return `[${prop}]`;
|
|
||||||
} else {
|
|
||||||
return `.${prop}`;
|
|
||||||
}
|
|
||||||
}).join('');
|
|
||||||
|
|
||||||
return path;
|
|
||||||
}
|
|
||||||
|
|
||||||
private formatValue(value: any): string {
|
|
||||||
if (value === null) {
|
|
||||||
return 'null';
|
|
||||||
} else if (value === undefined) {
|
|
||||||
return 'undefined';
|
|
||||||
} else if (typeof value === 'object') {
|
|
||||||
try {
|
|
||||||
return JSON.stringify(value);
|
|
||||||
} catch (e) {
|
|
||||||
return `[Object ${value.constructor.name}]`;
|
|
||||||
}
|
|
||||||
} else if (typeof value === 'function') {
|
|
||||||
return `[Function${value.name ? ': ' + value.name : ''}]`;
|
|
||||||
} else if (typeof value === 'string') {
|
|
||||||
return `"${value}"`;
|
|
||||||
} else {
|
|
||||||
return String(value);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
private createErrorMessage(message: string): string {
|
|
||||||
if (this.failMessage) {
|
|
||||||
return this.failMessage;
|
|
||||||
}
|
|
||||||
|
|
||||||
const testValue = this.getObjectToTestReference();
|
|
||||||
const formattedValue = this.formatValue(testValue);
|
|
||||||
const drillDown = this.formatDrillDown();
|
|
||||||
|
|
||||||
// Replace placeholders in the message
|
|
||||||
return message
|
|
||||||
.replace('{value}', formattedValue)
|
|
||||||
.replace('{path}', drillDown || '');
|
|
||||||
}
|
|
||||||
|
|
||||||
public get not() {
|
public get not() {
|
||||||
this.notSetting = true;
|
this.notSetting = true;
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
/**
|
|
||||||
* Assert that a Promise resolves.
|
|
||||||
*/
|
|
||||||
public get resolves(): this {
|
|
||||||
this.isResolves = true;
|
|
||||||
this.isRejects = false;
|
|
||||||
this.executionMode = 'async';
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
/**
|
|
||||||
* Assert that a Promise rejects.
|
|
||||||
*/
|
|
||||||
public get rejects(): this {
|
|
||||||
this.isRejects = true;
|
|
||||||
this.isResolves = false;
|
|
||||||
this.executionMode = 'async';
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @deprecated use `.withTimeout(ms)` instead for clarity
|
|
||||||
* Set a timeout (in ms) for async assertions (Promise must settle before timeout).
|
|
||||||
*/
|
|
||||||
public timeout(millisArg: number) {
|
public timeout(millisArg: number) {
|
||||||
// eslint-disable-next-line no-console
|
|
||||||
console.warn('[DEPRECATED] .timeout() is deprecated. Use .withTimeout(ms)');
|
|
||||||
this.timeoutSetting = millisArg;
|
this.timeoutSetting = millisArg;
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
/**
|
|
||||||
* Set a timeout (in ms) for async assertions (Promise must settle before timeout).
|
|
||||||
*/
|
|
||||||
public withTimeout(millisArg: number) {
|
|
||||||
this.timeoutSetting = millisArg;
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
public setFailMessage(failMessageArg: string) {
|
|
||||||
this.failMessage = failMessageArg;
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
public setSuccessMessage(successMessageArg: string) {
|
|
||||||
this.successMessage = successMessageArg;
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
private runCheck(checkFunction: () => any) {
|
private runCheck(checkFunction: () => any) {
|
||||||
const runDirectOrNegated = (checkFunction: () => any) => {
|
const runDirectOrNegated = (checkFunction: () => any) => {
|
||||||
@ -195,130 +43,170 @@ export class Assertion<T = unknown> {
|
|||||||
isOk = true;
|
isOk = true;
|
||||||
}
|
}
|
||||||
if (!isOk) {
|
if (!isOk) {
|
||||||
throw new Error(this.failMessage || 'Negated assertion failed');
|
throw new Error('Negated assertion is not ok!');
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
if (this.executionMode === 'async') {
|
if (this.executionMode === 'async') {
|
||||||
const done = plugins.smartpromise.defer();
|
const done = plugins.smartpromise.defer();
|
||||||
const isThenable = this.baseReference && typeof (this.baseReference as any).then === 'function';
|
if (!(this.baseReference instanceof Promise)) {
|
||||||
if (!isThenable) {
|
done.reject(new Error(`${this.baseReference} is not of type promise.`));
|
||||||
done.reject(new Error(`Expected a Promise but received: ${this.formatValue(this.baseReference)}`));
|
} else {
|
||||||
return done.promise;
|
|
||||||
}
|
|
||||||
if (this.timeoutSetting) {
|
if (this.timeoutSetting) {
|
||||||
plugins.smartdelay.delayFor(this.timeoutSetting).then(() => {
|
plugins.smartdelay.delayFor(this.timeoutSetting).then(() => {
|
||||||
if (done.status === 'pending') {
|
if (done.status === 'pending') {
|
||||||
done.reject(new Error(`Promise timed out after ${this.timeoutSetting}ms`));
|
done.reject(new Error(`${this.baseReference} timed out at ${this.timeoutSetting}!`));
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
if (this.isRejects) {
|
this.baseReference.then((promiseResultArg) => {
|
||||||
(this.baseReference as Promise<any>).then(
|
this.baseReference = promiseResultArg;
|
||||||
(res: any) => {
|
done.resolve(runDirectOrNegated(checkFunction));
|
||||||
done.reject(new Error(`Expected Promise to reject but it resolved with ${this.formatValue(res)}`));
|
});
|
||||||
},
|
|
||||||
(err: any) => {
|
|
||||||
this.baseReference = err;
|
|
||||||
try {
|
|
||||||
const ret = runDirectOrNegated(checkFunction);
|
|
||||||
done.resolve(ret);
|
|
||||||
} catch (e: any) {
|
|
||||||
done.reject(e);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
);
|
|
||||||
} else {
|
|
||||||
(this.baseReference as Promise<any>).then(
|
|
||||||
(res: any) => {
|
|
||||||
this.baseReference = res;
|
|
||||||
try {
|
|
||||||
const ret = runDirectOrNegated(checkFunction);
|
|
||||||
done.resolve(ret);
|
|
||||||
} catch (e: any) {
|
|
||||||
done.reject(e);
|
|
||||||
}
|
|
||||||
},
|
|
||||||
(err: any) => {
|
|
||||||
done.reject(err);
|
|
||||||
}
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
return done.promise;
|
return done.promise;
|
||||||
}
|
} else {
|
||||||
return runDirectOrNegated(checkFunction);
|
return runDirectOrNegated(checkFunction);
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
public customAssertion(
|
public toBeTypeofString() {
|
||||||
assertionFunction: (value: any) => boolean,
|
|
||||||
errorMessage: string
|
|
||||||
) {
|
|
||||||
return this.runCheck(() => {
|
return this.runCheck(() => {
|
||||||
const value = this.getObjectToTestReference();
|
if (typeof this.getObjectToTestReference() !== 'string') {
|
||||||
if (!assertionFunction(value)) {
|
throw new Error(
|
||||||
throw new Error(this.failMessage || errorMessage);
|
`Assertion failed: ${this.baseReference} with drill down ${this.propertyDrillDown} is not of type string, but typeof ${typeof this
|
||||||
|
.baseReference}`
|
||||||
|
);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
public toBeTypeofNumber() {
|
||||||
* Drill into a property of an object.
|
return this.runCheck(() => {
|
||||||
* @param propertyName Name of the property to navigate into.
|
if (typeof this.getObjectToTestReference() !== 'number') {
|
||||||
* @returns Assertion of the property type.
|
throw new Error(
|
||||||
*/
|
`Assertion failed: ${this.baseReference} with drill down ${this.propertyDrillDown} is not of type string, but typeof ${typeof this
|
||||||
public property<K extends keyof NonNullable<T>>(propertyName: K): Assertion<NonNullable<T>[K]> {
|
.baseReference}`
|
||||||
this.propertyDrillDown.push(propertyName as string);
|
);
|
||||||
return this as unknown as Assertion<NonNullable<T>[K]>;
|
}
|
||||||
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
public toBeTypeofBoolean() {
|
||||||
* Drill into an array element by index.
|
return this.runCheck(() => {
|
||||||
* @param index Index of the array item.
|
if (typeof this.getObjectToTestReference() !== 'boolean') {
|
||||||
* @returns Assertion of the element type.
|
throw new Error(
|
||||||
*/
|
`Assertion failed: ${this.baseReference} with drill down ${this.propertyDrillDown} is not of type string, but typeof ${typeof this
|
||||||
public arrayItem(index: number): Assertion<T extends Array<infer U> ? U : unknown> {
|
.baseReference}`
|
||||||
this.propertyDrillDown.push(index);
|
);
|
||||||
return this as unknown as Assertion<T extends Array<infer U> ? U : unknown>;
|
}
|
||||||
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
public log() {
|
public toEqual(comparisonObject: any) {
|
||||||
console.log(`Current value:`);
|
return this.runCheck(() => {
|
||||||
console.log(JSON.stringify(this.getObjectToTestReference(), null, 2));
|
const result = plugins.fastDeepEqual(this.getObjectToTestReference(), comparisonObject);
|
||||||
console.log(`Path: ${this.formatDrillDown() || '(root)'}`);
|
if (!result) {
|
||||||
|
throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} does not equal ${comparisonObject}`);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
public toBeTrue() {
|
||||||
|
return this.runCheck(() => {
|
||||||
|
const result = typeof this.getObjectToTestReference() === 'boolean' && this.getObjectToTestReference() === true;
|
||||||
|
if (!result) {
|
||||||
|
throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} is not true or not of type boolean`);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
public toBeFalse() {
|
||||||
|
return this.runCheck(() => {
|
||||||
|
const result = typeof this.getObjectToTestReference() === 'boolean' && this.getObjectToTestReference() === false;
|
||||||
|
if (!result) {
|
||||||
|
throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} is not false or not of type boolean`);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
public toBeInstanceOf(classArg: any) {
|
||||||
|
return this.runCheck(() => {
|
||||||
|
const result = this.getObjectToTestReference() instanceof classArg;
|
||||||
|
if (!result) {
|
||||||
|
throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} is not an instance of ${classArg}`);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
public toHaveProperty(propertyArg: string) {
|
||||||
|
return this.runCheck(() => {
|
||||||
|
const result = !!this.getObjectToTestReference()[propertyArg];
|
||||||
|
if (!result) {
|
||||||
|
throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} does not have property ${propertyArg}`);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
public toBeGreaterThan(numberArg: number) {
|
||||||
|
return this.runCheck(() => {
|
||||||
|
const result = this.getObjectToTestReference() > numberArg;
|
||||||
|
if (!result) {
|
||||||
|
throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} is not greater than ${numberArg}`);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
public toBeLessThan(numberArg: number) {
|
||||||
|
return this.runCheck(() => {
|
||||||
|
const result = this.getObjectToTestReference() < numberArg;
|
||||||
|
if (!result) {
|
||||||
|
throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} is not less than ${numberArg}`);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
public toBeNull() {
|
||||||
|
return this.runCheck(() => {
|
||||||
|
const result = this.getObjectToTestReference() === null;
|
||||||
|
if (!result) {
|
||||||
|
throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} is not null`);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
public toBeUndefined() {
|
||||||
|
return this.runCheck(() => {
|
||||||
|
const result = this.getObjectToTestReference() === undefined;
|
||||||
|
if (!result) {
|
||||||
|
throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} is not undefined`);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
public toBeNullOrUndefined() {
|
||||||
|
return this.runCheck(() => {
|
||||||
|
const result = this.getObjectToTestReference() === null || this.getObjectToTestReference() === undefined;
|
||||||
|
if (!result) {
|
||||||
|
throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} is not null or undefined`);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
public toContain(itemArg: any) {
|
||||||
|
return this.runCheck(() => {
|
||||||
|
const result =
|
||||||
|
this.getObjectToTestReference() instanceof Array &&
|
||||||
|
this.getObjectToTestReference().includes(itemArg);
|
||||||
|
if (!result) {
|
||||||
|
throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} is not contain ${itemArg}`);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
public property(propertyNameArg: string) {
|
||||||
|
this.propertyDrillDown.push(propertyNameArg);
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
// Namespaced matcher accessors
|
|
||||||
/** String-specific matchers */
|
|
||||||
public get string() {
|
|
||||||
return new StringMatchers(this as Assertion<string>);
|
|
||||||
}
|
|
||||||
/** Array-specific matchers */
|
|
||||||
public get array() {
|
|
||||||
return new ArrayMatchers<any>(this as Assertion<any[]>);
|
|
||||||
}
|
|
||||||
/** Number-specific matchers */
|
|
||||||
public get number() {
|
|
||||||
return new NumberMatchers(this as Assertion<number>);
|
|
||||||
}
|
|
||||||
/** Boolean-specific matchers */
|
|
||||||
public get boolean() {
|
|
||||||
return new BooleanMatchers(this as Assertion<boolean>);
|
|
||||||
}
|
|
||||||
/** Object-specific matchers */
|
|
||||||
public get object() {
|
|
||||||
return new ObjectMatchers<any>(this as Assertion<object>);
|
|
||||||
}
|
|
||||||
/** Function-specific matchers */
|
|
||||||
public get function() {
|
|
||||||
return new FunctionMatchers(this as Assertion<Function>);
|
|
||||||
}
|
|
||||||
/** Date-specific matchers */
|
|
||||||
public get date() {
|
|
||||||
return new DateMatchers(this as Assertion<Date>);
|
|
||||||
}
|
|
||||||
/** Type-based matchers */
|
|
||||||
public get type() {
|
|
||||||
return new TypeMatchers(this as Assertion<any>);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
14
ts/smartexpect.plugins.ts
Normal file
14
ts/smartexpect.plugins.ts
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
import * as smartdelay from '@pushrocks/smartdelay';
|
||||||
|
import * as smartpromise from '@pushrocks/smartpromise';
|
||||||
|
|
||||||
|
export {
|
||||||
|
smartdelay,
|
||||||
|
smartpromise
|
||||||
|
}
|
||||||
|
|
||||||
|
// third party scope
|
||||||
|
import fastDeepEqual from 'fast-deep-equal';
|
||||||
|
|
||||||
|
export {
|
||||||
|
fastDeepEqual,
|
||||||
|
}
|
||||||
13
ts/types.ts
13
ts/types.ts
@ -1,13 +0,0 @@
|
|||||||
/**
|
|
||||||
* Common types for smartexpect
|
|
||||||
*/
|
|
||||||
/** Execution mode: sync or async */
|
|
||||||
export type TExecutionType = 'sync' | 'async';
|
|
||||||
/**
|
|
||||||
* Definition of a custom matcher function.
|
|
||||||
* Should return an object with `pass` and optional `message`.
|
|
||||||
*/
|
|
||||||
export type TMatcher = (
|
|
||||||
received: any,
|
|
||||||
...args: any[]
|
|
||||||
) => { pass: boolean; message?: string | (() => string) };
|
|
||||||
@ -1,15 +0,0 @@
|
|||||||
{
|
|
||||||
"compilerOptions": {
|
|
||||||
"experimentalDecorators": true,
|
|
||||||
"emitDecoratorMetadata": true,
|
|
||||||
"useDefineForClassFields": false,
|
|
||||||
"target": "ES2022",
|
|
||||||
"module": "NodeNext",
|
|
||||||
"moduleResolution": "NodeNext",
|
|
||||||
"esModuleInterop": true,
|
|
||||||
"verbatimModuleSyntax": true
|
|
||||||
},
|
|
||||||
"exclude": [
|
|
||||||
"dist_*/**/*.d.ts"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
17
tslint.json
Normal file
17
tslint.json
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
{
|
||||||
|
"extends": ["tslint:latest", "tslint-config-prettier"],
|
||||||
|
"rules": {
|
||||||
|
"semicolon": [true, "always"],
|
||||||
|
"no-console": false,
|
||||||
|
"ordered-imports": false,
|
||||||
|
"object-literal-sort-keys": false,
|
||||||
|
"member-ordering": {
|
||||||
|
"options":{
|
||||||
|
"order": [
|
||||||
|
"static-method"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"defaultSeverity": "warning"
|
||||||
|
}
|
||||||
Loading…
x
Reference in New Issue
Block a user