aberlaas-test 2.22.3 → 2.24.0

package/configs/setupFiles/bench.js

@@ -0,0 +1,5 @@
+// We make bench publicly available inside of tests, so users won't need to
+// import it
+import { bench } from 'vitest';
+
+globalThis.bench = bench;

package/configs/setupFiles/describeName.js

@@ -0,0 +1,34 @@
+/**
+ * Make describeName available as a variable in the describe() body.
+ *
+ * Note: We need to replace the initial describe with a wrapped version that
+ * sets describeName when the callback is being executed. We need to be careful
+ * to correctly keep all the inner methods as well (like .only, .concurrent,
+ * etc).
+ **/
+/* global beforeEach, expect */
+
+// Keep reference to original method
+const originalDescribe = globalThis.describe;
+
+// New wrapping method, that sets describeName when the callback is executed
+const wrappedDescribe = function (name, callback) {
+  originalDescribe(name, () => {
+    globalThis.describeName = name;
+    callback();
+  });
+};
+
+// Re-assign the method, but keep internal methods
+globalThis.describe = Object.defineProperties(
+  wrappedDescribe,
+  Object.getOwnPropertyDescriptors(originalDescribe),
+);
+
+// Make describeName available in all it() callbacks
+beforeEach(() => {
+  globalThis.describeName = expect
+    .getState()
+    .currentTestName.split(' > ')
+    .at(-2);
+});

package/configs/setupFiles/focus.js

@@ -0,0 +1,3 @@
+// fit and fdescribe to run only those tests
+globalThis.fit = globalThis.it.only;
+globalThis.fdescribe = globalThis.describe.only;

package/configs/setupFiles/matchers.js

@@ -0,0 +1,43 @@
+// Helpful matchers not included in Vitest
+import { _ } from 'golgoth';
+import { expect } from 'vitest';
+
+expect.extend({
+  toInclude(received, expected) {
+    return {
+      pass: _.includes(received, expected),
+      message: () =>
+        this.isNot
+          ? `expected not to include ${expected}`
+          : `expected to include ${expected}`,
+    };
+  },
+
+  toBeString(received) {
+    return {
+      pass: _.isString(received),
+      message: () =>
+        this.isNot ? 'expected not to be a string' : 'expected to be a string',
+    };
+  },
+
+  toStartWith(received, expected) {
+    return {
+      pass: _.startsWith(received, expected),
+      message: () =>
+        this.isNot
+          ? `expected not to start with ${expected}`
+          : `expected to start with ${expected}`,
+    };
+  },
+
+  toEndWith(received, expected) {
+    return {
+      pass: _.endsWith(received, expected),
+      message: () =>
+        this.isNot
+          ? `expected not to end with ${expected}`
+          : `expected to end with ${expected}`,
+    };
+  },
+});

package/configs/setupFiles/mockStdin.js

@@ -0,0 +1,37 @@
+import { PassThrough } from 'node:stream';
+
+/**
+ * Allow mocking stdin in tests.
+ * Usage:
+ * mockStdin((stdin) => {
+ *   // do something
+ *   stdin.push('abc');
+ * });
+ * Initial code inspired by: https://github.com/sindresorhus/ora/blob/main/test.js
+ * @param {Function} callback Method called with a fake stdin as first argument
+ * @returns {any} Return value of the callback
+ **/
+globalThis.mockStdin = function (callback) {
+  const originalStdinDescriptor = Object.getOwnPropertyDescriptor(
+    process,
+    'stdin',
+  );
+
+  const fakeStdin = new PassThrough();
+  fakeStdin.isTTY = true;
+  fakeStdin.isRaw = false;
+  fakeStdin.setRawMode = (value) => {
+    fakeStdin.isRaw = value;
+  };
+
+  Object.defineProperty(process, 'stdin', {
+    value: fakeStdin,
+    configurable: true,
+  });
+
+  try {
+    return callback(fakeStdin);
+  } finally {
+    Object.defineProperty(process, 'stdin', originalStdinDescriptor);
+  }
+};

