aberlaas-test 2.10.0

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) Tim Carry (tim@pixelastic.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/configs/setupFiles/captureOutput.js

@@ -0,0 +1,4 @@
+// We make captureOutput publicly available inside of tests
+import { captureOutput } from 'firost';
+
+globalThis.captureOutput = captureOutput;

package/configs/setupFiles/dedent.js

@@ -0,0 +1,4 @@
+// We make dedent publicly available inside of tests
+import dedent from 'dedent';
+
+globalThis.dedent = dedent;

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

@@ -0,0 +1,13 @@
+/**
+ * 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

@@ -0,0 +1,10 @@
+// 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 { expect } from 'vitest';
+import * as matchers from 'jest-extended';
+
+expect.extend(matchers);

package/configs/setupFiles/testName.js

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

package/configs/vite.js

@@ -0,0 +1,43 @@
+import { dirname } from 'firost';
+import { defaultExclude, defineConfig } from 'vitest/config';
+
+const aberlaasVitestExclude = [...defaultExclude, '**/tmp/**'];
+
+const configDir = dirname();
+
+export default defineConfig({
+  test: {
+    // vitest default is to run in watch mode, we revert that
+    watch: false,
+    // Allow a success, even if no files are passed
+    passWithNoTests: true,
+    // Hide skipped tests, allowing less noisy debug with fit/fdescribe
+    hideSkippedTests: true,
+
+    // 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
+    restoreMocks: true,
+
+    // Make describe, it, beforeEach and other globally available
+    globals: true,
+    // Run before each test file
+    setupFiles: [
+      `${configDir}/setupFiles/dedent.js`,
+      `${configDir}/setupFiles/captureOutput.js`,
+      `${configDir}/setupFiles/fit-xit-fdescribe-xdescribe.js`,
+      `${configDir}/setupFiles/jest-extended.js`,
+      `${configDir}/setupFiles/testName.js`,
+    ],
+  },
+  server: {
+    watch: {
+      // Vitest 2.0 uses vite watcher, so files to exclude from watching are at
+      // the server level
+      // Source: https://vitest.dev/guide/migration.html#removal-of-the-watchexclude-option
+      ignored: aberlaasVitestExclude,
+    },
+  },
+});

package/lib/main.js

@@ -0,0 +1,132 @@
+import { createVitest, registerConsoleShortcuts } from 'vitest/node';
+import { env, firostError, packageRoot } from 'firost';
+import { _ } from 'golgoth';
+import helper from 'aberlaas-helper';
+import viteConfig from '../configs/vite.js';
+
+export default {
+  /**
+   * Test all files using Vitest
+   * Usage:
+   * $ aberlaas test                                # Test all files
+   * $ 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 --flags                        # Flags passed to vitest
+   * @param {object} cliArgs CLI Argument object, as created by minimist
+   * @returns {boolean} true on success
+   */
+  async run(cliArgs = {}) {
+    const options = await this.vitestOptions(cliArgs);
+    const isWatchMode = !!options.watch;
+    const isRelatedMode = options.related?.length > 0;
+
+    // If no files are passed, we assume we want to test the current project
+    // We'll NOT use helper.hostRoot() as this will force going to high in the
+    // parent tree, where aberlaas is installed. Instead, we need to stop at the
+    // first level where a package.json is defined
+    const closestHostRoot = await packageRoot(env('INIT_CWD'));
+    let files = _.isEmpty(cliArgs._) ? [closestHostRoot] : cliArgs._;
+
+    // If --related is passed, the list of files will already by in the .related
+    // key, and need to be removed from the files
+    if (isRelatedMode) files = [];
+
+    // Vitest will change process.exitCode, so we save it to revert it later
+    const initialExitCode = process.exitCode;
+
+    const vitest = await createVitest('test', options);
+
+    // Enable keyboard interaction in watch mode
+    if (isWatchMode) {
+      registerConsoleShortcuts(vitest);
+    }
+
+    try {
+      await vitest.start(files);
+    } catch (err) {
+      // We can safely swallow the VITEST_FILES_NOT_FOUND error. It's ok to
+      // continue if no files are found
+      if (err.code != 'VITEST_FILES_NOT_FOUND') {
+        throw err;
+      }
+    }
+
+    const testsAreFailing = process.exitCode == 1;
+    process.exitCode = initialExitCode;
+
+    if (isWatchMode) {
+      return;
+    }
+
+    // Stop vitest, it doesn't stop itself by default
+    await vitest.close();
+
+    if (testsAreFailing) {
+      throw firostError('ERROR_TEST_FAIL', 'Tests are failing');
+    }
+
+    return true;
+  },
+
+  /**
+   * Transform all aberlaas test cli options into suitable vitest options
+   * @param {object} cliArgs CLI Argument object, as created by minimist
+   * @returns {Array} Array of options for vitest
+   */
+  async vitestOptions(cliArgs = {}) {
+    // Options that have special meaning in aberlaas and shouldn't be passed
+    // as-is to vitest
+    const specialMeaningCliArgs = [
+      '_',
+      'config',
+      'failFast',
+      'related',
+      'exclude',
+    ];
+
+    // Reading base options from the config file
+    const config = await helper.getConfig(
+      cliArgs.config,
+      'vite.config.js',
+      viteConfig,
+    );
+    const optionsFromConfig = config.test;
+
+    // Enhancing options with custom CLI arguments
+    const optionsFromAberlaas = {
+      // We always allow fit/fdescribe, even in CI. Those errors will be caught
+      // by the lint command instead
+      allowOnly: true,
+    };
+    // --failFast stops early as soon as one test fails
+    if (cliArgs.failFast) {
+      optionsFromAberlaas.bail = 1;
+    }
+    // --related runs also related files
+    // Note (2024-10-01): The related option is not documented, but should
+    // contain the list of files.
+    if (cliArgs.related) {
+      optionsFromAberlaas.related = cliArgs._;
+    }
+    // --exclude arguments should be added to the existing list of exclude
+    // patterns
+    // TODO: Add test for that
+    if (cliArgs.exclude) {
+      optionsFromAberlaas.exclude = [
+        ...optionsFromConfig.exclude,
+        cliArgs.exclude,
+      ];
+    }
+
+    // Passing other CLI options directly to vitest
+    const optionsFromCli = _.omit(cliArgs, specialMeaningCliArgs);
+
+    return {
+      ...optionsFromConfig,
+      ...optionsFromAberlaas,
+      ...optionsFromCli,
+    };
+  },
+};

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "aberlaas-test",
+  "type": "module",
+  "description": "aberlaas test command: Run automated tests",
+  "version": "2.10.0",
+  "repository": "pixelastic/aberlaas",
+  "homepage": "https://projects.pixelastic.com/aberlaas/",
+  "author": "Tim Carry (@pixelastic)",
+  "license": "MIT",
+  "files": [
+    "lib/*.js",
+    "configs/**/*.js"
+  ],
+  "exports": {
+    ".": "./lib/main.js",
+    "./configs/vite": "./configs/vite.js"
+  },
+  "main": "./lib/main.js",
+  "engines": {
+    "node": ">=18.18.0"
+  },
+  "scripts": {
+    "build": "../../scripts/local/build",
+    "build:prod": "../../scripts/local/build-prod",
+    "cms": "../../scripts/local/cms",
+    "serve": "../../scripts/local/serve",
+    "ci": "../../scripts/local/ci",
+    "release": "../../scripts/local/release",
+    "update": "node ../../scripts/meta/update.js",
+    "test:meta": "../../scripts/local/test-meta",
+    "test": "../../scripts/local/test",
+    "test:watch": "../../scripts/local/test-watch",
+    "compress": "../../scripts/local/compress",
+    "lint": "../../scripts/local/lint",
+    "lint:fix": "../../scripts/local/lint-fix"
+  },
+  "dependencies": {
+    "aberlaas-helper": "^2.10.0",
+    "firost": "4.3.0",
+    "globals": "15.11.0",
+    "golgoth": "2.4.0",
+    "jest-extended": "4.0.2",
+    "vitest": "2.1.2"
+  },
+  "gitHead": "bcdaf87c198a588e02b5539c222f611e356d3079"
+}