Spaces:
Sleeping
Sleeping
/** | |
* @fileoverview A set of methods that mimic a bit of the Jasmine testing library, but simpler and | |
* more succinct for manipulating a comfy integration test. | |
*/ | |
import { wait } from "rgthree/common/shared_utils.js"; | |
type TestContext = { | |
label?: string; | |
beforeEach?: Function[]; | |
}; | |
let contexts: TestContext[] = []; | |
export function describe(label: string, fn: Function) { | |
return async () => { | |
await describeRun(label, fn); | |
}; | |
} | |
export async function describeRun(label: string, fn: Function) { | |
await wait(); | |
contexts.push({ label }); | |
console.group(`[Start] ${contexts[contexts.length - 1]!.label}`); | |
await fn(); | |
contexts.pop(); | |
console.groupEnd(); | |
} | |
export async function should(declaration: string, fn: Function) { | |
if (!contexts[contexts.length - 1]) { | |
throw Error("Called should outside of a describe."); | |
} | |
console.group(`...should ${declaration}`); | |
try { | |
for (const context of contexts) { | |
for (const beforeEachFn of context?.beforeEach || []) { | |
await beforeEachFn(); | |
} | |
} | |
await fn(); | |
} catch (e: any) { | |
fail(e); | |
} | |
console.groupEnd(); | |
} | |
export async function beforeEach(fn: Function) { | |
if (!contexts[contexts.length - 1]) { | |
throw Error("Called beforeEach outside of a describe."); | |
} | |
const last = contexts[contexts.length - 1]!; | |
last.beforeEach = last?.beforeEach || []; | |
last.beforeEach.push(fn); | |
} | |
export function fail(e: Error) { | |
log(`X Failure: ${e}`, "color:#600; background:#fdd; padding: 2px 6px;"); | |
} | |
function log(msg: string, styles: string) { | |
if (styles) { | |
console.log(`%c ${msg}`, styles); | |
} else { | |
console.log(msg); | |
} | |
} | |
class Expectation { | |
private propertyLabel: string | null = ""; | |
private expectedLabel: string | null = ""; | |
private expectedFn!: (v: any) => boolean; | |
private value: any; | |
constructor(value: any) { | |
this.value = value; | |
} | |
toBe(labelOrExpected: any, maybeExpected?: any) { | |
const expected = maybeExpected !== undefined ? maybeExpected : labelOrExpected; | |
this.propertyLabel = maybeExpected !== undefined ? labelOrExpected : null; | |
this.expectedLabel = JSON.stringify(expected); | |
this.expectedFn = (v) => v == expected; | |
return this.toBeEval(); | |
} | |
toBeUndefined(propertyLabel: string) { | |
this.expectedFn = (v) => v === undefined; | |
this.propertyLabel = propertyLabel || ""; | |
this.expectedLabel = "undefined"; | |
return this.toBeEval(true); | |
} | |
toBeNullOrUndefined(propertyLabel: string) { | |
this.expectedFn = (v) => v == null; | |
this.propertyLabel = propertyLabel || ""; | |
this.expectedLabel = "null or undefined"; | |
return this.toBeEval(true); | |
} | |
toBeTruthy(propertyLabel: string) { | |
this.expectedFn = (v) => !v; | |
this.propertyLabel = propertyLabel || ""; | |
this.expectedLabel = "truthy"; | |
return this.toBeEval(false); | |
} | |
toBeANumber(propertyLabel: string) { | |
this.expectedFn = (v) => typeof v === "number"; | |
this.propertyLabel = propertyLabel || ""; | |
this.expectedLabel = "a number"; | |
return this.toBeEval(); | |
} | |
toBeEval(strict = false) { | |
let evaluation = this.expectedFn(this.value); | |
let msg = `Expected ${this.propertyLabel ? this.propertyLabel + " to be " : ""}${ | |
this.expectedLabel | |
}`; | |
msg += evaluation ? "." : `, but was ${JSON.stringify(this.value)}`; | |
this.log(evaluation, msg); | |
return evaluation; | |
} | |
log(value: boolean, msg: string) { | |
if (value) { | |
log(`🗸 ${msg}`, "color:#060; background:#cec; padding: 2px 6px;"); | |
} else { | |
log(`X ${msg}`, "color:#600; background:#fdd; padding: 2px 6px;"); | |
} | |
} | |
} | |
export function expect(value: any, msg?: string) { | |
const expectation = new Expectation(value); | |
if (msg) { | |
expectation.log(value, msg); | |
} | |
return expectation; | |
} | |