Node.js test runner that lets you develop with confidence 🚀
AVA 4 is nearly done! We’re not expecting major breaking changes, so barring any bugs or other surprises this should be it.
As always with pre-releases though you’re best-off installing an exact version:
npm install -D -E ava@next
By default, test files are now run in worker threads! Huge thanks to @dnlup for landing this.
Test files should run a little quicker, since it's easier to spin up a worker thread than a child process. You can use --no-worker-threads on the command line, or workerThreads: false in your AVA configuration, to fall back to using child processes.
Shared workers are no longer experimental. This is a powerful feature that loads a program in a worker thread in AVA's main process and then communicate with code running in the test workers. This enables your tests to better utilize shared resources during a test run, as well as providing opportunities to set up these resources before tests start (or clean them up after).
When you use watch mode, shared workers remain loaded across runs.
AVA selects test files based on your package.json or ava.config.* configuration files. When used on the CLI you can then provide patterns to select a subset of these files.
You can now pass a folder and AVA will select the test files contained therein. Or you can provide a specific JavaScript file and AVA will run it even if it wasn’t selected by your configuration.
If AVA finds files based on the configuration, but none of those were selected to the CLI arguments, it now prints a warning.
AVA now looks for ava.config.* files in parent directories, until it finds a directory with a .git directory (or file). This lets you specify AVA configuration at the top of your monorepo and still run AVA from within each package.
@ninevra has worked tirelessly on landing a new snapshot format. It contains all information necessary to regenerate the report file. This allows for snapshots to be updated even if tests or assertions are skipped.
AVA now records which test files failed in the previous run. It then prioritizes testing these files when you run AVA again. Thanks @bunysae!
AVA 4 comes with full ES module support. Both ESM and CJS entrypoints are provided so that you can use it no matter how you manage your project.
The ava.config.js file is now treated as CJS or ESM depending on module type configured in the package.json file. ava.config.mjs is now supported.
If you use JavaScript files with non-standard extensions you can configure AVA to import them.
Note that dependency tracking in watch mode does not yet work with ES modules.
test.macro() returns an object that can be used with
test() and hooks. The t.context type is inherited from test. When used with TypeScript this gives much better type inference.
Like with AVA 3, regular functions that also have a title property
that is a string-returning function are supported. However the type checking won’t be as good.
AVA now uses the source map support that’s built in to Node.js itself. This should give better stack traces. However we’re not sure yet what happens if you load a program that automatically modifies stack traces.
Line number selection (where npx ava test.js:5 runs the test at line 5) now uses source maps and so should work better with TypeScript files.
Most assertions now return a boolean indicating whether they passed. If you use AVA with TypeScript, you can use this as a type guard. Thanks @jmarkham828!
(This is not supported for t.snapshot() and the "throws" assertions.)
AVA 4 requires at least Node.js 12.22, 14.17, 16.4 or 17. Node.js 10 is no longer supported.
If installed globally, AVA will no longer use any locally installed version. Install locally and run with npx ava instead. When running test files from another project that also has AVA installed, those test files will now fail to run (because they'll try and use that other AVA version).
@ava/babel has been removed. We haven’t seen enough contributions to that package to recommend it for AVA 4. We’d be open to reinstating it in the future (just as we’d be open to support any other compilation provider).avajs/[email protected] or newer.esm package has been removed.ava.config.js now follows the module type configured in package.json.ava.config.* files may be found that are outside your project directory.test.meta.file and test.meta.snapshotDirectory are now file URL strings.test() and t.try() no longer take an array of test implementations. Use a loop instead.t.throws() and t.throwAsync() assertions can no longer be called with a null value for the expectations argument.test.cb() and t.end() have been removed. Use async functions and util.promisify() instead.t.teardown() now executes in last-in-first-out order.npx ava -u to rebuild your snapshots after upgrading.t.snapshot() no longer works in hooks.t.snapshot() no longer takes an options argument allowing you to customize the snapshot ID.instanceOf expectation of t.throws() and t.throwsAsync() assertions must now be an Error constructor.test.macro() when declaring macros.unknown.Meta replaces MetaInterface, other types with Interface suffixes now use the Fn suffix. There may be some other changes too. 4b4b2f63f184056b4038dfc692f99421038d3ec1t.throws() and t.throwsAsync() return undefined when the assertion fails. The type definition now matches this behavior.--config argument may now point to a file that is not alongside the package.json file.t.timeout(), AVA itself won’t time out until your test does. Thanks @OhYash!.test and .spec extensions from file names, as well as test- prefixes.Full changelog since Alpha 2: https://github.com/avajs/ava/compare/v4.0.0-alpha.2...v4.0.0-rc.1
This is the second (pre)release of AVA 4 🎊 Please read the release notes for Alpha 1.
npx ava instead 1ee1e826https://github.com/avajs/ava/compare/v4.0.0-alpha.1...v4.0.0-alpha.2
This is the first (pre)release of AVA 4 🎊 There's some great new features, some cleanup of old interfaces, and some other smaller-but-still-breaking changes.
You can install the latest AVA 4 prerelease using:
npm install -D -E ava@next
By default, test files are now run in worker threads! Huge thanks to @dnlup for landing this. 0e5cc7dc2b1512d0abe9bfba57b26888eedea0cf
Test files should run a little quicker, since it's easier to spin up a worker thread than a child process. You can use --no-worker-threads on the command line, or workerThreads: false in your AVA configuration, to fall back to using child processes.
@ninevra has worked tirelessly on landing a new snapshot format. It contains all information necessary to regenerate the report file. This allows for snapshots to be updated even if tests or assertions are skipped. 14ec281dd6d71d46cf2b755e7451262dab6cbc64
AVA's configuration files may now export promises or asynchronous factory methods. The ava.config.js file is now treated as CJS or ESM depending on module type configured in the package.json file. ava.config.mjs is now supported. f7cb1c7b038eba017bd77fc93d9921b1db962174 c7b782098dbaeaacfd671c12ffc5100bfb7be75d
AVA now records which test files failed in the previous run. It then prioritizes testing these files when you run AVA again. Thanks @bunysae! d7426720ad55ba387d86aaae3a3af06a8020c761
Most assertions now return a boolean indicating whether they passed. If you use AVA with TypeScript, you can use this as a type guard. Thanks @jmarkham828! 72a4e2fd4c931b13354ad9d10149c383b4ca48b3 5eea60836402ff0ca052cf1d017deabdf8a6fb36
(This is not supported for t.snapshot() and the "throws" assertions.)
ava.config.js now follows the module type configured in package.json f7cb1c7b038eba017bd77fc93d9921b1db962174 c7b782098dbaeaacfd671c12ffc5100bfb7be75dnpx ava -u to rebuild your snapshots after upgrading 14ec281dd6d71d46cf2b755e7451262dab6cbc64t.snapshot() no longer works in hooks bcb750c1551cca380a0003ebc8f66987a6b16d6ct.snapshot() no longer takes an options argument allowing you to customize the snapshot ID d8b1e89e6e8b88e1582cf02f4cf088c87c2e058ftest.cb() and t.end() have been removed. Use async functions and util.promisify() instead.t.throws() and t.throwAsync() assertions can no longer be called with a null value for the expectations argument 7f64f5c834e8fab29f4778705ee05b2a81867879t.teardown() now executes in last-in-first-out order dc4483f440fe8736ff71226fd8b18c0e2cc86f51esm package has been removed 2011b92b638df42b4d050a19e9b37cbb19659970Our TypeScript recipe has been updated with ts-node and ESM instructions. Thanks @mesqueeb! a0791529c18394d92224232cf9d1696426ada505
We'd also like to thank @kiancross, @papb and @JerryGreen.
https://github.com/avajs/ava/compare/v3.15.0...v4.0.0-alpha.1
When you stop using snapshots in a test file, the next time you run ava --update-snapshots we'll remove the left-over snapshot files. Thanks @ninevra! 4f093ab
@tymfear has been on a roll improving our TAP reporter. t.log() output is now compliant with the spec 99ab93a. Tests that did not run due to timeouts are now reported 98595dae58209a9062d0238c7a3dd7078a9962d1.
AVA 4 will add full support for ESM configuration files as well as allowing you to have asynchronous factory functions a2f2614cc1e34fb9a7aa204b37b3b25559f203d9. If you're using Node.js 12 or later you can opt-in to these features in AVA 3 by enabling the nextGenConfig experiment. Say in an ava.config.mjs file:
export default {
nonSemVerExperiments: {
nextGenConfig: true
},
files: ['unit-tests/**/*]
};
This also allows you to pass an .mjs file using the --config argument.
With this experiment enabled, AVA will no longer have special treatment for ava.config.js files. Instead AVA follows Node.js' behavior, so if you've set "type": "module" you must use ESM, and otherwise you must use CommonJS.
You mustn't have an ava.config.mjs file next to an ava.config.js or ava.config.cjs file.
See https://github.com/avajs/ava/compare/v3.14.0...v3.15.0 for all changes.
With this release, snapshot files are now ordered based on test declaration, not completion. This makes it easier to compare the human-readable reports to your test file, and also stops the .snap from changing when the reports themselves don't. You'll want to rebuild snapshots after upgrading to this release to isolate any changes. Thanks @ninevra! e66b54ce61d8bb16bbcd15b7fb90893d02e5a65c
We’ve been working on making AVA more extensible. One major step on this path is our new shared worker support: run code in the main process, communicate with test workers and influence execution. Find out more in our shared workers recipe.
See https://github.com/avajs/ava/compare/v3.13.0...v3.14.0 for all changes.
t.passed can now be used in tests and teardown functions. Thanks @tymfear! 900dc6d46a1f8728dddfab1e42caef1fa8a51c85null as the expectation for t.throws() & t.throwsAsync(). You can opt in to this early by enabling the disableNullExpectations experiment. Thanks @JSimoni42! f328a6933af7aca221b08f694bb14b03701eca68See https://github.com/avajs/ava/compare/v3.12.1...v3.13.0 for all changes.
Normally, AVA loads all files as CommonJS, except for mjs files and if you've configured "type": "module" in your package.json.
As an experiment, you can now configure how AVA loads other file extensions. This is useful if you want to use Node.js' experimental loaders feature. Read more in our documentation. Thank you @macarie for working on this! 5c9dbb96ad0beb7521e5051390478493250ba6b0
There was a bug in our comparison library which meant that negative-index properties on lists were not compared. This was fixed in a patch release, which will definitely be installed when you install AVA 3.12. Your tests may have been passing, even though they should have been failing. They'll fail now. Snapshots may also be different, causing tests to fail.
See https://github.com/avajs/ava/compare/v3.11.1...v3.12.1 for all changes.
Thank you @AnthumChris for making sure our ESM example used ESM syntax (20bc7810536b3b968db5461ff4093bb5ae912050).
This release fixes corrupted output of the default reporter when test or program code writes to standard out. 5ddc9fda100205a5ca315a86e27a01be443b88b1
Also, thanks to @jonathansamines we've taken another step to using AVA to test AVA. 1150991ba1921cbf888438d46350894484356078
See https://github.com/avajs/ava/compare/v3.11.0...v3.11.1 for all changes.
t.like() assertionThanks to @futpib we now have a t.like() assertion 19c4f35fbae740268dedeeb4d450f813f2d5e85e:
In the following example, the map property of value must be deeply equal to that of selector. However nested.qux is ignored, because it's not in selector.
t.like({
map: new Map([['foo', 'bar']]),
nested: {
baz: 'thud',
qux: 'quux'
}
}, {
map: new Map([['foo', 'bar']]),
nested: {
baz: 'thud',
}
})
Read more in the t.like() assertion documentation.
This assertion was previously introduced as an experiment.
You can now debug tests using the new JavaScript Debug Terminal in VSCode 1.47. We've updated our debugging recipe accordingly. Thank you @connor4312 for the documentation updates and your work on VSCode! bc39bcc3ff92cb2979564ec2e69dc72be6509f78
See https://github.com/avajs/ava/compare/v3.10.1...v3.11.0 for all changes.
When executing a subset of tests, through --match or or .only() or .skip(), you can no longer also update snapshots. This prevents you from accidentally deleting snapshots. Thank you @bunysae for putting this together. f72fab40160a413f4d7ab0208979fe3e721198ea
If you are skipping a test that you can't immediately fix, but you still need to update snapshots, use .failing() instead.
t.timeout() callsThanks to @jonathansamines you can now provide a message string when using t.timeout(). This can be useful if your test depends on some other setup that may not have been completed: ca8ea45587ebefa5584d6a7aa50adf90840701cf
test('foo', t => {
t.timeout(100, 'make sure database has started');
// Write your assertions here
});
t.try() does not work in hookst.try() has never worked in hooks, but thanks to @okyantoro it now fails properly instead of crashing. d01db61ee5e9785d9f80ad5683cac21db4b96509
t.snapshot() does not really work in hooks eithert.snapshot() sort of works in hooks, but we'll be removing this in AVA 4. You can opt in to this behavior by enabling the disableSnapshotsInHooks experiment. Again thank you @okyantoro d01db61ee5e9785d9f80ad5683cac21db4b96509.
t.like()The experimental t.like() assertion should now work better with TypeScript.
See https://github.com/avajs/ava/compare/v3.9.0...v3.10.1 for all changes.