qunitx 0.8.2 → 0.9.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "qunitx",
   "type": "module",
-  "version": "0.8.2",
+  "version": "0.9.0",
   "description": "A universal test framework for testing any js file on node.js, browser or deno with QUnit API",
   "author": "Izel Nakri",
   "license": "MIT",
@@ -61,7 +61,7 @@
     "ts-node": ">=10.7.0"
   },
   "volta": {
-    "node": "20.4.0"
+    "node": "20.5.0"
   },
   "prettier": {
     "printWidth": 100,

package/shims/deno/assert.js

@@ -1,6 +1,6 @@
 import { AssertionError as DenoAssertionError, assertRejects, assertThrows } from "https://deno.land/std@0.192.0/testing/asserts.ts";
 import '../../vendor/qunit.js';
-import { objectValuesSubset } from '../shared/index.js';
+import { objectValues, objectValuesSubset, validateExpectedExceptionArgs, validateException } from '../shared/index.js';
 import util from 'node:util';
 
 export class AssertionError extends DenoAssertionError {
@@ -9,39 +9,79 @@ export class AssertionError extends DenoAssertionError {
   }
 }
 
-// NOTE: Maybe do the expect, steps in some object, and also do timeout and async(?)
-export default {
-  _steps: [],
-  timeout() {
-    return true; // NOTE: NOT implemented
-  },
-  step(value = '') {
-    this._steps.push(value);
-  },
-  verifySteps(steps, message = 'Verify steps failed!') {
-    const result = this.deepEqual(this._steps, steps, message);
+export default class Assert {
+  AssertionError = AssertionError
+
+  #asyncOps = [];
+
+  constructor(module, test) {
+    this.test = test || module;
+  }
+  _incrementAssertionCount() {
+    this.test.totalExecutedAssertions++;
+  }
+  timeout(number) {
+    if (!Number.isInteger(number) || number < 0) {
+      throw new Error('assert.timeout() expects a positive integer.');
+    }
+
+    this.test.timeout = number;
+  }
+  step(message) {
+    let assertionMessage = message;
+    let result = !!message;
+
+    this.test.steps.push(message);
 
-    this._steps.length = 0;
+    if (typeof message === 'undefined' || message === '') {
+      assertionMessage = 'You must provide a message to assert.step';
+    } else if (typeof message !== 'string') {
+      assertionMessage = 'You must provide a string value to assert.step';
+      result = false;
+    }
 
-    return result;
-  },
-  expect() {
-    return () => {}; // NOTE: NOT implemented
-  },
+    this.pushResult({
+      result,
+      message: assertionMessage
+    });
+  }
+  verifySteps(steps, message = 'Verify steps failed!') {
+    this.deepEqual(this.test.steps, steps, message);
+    this.test.steps.length = 0;
+  }
+  expect(number) {
+    if (!Number.isInteger(number) || number < 0) {
+      throw new Error('assert.expect() expects a positive integer.');
+    }
+
+    this.test.expectedAssertionCount = number;
+  }
   async() {
-    return () => {}; // NOTE: noop, node should have sanitizeResources
-  },
+    let resolveFn;
+    let done = new Promise(resolve => { resolveFn = resolve; });
+
+    this.#asyncOps.push(done);
+
+    return () => { resolveFn(); };
+  }
+  async waitForAsyncOps() {
+    return Promise.all(this.#asyncOps);
+  }
   pushResult(resultInfo = {}) {
-    if (!result) {
+    this._incrementAssertionCount();
+    if (!resultInfo.result) {
       throw new AssertionError({
         actual: resultInfo.actual,
         expected: resultInfo.expected,
-        message: result.Infomessage || 'Custom assertion failed!',
+        message: resultInfo.message || 'Custom assertion failed!',
         stackStartFn: this.pushResult,
       });
     }
-  },
+
+    return this;
+  }
   ok(state, message) {
+    this._incrementAssertionCount();
     if (!state) {
       throw new AssertionError({
         actual: state,
@@ -50,8 +90,9 @@ export default {
         stackStartFn: this.ok,
       });
     }
-  },
+  }
   notOk(state, message) {
+    this._incrementAssertionCount();
     if (state) {
       throw new AssertionError({
         actual: state,
@@ -60,9 +101,10 @@ export default {
         stackStartFn: this.notOk,
       });
     }
-  },
+  }
   true(state, message) {
-    if (state === true) {
+    this._incrementAssertionCount();
+    if (state !== true) {
       throw new AssertionError({
         actual: state,
         expected: true,
@@ -70,9 +112,10 @@ export default {
         stackStartFn: this.true,
       });
     }
-  },
+  }
   false(state, message) {
-    if (state === false) {
+    this._incrementAssertionCount();
+    if (state !== false) {
       throw new AssertionError({
         actual: state,
         expected: true,
@@ -80,9 +123,10 @@ export default {
         stackStartFn: this.false,
       });
     }
-  },
+  }
   equal(actual, expected, message) {
-    if (actual == expected) {
+    this._incrementAssertionCount();
+    if (actual != expected) {
       throw new AssertionError({
         actual,
         expected,
@@ -91,9 +135,10 @@ export default {
         stackStartFn: this.equal,
       });
     }
-  },
+  }
   notEqual(actual, expected, message) {
-    if (actual != expected) {
+    this._incrementAssertionCount();
+    if (actual == expected) {
       throw new AssertionError({
         actual,
         expected,
@@ -102,11 +147,12 @@ export default {
         stackStartFn: this.notEqual,
       });
     }
-  },
+  }
   propEqual(actual, expected, message) {
+    this._incrementAssertionCount();
     let targetActual = objectValues(actual);
     let targetExpected = objectValues(expected);
-    if (!window.QUnit.window.QUnit.equiv(targetActual, targetExpected)) {
+    if (!QUnit.equiv(targetActual, targetExpected)) {
       throw new AssertionError({
         actual: targetActual,
         expected: targetExpected,
@@ -114,11 +160,12 @@ export default {
         stackStartFn: this.propEqual,
       });
     }
-  },
+  }
   notPropEqual(actual, expected, message) {
+    this._incrementAssertionCount();
     let targetActual = objectValues(actual);
     let targetExpected = objectValues(expected);
-    if (window.QUnit.equiv(targetActual, targetExpected)) {
+    if (QUnit.equiv(targetActual, targetExpected)) {
       throw new AssertionError({
         actual: targetActual,
         expected: targetExpected,
@@ -126,11 +173,12 @@ export default {
         stackStartFn: this.notPropEqual,
       });
     }
-  },
+  }
   propContains(actual, expected, message) {
+    this._incrementAssertionCount();
     let targetActual = objectValuesSubset(actual, expected);
     let targetExpected = objectValues(expected, false);
-    if (!window.QUnit.equiv(targetActual, targetExpected)) {
+    if (!QUnit.equiv(targetActual, targetExpected)) {
       throw new AssertionError({
         actual: targetActual,
         expected: targetExpected,
@@ -138,11 +186,12 @@ export default {
         stackStartFn: this.propContains,
       });
     }
-  },
+  }
   notPropContains(actual, expected, message) {
+    this._incrementAssertionCount();
     let targetActual = objectValuesSubset(actual, expected);
     let targetExpected = objectValues(expected);
-    if (window.QUnit.equiv(targetActual, targetExpected)) {
+    if (QUnit.equiv(targetActual, targetExpected)) {
       throw new AssertionError({
         actual: targetActual,
         expected: targetExpected,
@@ -150,9 +199,10 @@ export default {
         stackStartFn: this.notPropContains,
       });
     }
-  },
+  }
   deepEqual(actual, expected, message) {
-    if (!window.QUnit.equiv(actual, expected)) {
+    this._incrementAssertionCount();
+    if (!QUnit.equiv(actual, expected)) {
       throw new AssertionError({
         actual,
         expected,
@@ -161,9 +211,10 @@ export default {
         stackStartFn: this.deepEqual,
       });
     }
-  },
+  }
   notDeepEqual(actual, expected, message) {
-    if (window.QUnit.equiv(actual, expected)) {
+    this._incrementAssertionCount();
+    if (QUnit.equiv(actual, expected)) {
       throw new AssertionError({
         actual,
         expected,
@@ -172,8 +223,9 @@ export default {
         stackStartFn: this.notDeepEqual,
       });
     }
-  },
+  }
   strictEqual(actual, expected, message) {
+    this._incrementAssertionCount();
     if (actual !== expected) {
       throw new AssertionError({
         actual,
@@ -183,8 +235,9 @@ export default {
         stackStartFn: this.strictEqual,
       });
     }
-  },
+  }
   notStrictEqual(actual, expected, message) {
+    this._incrementAssertionCount();
     if (actual === expected) {
       throw new AssertionError({
         actual,
@@ -194,24 +247,76 @@ export default {
         stackStartFn: this.notStrictEqual,
       });
     }
-  },
-  throws: assertThrows,
-  rejects: assertRejects,
-};
+  }
+  throws(blockFn, expectedInput, assertionMessage) {
+    this?._incrementAssertionCount();
+    let [expected, message] = validateExpectedExceptionArgs(expectedInput, assertionMessage, 'rejects');
+    if (typeof blockFn !== 'function') {
+      throw new AssertionError({
+        actual: blockFn,
+        expected: Function,
+        message: 'The value provided to `assert.throws` was not a function.',
+        stackStartFn: this.throws,
+      });
+    }
 
-function objectValues(obj) {
-  let allowArray = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : true;
-  let vals = allowArray && is('array', obj) ? [] : {};
+    try {
+      blockFn();
+    } catch (error) {
+      let validation = validateException(error, expected, message);
+      if (validation.result === false) {
+        throw new AssertionError({
+          actual: validation.result,
+          expected: validation.expected,
+          message: validation.message,
+          stackStartFn: this.throws,
+        });
+      }
 
-  for (var key in obj) {
-    if (hasOwn$1.call(obj, key)) {
-      let val = obj[key];
-      vals[key] = val === Object(val) ? objectValues(val, allowArray) : val;
+      return;
     }
+
+    throw new AssertionError({
+      actual: blockFn,
+      expected: expected,
+      message: 'Function passed to `assert.throws` did not throw an exception!',
+      stackStartFn: this.throws,
+    });
   }
+  async rejects(promise, expectedInput, assertionMessage) {
+    this._incrementAssertionCount();
+    let [expected, message] = validateExpectedExceptionArgs(expectedInput, assertionMessage, 'rejects');
+    let then = promise && promise.then;
+    if (typeof then !== 'function') {
+      throw new AssertionError({
+        actual: promise,
+        expected: expected,
+        message: 'The value provided to `assert.rejects` was not a promise!',
+        stackStartFn: this.rejects,
+      });
+    }
 
-  return vals;
-}
+    try {
+      await promise;
+      throw new AssertionError({
+        actual: promise,
+        expected: expected,
+        message: 'The promise returned by the `assert.rejects` callback did not reject!',
+        stackStartFn: this.rejects,
+      });
+    } catch (error) {
+      let validation = validateException(error, expected, message);
+      if (validation.result === false) {
+        throw new AssertionError({
+          actual: validation.result,
+          expected: validation.expected,
+          message: validation.message,
+          stackStartFn: this.rejects,
+        });
+      }
+    }
+  }
+};
 
 function defaultMessage(actual, description, expected) {
   return `

package/shims/deno/index.js

@@ -1,48 +1,238 @@
 import {
-  afterEach,
-  beforeEach,
   beforeAll,
   afterAll,
   describe,
   it,
 } from "https://deno.land/std@0.192.0/testing/bdd.ts";
-import assert from './assert.js';
+import Assert from './assert.js';
 
-// TODO: TEST beforeEach, before, afterEach, after, currently not sure if they work!
-export const module = async function(moduleName, runtimeOptions, moduleContent) {
-  let targetRuntimeOptions = moduleContent ? Object.assign(runtimeOptions, { name: moduleName }) : { name: moduleName };
-  let targetModuleContent = moduleContent ? moduleName : runtimeOptions;
+class TestContext {
+  name;
 
-  return describe(assignDefaultValues(targetRuntimeOptions, { concurrency: true }), async function() {
-    return await targetModuleContent({ before: beforeAll, after: afterAll, beforeEach, afterEach }, {
-      moduleName,
-      options: runtimeOptions
+  #module;
+  get module() {
+    return this.#module;
+  }
+  set module(value) {
+    this.#module = value;
+  }
+
+  #assert;
+  get assert() {
+    return this.#assert;
+  }
+  set assert(value) {
+    this.#assert = value;
+  }
+
+  #timeout;
+  get timeout() {
+    return this.#timeout;
+  }
+  set timeout(value) {
+    this.#timeout = value;
+  }
+
+  #steps = [];
+  get steps() {
+    return this.#steps;
+  }
+  set steps(value) {
+    this.#steps = value;
+  }
+
+  #expectedAssertionCount;
+  get expectedAssertionCount() {
+    return this.#expectedAssertionCount;
+  }
+  set expectedAssertionCount(value) {
+    this.#expectedAssertionCount = value;
+  }
+
+  #totalExecutedAssertions = 0;
+  get totalExecutedAssertions() {
+    return this.#totalExecutedAssertions;
+  }
+  set totalExecutedAssertions(value) {
+    this.#totalExecutedAssertions = value;
+  }
+
+  constructor(name, moduleContext) {
+    if (moduleContext) {
+      this.name = `${moduleContext.name} | ${name}`;
+      this.module = moduleContext;
+      this.module.tests.push(this);
+      this.assert = new Assert(moduleContext, this);
+    }
+  }
+
+  finish() {
+    if (this.totalExecutedAssertions === 0) {
+      this.assert.pushResult({
+        result: false,
+        actual: this.totalExecutedAssertions,
+        expected: '> 0',
+        message: `Expected at least one assertion to be run for test: ${this.name}`,
+      });
+    } else if (this.steps.length > 0) {
+      this.assert.pushResult({
+        result: false,
+        actual: this.steps,
+        expected: [],
+        message: `Expected assert.verifySteps() to be called before end of test after using assert.step(). Unverified steps: ${this.steps.join(', ')}`,
+      });
+    } else if (this.expectedAssertionCount && this.expectedAssertionCount !== this.totalExecutedAssertions) {
+      this.assert.pushResult({
+        result: false,
+        actual: this.totalExecutedAssertions,
+        expected: this.expectedAssertionCount,
+        message: `Expected ${this.expectedAssertionCount} assertions, but ${this.totalExecutedAssertions} were run for test: ${this.name}`,
+      });
+    }
+  }
+}
+
+class ModuleContext extends TestContext {
+  static currentModuleChain = [];
+
+  static get lastModule() {
+    return this.currentModuleChain[this.currentModuleChain.length - 1];
+  }
+
+  #tests = [];
+  get tests() {
+    return this.#tests;
+  }
+
+  #beforeEachHooks = [];
+  get beforeEachHooks() {
+    return this.#beforeEachHooks;
+  }
+
+  #afterEachHooks = [];
+  get afterEachHooks() {
+    return this.#afterEachHooks;
+  }
+
+  #moduleChain = [];
+  get moduleChain() {
+    return this.#moduleChain;
+  }
+  set moduleChain(value) {
+    this.#moduleChain = value;
+  }
+
+  constructor(name) {
+    super(name);
+
+    let parentModule = ModuleContext.currentModuleChain[ModuleContext.currentModuleChain.length - 1];
+
+    ModuleContext.currentModuleChain.push(this);
+
+    this.moduleChain = ModuleContext.currentModuleChain.slice(0);
+    this.name = parentModule ? `${parentModule.name} > ${name}` : name;
+    this.assert = new Assert(this);
+  }
+}
+
+export const module = (moduleName, runtimeOptions, moduleContent) => {
+  let targetRuntimeOptions = moduleContent ? runtimeOptions : {};
+  let targetModuleContent = moduleContent ? moduleContent : runtimeOptions;
+  let moduleContext = new ModuleContext(moduleName);
+
+  return describe(moduleName, { concurrency: true, ...targetRuntimeOptions }, async function () {
+    let beforeHooks = [];
+    let afterHooks = [];
+
+    beforeAll(async function () {
+      Object.assign(moduleContext, moduleContext.moduleChain.reduce((result, module) => {
+        const { name, ...moduleWithoutName } = module;
+
+        return Object.assign(result, moduleWithoutName, {
+          steps: result.steps.concat(module.steps),
+          expectedAssertionCount: module.expectedAssertionCount
+            ? module.expectedAssertionCount
+            : result.expectedAssertionCount
+        });
+      }, { steps: [], expectedAssertionCount: undefined }));
+
+      for (let hook of beforeHooks) {
+        await hook.call(moduleContext, moduleContext.assert);
+      }
+
+      moduleContext.tests.forEach((testContext) => {
+        const { name, ...moduleContextWithoutName } = moduleContext;
+
+        Object.assign(testContext, moduleContextWithoutName, {
+          steps: moduleContext.steps,
+          totalExecutedAssertions: moduleContext.totalExecutedAssertions,
+          expectedAssertionCount: moduleContext.expectedAssertionCount,
+        });
+      });
+    });
+    afterAll(async () => {
+      for (const assert of moduleContext.tests.map(testContext => testContext.assert)) {
+        await assert.waitForAsyncOps();
+      }
+
+      let targetContext = moduleContext.tests[moduleContext.tests.length - 1];
+      for (let j = afterHooks.length - 1; j >= 0; j--) {
+        await afterHooks[j].call(targetContext, targetContext.assert);
+      }
+
+      moduleContext.tests.forEach(testContext => testContext.finish());
     });
+
+    targetModuleContent.call(moduleContext, {
+      before(beforeFn) {
+        return beforeHooks.push(beforeFn);
+      },
+      beforeEach(beforeEachFn) {
+        return moduleContext.beforeEachHooks.push(beforeEachFn);
+      },
+      afterEach(afterEachFn) {
+        return moduleContext.afterEachHooks.push(afterEachFn);
+      },
+      after(afterFn) {
+        return afterHooks.push(afterFn);
+      }
+    }, { moduleName, options: runtimeOptions });
+
+    ModuleContext.currentModuleChain.pop();
   });
 }
 
-export const test = async function(testName, runtimeOptions, testContent) {
-  let targetRuntimeOptions = testContent ? Object.assign(runtimeOptions, { name: testName }) : { name: testName };
+export const test = (testName, runtimeOptions, testContent) => {
+  let moduleContext = ModuleContext.lastModule;
+  if (!moduleContext) {
+    throw new Error(`Test '${testName}' called outside of module context.`);
+  }
+
+  let targetRuntimeOptions = testContent ? runtimeOptions : {};
   let targetTestContent = testContent ? testContent : runtimeOptions;
+  let context = new TestContext(testName, moduleContext);
 
-  return it(targetRuntimeOptions, async function() {
-    let metadata = { testName, options: targetRuntimeOptions, expectedTestCount: undefined };
-    return await targetTestContent(assert, metadata);
+  return it(testName, { concurrency: true, ...targetRuntimeOptions }, async function () {
+    let result;
+    for (let module of context.module.moduleChain) {
+      for (let hook of module.beforeEachHooks) {
+        await hook.call(context, context.assert);
+      }
+    }
 
-    if (expectedTestCount) {
+    result = await targetTestContent.call(context, context.assert, { testName, options: runtimeOptions });
 
-    }
-  });
-}
+    await context.assert.waitForAsyncOps();
 
-function assignDefaultValues(options, defaultValues) {
-  for (let key in defaultValues) {
-    if (options[key] === undefined) {
-      options[key] = defaultValues[key];
+    for (let i = context.module.moduleChain.length - 1; i >= 0; i--) {
+      let module = context.module.moduleChain[i];
+      for (let j = module.afterEachHooks.length - 1; j >= 0; j--) {
+        await module.afterEachHooks[j].call(context, context.assert);
+      }
     }
-  }
 
-  return options;
+    return result;
+  });
 }
 
-export default { module, test, assert };
+export default { module, test, config: {} };