Compare commits

..

9 Commits

Author SHA1 Message Date
465e579298 1.0.17 2023-08-11 18:10:09 +02:00
f5f6e40fff fix(core): update 2023-08-11 18:10:08 +02:00
9d065a54e6 1.0.16 2023-08-11 18:08:51 +02:00
ee0a797424 fix(core): update 2023-08-11 18:08:50 +02:00
a234069cc8 switch to new org scheme 2023-07-10 02:49:04 +02:00
534c1e4215 1.0.15 2023-06-22 11:57:29 +02:00
931a713ae7 fix(core): update 2023-06-22 11:57:29 +02:00
d1be0d8ce2 1.0.14 2022-07-24 12:45:29 +02:00
3e5121171a fix(core): update 2022-07-24 12:45:29 +02:00
14 changed files with 5032 additions and 27666 deletions

View File

@ -0,0 +1,104 @@
name: CI Pipeline
on: push
env:
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
jobs:
security:
runs-on: ubuntu-latest
continue-on-error: true
container:
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
- name: Audit development dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --dev
test:
needs: security
runs-on: ubuntu-latest
container:
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
release:
needs: test
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
runs-on: ubuntu-latest
container:
image: $
steps:
- uses: actions/checkout@v3
- 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: $
continue-on-error: true
steps:
- uses: actions/checkout@v3
- name: Code quality
run: |
npmci command npm install -g typescript
npmci npm prepare
npmci npm install
- name: Trigger
run: npmci trigger
- name: Build docs and upload artifacts
run: |
npmci node install stable
npmci npm install
npmci command npm run buildDocs
- name: Upload artifacts
uses: actions/upload-artifact@v2
with:
name: public
path: public
retention-days: 7

View File

@ -13,31 +13,24 @@ stages:
- metadata - metadata
before_script: before_script:
- npm install -g @shipzone/npmci - pnpm install -g pnpm
- pnpm install -g @shipzone/npmci
- npmci npm prepare
# ==================== # ====================
# security stage # security stage
# ==================== # ====================
mirror: # ====================
stage: security # security stage
script: # ====================
- npmci git mirror
only:
- tags
tags:
- lossless
- docker
- notpriv
auditProductionDependencies: auditProductionDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security stage: security
script: script:
- npmci npm prepare - npmci command npm config set registry https://registry.npmjs.org
- npmci command npm install --production --ignore-scripts - npmci command pnpm audit --audit-level=high --prod
- npmci command npm config set registry https://registry.npmjs.org
- npmci command npm audit --audit-level=high --only=prod --production
tags: tags:
- lossless
- docker - docker
allow_failure: true allow_failure: true
@ -45,11 +38,10 @@ auditDevDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security stage: security
script: script:
- npmci npm prepare
- npmci command npm install --ignore-scripts
- npmci command npm config set registry https://registry.npmjs.org - npmci command npm config set registry https://registry.npmjs.org
- npmci command npm audit --audit-level=high --only=dev - npmci command pnpm audit --audit-level=high --dev
tags: tags:
- lossless
- docker - docker
allow_failure: true allow_failure: true
@ -60,7 +52,6 @@ auditDevDependencies:
testStable: testStable:
stage: test stage: test
script: script:
- npmci npm prepare
- npmci node install stable - npmci node install stable
- npmci npm install - npmci npm install
- npmci npm test - npmci npm test
@ -71,10 +62,9 @@ testStable:
testBuild: testBuild:
stage: test stage: test
script: script:
- npmci npm prepare
- npmci node install stable - npmci node install stable
- npmci npm install - npmci npm install
- npmci command npm run build - npmci npm build
coverage: /\d+.?\d+?\%\s*coverage/ coverage: /\d+.?\d+?\%\s*coverage/
tags: tags:
- docker - docker
@ -100,10 +90,9 @@ codequality:
only: only:
- tags - tags
script: script:
- npmci command npm install -g tslint typescript - npmci command npm install -g typescript
- npmci npm prepare - npmci npm prepare
- npmci npm install - npmci npm install
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
tags: tags:
- lossless - lossless
- docker - docker
@ -123,11 +112,9 @@ trigger:
pages: pages:
stage: metadata stage: metadata
script: script:
- npmci node install lts - npmci node install stable
- npmci command npm install -g @gitzone/tsdoc
- npmci npm prepare
- npmci npm install - npmci npm install
- npmci command tsdoc - npmci command npm run buildDocs
tags: tags:
- lossless - lossless
- docker - docker

