@exodus/test 1.0.0-rc.24 → 1.0.0-rc.26

package/bin/index.js

@@ -1,6 +1,7 @@
 #!/usr/bin/env node
 
 import { spawn } from 'node:child_process'
+import { once } from 'node:events'
 import { fileURLToPath } from 'node:url'
 import { basename, dirname, resolve } from 'node:path'
 import { createRequire } from 'node:module'
@@ -13,6 +14,14 @@ const bindir = dirname(fileURLToPath(import.meta.url))
 const EXTS = `.?([cm])[jt]s?(x)` // we differ from jest, allowing [cm] before everything
 const DEFAULT_PATTERNS = [`**/__tests__/**/*${EXTS}`, `**/?(*.)+(spec|test)${EXTS}`]
 
+const ENGINES = new Map(
+  Object.entries({
+    'node:test': { binary: 'node', pure: false, hasImportLoader: true },
+    'node:pure': { binary: 'node', pure: true, hasImportLoader: true },
+    'bun:pure': { binary: 'bun', pure: true, hasImportLoader: false },
+  })
+)
+
 function parseOptions() {
   const options = {
     jest: false,
@@ -26,6 +35,12 @@ function parseOptions() {
     passWithNoTests: false,
     writeSnapshots: false,
     debug: { files: false },
+    ideaCompat: false,
+    engine: process.env.EXODUS_TEST_ENGINE ?? 'node:test',
+    // Engine options
+    binary: 'node',
+    pure: false,
+    hasImportLoader: false,
   }
 
   const args = [...process.argv]
@@ -40,6 +55,20 @@ function parseOptions() {
 
   while (args[0]?.startsWith('--')) {
     const option = args.shift()
+    if (options.ideaCompat) {
+      // Ignore some options IntelliJ IDEA is passing
+      switch (option) {
+        case '--reporters':
+          args.shift()
+          continue
+        case '--verbose':
+        case '--runTestsByPath':
+        case '--runInBand':
+        case '--testTimeout=7200000':
+          continue
+      }
+    }
+
     switch (option) {
       case '--global': // compat, will be removed in release
       case '--jest':
@@ -79,9 +108,23 @@ function parseOptions() {
       case '--forceExit':
         options.forceExit = true
         break
+      case '--engine':
+        options.engine = args.shift()
+        break
       case '--debug-files':
         options.debug.files = true
         break
+      case '--colors':
+        process.env.FORCE_COLOR = '1'
+        break
+      case '--no-colors':
+        process.env.FORCE_COLOR = '0'
+        process.env.NO_COLOR = '1'
+        process.env.NODE_DISABLE_COLORS = '1'
+        break
+      case '--idea-compat':
+        options.ideaCompat = true
+        break
       default:
         throw new Error(`Unknown option: ${option}`)
     }
@@ -99,46 +142,44 @@ function parseOptions() {
 
 const { options, patterns } = parseOptions()
 
-let program = 'node'
+const engineOptions = ENGINES.get(options.engine)
+assert(engineOptions, `Unknown engine: ${options.engine}`)
+Object.assign(options, engineOptions)
 
 const require = createRequire(import.meta.url)
 const resolveRequire = (query) => require.resolve(query)
 const resolveImport = import.meta.resolve && ((query) => fileURLToPath(import.meta.resolve(query)))
 
-const c8 = resolveRequire('c8/bin/c8.js')
-if (resolveImport) assert.equal(c8, resolveImport('c8/bin/c8.js'))
-
-const args = ['--test', '--no-warnings=ExperimentalWarning', '--test-reporter=spec']
-
-if (haveModuleMocks) args.push('--experimental-test-module-mocks')
-if (haveSnapshots) args.push('--experimental-test-snapshots')
-
-if (options.writeSnapshots) {
-  assert(haveSnapshots, 'For snapshots, use Node.js >=22.3.0')
-  args.push('--test-update-snapshots')
-}
-
-if (options.forceExit) {
-  assert(haveForceExit, 'For forceExit, use Node.js >= 20.14.0')
-  args.push('--test-force-exit')
-}
+const args = []
+if (options.pure) {
+  const requiresNodeCoverage = options.coverage && options.coverageEngine === 'node'
+  assert(!requiresNodeCoverage, '"--coverage-engine node" requires "--engine node:test" (default)')
+  assert(!options.writeSnapshots, `Can not use write snapshots with ${options.engine} engine`)
+  assert(!options.forceExit, `Can not use --force-exit with ${options.engine} engine yet`) // TODO
+  assert(!options.watch, `Can not use --watch with with ${options.engine} engine`)
+  assert(!options.only, `Can not use --only with with ${options.engine} engine yet`) // TODO
+} else if (options.engine === 'node:test') {
+  args.push('--test', '--no-warnings=ExperimentalWarning', '--test-reporter=spec')
+
+  if (haveModuleMocks) args.push('--experimental-test-module-mocks')
+  if (haveSnapshots) args.push('--experimental-test-snapshots')
+
+  if (options.writeSnapshots) {
+    assert(haveSnapshots, 'For snapshots, use Node.js >=22.3.0')
+    args.push('--test-update-snapshots')
+  }
 
-if (options.watch) args.push('--watch')
-if (options.only) args.push('--test-only')
+  if (options.forceExit) {
+    assert(haveForceExit, 'For forceExit, use Node.js >= 20.14.0')
+    args.push('--test-force-exit')
+  }
 
-args.push('--expose-internals') // this is unoptimal and hopefully temporary, see rationale in src/dark.cjs
+  if (options.watch) args.push('--watch')
+  if (options.only) args.push('--test-only')
 
-if (options.coverage) {
-  if (options.coverageEngine === 'node') {
-    args.push('--experimental-test-coverage')
-  } else if (options.coverageEngine === 'c8') {
-    program = c8
-    args.unshift('node')
-    // perhaps use text-summary ?
-    args.unshift('-r', 'text', '-r', 'html')
-  } else {
-    throw new Error(`Unknown coverage engine: ${JSON.stringify(options.coverageEngine)}`)
-  }
+  args.push('--expose-internals') // this is unoptimal and hopefully temporary, see rationale in src/dark.cjs
+} else {
+  throw new Error('Unreachable')
 }
 
 const ignore = ['**/node_modules']
@@ -154,7 +195,7 @@ if (process.env.EXODUS_TEST_IGNORE) {
 if (options.jest) {
   const { loadJestConfig } = await import('../src/jest.config.js')
   const config = await loadJestConfig(process.cwd())
-  args.push('--import', resolve(bindir, 'jest.js'))
+  args.push(options.hasImportLoader ? '--import' : '-r', resolve(bindir, 'jest.js'))
 
   if (config.testFailureExitCode !== undefined) {
     if (Number(config.testFailureExitCode) === 0) {
@@ -176,6 +217,7 @@ if (options.jest) {
     patterns.push(...(Array.isArray(config.testMatch) ? config.testMatch : [config.testMatch]))
   }
 
+  if (config.passWithNoTests) options.passWithNoTests = true
   const testRegex = config.testRegex ? new RegExp(config.testRegex, 'u') : null
   const ignoreRegexes = config.testPathIgnorePatterns.map((x) => new RegExp(x, 'u'))
   if (testRegex || ignoreRegexes.length > 0) {
@@ -189,7 +231,11 @@ if (options.jest) {
 
 if (options.esbuild) {
   assert(resolveImport)
-  args.push('--import', resolveImport('tsx'))
+  if (options.hasImportLoader) {
+    args.push('--import', resolveImport('tsx'))
+  } else {
+    args.push('-r', resolveImport('tsx/cjs'))
+  }
 }
 
 if (options.babel) {
@@ -260,14 +306,54 @@ if (tsTests.length > 0 && !options.esbuild) {
   console.warn(`Flag --typescript has been used, but there were no TypeScript tests found!`)
 }
 
-assert(files.length > 0) // otherwise we can run recursively
-args.push(...files)
-
 if (!Object.hasOwn(process.env, 'NODE_ENV')) process.env.NODE_ENV = 'test'
+process.env.EXODUS_TEST_PLATFORM = options.binary
 
-assert(program && ['node', c8].includes(program))
-const node = spawn(program, args, { stdio: 'inherit' })
+const c8 = resolveRequire('c8/bin/c8.js')
+if (resolveImport) assert.equal(c8, resolveImport('c8/bin/c8.js'))
 
-node.on('close', (code) => {
+if (options.coverage) {
+  assert.equal(options.binary, 'node', 'Coverage is only supported with Node.js')
+  if (options.coverageEngine === 'node') {
+    args.push('--experimental-test-coverage')
+  } else if (options.coverageEngine === 'c8') {
+    args.unshift(options.binary)
+    options.binary = c8
+    // perhaps use text-summary ?
+    args.unshift('-r', 'text', '-r', 'html')
+  } else {
+    throw new Error(`Unknown coverage engine: ${JSON.stringify(options.coverageEngine)}`)
+  }
+}
+
+assert(files.length > 0) // otherwise we can run recursively
+assert(options.binary && ['node', 'bun', c8].includes(options.binary))
+process.env.EXODUS_TEST_EXECARGV = JSON.stringify(args)
+
+if (options.pure) {
+  process.env.EXODUS_TEST_CONTEXT = 'pure'
+  console.warn(`\n${options.engine} engine is experimental and may not work an expected\n\n`)
+  const failures = []
+  for (const file of files) {
+    const node = spawn(options.binary, [...args, file], { stdio: 'inherit' })
+    const [code] = await once(node, 'close')
+    if (code !== 0) failures.push(file)
+  }
+
+  if (failures.length > 0) {
+    process.exitCode = 1
+    const [total, passed, failed] = [files.length, files.length - failures.length, failures.length]
+    console.log(`Test suites failed: ${failed} / ${total} (passed: ${passed} / ${total})`)
+    console.log('Failed test suites:')
+    for (const file of failures) console.log(`  ${file}`) // joining with \n can get truncated, too big
+  } else {
+    console.log(`All ${files.length} test suites passed`)
+  }
+} else {
+  assert(['node', c8].includes(options.binary), 'Native test engine is only supported with Node.js')
+  assert.equal(options.engine, 'node:test')
+  process.env.EXODUS_TEST_CONTEXT = 'node:test'
+  const node = spawn(options.binary, [...args, ...files], { stdio: 'inherit' })
+  const [code] = await once(node, 'close')
   process.exitCode = code
-})
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/test",
-  "version": "1.0.0-rc.24",
+  "version": "1.0.0-rc.26",
   "author": "Exodus Movement, Inc.",
   "description": "A test suite runner",
   "homepage": "https://github.com/ExodusMovement/test",
@@ -30,6 +30,7 @@
   },
   "exports": {
     "./jest": "./src/jest.js",
+    "./node": "./src/node.js",
     "./tape": "./src/tape.js"
   },
   "prettier": "@exodus/prettier",
@@ -37,13 +38,19 @@
     "bin/babel.cjs",
     "bin/jest.js",
     "src/dark.cjs",
+    "src/engine.js",
+    "src/engine.node.cjs",
+    "src/engine.pure.cjs",
+    "src/engine.select.cjs",
     "src/jest.js",
     "src/jest.config.js",
+    "src/jest.config.fs.js",
     "src/jest.environment.js",
     "src/jest.fn.js",
     "src/jest.mock.js",
     "src/jest.snapshot.js",
     "src/jest.timers.js",
+    "src/node.js",
     "src/tape.js",
     "src/version.js",
     "!__tests__",
@@ -51,9 +58,12 @@
   ],
   "scripts": {
     "test": "npm run test:jest",
-    "test:all": "npm run test:jest && npm run test:tape",
+    "test:all": "npm run test:jest && npm run test:tape && npm run test:native",
+    "test:native": "EXODUS_TEST_IGNORE='{**/typescript/**,**/jest-repo/**/user.test.js}' ./bin/index.js --jest '__test__/**/*.test.js'",
     "test:jest": "./bin/index.js --jest --esbuild",
     "test:tape": "./bin/index.js --esbuild '__test__/tape/test/*.js' __test__/tape.test.js",
+    "test:pure": "EXODUS_TEST_ENGINE=node:pure npm run test",
+    "test:bun:pure": "EXODUS_TEST_ENGINE=bun:pure npm run test",
     "coverage": "./bin/index.js --jest --esbuild --coverage",
     "lint": "prettier --list-different . && eslint .",
     "lint:fix": "prettier --write . && eslint --fix ."
@@ -61,9 +71,11 @@
   "dependencies": {
     "@babel/register": "^7.0.0",
     "c8": "^9.1.0",
+    "esbuild": "~0.21.5",
     "expect": "^29.7.0",
     "fast-glob": "^3.2.11",
     "jest-extended": "^4.0.2",
+    "jsdom": "^24.1.0",
     "pretty-format": "^29.7.0",
     "tsx": "^4.16.2"
   },

package/src/dark.cjs

@@ -1,7 +1,3 @@
-const { fileURLToPath } = require('node:url')
-
-const mayBeUrlToPath = (str) => (str.startsWith('file://') ? fileURLToPath(str) : str)
-
 let locForNextTest
 
 const installLocationInNextTest = function (loc) {
@@ -26,6 +22,8 @@ function createCallerLocationHook() {
 
   try {
     const { Test } = require('node:internal/test_runner/test')
+    const { fileURLToPath } = require('node:url')
+    const mayBeUrlToPath = (str) => (str.startsWith('file://') ? fileURLToPath(str) : str)
     const locStorage = new Map()
     Object.defineProperty(Test.prototype, 'loc', {
       get() {
@@ -107,9 +105,13 @@ function getTestNamePath(t) {
   return [t.name] // last resort
 }
 
+const execArgv = process.env.EXODUS_TEST_EXECARGV
+  ? JSON.parse(process.env.EXODUS_TEST_EXECARGV)
+  : process.execArgv
+const insideEsbuild = execArgv.some((x) => x.includes('node_modules/tsx/dist/'))
+
 function makeEsbuildMockable() {
-  const usingTsx = process.execArgv.some((x) => x.endsWith('node_modules/tsx/dist/loader.mjs'))
-  if (!usingTsx) return
+  if (!insideEsbuild) return
   // Hook into tsx/esbuild transpiled module conversion magic to make loaded modules mockable in runtime
   // We want all modules to be .configurable = true, so we can override them
   const defineProperty = Object.defineProperty
@@ -140,4 +142,4 @@ function makeEsbuildMockable() {
   }
 }
 
-module.exports = { createCallerLocationHook, getTestNamePath, makeEsbuildMockable }
+module.exports = { createCallerLocationHook, getTestNamePath, insideEsbuild, makeEsbuildMockable }

package/src/engine.js

@@ -0,0 +1,22 @@
+import engine from './engine.select.cjs' // need to be sync for non-preloaded imports into cjs
+
+const { engine: name } = engine
+export { name as engine }
+
+const { assert, assertLoose } = engine
+export { assert, assertLoose }
+
+const { mock, describe, test, beforeEach, afterEach, before, after } = engine
+export { mock, describe, test, beforeEach, afterEach, before, after }
+
+const { builtinModules, syncBuiltinESMExports } = engine
+export { builtinModules, syncBuiltinESMExports }
+
+const { utilFormat, isPromise, nodeVersion } = engine
+export { utilFormat, isPromise, nodeVersion }
+
+const { baseFile, relativeRequire, isTopLevelESM } = engine
+export { baseFile, relativeRequire, isTopLevelESM }
+
+const { readSnapshot, setSnapshotSerializers, setSnapshotResolver } = engine
+export { readSnapshot, setSnapshotSerializers, setSnapshotResolver }

package/src/engine.node.cjs

@@ -0,0 +1,39 @@
+const assert = require('node:assert/strict')
+const assertLoose = require('node:assert')
+const { types, format: utilFormat } = require('node:util')
+const { existsSync, readFileSync } = require('node:fs')
+const { normalize, basename, dirname, join: pathJoin } = require('node:path')
+const { createRequire, builtinModules, syncBuiltinESMExports } = require('node:module')
+const nodeTest = require('node:test')
+
+const { mock, describe, test, beforeEach, afterEach, before, after } = nodeTest
+
+const isPromise = types.isPromise
+const nodeVersion = process.versions.node
+
+const files = process.argv.slice(1)
+const baseFile = files.length === 1 && existsSync(files[0]) ? normalize(files[0]) : undefined
+const relativeRequire = baseFile ? createRequire(baseFile) : require
+const isTopLevelESM = () => !baseFile || !Object.hasOwn(relativeRequire.cache, baseFile) // assume ESM otherwise
+
+const snapshot = nodeTest.snapshot
+let snapshotResolver = (dir, name) => [dir, `${name}.snapshot`] // default per Node.js docs
+const resolveSnapshot = (f) => pathJoin(...snapshotResolver(dirname(f), basename(f)))
+const readSnapshot = (f = baseFile) => (f ? readFileSync(resolveSnapshot(f), 'utf8') : null)
+const setSnapshotSerializers = (list) => snapshot?.setDefaultSnapshotSerializers(list)
+const setSnapshotResolver = (fn) => {
+  snapshotResolver = fn
+  snapshot?.setResolveSnapshotPath(resolveSnapshot)
+}
+
+/* eslint-disable unicorn/no-useless-spread */
+module.exports = {
+  engine: 'node:test',
+  ...{ assert, assertLoose },
+  ...{ mock, describe, test, beforeEach, afterEach, before, after },
+  ...{ builtinModules, syncBuiltinESMExports },
+  ...{ utilFormat, isPromise, nodeVersion },
+  ...{ baseFile, relativeRequire, isTopLevelESM },
+  ...{ readSnapshot, setSnapshotSerializers, setSnapshotResolver },
+}
+/* eslint-enable unicorn/no-useless-spread */