@exodus/test 1.0.0-rc.16 → 1.0.0-rc.17

package/README.md

@@ -58,9 +58,7 @@ Just use `"test": "exodus-test"`
 
 - `--jest` -- register jest test helpers as global variables, also load `jest.config.*` configuration options
 
-- `--typescript` -- use typescript loader (which also compiles esm to cjs where needed)
-
-- `--esbuild` -- use esbuild loader (currently an alias for `--typescript`)
+- `--esbuild` -- use esbuild loader, also enables Typescript support
 
 - `--babel` -- use babel loader (slower than `--esbuild`, makes sense if you have a special config)
 

package/bin/index.js

@@ -9,7 +9,8 @@ import glob from 'fast-glob'
 
 const bindir = dirname(fileURLToPath(import.meta.url))
 
-const DEFAULT_PATTERNS = ['**/?(*.)+(spec|test).?([cm])[jt]s?(x)']
+const EXTS = `.?([cm])[jt]s?(x)` // we differt from jest, allowing [cm] before everything
+const DEFAULT_PATTERNS = [`**/__tests__/**/*${EXTS}`, `**/?(*.)+(spec|test)${EXTS}`]
 
 function versionCheck() {
   const [major, minor, patch] = process.versions.node.split('.').map(Number)
@@ -51,7 +52,9 @@ function parseOptions() {
         options.jest = true
         break
       case '--typescript':
+        console.warn('Option --typescript is going to be gone or changed. Use --esbuild instead')
         options.typescript = true
+        options.esbuild = true
         break
       case '--esbuild':
         options.esbuild = true
@@ -147,7 +150,7 @@ if (options.coverage) {
   }
 }
 
-if (options.typescript || options.esbuild) {
+if (options.esbuild) {
   if (major >= 22 || (major === 20 && minor >= 6) || (major === 18 && minor >= 18)) {
     assert(resolveImport)
     args.push('--import', resolveImport('tsx'))
@@ -157,11 +160,12 @@ if (options.typescript || options.esbuild) {
 }
 
 if (options.babel) {
-  assert(!options.typescript, 'Options --babel and --typescript are mutually exclusive')
+  assert(!options.esbuild, 'Options --babel and --esbuild are mutually exclusive')
   args.push('-r', resolveRequire('./babel.cjs'))
 }
 
 const ignore = ['**/node_modules']
+let filter
 if (process.env.EXODUS_TEST_IGNORE) {
   // fast-glob treats negative ignore patterns exactly the same as positive, let's not cause a confusion
   assert(!process.env.EXODUS_TEST_IGNORE.startsWith('!'), 'Ignore pattern should not be negative')
@@ -172,7 +176,6 @@ if (process.env.EXODUS_TEST_IGNORE) {
 if (options.jest) {
   const { loadJestConfig } = await import('../src/jest.config.js')
   const config = await loadJestConfig(process.cwd())
-  ignore.push(...config.testPathIgnorePatterns)
   if (major >= 20 || (major === 18 && minor >= 18)) {
     args.push('--import', resolve(bindir, 'jest.js'))
   } else {
@@ -189,12 +192,30 @@ if (options.jest) {
     })
   }
 
-  const jestPatterns = Array.isArray(config.testMatch) ? config.testMatch : [config.testMatch]
-  if (patterns.length === 0) patterns.push(...jestPatterns) // no patterns specified via argv
+  if (patterns.length > 0) {
+    // skip, we already have patterns via argv
+  } else if (config.testRegex) {
+    assert(typeof config.testRegex === 'string', `config.testRegex should be a string`)
+    assert(!config.testMatch, 'config.testRegex can not be used together with config.testMatch')
+    patterns.push('**/*')
+  } else if (config.testMatch) {
+    patterns.push(...(Array.isArray(config.testMatch) ? config.testMatch : [config.testMatch]))
+  }
+
+  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) {
+    filter = (x) => {
+      const resolved = `<rootDir>/${x}` // don't actually include cwd, that should be irrelevant
+      if (testRegex && !testRegex.test(resolved)) return false
+      return !ignoreRegexes.some((r) => r.test(resolved))
+    }
+  }
 }
 
 if (patterns.length === 0) patterns.push(...DEFAULT_PATTERNS) // defaults
-const allfiles = await glob(patterns, { ignore })
+const globbed = await glob(patterns, { ignore })
+const allfiles = filter ? globbed.filter(filter) : globbed
 
 if (allfiles.length === 0) {
   if (options.passWithNoTests) {
@@ -243,13 +264,13 @@ files.sort((a, b) => {
 })
 
 if (options.debug.files) {
-  console.log(files.join('\n'))
+  for (const f of files) console.log(f) // joining with \n can get truncated, too big
   process.exit(1) // do not succeed!
 }
 
 const tsTests = files.filter((file) => /\.[mc]?tsx?$/u.test(file))
-if (tsTests.length > 0 && !options.typescript) {
-  console.error(`Some tests require --typescript flag:\n  ${tsTests.join('\n  ')}`)
+if (tsTests.length > 0 && !options.esbuild) {
+  console.error(`Some tests require --esbuild flag:\n  ${tsTests.join('\n  ')}`)
   process.exit(1)
 } else if (!allfiles.some((file) => file.endsWith('.ts')) && options.typescript) {
   console.warn(`Flag --typescript has been used, but there were no TypeScript tests found!`)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/test",
-  "version": "1.0.0-rc.16",
+  "version": "1.0.0-rc.17",
   "author": "Exodus Movement, Inc.",
   "description": "A test suite runner",
   "homepage": "https://github.com/ExodusMovement/test",
@@ -46,9 +46,9 @@
     "CHANGELOG.md"
   ],
   "scripts": {
-    "test": "./bin/index.js --jest --typescript",
+    "test": "./bin/index.js --jest --esbuild",
     "test:tape": "./bin/index.js --esbuild '__test__/tape/test/*.js' __test__/tape.test.js",
-    "coverage": "./bin/index.js --jest --typescript --coverage",
+    "coverage": "./bin/index.js --jest --esbuild --coverage",
     "lint": "prettier --list-different . && eslint .",
     "lint:fix": "prettier --write . && eslint --fix ."
   },

package/src/jest.config.js

@@ -53,7 +53,6 @@ async function getJestConfig(dir) {
 const normalizeJestConfig = (config) => ({
   testEnvironment: 'node',
   testTimeout: 5000,
-  testMatch: ['**/__tests__/**/*.?([cm])[jt]s?(x)', '**/?(*.)+(spec|test).?([cm])[jt]s?(x)'],
   testPathIgnorePatterns: [],
   snapshotSerializers: [],
   injectGlobals: true,
@@ -93,7 +92,7 @@ function verifyJestConfig(c) {
   assert(!c.preset, 'Jest config.preset is not supported')
 
   // TODO
-  const TODO = ['globalSetup', 'globalTeardown', 'randomize', 'projects', 'roots', 'testRegex']
+  const TODO = ['globalSetup', 'globalTeardown', 'randomize', 'projects', 'roots']
   TODO.push('resolver', 'unmockedModulePathPatterns', 'watchPathIgnorePatterns', 'snapshotResolver')
   for (const key of TODO) assert.equal(c[key], undefined, `Jest config.${key} is not supported yet`)
 }

package/src/jest.js

@@ -15,6 +15,7 @@ const { getCallerLocation, installLocationInNextTest } = createCallerLocationHoo
 expect.extend(matchers)
 
 let defaultTimeout = jestConfig().testTimeout // overridable via jest.setTimeout()
+const defaultConcurrency = jestConfig().maxConcurrency
 
 function parseArgs(list, targs) {
   if (!(Object.isFrozen(list) && list.length === targs.length + 1)) return list // template check
@@ -79,10 +80,37 @@ const makeEach =
 
 const forceExit = process.execArgv.map((x) => x.replaceAll('_', '-')).includes('--test-force-exit')
 
-const describe = (...args) => nodeDescribe(...args)
-const test = (name, fn, testTimeout) => {
+const inConcurrent = []
+const concurrent = []
+const describe = (...args) => {
+  const fn = args.pop()
+  const optionsConcurrent = args?.at(-1)?.concurrency > 1
+  if (optionsConcurrent) inConcurrent.push(fn)
+  const result = nodeDescribe(...args, async () => {
+    const res = fn()
+
+    // We do only block-level concurrency, not file-level
+    if (concurrent.length === 1) {
+      const [args, callerLocation] = concurrent[0]
+      testRaw(callerLocation, ...args)
+      concurrent.length = 0
+    } else if (concurrent.length > 0) {
+      const queue = [...concurrent]
+      concurrent.length = 0
+      describe('concurrent', { concurrency: defaultConcurrency }, () => {
+        for (const [args, callerLocation] of queue) testRaw(callerLocation, ...args)
+      })
+    }
+
+    return res
+  })
+  if (optionsConcurrent) inConcurrent.pop()
+  return result
+}
+
+const testRaw = (callerLocation, name, fn, testTimeout) => {
   const timeout = testTimeout ?? defaultTimeout
-  installLocationInNextTest(getCallerLocation())
+  installLocationInNextTest(callerLocation)
   if (fn.length > 0) return nodeTest(name, (t, c) => fn(c))
   if (!forceExit) return nodeTest(name, fn)
   return nodeTest(name, { timeout }, async (t) => {
@@ -97,8 +125,13 @@ Also, using expect.assertions() to ensure the planned number of assertions is be
   })
 }
 
+const test = (...args) => testRaw(getCallerLocation(), ...args)
+
 describe.each = makeEach(describe)
 test.each = makeEach(test)
+test.concurrent = (...args) =>
+  inConcurrent.length > 0 ? test(...args) : concurrent.push([args, getCallerLocation()])
+test.concurrent.each = makeEach(test.concurrent)
 describe.skip = (...args) => nodeDescribe.skip(...args)
 test.skip = (...args) => nodeTest.skip(...args)