package/configs/setupFiles/skip.js

@@ -0,0 +1,3 @@
+// xit and xdescribe to skip running those tests
+globalThis.xit = globalThis.it.skip;
+globalThis.xdescribe = globalThis.describe.skip;

package/configs/setupFiles/slow.js

@@ -0,0 +1,16 @@
+// Add .slow() method to it/test/describe for tests that need more time
+import { vi } from 'vitest';
+import { slowPrefix, slowTimeout } from '../../configs/slow.js';
+
+// Wrapper for it.slow()
+globalThis.it.slow = (name, callback, timeout = slowTimeout) => {
+  return globalThis.it(`${slowPrefix}${name}`, callback, timeout);
+};
+
+// Wrapper for describe.slow()
+globalThis.describe.slow = (name, callback) => {
+  return globalThis.describe(`${slowPrefix}${name}`, () => {
+    vi.setConfig({ testTimeout: slowTimeout });
+    callback();
+  });
+};

package/configs/setupFiles/testName.js

@@ -1,9 +1,6 @@
 /* global beforeEach, expect */
-/**
- * Make the variable `testName` contain the name of the current test in each
- * test
- */
+
+// Make testName available in all it() callbacks
 beforeEach(() => {
-  const fullName = expect.getState().currentTestName;
-  globalThis.testName = fullName.split(' > ').pop();
+  globalThis.testName = expect.getState().currentTestName.split(' > ').at(-1);
 });

package/configs/slow.js

@@ -0,0 +1,9 @@
+/**
+ * Configuration for slow tests
+ */
+
+// Timeout of slow tests
+export const slowTimeout = 30_000;
+
+// Prefix of slow tests
+export const slowPrefix = 'slow/';

package/configs/vite.js

@@ -1,7 +1,7 @@
 import { dirname } from 'firost';
 import { defaultExclude, defineConfig } from 'vitest/config';
 
-const aberlaasVitestExclude = [...defaultExclude, '**/tmp/**'];
+const aberlaasVitestExclude = [...defaultExclude, '**/tmp/**', '**/*.bench.js'];
 
 const configDir = dirname();
 
