qunitx 0.9.0 → 0.9.2

package/shims/node/index.js

@@ -1,237 +1,22 @@
-import { describe, it, before as beforeAll, after as afterAll } from 'node:test';
-import Assert from './assert.js';
+import { AssertionError } from 'node:assert';
+import QUnit from '../../vendor/qunit.js';
+import Assert from '../shared/assert.js';
+import ModuleContext from '../shared/module-context.js';
+import TestContext from '../shared/test-context.js';
+import Module from './module.js';
+import Test from './test.js';
 
-// NOTE: node.js beforeEach & afterEach is buggy because the TestContext it has is NOT correct reference when called, it gets the last context
-// NOTE: QUnit expect() logic is buggy in nested modules
-// NOTE: after gets the last direct children test of the module, not last defined context of a module(last defined context is a module)
+Assert.QUnit = QUnit;
+Assert.AssertionError = AssertionError;
 
-class TestContext {
-  name;
+ModuleContext.Assert = Assert;
+TestContext.Assert = Assert;
 
-  #module;
-  get module() {
-    return this.#module;
-  }
-  set module(value) {
-    this.#module = value;
-  }
+Object.freeze(Assert);
+Object.freeze(ModuleContext);
+Object.freeze(TestContext);
 
-  #assert;
-  get assert() {
-    return this.#assert;
-  }
-  set assert(value) {
-    this.#assert = value;
-  }
+export const module = Module;
+export const test = Test;
 
-  #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 = (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(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);
-      }
-    }
-
-    result = await targetTestContent.call(context, context.assert, { testName, options: runtimeOptions });
-
-    await context.assert.waitForAsyncOps();
-
-    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 result;
-  });
-}
-
-export default { module, test, config: {} };
+export default { AssertionError: Assert.AssertionError, module, test, config: {} };

package/shims/node/module.js

@@ -0,0 +1,71 @@
+import { describe, before as beforeAll, after as afterAll } from 'node:test';
+import ModuleContext from '../shared/module-context.js';
+
+// NOTE: node.js beforeEach & afterEach is buggy because the TestContext it has is NOT correct reference when called, it gets the last context
+// NOTE: QUnit expect() logic is buggy in nested modules
+// NOTE: after gets the last direct children test of the module, not last defined context of a module(last defined context is a module)
+
+export default function 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.context, moduleContext.moduleChain.reduce((result, module) => {
+        return Object.assign(result, module.context, {
+          steps: result.steps.concat(module.context.steps),
+          expectedAssertionCount: module.context.expectedAssertionCount
+            ? module.context.expectedAssertionCount
+            : result.expectedAssertionCount
+        });
+      }, { steps: [], expectedAssertionCount: undefined }));
+
+      for (let hook of beforeHooks) {
+        await hook.call(moduleContext.context, moduleContext.assert);
+      }
+
+      for (let i = 0, len = moduleContext.tests.length; i < len; i++) {
+        Object.assign(moduleContext.tests[i], moduleContext.context, {
+          steps: moduleContext.context.steps,
+          totalExecutedAssertions: moduleContext.context.totalExecutedAssertions,
+          expectedAssertionCount: moduleContext.context.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);
+      }
+
+      for (let i = 0, len = moduleContext.tests.length; i < len; i++) {
+        moduleContext.tests[i].finish();
+      }
+    });
+
+    targetModuleContent.call(moduleContext.context, {
+      before(beforeFn) {
+        beforeHooks[beforeHooks.length] = beforeFn;
+      },
+      beforeEach(beforeEachFn) {
+        moduleContext.beforeEachHooks[moduleContext.beforeEachHooks.length] = beforeEachFn;
+      },
+      afterEach(afterEachFn) {
+        moduleContext.afterEachHooks[moduleContext.afterEachHooks.length] = afterEachFn;
+      },
+      after(afterFn) {
+        afterHooks[afterHooks.length] = afterFn;
+      }
+    }, { moduleName, options: runtimeOptions });
+
+    ModuleContext.currentModuleChain.pop();
+  });
+}

package/shims/node/test.js

@@ -0,0 +1,36 @@
+import { it } from 'node:test';
+import TestContext from '../shared/test-context.js';
+import ModuleContext from '../shared/module-context.js';
+
+export default function 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(testName, { concurrency: true, ...targetRuntimeOptions }, async function () {
+    for (let module of context.module.moduleChain) {
+      for (let hook of module.beforeEachHooks) {
+        await hook.call(context, context.assert);
+      }
+    }
+
+    let result = await targetTestContent.call(context, context.assert, { testName, options: runtimeOptions });
+
+    await context.assert.waitForAsyncOps();
+
+    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 result;
+  });
+}
+

package/shims/{node → shared}/assert.js

@@ -1,23 +1,19 @@
-import QUnit from '../../vendor/qunit.js';
+import '../../vendor/qunit.js';
 import { objectValues, objectValuesSubset, validateExpectedExceptionArgs, validateException } from '../shared/index.js';
-import assert, { AssertionError as _AssertionError } from 'node:assert';
 import util from 'node:util';
 