View File

@ -3,10 +3,10 @@
"projectType": "npm", "projectType": "npm",
"module": { "module": {
"githost": "gitlab.com", "githost": "gitlab.com",
"gitscope": "pushrocks", "gitscope": "push.rocks",
"gitrepo": "smartexpect", "gitrepo": "smartexpect",
"description": "manage expectations in code", "description": "manage expectations in code",
"npmPackagename": "@pushrocks/smartexpect", "npmPackagename": "@push.rocks/smartexpect",
"license": "MIT", "license": "MIT",
"projectDomain": "push.rocks" "projectDomain": "push.rocks"
} }

27557
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,28 +1,31 @@
{ {
"name": "@pushrocks/smartexpect", "name": "@push.rocks/smartexpect",
"version": "1.0.13", "version": "1.0.17",
"private": false, "private": false,
"description": "manage expectations in code", "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 --web)" "build": "(tsbuild --web)",
"buildDocs": "tsdoc"
}, },
"devDependencies": { "devDependencies": {
"@gitzone/tsbuild": "^2.1.25", "@gitzone/tsbuild": "^2.1.66",
"@gitzone/tsbundle": "^1.0.89", "@gitzone/tsbundle": "^2.0.8",
"@gitzone/tstest": "^1.0.44", "@gitzone/tsrun": "^1.2.42",
"@pushrocks/tapbundle": "^4.0.0", "@gitzone/tstest": "^1.0.74",
"@types/node": "^17.0.14", "@pushrocks/tapbundle": "^5.0.4",
"@types/node": "^20.3.1",
"tslint": "^6.1.3", "tslint": "^6.1.3",
"tslint-config-prettier": "^1.15.0" "tslint-config-prettier": "^1.18.0"
}, },
"dependencies": { "dependencies": {
"@pushrocks/smartdelay": "^2.0.13", "@pushrocks/smartdelay": "^3.0.1",
"@pushrocks/smartpromise": "^3.1.6", "@pushrocks/smartpromise": "^4.0.2",
"fast-deep-equal": "^3.1.3" "fast-deep-equal": "^3.1.3"
}, },
"browserslist": [ "browserslist": [

4556
pnpm-lock.yaml generated Normal file

File diff suppressed because it is too large Load Diff

View File

@ -21,7 +21,6 @@ Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](htt
PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/smartexpect)](https://lossless.cloud) PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/smartexpect)](https://lossless.cloud)
PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartexpect)](https://lossless.cloud) PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartexpect)](https://lossless.cloud)
BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartexpect)](https://lossless.cloud) BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartexpect)](https://lossless.cloud)
Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
## Usage ## Usage
@ -33,7 +32,6 @@ We are always happy for code contributions. If you are not the code contributing
For further information read the linked docs at the top of this readme. For further information read the linked docs at the top of this readme.
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh) ## Legal
> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy) | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

View File

