smartexpect/ts/smartexpect.classes.assertion.ts

213 lines
6.7 KiB
TypeScript
Raw Normal View History

2022-01-21 02:33:24 +00:00
import * as plugins from './smartexpect.plugins';
export type TExecutionType = 'sync' | 'async';
export class Assertion {
executionMode: TExecutionType;
baseReference: any;
2022-02-15 15:13:48 +00:00
propertyDrillDown: string[] = [];
2022-01-21 02:33:24 +00:00
private notSetting = false;
private timeoutSetting = 0;
constructor(baseReferenceArg: any, executionModeArg: TExecutionType) {
this.baseReference = baseReferenceArg;
this.executionMode = executionModeArg;
}
2022-02-15 15:13:48 +00:00
private getObjectToTestReference() {
let returnObjectToTestReference = this.baseReference;
for (const property of this.propertyDrillDown) {
returnObjectToTestReference = returnObjectToTestReference[property];
}
return returnObjectToTestReference;
}
2022-01-21 02:33:24 +00:00
public get not() {
this.notSetting = true;
return this;
}
public timeout(millisArg: number) {
this.timeoutSetting = millisArg;
return this;
}
private runCheck(checkFunction: () => any) {
const runDirectOrNegated = (checkFunction: () => any) => {
if (!this.notSetting) {
return checkFunction();
} else {
let isOk = false;
try {
2022-02-02 03:24:39 +00:00
runDirectOrNegated(checkFunction());
2022-01-21 02:33:24 +00:00
} catch (e) {
isOk = true;
}
if (!isOk) {
throw new Error('Negated assertion is not ok!');
}
}
2022-02-02 03:24:39 +00:00
};
2022-01-21 02:33:24 +00:00
if (this.executionMode === 'async') {
const done = plugins.smartpromise.defer();
if (!(this.baseReference instanceof Promise)) {
done.reject(new Error(`${this.baseReference} is not of type promise.`));
} else {
if (this.timeoutSetting) {
plugins.smartdelay.delayFor(this.timeoutSetting).then(() => {
if (done.status === 'pending') {
2022-02-02 03:24:39 +00:00
done.reject(new Error(`${this.baseReference} timed out at ${this.timeoutSetting}!`));
}
2022-01-21 02:33:24 +00:00
});
}
2022-02-02 03:24:39 +00:00
this.baseReference.then((promiseResultArg) => {
2022-01-21 02:33:24 +00:00
this.baseReference = promiseResultArg;
done.resolve(runDirectOrNegated(checkFunction));
2022-02-02 03:24:39 +00:00
});
2022-01-21 02:33:24 +00:00
}
return done.promise;
} else {
return runDirectOrNegated(checkFunction);
}
}
public toBeTypeofString() {
return this.runCheck(() => {
2022-02-15 15:13:48 +00:00
if (typeof this.getObjectToTestReference() !== 'string') {
2022-01-21 02:33:24 +00:00
throw new Error(
2022-02-15 15:13:48 +00:00
`Assertion failed: ${this.baseReference} with drill down ${this.propertyDrillDown} is not of type string, but typeof ${typeof this
2022-02-02 03:24:39 +00:00
.baseReference}`
2022-01-21 02:33:24 +00:00
);
}
});
}
public toBeTypeofNumber() {
return this.runCheck(() => {
2022-02-15 15:13:48 +00:00
if (typeof this.getObjectToTestReference() !== 'number') {
2022-01-21 02:33:24 +00:00
throw new Error(
2022-02-15 15:13:48 +00:00
`Assertion failed: ${this.baseReference} with drill down ${this.propertyDrillDown} is not of type string, but typeof ${typeof this
2022-02-02 03:24:39 +00:00
.baseReference}`
2022-01-21 02:33:24 +00:00
);
}
});
}
public toBeTypeofBoolean() {
return this.runCheck(() => {
2022-02-15 15:13:48 +00:00
if (typeof this.getObjectToTestReference() !== 'boolean') {
2022-01-21 02:33:24 +00:00
throw new Error(
2022-02-15 15:13:48 +00:00
`Assertion failed: ${this.baseReference} with drill down ${this.propertyDrillDown} is not of type string, but typeof ${typeof this
2022-02-02 03:24:39 +00:00
.baseReference}`
2022-01-21 02:33:24 +00:00
);
}
});
}
2022-01-21 16:37:30 +00:00
public toEqual(comparisonObject: any) {
return this.runCheck(() => {
2022-02-15 15:13:48 +00:00
const result = plugins.fastDeepEqual(this.getObjectToTestReference(), comparisonObject);
2022-01-21 16:37:30 +00:00
if (!result) {
2022-02-15 15:13:48 +00:00
throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} does not equal ${comparisonObject}`);
2022-01-21 16:37:30 +00:00
}
});
}
2022-01-21 18:40:30 +00:00
public toBeTrue() {
return this.runCheck(() => {
2022-02-15 15:13:48 +00:00
const result = typeof this.getObjectToTestReference() === 'boolean' && this.getObjectToTestReference() === true;
2022-01-21 18:40:30 +00:00
if (!result) {
2022-02-15 15:13:48 +00:00
throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} is not true or not of type boolean`);
2022-01-21 18:40:30 +00:00
}
});
}
public toBeFalse() {
return this.runCheck(() => {
2022-02-15 15:13:48 +00:00
const result = typeof this.getObjectToTestReference() === 'boolean' && this.getObjectToTestReference() === false;
2022-01-21 18:40:30 +00:00
if (!result) {
2022-02-15 15:13:48 +00:00
throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} is not false or not of type boolean`);
2022-01-21 18:40:30 +00:00
}
});
}
public toBeInstanceOf(classArg: any) {
return this.runCheck(() => {
2022-02-15 15:13:48 +00:00
const result = this.getObjectToTestReference() instanceof classArg;
2022-01-21 18:40:30 +00:00
if (!result) {
2022-02-15 15:13:48 +00:00
throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} is not an instance of ${classArg}`);
2022-01-21 18:40:30 +00:00
}
});
}
2022-02-02 01:45:45 +00:00
public toHaveProperty(propertyArg: string) {
return this.runCheck(() => {
2022-02-15 15:13:48 +00:00
const result = !!this.getObjectToTestReference()[propertyArg];
2022-02-02 01:45:45 +00:00
if (!result) {
2022-02-15 15:13:48 +00:00
throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} does not have property ${propertyArg}`);
2022-02-02 01:45:45 +00:00
}
});
}
public toBeGreaterThan(numberArg: number) {
return this.runCheck(() => {
2022-02-15 15:13:48 +00:00
const result = this.getObjectToTestReference() > numberArg;
2022-02-02 01:45:45 +00:00
if (!result) {
2022-02-15 15:13:48 +00:00
throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} is not greater than ${numberArg}`);
2022-02-02 01:45:45 +00:00
}
});
}
public toBeLessThan(numberArg: number) {
return this.runCheck(() => {
2022-02-15 15:13:48 +00:00
const result = this.getObjectToTestReference() < numberArg;
2022-02-02 01:45:45 +00:00
if (!result) {
2022-02-15 15:13:48 +00:00
throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} is not less than ${numberArg}`);
2022-02-02 01:45:45 +00:00
}
});
}
2022-02-02 03:24:39 +00:00
public toBeNull() {
return this.runCheck(() => {
2022-02-15 15:13:48 +00:00
const result = this.getObjectToTestReference() === null;
2022-02-02 03:24:39 +00:00
if (!result) {
2022-02-15 15:13:48 +00:00
throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} is not null`);
2022-02-02 03:24:39 +00:00
}
});
}
public toBeUndefined() {
return this.runCheck(() => {
2022-02-15 15:13:48 +00:00
const result = this.getObjectToTestReference() === undefined;
2022-02-02 03:24:39 +00:00
if (!result) {
2022-02-15 15:13:48 +00:00
throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} is not undefined`);
2022-02-02 03:24:39 +00:00
}
});
}
public toBeNullOrUndefined() {
return this.runCheck(() => {
2022-02-15 15:13:48 +00:00
const result = this.getObjectToTestReference() === null || this.getObjectToTestReference() === undefined;
2022-02-02 03:24:39 +00:00
if (!result) {
2022-02-15 15:13:48 +00:00
throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} is not null or undefined`);
2022-02-02 03:24:39 +00:00
}
});
}
public toContain(itemArg: any) {
return this.runCheck(() => {
2022-02-02 03:26:22 +00:00
const result =
2022-02-15 15:13:48 +00:00
this.getObjectToTestReference() instanceof Array &&
this.getObjectToTestReference().includes(itemArg);
2022-02-02 03:24:39 +00:00
if (!result) {
2022-02-15 15:13:48 +00:00
throw new Error(`${this.baseReference} with drill down ${this.propertyDrillDown} is not contain ${itemArg}`);
2022-02-02 03:24:39 +00:00
}
});
}
2022-02-15 15:13:48 +00:00
public property(propertyNameArg: string) {
this.propertyDrillDown.push(propertyNameArg);
return this;
}
2022-01-21 02:33:24 +00:00
}