-export const AssertionError = _AssertionError;
-
 // More: contexts needed for timeout
-// NOTE: QUnit API provides assert on hooks, which makes it hard to make it concurrent
 // NOTE: Another approach for a global report Make this._assertions.set(this.currentTest, (this._assertions.get(this.currentTest) || 0) + 1); for pushResult
 // NOTE: This should *always* be a singleton(?), passed around as an argument for hooks. Seems difficult with concurrency. Singleton needs to be a concurrent data structure.
 
 export default class Assert {
-  AssertionError = _AssertionError;
-
-  #asyncOps = [];
+  static QUnit;
+  static AssertionError;
 
   constructor(module, test) {
-    this.test = test || module;
+    this.test = test || module.context;
   }
+
   _incrementAssertionCount() {
     this.test.totalExecutedAssertions++;
   }
@@ -61,17 +57,17 @@ export default class Assert {
     let resolveFn;
     let done = new Promise(resolve => { resolveFn = resolve; });
 
-    this.#asyncOps.push(done);
+    this.test.asyncOps.push(done);
 
     return () => { resolveFn(); };
   }
   async waitForAsyncOps() {
-    return Promise.all(this.#asyncOps);
+    return Promise.all(this.test.asyncOps);
   }
   pushResult(resultInfo = {}) {
     this._incrementAssertionCount();
     if (!resultInfo.result) {
-      throw new AssertionError({
+      throw new Assert.AssertionError({
         actual: resultInfo.actual,
         expected: resultInfo.expected,
         message: resultInfo.message || 'Custom assertion failed!',
@@ -84,7 +80,7 @@ export default class Assert {
   ok(state, message) {
     this._incrementAssertionCount();
     if (!state) {
-      throw new AssertionError({
+      throw new Assert.AssertionError({
         actual: state,
         expected: true,
         message: message || `Expected argument to be truthy, it was: ${inspect(state)}`,
@@ -95,7 +91,7 @@ export default class Assert {
   notOk(state, message) {
     this._incrementAssertionCount();
     if (state) {
-      throw new AssertionError({
+      throw new Assert.AssertionError({
         actual: state,
         expected: false,
         message: message || `Expected argument to be falsy, it was: ${inspect(state)}`,
@@ -106,7 +102,7 @@ export default class Assert {
   true(state, message) {
     this._incrementAssertionCount();
     if (state !== true) {
-      throw new AssertionError({
+      throw new Assert.AssertionError({
         actual: state,
         expected: true,
         message: message || `Expected argument to be true, it was: ${inspect(state)}`,
@@ -117,9 +113,9 @@ export default class Assert {
   false(state, message) {
     this._incrementAssertionCount();
     if (state !== false) {
-      throw new AssertionError({
+      throw new Assert.AssertionError({
         actual: state,
-        expected: true,
+        expected: false,
         message: message || `Expected argument to be false, it was: ${inspect(state)}`,
         stackStartFn: this.false,
       });
@@ -128,7 +124,7 @@ export default class Assert {
   equal(actual, expected, message) {
     this._incrementAssertionCount();
     if (actual != expected) {
-      throw new AssertionError({
+      throw new Assert.AssertionError({
         actual,
         expected,
         message: message || `Expected: ${defaultMessage(actual, 'should equal to:', expected)}`,
@@ -140,7 +136,7 @@ export default class Assert {
   notEqual(actual, expected, message) {
     this._incrementAssertionCount();
     if (actual == expected) {
-      throw new AssertionError({
+      throw new Assert.AssertionError({
         actual,
         expected,
         operator: '!=',
@@ -153,8 +149,8 @@ export default class Assert {
     this._incrementAssertionCount();
     let targetActual = objectValues(actual);
     let targetExpected = objectValues(expected);
-    if (!QUnit.equiv(targetActual, targetExpected)) {
-      throw new AssertionError({
+    if (!Assert.QUnit.equiv(targetActual, targetExpected)) {
+      throw new Assert.AssertionError({
         actual: targetActual,
         expected: targetExpected,
         message: message || `Expected properties to be propEqual: ${defaultMessage(targetActual, 'should propEqual to:', targetExpected)}`,
@@ -166,8 +162,8 @@ export default class Assert {
     this._incrementAssertionCount();
     let targetActual = objectValues(actual);
     let targetExpected = objectValues(expected);
-    if (QUnit.equiv(targetActual, targetExpected)) {
-      throw new AssertionError({
+    if (Assert.QUnit.equiv(targetActual, targetExpected)) {
+      throw new Assert.AssertionError({
         actual: targetActual,
         expected: targetExpected,
         message: message || `Expected properties to NOT be propEqual: ${defaultMessage(targetActual, 'should notPropEqual to:', targetExpected)}`,
@@ -179,8 +175,8 @@ export default class Assert {
     this._incrementAssertionCount();
     let targetActual = objectValuesSubset(actual, expected);
     let targetExpected = objectValues(expected, false);
-    if (!QUnit.equiv(targetActual, targetExpected)) {
-      throw new AssertionError({
+    if (!Assert.QUnit.equiv(targetActual, targetExpected)) {
+      throw new Assert.AssertionError({
         actual: targetActual,
         expected: targetExpected,
         message: message || `propContains assertion fail on: ${defaultMessage(targetActual, 'should propContains to:', targetExpected)}`,
@@ -192,8 +188,8 @@ export default class Assert {
     this._incrementAssertionCount();
     let targetActual = objectValuesSubset(actual, expected);
     let targetExpected = objectValues(expected);
-    if (QUnit.equiv(targetActual, targetExpected)) {
-      throw new AssertionError({
+    if (Assert.QUnit.equiv(targetActual, targetExpected)) {
+      throw new Assert.AssertionError({
         actual: targetActual,
         expected: targetExpected,
         message: message || `notPropContains assertion fail on: ${defaultMessage(targetActual, 'should notPropContains of:', targetExpected)}`,
@@ -203,8 +199,8 @@ export default class Assert {
   }
   deepEqual(actual, expected, message) {
     this._incrementAssertionCount();
-    if (!QUnit.equiv(actual, expected)) {
-      throw new AssertionError({
+    if (!Assert.QUnit.equiv(actual, expected)) {
+      throw new Assert.AssertionError({
         actual,
         expected,
         message: message || `Expected values to be deepEqual: ${defaultMessage(actual, 'should deepEqual to:', expected)}`,
@@ -215,8 +211,8 @@ export default class Assert {
   }
   notDeepEqual(actual, expected, message) {
     this._incrementAssertionCount();
-    if (QUnit.equiv(actual, expected)) {
-      throw new AssertionError({
+    if (Assert.QUnit.equiv(actual, expected)) {
+      throw new Assert.AssertionError({
         actual,
         expected,
         message: message || `Expected values to be NOT deepEqual: ${defaultMessage(actual, 'should notDeepEqual to:', expected)}`,
@@ -228,7 +224,7 @@ export default class Assert {
   strictEqual(actual, expected, message) {
     this._incrementAssertionCount();
     if (actual !== expected) {
-      throw new AssertionError({
+      throw new Assert.AssertionError({
         actual,
         expected,
         message: message || `Expected: ${defaultMessage(actual, 'is strictEqual to:', expected)}`,
@@ -240,7 +236,7 @@ export default class Assert {
   notStrictEqual(actual, expected, message) {
     this._incrementAssertionCount();
     if (actual === expected) {
-      throw new AssertionError({
+      throw new Assert.AssertionError({
         actual,
         expected,
         message: message || `Expected: ${defaultMessage(actual, 'is notStrictEqual to:', expected)}`,
@@ -253,7 +249,7 @@ export default class Assert {
     this?._incrementAssertionCount();
     let [expected, message] = validateExpectedExceptionArgs(expectedInput, assertionMessage, 'rejects');
     if (typeof blockFn !== 'function') {
-      throw new AssertionError({
+      throw new Assert.AssertionError({
         actual: blockFn,
         expected: Function,
         message: 'The value provided to `assert.throws` was not a function.',
@@ -266,7 +262,7 @@ export default class Assert {
     } catch (error) {
       let validation = validateException(error, expected, message);
       if (validation.result === false) {
-        throw new AssertionError({
+        throw new Assert.AssertionError({
           actual: validation.result,
           expected: validation.expected,
           message: validation.message,
@@ -277,7 +273,7 @@ export default class Assert {
       return;
     }
 
-    throw new AssertionError({
+    throw new Assert.AssertionError({
       actual: blockFn,
       expected: expected,
       message: 'Function passed to `assert.throws` did not throw an exception!',
@@ -289,7 +285,7 @@ export default class Assert {
     let [expected, message] = validateExpectedExceptionArgs(expectedInput, assertionMessage, 'rejects');
     let then = promise && promise.then;
     if (typeof then !== 'function') {
-      throw new AssertionError({
+      throw new Assert.AssertionError({
         actual: promise,
         expected: expected,
         message: 'The value provided to `assert.rejects` was not a promise!',
@@ -299,7 +295,7 @@ export default class Assert {
 
     try {
       await promise;
-      throw new AssertionError({
+      throw new Assert.AssertionError({
         actual: promise,
         expected: expected,
         message: 'The promise returned by the `assert.rejects` callback did not reject!',
@@ -308,7 +304,7 @@ export default class Assert {
     } catch (error) {
       let validation = validateException(error, expected, message);
       if (validation.result === false) {
-        throw new AssertionError({
+        throw new Assert.AssertionError({
           actual: validation.result,
           expected: validation.expected,
           message: validation.message,

package/shims/shared/module-context.js

@@ -0,0 +1,29 @@
+import TestContext from './test-context.js';
+
+export default class ModuleContext {
+  static Assert;
+  static currentModuleChain = [];
+
+  static get lastModule() {
+    return this.currentModuleChain[this.currentModuleChain.length - 1];
+  }
+
+  context = new TestContext();
+
+  moduleChain = [];
+  beforeEachHooks = [];
+  afterEachHooks = [];
+  tests = [];
+
+  constructor(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 ModuleContext.Assert(this);
+
+    return Object.freeze(this);
+  }
+}