@@ -14,21 +14,32 @@ export default defineConfig({
     // Hide skipped tests, allowing less noisy debug with fit/fdescribe
     hideSkippedTests: true,
 
+    // Display details of tests as they run
+    reporters: ['tree'],
+
     // Tests should be in a __tests__ folder next to their code
     include: ['**/__tests__/**/*.js?(x)'],
     // We ignore temporary folders from the tests
     exclude: aberlaasVitestExclude,
-    // Restore mocks after each tests
+
+    // Restore mocks to their real implementation between tests
     restoreMocks: true,
+    // Clear the number of time a mock has been called between tests
+    clearMocks: true,
 
     // Make describe, it, beforeEach and other globally available
     globals: true,
     // Run before each test file
     setupFiles: [
-      `${configDir}/setupFiles/dedent.js`,
+      `${configDir}/setupFiles/bench.js`,
       `${configDir}/setupFiles/captureOutput.js`,
-      `${configDir}/setupFiles/fit-xit-fdescribe-xdescribe.js`,
-      `${configDir}/setupFiles/jest-extended.js`,
+      `${configDir}/setupFiles/dedent.js`,
+      `${configDir}/setupFiles/describeName.js`,
+      `${configDir}/setupFiles/focus.js`,
+      `${configDir}/setupFiles/matchers.js`,
+      `${configDir}/setupFiles/mockStdin.js`,
+      `${configDir}/setupFiles/skip.js`,
+      `${configDir}/setupFiles/slow.js`,
       `${configDir}/setupFiles/testName.js`,
     ],
   },

package/lib/main.js

@@ -2,6 +2,7 @@ import { _ } from 'golgoth';
 import { firostError } from 'firost';
 import { getConfig, hostPackageRoot } from 'aberlaas-helper';
 import { createVitest, registerConsoleShortcuts } from 'vitest/node';
+import { slowPrefix } from '../configs/slow.js';
 import viteConfig from '../configs/vite.js';
 
 export let __;
@@ -13,7 +14,8 @@ export let __;
  * $ aberlaas test ./path/to/__tests__/file.js    # Test specific files
  * $ aberlaas test ./path/to/file.js              # Test specific files
  * $ aberlaas test --related                      # Test all related files
- * $ aberlaas test --failFast                     # Stop early as soon as one test fails
+ * $ aberlaas test --fail-fast                    # Stop early as soon as one test fails
+ * $ aberlaas test --only-slow                    # Run only tests marked with .slow()
  * $ aberlaas test --flags                        # Flags passed to vitest
  * @param {object} cliArgs CLI Argument object, as created by minimist
  * @returns {boolean} true on success
@@ -80,9 +82,10 @@ __ = {
     const specialMeaningCliArgs = [
       '_',
       'config',
-      'failFast',
+      'fail-fast',
       'related',
       'exclude',
+      'only-slow',
     ];
 
     // Reading base options from the config file
@@ -99,10 +102,14 @@ __ = {
       // by the lint command instead
       allowOnly: true,
     };
-    // --failFast stops early as soon as one test fails
-    if (cliArgs.failFast) {
+    // --fail-fast stops early as soon as one test fails
+    if (cliArgs['fail-fast']) {
       optionsFromAberlaas.bail = 1;
     }
+    // --only-slow runs only tests marked with .slow()
+    if (cliArgs['only-slow']) {
+      optionsFromAberlaas.testNamePattern = _.escapeRegExp(slowPrefix);
+    }
     // --related runs also related files
     // Note (2024-10-01): The related option is not documented, but should
     // contain the list of files.
@@ -111,7 +118,6 @@ __ = {
     }
     // --exclude arguments should be added to the existing list of exclude
     // patterns
-    // TODO: Add test for that
     if (cliArgs.exclude) {
       optionsFromAberlaas.exclude = [
         ...optionsFromConfig.exclude,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aberlaas-test",
-  "version": "2.22.3",
+  "version": "2.24.0",
   "type": "module",
   "description": "aberlaas test command: Run automated tests",
   "author": "Tim Carry <tim@pixelastic.com>",
@@ -21,13 +21,12 @@
   },
   "main": "./lib/main.js",
   "dependencies": {
-    "aberlaas-helper": "2.22.3",
+    "aberlaas-helper": "2.24.0",
     "dedent": "1.7.1",
-    "firost": "5.5.1",
+    "firost": "5.6.1",
     "globals": "17.2.0",
     "golgoth": "3.1.0",
-    "jest-extended": "4.0.2",
-    "vitest": "2.1.2"
+    "vitest": "4.0.18"
   },
   "scripts": {
     "build": "cd ../docs && yarn run build",

package/configs/setupFiles/fit-xit-fdescribe-xdescribe.js

@@ -1,13 +0,0 @@
-/**
- * Add faster to type aliases:
- * - fit, ftest, fdescribe: To focus specific tests
- * - xit, xtest, xdescribe: To skip specific tests
- */
-
-globalThis.fit = globalThis.it.only;
-globalThis.ftest = globalThis.test.only;
-globalThis.fdescribe = globalThis.describe.only;
-
-globalThis.xit = globalThis.it.skip;
-globalThis.xtest = globalThis.test.skip;
-globalThis.xdescribe = globalThis.describe.skip;

package/configs/setupFiles/jest-extended.js

@@ -1,10 +0,0 @@
-// We use extended matchers from jest-extended in vitest
-// It includes matcher like .toStartWith, .toBeEmpty, etc
-// See: https://github.com/jest-community/jest-extended
-//
-// The expect.extend() from Vitest is compatible with the one from Jest, so
-// setup is straightforward
-import * as matchers from 'jest-extended';
-import { expect } from 'vitest';
-
-expect.extend(matchers);