@exodus/test 1.0.0-rc.6 → 1.0.0-rc.7

package/README.md

@@ -8,6 +8,8 @@ Comes with typescript support, optional esm/cjs interop, and also loading babel
 
 Use `--coverage` to generate coverage output
 
+Default `NODE_ENV` value is "test", use `NODE_ENV=` to override (e.g. to empty)
+
 ## Library
 
 ### Using with `node:test` natively
@@ -68,6 +70,8 @@ Just use `"test": "exodus-test"`
 
 - `--coverage-engine node` -- use Node.js builtint coverage engine
 
+- `--watch` -- operate in watch mode and re-run tests on file changes
+
 - `--passWithNoTests` -- do not error when no test files were found
 
 - `--write-snapshots` -- write snapshots instead of verifying them (has `--test-update-snapshots` alias)

package/bin/index.js

@@ -26,9 +26,10 @@ function parseOptions() {
     esbuild: false,
     babel: false,
     coverage: false,
+    coverageEngine: 'c8', // c8 or node
+    watch: false,
     passWithNoTests: false,
     writeSnapshots: false,
-    coverageEngine: 'c8', // c8 or node
   }
 
   const args = [...process.argv]
@@ -63,6 +64,9 @@ function parseOptions() {
       case '--coverage':
         options.coverage = true
         break
+      case '--watch':
+        options.watch = true
+        break
       case '--passWithNoTests':
         options.passWithNoTests = true
         break
@@ -120,6 +124,11 @@ if (options.forceExit) {
   args.push('--test-force-exit')
 }
 
+if (options.watch) {
+  assert((major === 18 && minor > 13) || major >= 20, 'For watch mode, use Node.js >= 18.13.0')
+  args.push('--watch')
+}
+
 if (options.coverage) {
   if (options.coverageEngine === 'node') {
     args.push('--experimental-test-coverage')
@@ -181,6 +190,8 @@ if (tsTests.length > 0 && !options.typescript) {
 assert(files.length > 0) // otherwise we can run recursively
 args.push(...files)
 
+if (!Object.hasOwn(process.env, 'NODE_ENV')) process.env.NODE_ENV = 'test'
+
 assert(program && ['node', c8].includes(program))
 const node = spawn(program, args, { stdio: 'inherit' })
 

package/bin/jest.js

@@ -1,8 +1,10 @@
 import * as globals from '../src/jest.js'
+import { resolveModule } from '../src/jest.mock.js'
 import { mock } from 'node:test'
 
 Object.assign(globalThis, globals)
 
 try {
-  if (mock.module) mock.module('@jest/globals', { defaultExport: globals, namedExports: globals })
+  const resolved = resolveModule('@jest/globals')
+  if (mock.module) mock.module(resolved, { defaultExport: globals, namedExports: globals })
 } catch {}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/test",
-  "version": "1.0.0-rc.6",
+  "version": "1.0.0-rc.7",
   "author": "Exodus Movement, Inc.",
   "description": "A test suite runner",
   "homepage": "https://github.com/ExodusMovement/test",
@@ -44,6 +44,7 @@
   ],
   "scripts": {
     "test": "./bin/index.js --jest --typescript",
+    "test:tape": "./bin/index.js --esbuild '__test__/tape/test/*.js' __test__/tape.test.js",
     "coverage": "./bin/index.js --jest --typescript --coverage",
     "lint": "prettier --list-different . && eslint .",
     "lint:fix": "prettier --write . && eslint --fix ."
@@ -59,6 +60,7 @@
   "devDependencies": {
     "@exodus/eslint-config": "^5.24.0",
     "@exodus/prettier": "^1.0.0",
+    "@jest/globals": "^29.7.0",
     "@types/jest-when": "^3.5.2",
     "@typescript-eslint/eslint-plugin": "^7.15.0",
     "eslint": "^8.44.0",

package/src/jest.fn.js

@@ -35,6 +35,7 @@ export const jestfn = (baseimpl, parent, property) => {
     queuedMockClear()
     onceStack.length = 0
     mockimpl = noop
+    mockname = undefined
     reportedmockimpl = undefined
     fnmock.mockImplementation(mockimpl)
   }
@@ -68,18 +69,20 @@ export const jestfn = (baseimpl, parent, property) => {
 
   const queuedMockOnce = (impl) => {
     onceStack.push(impl)
-    fnmock.mockImplementation(function (...args) {
-      try {
-        const impl = onceStack.shift() || mockimpl
-        return impl.call(this, ...args)
-      } finally {
-        // load fast path if we are done with the queue
-        if (onceStack.length === 0) {
-          assert(mockimpl)
-          fnmock.mockImplementation(mockimpl)
-        }
+    fnmock.mockImplementation(queueImplementation)
+  }
+
+  const queueImplementation = function (...args) {
+    try {
+      const impl = onceStack.shift() || mockimpl
+      return impl.call(this, ...args)
+    } finally {
+      // load fast path if we are done with the queue
+      if (onceStack.length === 0) {
+        assert(mockimpl)
+        fnmock.mockImplementation(mockimpl)
       }
-    })
+    }
   }
 
   const jestfnmock = {
@@ -125,7 +128,7 @@ export const jestfn = (baseimpl, parent, property) => {
       case '_isMockFunction':
         return true
       case 'getMockName':
-        return () => mockname
+        return () => mockname ?? 'jest.fn()'
       case 'mockName':
         return wrap((name) => {
           mockname = name

package/src/jest.js

@@ -2,7 +2,7 @@ import assert from 'node:assert/strict'
 import { describe as nodeDescribe, test as nodeTest, afterEach } from 'node:test'
 import { format, types } from 'node:util'
 import { jestfn, allMocks } from './jest.fn.js'
-import { jestmock, requireActual, requireMock } from './jest.mock.js'
+import { jestmock, requireActual, requireMock, resetModules } from './jest.mock.js'
 import * as jestTimers from './jest.timers.js'
 import './jest.snapshot.js'
 import { expect } from 'expect'
@@ -57,7 +57,8 @@ afterEach(() => {
 const jest = {
   fn: (impl) => jestfn(impl), // hide extra arguments
   ...allMocks,
-  spyOn: (obj, name) => {
+  spyOn: (obj, name, accessType) => {
+    assert(!accessType, `accessType "${accessType}" is not supported`)
     assert(obj && name && name in obj && !(name in {}) && !(name in Object.prototype))
     const fn = jestfn(obj[name], obj, name)
     // eslint-disable-next-line @exodus/mutable/no-param-reassign-prop-only
@@ -67,6 +68,7 @@ const jest = {
   mock: jestmock,
   requireMock,
   requireActual,
+  resetModules,
   ...jestTimers,
 }
 

package/src/jest.mock.js

@@ -1,14 +1,18 @@
 import assert from 'node:assert/strict'
-import { createRequire, builtinModules } from 'node:module'
+import { createRequire, builtinModules, syncBuiltinESMExports } from 'node:module'
+import { existsSync } from 'node:fs'
+import { normalize } from 'node:path'
 import { mock } from 'node:test'
 import { jestfn } from './jest.fn.js'
 
-const require = createRequire(import.meta.url)
+const files = process.argv.slice(1)
+const baseUrl = files.length === 1 && existsSync(files[0]) ? normalize(files[0]) : undefined
+const require = createRequire(baseUrl || import.meta.url)
 const mapMocks = new Map()
 const mapActual = new Map()
 
-function resolveModule(name) {
-  assert(/^[@a-zA-Z]/u.test(name), 'Mocking relative paths is not supported')
+export function resolveModule(name) {
+  assert(baseUrl || /^[@a-zA-Z]/u.test(name), 'Mocking relative paths is not possible')
   return require.resolve(name)
 }
 
@@ -25,6 +29,11 @@ export function requireMock(name) {
   return mapMocks.get(resolved)
 }
 
+export function resetModules() {
+  // Caveat: only resets CJS modules, not ESM
+  for (const key of Object.keys(require.cache)) delete require.cache[key]
+}
+
 const isObject = (obj) => [Object.prototype, null].includes(Object.getPrototypeOf(obj))
 
 function override(resolved, lax = false) {
@@ -41,7 +50,9 @@ function override(resolved, lax = false) {
 
   // We want to skip overriding frozen properties that already match, e.g. fs.constants
   const filtered = Object.entries(value).filter(([k, v]) => !(k in {}) && current[k] !== v)
-  Object.assign(current, Object.fromEntries(filtered))
+  const access = { configurable: true, enumerable: true, writable: true }
+  const definitions = Object.fromEntries(filtered.map(([k, value]) => [k, { value, ...access }]))
+  Object.defineProperties(current, definitions)
   if (!lax) assert.deepEqual({ ...current }, value)
 }
 
@@ -113,6 +124,7 @@ export function jestmock(name, mocker) {
     require.cache[resolved].exports = value
   } else if (builtinModules.includes(resolved.replace(/^node:/, ''))) {
     override(resolved, true) // Override builtin modules
+    syncBuiltinESMExports()
   }
 
   mock.module(name, { defaultExport: value.default, namedExports: value })

package/src/tape.js

@@ -1,7 +1,8 @@
 import assert from 'node:assert/strict'
+import assertLoose from 'node:assert'
 import { test } from 'node:test'
 
-const knownOptions = new Set(['skip', 'todo', 'concurrency'])
+const knownOptions = new Set(['skip', 'todo', 'concurrency', 'timeout'])
 
 function verifyOptions(options) {
   for (const key of Object.keys(options)) {
@@ -71,7 +72,7 @@ function tapeWrapAssert(t, callback) {
     if (plan !== null) assert(plan >= count, `plan (${plan}) < count (${count})`)
   }
 
-  const plannedAssert = () => (plan !== null && t.assert) || assert // t.assert is cached and affected by t.plan
+  const plannedAssert = () => (plan !== null && t.assert) || assertLoose // t.assert is cached and affected by t.plan
 
   // Note: we must use plannedAssert instead of assert everywhere on user calls as we have t.plan
   const api = {
@@ -112,8 +113,9 @@ function tapeWrapAssert(t, callback) {
 const AsyncFunction = (async () => {}).constructor
 
 function tapeWrap(test) {
-  const tap = (name, ...args) => {
+  const tap = (...args) => {
     const fn = args.pop()
+    const name = args.shift() || 'test'
     assert(args.length <= 1)
     const [opts = {}] = args
     verifyOptions(opts)
@@ -126,6 +128,7 @@ function tapeWrap(test) {
   }
 
   tap.skip = (...args) => test.skip(...args)
+  if (test.only) tap.only = tapeWrap(test.only)
   return tap
 }