aberlaas-test 2.23.0 → 2.24.1

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/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/slow.js

@@ -4,12 +4,12 @@ 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);
+  return globalThis.it(`${slowPrefix}${name}`, callback, timeout);
 };
 
 // Wrapper for describe.slow()
 globalThis.describe.slow = (name, callback) => {
-  return globalThis.describe(`${slowPrefix} ${name}`, () => {
+  return globalThis.describe(`${slowPrefix}${name}`, () => {
     vi.setConfig({ testTimeout: slowTimeout });
     callback();
   });

package/configs/slow.js

@@ -6,4 +6,4 @@
 export const slowTimeout = 30_000;
 
 // Prefix of slow tests
-export const slowPrefix = '[slow]';
+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();
 
@@ -31,11 +31,13 @@ export default defineConfig({
     globals: true,
     // Run before each test file
     setupFiles: [
+      `${configDir}/setupFiles/bench.js`,
       `${configDir}/setupFiles/captureOutput.js`,
       `${configDir}/setupFiles/dedent.js`,
       `${configDir}/setupFiles/describeName.js`,
       `${configDir}/setupFiles/focus.js`,
-      `${configDir}/setupFiles/jest-extended.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

@@ -118,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.23.0",
+  "version": "2.24.1",
   "type": "module",
   "description": "aberlaas test command: Run automated tests",
   "author": "Tim Carry <tim@pixelastic.com>",
@@ -21,12 +21,11 @@
   },
   "main": "./lib/main.js",
   "dependencies": {
-    "aberlaas-helper": "2.23.0",
+    "aberlaas-helper": "2.24.1",
     "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": "4.0.18"
   },
   "scripts": {

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);