@ -1,5 +1,5 @@
import { tap } from '@pushrocks/tapbundle'; import { tap } from '@pushrocks/tapbundle';
import * as smartexpect from '../ts/index'; import * as smartexpect from '../ts/index.js';
tap.test('sync tests', async () => { tap.test('sync tests', async () => {
smartexpect.expect('hello').toBeTypeofString(); smartexpect.expect('hello').toBeTypeofString();
@ -20,11 +20,16 @@ tap.test('async tests', async (toolsArg) => {
tap.test('should check equality', async () => { tap.test('should check equality', async () => {
smartexpect.expect('hithere').toEqual('hithere'); smartexpect.expect('hithere').toEqual('hithere');
smartexpect.expect('hithere').not.toEqual('hithere2'); smartexpect.expect('hithere').not.toEqual('hithere2');
}) });
tap.test('should check for regexp matching', async () => {
smartexpect.expect('hithere').toMatch(/hi/);
smartexpect.expect('hithere').not.toMatch(/ho/);
});
tap.test('should correctly state property presence', async () => { tap.test('should correctly state property presence', async () => {
const testObject = { const testObject = {
aprop: 'hello' aprop: 'hello',
}; };
smartexpect.expect(testObject).toHaveProperty('aprop'); smartexpect.expect(testObject).toHaveProperty('aprop');
@ -34,14 +39,14 @@ tap.test('should correctly state property presence', async () => {
tap.test('should be greater than', async () => { tap.test('should be greater than', async () => {
smartexpect.expect(4).toBeGreaterThan(3); smartexpect.expect(4).toBeGreaterThan(3);
smartexpect.expect(4).toBeLessThan(5); smartexpect.expect(4).toBeLessThan(5);
}) });
tap.test('should correctly determine toContain', async () => { tap.test('should correctly determine toContain', async () => {
const hello = { const hello = {
socool: 'yes' socool: 'yes',
}; };
const testArray = [hello]; const testArray = [hello];
smartexpect.expect(testArray).toContain(hello); smartexpect.expect(testArray).toContain(hello);
}) });
tap.start(); tap.start();

8
ts/00_commitinfo_data.ts Normal file
View File

@ -0,0 +1,8 @@
/**
* autocreated commitinfo by @pushrocks/commitinfo
*/
export const commitinfo = {
name: '@push.rocks/smartexpect',
version: '1.0.17',
description: 'manage expectations in code'
}

View File

@ -1,13 +1,13 @@
import * as plugins from './smartexpect.plugins'; import * as plugins from './smartexpect.plugins.js';
import { Assertion } from './smartexpect.classes.assertion'; import { Assertion } from './smartexpect.classes.assertion.js';
export const expect = (baseArg: any) => { export const expect = (baseArg: any) => {
const assertion = new Assertion(baseArg, 'sync'); const assertion = new Assertion(baseArg, 'sync');
return assertion; return assertion;
} };
export const expectAsync = (baseArg: any) => { export const expectAsync = (baseArg: any) => {
const assertion = new Assertion(baseArg, 'async'); const assertion = new Assertion(baseArg, 'async');
return assertion; return assertion;
} };

View File

@ -1,4 +1,4 @@
import * as plugins from './smartexpect.plugins'; import * as plugins from './smartexpect.plugins.js';
export type TExecutionType = 'sync' | 'async'; export type TExecutionType = 'sync' | 'async';
@ -75,8 +75,9 @@ export class Assertion {
return this.runCheck(() => { return this.runCheck(() => {
if (typeof this.getObjectToTestReference() !== 'string') { if (typeof this.getObjectToTestReference() !== 'string') {
throw new Error( throw new Error(
`Assertion failed: ${this.baseReference} with drill down ${this.propertyDrillDown} is not of type string, but typeof ${typeof this `Assertion failed: ${this.baseReference} with drill down ${
.baseReference}` this.propertyDrillDown
} is not of type string, but typeof ${typeof this.baseReference}`
); );
} }
}); });
@ -86,8 +87,9 @@ export class Assertion {
return this.runCheck(() => { return this.runCheck(() => {
if (typeof this.getObjectToTestReference() !== 'number') { if (typeof this.getObjectToTestReference() !== 'number') {
throw new Error( throw new Error(
`Assertion failed: ${this.baseReference} with drill down ${this.propertyDrillDown} is not of type string, but typeof ${typeof this `Assertion failed: ${this.baseReference} with drill down ${
.baseReference}` this.propertyDrillDown
} is not of type string, but typeof ${typeof this.baseReference}`
); );
} }
}); });
@ -97,8 +99,9 @@ export class Assertion {
return this.runCheck(() => { return this.runCheck(() => {
if (typeof this.getObjectToTestReference() !== 'boolean') { if (typeof this.getObjectToTestReference() !== 'boolean') {
throw new Error( throw new Error(
`Assertion failed: ${this.baseReference} with drill down ${this.propertyDrillDown} is not of type string, but typeof ${typeof this `Assertion failed: ${this.baseReference} with drill down ${
.baseReference}` this.propertyDrillDown
} is not of type string, but typeof ${typeof this.baseReference}`
); );
} }
}); });
@ -108,25 +111,46 @@ export class Assertion {
return this.runCheck(() => { return this.runCheck(() => {
const result = plugins.fastDeepEqual(this.getObjectToTestReference(), comparisonObject); const result = plugins.fastDeepEqual(this.getObjectToTestReference(), comparisonObject);
if (!result) { if (!result) {
throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} does not equal ${comparisonObject}`); throw new Error(
`${this.baseReference} with drill down ${this.propertyDrillDown} does not equal ${comparisonObject}`
);
}
});
}
public toMatch(comparisonObject: RegExp) {
return this.runCheck(() => {
const result = comparisonObject.test(this.getObjectToTestReference());
if (!result) {
throw new Error(
`${this.baseReference} with drill down ${this.propertyDrillDown} does not equal ${comparisonObject}`
);
} }
}); });
} }
public toBeTrue() { public toBeTrue() {
return this.runCheck(() => { return this.runCheck(() => {
const result = typeof this.getObjectToTestReference() === 'boolean' && this.getObjectToTestReference() === true; const result =
typeof this.getObjectToTestReference() === 'boolean' &&
this.getObjectToTestReference() === true;
if (!result) { if (!result) {
throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} is not true or not of type boolean`); throw new Error(
`${this.baseReference} with drill down ${this.propertyDrillDown} is not true or not of type boolean`
);
} }
}); });
} }
public toBeFalse() { public toBeFalse() {
return this.runCheck(() => { return this.runCheck(() => {
const result = typeof this.getObjectToTestReference() === 'boolean' && this.getObjectToTestReference() === false; const result =
typeof this.getObjectToTestReference() === 'boolean' &&
this.getObjectToTestReference() === false;
if (!result) { if (!result) {
throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} is not false or not of type boolean`); throw new Error(
`${this.baseReference} with drill down ${this.propertyDrillDown} is not false or not of type boolean`
);
} }
}); });
} }
@ -135,16 +159,27 @@ export class Assertion {
return this.runCheck(() => { return this.runCheck(() => {
const result = this.getObjectToTestReference() instanceof classArg; const result = this.getObjectToTestReference() instanceof classArg;
if (!result) { if (!result) {
throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} is not an instance of ${classArg}`); throw new Error(
`${this.baseReference} with drill down ${this.propertyDrillDown} is not an instance of ${classArg}`
);
} }
}); });
} }
public toHaveProperty(propertyArg: string) { public toHaveProperty(propertyArg: string, equalsArg?: any) {
return this.runCheck(() => { return this.runCheck(() => {
const result = !!this.getObjectToTestReference()[propertyArg]; const result = !!this.getObjectToTestReference()[propertyArg];
if (!result) { if (!result) {
throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} does not have property ${propertyArg}`); throw new Error(
`${this.baseReference} with drill down ${this.propertyDrillDown} does not have property ${propertyArg}`
);
}
if (equalsArg) {
if (result !== equalsArg) {
throw new Error(
`${this.baseReference} with drill down ${this.propertyDrillDown} does have property ${propertyArg}, but it does not equal ${equalsArg}`
);
}
} }
}); });
} }
@ -153,7 +188,9 @@ export class Assertion {
return this.runCheck(() => { return this.runCheck(() => {
const result = this.getObjectToTestReference() > numberArg; const result = this.getObjectToTestReference() > numberArg;
if (!result) { if (!result) {
throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} is not greater than ${numberArg}`); throw new Error(
`${this.baseReference} with drill down ${this.propertyDrillDown} is not greater than ${numberArg}`
);
} }
}); });
} }
@ -162,7 +199,9 @@ export class Assertion {
return this.runCheck(() => { return this.runCheck(() => {
const result = this.getObjectToTestReference() < numberArg; const result = this.getObjectToTestReference() < numberArg;
if (!result) { if (!result) {
throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} is not less than ${numberArg}`); throw new Error(
`${this.baseReference} with drill down ${this.propertyDrillDown} is not less than ${numberArg}`
);
} }
}); });
} }
@ -171,7 +210,9 @@ export class Assertion {
return this.runCheck(() => { return this.runCheck(() => {
const result = this.getObjectToTestReference() === null; const result = this.getObjectToTestReference() === null;
if (!result) { if (!result) {
throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} is not null`); throw new Error(
`${this.baseReference} with drill down ${this.propertyDrillDown} is not null`
);
} }
}); });
} }
@ -180,16 +221,21 @@ export class Assertion {
return this.runCheck(() => { return this.runCheck(() => {
const result = this.getObjectToTestReference() === undefined; const result = this.getObjectToTestReference() === undefined;
if (!result) { if (!result) {
throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} is not undefined`); throw new Error(
`${this.baseReference} with drill down ${this.propertyDrillDown} is not undefined`
);
} }
}); });
} }
public toBeNullOrUndefined() { public toBeNullOrUndefined() {
return this.runCheck(() => { return this.runCheck(() => {
const result = this.getObjectToTestReference() === null || this.getObjectToTestReference() === undefined; const result =
this.getObjectToTestReference() === null || this.getObjectToTestReference() === undefined;
if (!result) { if (!result) {
throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} is not null or undefined`); throw new Error(
`${this.baseReference} with drill down ${this.propertyDrillDown} is not null or undefined`
);
} }
}); });
} }
@ -200,7 +246,9 @@ export class Assertion {
this.getObjectToTestReference() instanceof Array && this.getObjectToTestReference() instanceof Array &&
this.getObjectToTestReference().includes(itemArg); this.getObjectToTestReference().includes(itemArg);
if (!result) { if (!result) {
throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} is not contain ${itemArg}`); throw new Error(
`${this.baseReference} with drill down ${this.propertyDrillDown} is not contain ${itemArg}`
);
} }
}); });
} }
@ -208,11 +256,11 @@ export class Assertion {
public toStartWith(itemArg: any) { public toStartWith(itemArg: any) {
return this.runCheck(() => { return this.runCheck(() => {
const testObject = this.getObjectToTestReference(); const testObject = this.getObjectToTestReference();
const result = const result = typeof testObject === 'string' && testObject.startsWith(itemArg);
typeof testObject === 'string' &&
testObject.startsWith(itemArg);
if (!result) { if (!result) {
throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} is not contain ${itemArg}`); throw new Error(
`${this.baseReference} with drill down ${this.propertyDrillDown} is not contain ${itemArg}`
);
} }
}); });
} }
@ -220,11 +268,236 @@ export class Assertion {
public toEndWith(itemArg: any) { public toEndWith(itemArg: any) {
return this.runCheck(() => { return this.runCheck(() => {
const testObject = this.getObjectToTestReference(); const testObject = this.getObjectToTestReference();
const result = const result = typeof testObject === 'string' && testObject.endsWith(itemArg);
typeof testObject === 'string' &&
testObject.endsWith(itemArg);
if (!result) { if (!result) {
throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} is not contain ${itemArg}`); throw new Error(
`${this.baseReference} with drill down ${this.propertyDrillDown} is not contain ${itemArg}`
);
}
});
}
// ... previous code ...
public toBeOneOf(values: any[]) {
return this.runCheck(() => {
const result = values.includes(this.getObjectToTestReference());
if (!result) {
throw new Error(
`${this.baseReference} with drill down ${this.propertyDrillDown} is not one of ${values}`
);
}
});
}
public toHaveLength(length: number) {
return this.runCheck(() => {
const obj = this.getObjectToTestReference();
if (typeof obj.length !== 'number' || obj.length !== length) {
throw new Error(
`${this.baseReference} with drill down ${this.propertyDrillDown} does not have a length of ${length}`
);
}
});
}
public toBeCloseTo(value: number, precision = 2) {
return this.runCheck(() => {
const difference = Math.abs(this.getObjectToTestReference() - value);
if (difference > Math.pow(10, -precision) / 2) {
throw new Error(
`${this.baseReference} with drill down ${this.propertyDrillDown} is not close to ${value} up to ${precision} decimal places`
);
}
});
}
public toThrow(expectedError?: any) {
return this.runCheck(() => {
let thrown = false;
try {
this.getObjectToTestReference()();
} catch (e) {
thrown = true;
if (expectedError && !(e instanceof expectedError)) {
throw new Error(
`Expected function to throw ${expectedError.name}, but it threw ${e.name}`
);
}
}
if (!thrown) {
throw new Error(`Expected function to throw, but it didn't.`);
}
});
}
public toBeTruthy() {
return this.runCheck(() => {
if (!this.getObjectToTestReference()) {
throw new Error(
`${this.baseReference} with drill down ${this.propertyDrillDown} is not truthy`
);
}
});
}
public toBeFalsy() {
return this.runCheck(() => {
if (this.getObjectToTestReference()) {
throw new Error(
`${this.baseReference} with drill down ${this.propertyDrillDown} is not falsy`
);
}
});
}
public toBeGreaterThanOrEqual(numberArg: number) {
return this.runCheck(() => {
if (this.getObjectToTestReference() <= numberArg) {
throw new Error(
`${this.baseReference} with drill down ${this.propertyDrillDown} is not greater than or equal to ${numberArg}`
);
}
});
}
public toBeLessThanOrEqual(numberArg: number) {
return this.runCheck(() => {
if (this.getObjectToTestReference() >= numberArg) {
throw new Error(
`${this.baseReference} with drill down ${this.propertyDrillDown} is not less than or equal to ${numberArg}`
);
}
});
}
public toMatchObject(objectArg: object) {
return this.runCheck(() => {
function deepEqual(obj1: any, obj2: any): boolean {
// If both are of primitive types and are equal
if (obj1 === obj2) {
return true;
}
// If either of them is null or not an object
if (
typeof obj1 !== 'object' ||
obj1 === null ||
typeof obj2 !== 'object' ||
obj2 === null
) {
return false;
}
const keys1 = Object.keys(obj1);
const keys2 = Object.keys(obj2);
// If their properties' count doesn't match
if (keys1.length !== keys2.length) {
return false;
}
// Checking if every property in obj1 has a counterpart in obj2
for (const key of keys1) {
if (!keys2.includes(key)) {
return false;
}
if (!deepEqual(obj1[key], obj2[key])) {
return false;
}
}
return true;
}
const partialMatch = deepEqual(this.getObjectToTestReference(), objectArg); // Note: Implement a deep comparison function or use one from a library
if (!partialMatch) {
throw new Error(
`${this.baseReference} with drill down ${this.propertyDrillDown} does not match the object ${objectArg}`
);
}
});
}
public toContainEqual(value: any) {
return this.runCheck(() => {
const arr = this.getObjectToTestReference();
const found = arr.some((item: any) => plugins.fastDeepEqual(item, value)); // Assuming fastDeepEqual checks deep equality
if (!found) {
throw new Error(
`${this.baseReference} with drill down ${this.propertyDrillDown} does not contain the value ${value}`
);
}
});
}
public toBeArray() {
return this.runCheck(() => {
if (!Array.isArray(this.getObjectToTestReference())) {
throw new Error(
`${this.baseReference} with drill down ${this.propertyDrillDown} is not an array`
);
}
});
}
public toInclude(substring: string) {
return this.runCheck(() => {
if (!this.getObjectToTestReference().includes(substring)) {
throw new Error(
`${this.baseReference} with drill down ${this.propertyDrillDown} does not include the substring ${substring}`
);
}
});
}
public toHaveLengthGreaterThan(length: number) {
return this.runCheck(() => {
const obj = this.getObjectToTestReference();
if (typeof obj.length !== 'number' || obj.length <= length) {
throw new Error(
`${this.baseReference} with drill down ${this.propertyDrillDown} does not have a length greater than ${length}`
);
}
});
}
public toHaveLengthLessThan(length: number) {
return this.runCheck(() => {
const obj = this.getObjectToTestReference();
if (typeof obj.length !== 'number' || obj.length >= length) {
throw new Error(
`${this.baseReference} with drill down ${this.propertyDrillDown} does not have a length less than ${length}`
);
}
});
}
public toBeDate() {
return this.runCheck(() => {
if (!(this.getObjectToTestReference() instanceof Date)) {
throw new Error(
`${this.baseReference} with drill down ${this.propertyDrillDown} is not a date`
);
}
});
}
public toBeBeforeDate(date: Date) {
return this.runCheck(() => {
if (!(this.getObjectToTestReference() < date)) {
throw new Error(
`${this.baseReference} with drill down ${this.propertyDrillDown} is not before ${date}`
);
}
});
}
public toBeAfterDate(date: Date) {
return this.runCheck(() => {
if (!(this.getObjectToTestReference() > date)) {
throw new Error(
`${this.baseReference} with drill down ${this.propertyDrillDown} is not after ${date}`
);
} }
}); });
} }

View File

@ -1,14 +1,9 @@
import * as smartdelay from '@pushrocks/smartdelay'; import * as smartdelay from '@pushrocks/smartdelay';
import * as smartpromise from '@pushrocks/smartpromise'; import * as smartpromise from '@pushrocks/smartpromise';
export { export { smartdelay, smartpromise };
smartdelay,
smartpromise
}
// third party scope // third party scope
import fastDeepEqual from 'fast-deep-equal'; import fastDeepEqual from 'fast-deep-equal';
export { export { fastDeepEqual };
fastDeepEqual,
}

11
tsconfig.json Normal file
View File

@ -0,0 +1,11 @@
{
"compilerOptions": {
"experimentalDecorators": true,
"useDefineForClassFields": false,
"target": "ES2022",
"module": "ES2022",
"moduleResolution": "nodenext",
"esModuleInterop": true,
"verbatimModuleSyntax": true,
}
}

View File

@ -1,17 +0,0 @@
{
"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"
}