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

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Exodus Movement, Inc
+
+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/README.md

@@ -1,52 +1,95 @@
 # @exodus/test
 
-A runner for `node:test`, `jest`, and `tape` test suites on top of `node:test`
-
-Most likely it will just work on your simple jest tests as as drop-in replacement
-
-Comes with typescript support, optional esm/cjs interop, and also loading babel transforms!
-
-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
-
-You can just use pure [`node:test`](https://nodejs.org/api/test.html) in your tests,
-this runner is fully compatible with that (and will set version-specific options for you)!
-
-### Moving from jest
-
-```js
-import {
-  jest,
-  expect,
-  describe,
-  it,
-  beforeEach,
-  afterEach,
-  beforeAll,
-  afterAll,
-} from '@exodus/test/jest'
-```
-
-Or, run with [`--jest` option](#options) to register jest globals
-
-### Moving from tap/tape
-
-```js
-import test from '@exodus/test/tap'
+A runner for `node:test`, `jest`, and `tape` test suites on top of `node:test` (and any runtime)
+
+## Features
+
+- Native ESM, including in Jest tests
+- Esbuild on the fly for babelified ESM interop (enable via `--esbuild`)
+- TypeScript support in both transform (through [tsx](https://tsx.is/), enable via `--esbuild`)
+  and typestrip (via `--typescript`) modes
+- Runs on [node:test](https://nodejs.org/api/test.html), and (experimental) on bun, deno, d8, JSC,
+  [Hermes](https://hermesengine.dev), Chrome, Firefox and WebKit.
+- Testsuite-agnostic -- can run any file as long as it sets exit code based on test results
+- Built-in [Jest](https://jestjs.io) compatibility (with `--jest`), including `jest.*` global
+  - Up to ~10x faster depending on the original setup
+  - Actual `expect` module, also `jest-extended` and `jest-when` just work on top
+  - Snapshots, including snapshot matchers
+  - Function and timer mocks
+  - [test.concurrent]()
+  - Module mocks (on top of Node.js runtime only), including for ESM modules
+  - Loads Jest configuration
+  - It works on Hermes too!
+- Built-in network record/replay for offline tests, mocking `fetch` and `WebSocket` sessions
+- `--drop-network` support for guaranteed offline testing
+- Native code coverage via v8 (Node.js or [c8](https://github.com/bcoe/c8)), with istanbul reporters
+- GitHub reporter (auto-enabled by default)
+- JSDOM env support
+- Hanging tests error by default (unlike `jest`)
+- Babel support, picks up your Babel config (enable via `--babel`)
+- Unlike `bun:test`, it runs test files in isolated contexts \
+  Bun leaks globals / side effects between test files ([ref](https://github.com/oven-sh/bun/issues/6024)),
+  and has incompatible `test()` lifecycle / order
+- Also features a tape API for drop-in replacement
+
+## Reporter samples
+
+#### CLI (but uses colors when output supports them, e.g. in terminal):
+
+```console
+# tests/jest/expect.mock.test.js
+✔ PASS drinkAll > drinks something lemon-flavoured (1.300417ms)
+✔ PASS drinkAll > does not drink something octopus-flavoured (0.191791ms)
+✔ PASS drinkAll (1.842959ms)
+✔ PASS drinkEach > drinkEach drinks each drink (0.360625ms)
+✔ PASS drinkEach (0.463416ms)
+✔ PASS toHaveBeenCalledWith > registration applies correctly to orange La Croix (0.53325ms)
+✔ PASS toHaveBeenCalledWith (0.564166ms)
+✔ PASS toHaveBeenLastCalledWith > applying to all flavors does mango last (0.380375ms)
+✔ PASS toHaveBeenLastCalledWith (0.473417ms)
+# tests/jest/fn.invocationCallOrder.test.js
+✔ PASS mock.invocationCallOrder (4.221042ms)
 ```
 
-### Running tests asynchronously
+#### GitHub Actions collapses test results per-file, like this:
+
+<details>
+ <summary>✅ <strong>tests/jest/lifecycle.test.js</strong></summary>
+ <pre>
+  ✔ PASS A > B > C (3.26166ms)
+  ✔ PASS A > B > D (1.699463ms)
+  ✔ PASS A > B (6.72719ms)
+  ✔ PASS A > E > F (1.117997ms)
+  ✔ PASS A > E > G > H (1.330904ms)
+  ✔ PASS A > E > G (1.94971ms)
+  ✔ PASS A > E (3.821825ms)
+  ✔ PASS A > I (0.533096ms)
+  ✔ PASS A (13.887889ms)
+  ✔ PASS J (0.373187ms)
+  ✔ PASS K > L (0.659852ms)
+  ✔ PASS K (1.143195ms)
+ </pre>
+</details><details>
+ <summary>✅ <strong>tests/jest/timers.async.test.js</strong></summary>
+ <pre>
+  ✔ PASS advanceTimersByTime() does not let microtasks to pass (5.326604ms)
+  ✔ PASS advanceTimersByTime() does not let microtasks to pass even with await (1.336064ms)
+  ✔ PASS advanceTimersByTimeAsync() lets microtasks to pass (6.99526ms)
+  ✔ PASS advanceTimersByTimeAsync() lets microtasks to pass, chained (10.131664ms)
+  ✔ PASS advanceTimersByTimeAsync() lets microtasks to pass, longer chained (8.635472ms)
+  ✔ PASS advanceTimersByTimeAsync() lets microtasks to pass, async chain (56.937983ms)
+ </pre>
+</details>
+
+See live output in [CI](https://github.com/ExodusMovement/test/actions/workflows/checks.yaml)
 
-Add `{ concurrency: true }`, like this: `describe('my testsuite', { concurrency: true }, () => {`
+## Library
 
 ### List of exports
 
-- `@exodus/test/jest` -- `jest` mock
+- `@exodus/test/node` -- `node:test` API, working under non-Node.js platforms
+
+- `@exodus/test/jest` -- `jest` implementation
 
 - `@exodus/test/tape` -- `tape` mock (can also be helpful when moving from `tap`)
 
@@ -56,11 +99,9 @@ Just use `"test": "exodus-test"`
 
 ### Options
 
-- `--jest` -- register jest test helpers as global variables
+- `--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)
 
@@ -72,8 +113,43 @@ Just use `"test": "exodus-test"`
 
 - `--watch` -- operate in watch mode and re-run tests on file changes
 
+- `--only` -- only run the tests marked with `test.only`
+
 - `--passWithNoTests` -- do not error when no test files were found
 
 - `--write-snapshots` -- write snapshots instead of verifying them (has `--test-update-snapshots` alias)
 
 - `--test-force-exit` -- force exit after tests are done (useful in integration tests where it could be unfeasible to resolve all open handles)
+
+## Jest compatibility
+
+The `--jest` mode is mostly compatible with Jest. There are some noteworthy differences though.
+This tool does not hoist mocks, so it is important that a mock is defined before the module that uses it is imported.
+In ESM, this can be achieved with dynamic imports:
+
+```js
+jest.mock('./hogwarts.js', () => {
+  return {
+    __esModule: true,
+    default: jest.fn(),
+  }
+})
+
+const { default: getEntryQualification } = await import('./hogwarts.js')
+const { qualifiesForHogwarts } = await import('./wizard.js') // module importing ./hogwarts.js
+
+test('qualifies for Hogwarts', () => {
+  // doSomething is a mock function
+  getEntryQualification.mockReturnValue(['lumos'])
+
+  expect(qualifiesForHogwarts('potter')).toBe(false)
+  getEntryQualification.mockReturnValue([])
+  expect(qualifiesForHogwarts('potter')).toBe(true)
+})
+```
+
+Note that all modules that transitively import `hogwarts.js` will have to be imported after the mock is defined.
+
+## License
+
+[MIT](./LICENSE)

package/bin/browsers.js

@@ -0,0 +1,97 @@
+import assert from 'node:assert/strict'
+import { readFile } from 'node:fs/promises'
+import { findBinary } from './find-binary.js'
+
+// See https://playwright.dev/docs/browsers
+// > Playwright doesn't work with the branded version of Firefox since it relies on patches.
+// > Playwright doesn't work with the branded version of Safari since it relies on patches.
+// We don't even attempt to use built-in engine for Chromium, just rely on Playwright to load its.
+// To run system browsers, we use Puppeteer.
+
+let puppeteer
+let playwright
+
+const launched = Object.create(null)
+const launchers = {
+  async puppeteer({ binary, devtools }) {
+    if (!puppeteer) puppeteer = await import('puppeteer-core')
+    assert(['chrome', 'firefox'].includes(binary))
+    return puppeteer.launch({ executablePath: findBinary(binary), browser: binary, devtools })
+  },
+  async playwright({ binary, devtools }) {
+    if (!playwright) playwright = await import('playwright-core')
+    assert(['chromium', 'firefox', 'webkit'].includes(binary) && Object.hasOwn(playwright, binary))
+    return playwright[binary].launch({ devtools })
+  },
+}
+
+export const close = () => Promise.all(Object.values(launched).map((p) => p.then((b) => b.close())))
+
+async function newPage(runner, browser, { binary, dropNetwork }) {
+  const context = await (browser.newContext ? browser.newContext() : browser.createBrowserContext())
+  if (dropNetwork && context.setOffline && binary !== 'webkit') await context.setOffline(true) // WebKit crashes if this is done prior to navigation to /dev/null
+  let page
+  try {
+    page = await context.newPage()
+  } catch (err) {
+    // Puppeteer has a bug with Firefox, we expect that and just retry
+    if (runner !== 'puppeteer' || binary !== 'firefox' || err.name !== 'ProtocolError') throw err
+    await context.close()
+    return newPage(runner, browser, { binary, dropNetwork })
+  }
+
+  await page.goto('file:///dev/null') // Need to load a secure origin for e.g. crypto.subtle to be available
+
+  if (dropNetwork && context.setOffline) await context.setOffline(true)
+  if (dropNetwork && page.setOfflineMode) await page.setOfflineMode(true)
+  assert(!dropNetwork || context.setOffline || page.setOfflineMode)
+  return { context, page }
+}
+
+export async function run(runner, args, { binary, devtools, dropNetwork, timeout }) {
+  assert(args.length === 1, 'Unexpected args to browser runner')
+
+  const bundle = await readFile(args[0], 'utf8')
+  let code = 0
+  const [stdout, stderr] = [[], []]
+
+  assert(Object.hasOwn(launchers, runner), 'Unexpected runner')
+  if (!launched[runner]) launched[runner] = launchers[runner]({ binary, devtools })
+  const { page, context } = await newPage(runner, await launched[runner], { binary, dropNetwork })
+
+  page.on('console', (message) => {
+    const type = message.type()
+    const target = type === 'error' ? stderr : stdout
+    target.push(message.text())
+  })
+  page.on('pageerror', (error) => {
+    if (!code) code = 1
+    stderr.push(`${error}`)
+  })
+
+  let timer
+  const promise = new Promise((resolve) => {
+    timer = setTimeout(() => {
+      stderr.push('timeout reached')
+      resolve(1) // Error code
+    }, timeout)
+  })
+
+  const wait = async () => {
+    await page.evaluate(bundle)
+    return page.evaluate('globalThis.EXODUS_TEST_PROMISE')
+  }
+
+  try {
+    // exitCode might be undefined if we failed before EXODUS_TEST_PROMISE was set, but we will have code then
+    const exitCode = await Promise.race([wait(), promise])
+    code = code || exitCode
+    assert(Number.isInteger(code))
+    return { code, stdout: stdout.join('\n'), stderr: stderr.join('\n') }
+  } catch (error) {
+    return { code: 1, stdout: '', stderr: `${error}` }
+  } finally {
+    clearTimeout(timer)
+    await context.close()
+  }
+}

package/bin/find-binary.js

@@ -0,0 +1,67 @@
+import { existsSync } from 'node:fs'
+import { dirname, join } from 'node:path'
+import { createRequire } from 'node:module'
+
+const require = createRequire(import.meta.url)
+
+// Can modify PATH to add the binary to it!
+function findBinaryOnce(name) {
+  const paths = []
+  const addPaths = (platform, ...args) => process.platform === platform && paths.push(...args)
+
+  switch (name) {
+    case 'hermes':
+      try {
+        const dir = dirname(require.resolve('hermes-engine-cli/package.json'))
+        const platformDirs = { darwin: 'osx-bin', linux: 'linux64-bin', win32: 'win64-bin' }
+        if (Object.hasOwn(platformDirs, process.platform)) {
+          process.env.PATH = `${join(dir, platformDirs[process.platform])}:${process.env.PATH}`
+        } else {
+          console.error(`Unexpected platform: ${process.platform}`)
+        }
+      } catch {
+        console.warn("'hermes-engine-cli' not installed, attempting to load global `hermes`...")
+      }
+
+      return 'hermes'
+    case 'jsc':
+      if (process.platform === 'darwin') {
+        const prefix = '/System/Library/Frameworks/JavaScriptCore.framework/Versions/A'
+        for (const dir of [`${prefix}/Helpers`, `${prefix}/Resources`]) {
+          if (existsSync(join(dir, 'jsc'))) {
+            process.env.PATH = `${dir}:${process.env.PATH}`
+            break
+          }
+        }
+      }
+
+      return 'jsc'
+    case 'electron':
+      return require('electron')
+    case 'c8':
+      return require.resolve('c8/bin/c8.js')
+    case 'chrome':
+      addPaths('darwin', '/Applications/Google Chrome.app/Contents/MacOS/Google Chrome')
+      addPaths('linux', '/usr/bin/chromium', '/snap/bin/chromium', '/usr/bin/google-chrome')
+      break
+    case 'firefox':
+      addPaths('darwin', '/Applications/Firefox.app/Contents/MacOS/firefox')
+      addPaths('linux', '/usr/bin/firefox')
+      break
+    case 'safari':
+      addPaths('darwin', '/Applications/Safari.app/Contents/MacOS/Safari')
+      break
+    default:
+      throw new Error('Trying to find an unexpected executable name')
+  }
+
+  for (const path of paths) if (existsSync(path)) return path
+  throw new Error(`Failed to find ${name} executable`)
+}
+
+const binaries = new Map()
+
+export function findBinary(name) {
+  if (!binaries.has(name)) binaries.set(name, findBinaryOnce(name))
+  return binaries.get(name)
+}

package/bin/inband.js

@@ -0,0 +1,11 @@
+import { resolve } from 'node:path'
+import { describe } from '../src/engine.js'
+
+const files = JSON.parse(process.env.EXODUS_TEST_INBAND)
+if (!Array.isArray(files)) throw new Error('Unexpected')
+
+for (const file of files.sort()) {
+  await describe(`EXODUS_TEST_INBAND:${file}`, async () => {
+    await import(resolve(file))
+  })
+}