You can now specify an alternative config file, using the --config CLI argument. This is useful if you want to run unit tests separately from integration tests, since you can have a config file specific to your integration tests which specifies different glob patterns. 2dae2bf
Bug fixes
We're now faking the new hasColors() method for better compatibility with Node.js 12. d399797
Node.js 11
We've removed Node.js 11 from our test matrix. You should upgrade to Node.js 12. 90acbb9
We welcome new contributors. AVA is a friendly place to get started in open source. We have a great article on getting started contributing and a comprehensive contributing guide.
We welcome new contributors. AVA is a friendly place to get started in open source. We have a great article on getting started contributing and a comprehensive contributing guide.
Per the Node.js release schedule, the 6.x releases reach end of live on April 30th. Consequently we've removed support in AVA. We are now testing with Node.js 12 though. 3a4afc6
Test file and helper selection
We've been working on simplifying how test files and helpers are selected. First off, the files option now only accepts glob patterns. If you configured it with directories before, please add /**/* to get the previous behavior.
AVA used to treat all files inside a helpers directory as test helpers. Finding these files could be really slow, however, and it also meant you couldn't have tests inside a helpers directory. Instead you can now specify glob paterns to find these helpers:
{
"ava": {
"helpers": [
"**/helpers/**/*"
]
}
}
Test files starting with an underscore are still recognized as helpers.
Files inside fixtures directories are no longer ignored, and will now be treated as test files. The watcher now also watches ava.config.js files.
AVA now also selects files ending with .spec.js when looking for tests, as well as looking in tests directories. 08e99e5b1e54b1
The CLI now only takes file paths, not glob patterns.
When you run tests locally and add a new snapshot, AVA automatically updates the .snap file. However if you forget to commit this file and then run your CI tests, they won't fail because AVA quietly updates the .snap file, just like it does locally.
With this release, AVA will fail the t.snapshot() assertion if it is run in CI and no snapshot could be found. 0804107
Assertion messages must be strings
AVA now enforces assertion messages to be strings. The message is only used when the assertion fails, and non-string values may cause AVA to crash. You may see test failures if you were accidentally passing a non-string message. 49120aa
Flow type definitions
We've decided to remove the Flow type definitions from AVA itself. We don't have anybody to maintain them and consequently they've become a blocker when adding features to AVA. c633cf0
We've set up a new repository from which we'll publish the definitions, but we need your help setting it up. If you use AVA and Flow, please join us in avajs/flow-typed#1.
Observable typing
Test implementations may return observables. We've updated our TypeScript definition to require these to have a Symbol.observable function. c2d8218
You can now specify environment variables in your config, using the environmentVariables object. a53ea15
Other changes
We've added UntitledMacro and UntitledCbMacro types, for macro functions that will never have a .title function. Though really this just helped simplify the type definition. Thanks @qlonik! ebf4807
The dependency tracking in watch mode now respects custom require hooks you install in the worker processes. Thanks @lo1tuma! cb4c809
The TypeScript definition once again allows test.skip(macro)ba5cd80
AVA now exposes some methods to our ESLint plugin, allowing our plugin to support the new test & helper file selection. 51433be
We welcome new contributors. AVA is a friendly place to get started in open source. We have a great article on getting started contributing and a comprehensive contributing guide.
AVA comes with power-assert built-in, giving you more descriptive assertion messages. However it's been confusing to understand which assertions come with power-assert. To address this we've added the new t.assert() assertion. It's now the only assertion that is power-assert enabled. The assertion passes if called with a truthy value. Consider this example:
6: const c = 'baz';
7: t.assert(a.test(b) || b === c);
8: });
Value is not truthy:
false
a.test(b) || b === c
=> false
b === c
=> false
c
=> 'baz'
b
=> 'bar'
a.test(b)
=> false
b
=> 'bar'
a
=> /foo/
Our ESLint plugin has been updated to support this new assertion. Many thanks to @eemed for implementing this! 9406470
Watch mode
Watch mode now prints the available commands. Thanks @KompKK! cd256ac
Bug fixes
Filtered tests (when using --match, .skip() or .only()) are no longer included in the list of pending tests when timeouts occur or when you interrupt a test run. Thanks @vancouverwill! 23e302a
We're now shimming all TTY methods in the worker processes, thanks to @okyantoro. c1f6fdf
Documentation updates
We've added a note to say that, by default, AVA does not have a default test timeout. Thanks @amokmen! 99a10a1
We welcome new contributors. AVA is a friendly place to get started in open source. We have a great article on getting started contributing and a comprehensive contributing guide.
We've fixed a rather embarrasing bug with t.throws() and t.throwsAsync(). If you'd set a code expectation to a number we never actually checked that the thrown error had such a code! Thanks to @qlonik for both spotting and fixing this. 82daa5e
1.2.0 contained a regression which meant that if you fakedclearTimeout(), you'd break AVA. That's now been fixed. 40f331c
Snapshot files are now recognized as source files, so if you're using watch mode and you delete one, AVA won't rerun all your test files. d066f6f
New features
You can now use require() in ava.config.js files to load non-ES modules. 334e15b
We welcome new contributors. AVA is a friendly place to get started in open source. We have a great article on getting started contributing and a comprehensive contributing guide.
This is a bug fix release. In very large projects, the options send to worker processes would exceed limits on process argument size. We're now sending the options via the inter-process communication channel. 3078892
We welcome new contributors. AVA is a friendly place to get started in open source. We have a great article on getting started contributing and a comprehensive contributing guide.
AVA also has a global timeout feature. The mini reporter now logs tests that were pending when those timeouts occur. Additionally, if you interrupt a test using ctrl+c we'll now also show the pending tests. 2b60556
We welcome new contributors. AVA is a friendly place to get started in open source. We have a great article on getting started contributing and a comprehensive contributing guide.
We welcome new contributors. AVA is a friendly place to get started in open source. We have a great article on getting started contributing and a comprehensive contributing guide.
Back in January we started work on the 1.0 release, taking the opportunity to upgrade to Babel 7 and follow its beta releases. It's been a year where we made massive improvements to AVA. It's also been a year with many exciting events in our personal lives. Be it honeymoons & weddings, work & friends, naturalizations and international relocations.
So, we're done. Or, rather, we're just beginning. Testing can be a drag. AVA helps you get it done. Its concise API, detailed error output, embrace of new language features and process isolation let you write tests more effectively. So you can ship more awesome code or do non-programming things.
Starting now we'll push out patches and new features more regularly. And, when the time comes, ship a 2.0 and a 3.0 and so forth. If you like what we're doing, why not try and contribute? We're a friendly bunch and we could use your help to make AVA even better.
We couldn't have gotten here without the nearly one hundred people who've contributed more, and the many more who suggested improvements, reported bugs and provided feedback. And, of course, everyone who's used AVA. Thank you for your enthusiasm and support.
We've rewritten t.throws() so it behaves better, has better error output and lets you write better tests:
The assertion takes a first thrower argument. It must throw an exception, or your test fails. Throwing other values like strings also causes your test to fail.
The exception must be an error object.
The assertion returns the exception.
You have a few ways of asserting that the exception is as designed. You can pass a second argument:
If you pass a function it should be a constructor: the exception must be an instance of it. Previously you could pass a validation function. This is no longer possible.
If you pass a string: the exception's message should be equal to it.
If you pass a regular expression: the exception's message should match it.
The most exciting new feature though is that you can pass an expectation object. A combination of the following expectations is supported:
// Old assertionconsterr=t.throws(fn, TypeError)
t.is(err.message, 'Expected a string')
// New assertiont.throws(fn, {
instanceOf:TypeError,
message:'Expected a string'
})
We've removed promise support from t.throws() and t.notThrows(). Use the new t.throwsAsync() and t.notThrowsAsync() assertions instead. Support for observables has been removed completey.
The original behavior was both hard to explain and hard to express in Flow and TypeScript. Now, if you have a function that throws a synchronous error, use t.throws() (or t.notThrows()). If you have a promise that should reject, or an asynchronous function that should fail, use await t.throwsAsync() (or await t.notThrowsAsync()).
Generally speaking, you should be able to replace every occurence of await t.throws with await t.throwsAsync, and await t.notThrows with await t.notThrowsAsync. A transform file for jscodeshift is available in this Gist. Run it like:
Whilst not strictly assertions, t.plan() and t.log() are now also bound to the test.
BigInt
As part of our Node.js 10 support you can now use BigInt values in t.deepEqual() and t.snapshot(). Note that this is still a stage-3 proposal.
Babel 7
AVA now uses Babel 7, with support for babel.config.js files. We'll automatically use your project's Babel configuration. Babel options must now be specified in a testOptions object. This will allow us to add source related options in the future.
Our @ava/stage-4 preset is now accessible via ava/stage-4. We've added transforms for the latest ES2018 features where available (and even an ES2019 one!). You can also disable ava/stage-4 entirely:
The powerAssert option and command line flags have been removed. You can now disable AVA's test enhancements by setting compileEnhancements to false. You can also disable AVA's Babel pipeline entirely:
Hooks declared using test.serial will now execute serially. Only one of those hooks will run at a time. Other hooks run concurrently. Hooks still run in their declaration order.
Note that concurrent tests run concurrently. This means that .beforeEach() and .afterEach() hooks for those tests may also run concurrently, even if you use test.serial to declare them.
t.context can now be used in .before and .after hooks.
CLI
Pass flags to your test
AVA now forwards arguments, provided after an -- argument terminator, to the worker processes. Arguments are available from process.argv[2] onwards.
Previously AVA populated process.argv[2] and process.argv[3] with some undocumented internal values. These are no longer available.
Resetting AVA's cache
The --no-cache CLI flag has been replaced by a --reset-cache command. The latter resets AVA's regular cache location. You can still disable the cache through the cache configuration option.
npx ava --reset-cache
Configuration
Introducing ava.config.js
You can now configure AVA through an ava.config.js file. It must be placed next to the package.json, and you mustn't have any "ava" options in the package.json file. Export the configuration as a default:
Following our convention to use ES modules in test files, we're expecting ES modules to be used in the configuration file. If this is causing difficulties please let us know in #1820.
Configurable test & helper file extensions
You can now tell AVA to run test files with extensions other than js! For files that should be compiled using Babel you can specify babel.extensions:
Note that AVA still assumes test & helper files to be valid JavaScript. They're still precompiled to enable some AVA-specific enhancements. You can disable this behavior by specifying "compileEnhancements": false.
Snapshots
Adding new snapshots no longer causes the Markdown files to become malformed. Snapshots are now consistent across operating systems. If you've previously generated snapshots on Windows, you should update them using this release.
We now support BigInt and <React.Fragment> in t.snapshot(). We've also improved support for the Symbol.asyncIterator well-known symbol. Unfortunately these changes are not backwards compatible. You'll need to update your snapshots when upgrading to this release.
We've improved how AVA builds snapshot files to better support precompiled projects. Say, if you compile your TypeScript test files using tsc before running AVA on the build output. AVA will now use the source map to figure out the original filename and use that as the basis for the snapshot files. You'll have to manually remove snapshots generated by previous AVA versions.
Type definitions
The TypeScript and Flow definitions have been rewritten and much improved. The TypeScript recipe has been updated to reflect the changes, and there's a new Flow recipe too.
TypeScript
AVA recognizes TypeScript build errors when using ts-node/register.
TypeScript now type-checks additional arguments used by macros. You must type the arguments used:
You can now specify helpers — that need to be compiled by AVA — in the require configuration.
--fail-fast behavior has been improved. AVA now makes sure not to start new tests. Tests that are already running though will finish. Hooks will also be called. AVA now prints the number of skipped test files if an error occurs and --fail-fast is enabled.
AVA now uses its own Chalk instance, so AVA's color settings no longer impact the code you're testing.
Error serialization has been made smarter, especially if non-Error errors are encountered.
Uncaught exceptions and unhandled rejections are now shown with a code excerpt.
You should see fewer repeated test timeout messages.
Error messages now link to the documentation appropriate for the version of AVA you're using.
AVA now automatically detects whether your CI environment supports parallel builds. Each build will run a subset of all test files, while still making sure all tests get executed. See the ci-parallel-vars package for a list of supported CI environments.
AVA now detects when it's required from a Node.js REPL.
We've improved the colors for use on light terminal themes.
The assert module in Node.js 10 no longer crashes.
Source maps, generated by AVA when compiling test & helper files, now contain correct paths to the source files.
TTY support for process.stderr is now emulated in the worker processes.
The default reporter now includes files that did not declare any tests in its final output.
AVA now prints pending tests when timeouts occur, when using --verbose.
<React.Fragment> can be used in t.deepEqual.
title functions of macros now receive undefined rather than an empty string if no title was given in the test declaration. This means you can use default parameters.
Breaking changes since 0.25.0
Supported Node.js versions
We've published a statement with regards to which Node.js versions we intend to support. As of this release we're only supporting Node.js 6.12.3 or newer, 8.9.4 or newer, 10.0.0 or newer and 11.0.0 or newer. This does not include Node.js 7 and 9.
Tests must now have titles, and they must be unique
You can no longer do:
test(t=>t.pass());
Instead all tests must have titles, and they must be unique within the test file:
test('passes', t=>t.pass());
This makes it easier to pinpoint test failures and makes snapshots better too.
Note that AVA no longer infers a test title from a function name:
test(functionmyTest (t) {
t.pass();
});
Modifier chaining
AVA's various test modifiers (.serial, .skip) must now be used in the correct order:
.serial must be used at the beginning, e.g. test.serial().
.only and .skip must be used at the end, e.g. test.skip(). You cannot combine them.
.failing must be used at the end, but can be followed by .only and .skip, e.g. test.cb.failing() and test.cb.failing.only().
.always can only be used after .after and .afterEach, e.g. test.after.always().
.todo() is only available on test and test.serial. No further modifiers can be applied.
Declaring tests
You must declare all tests and hooks at once. This was always the intent but previously AVA didn't enforce it very well. Now, once you declare a test or hook, all other tests and hooks must be declared synchronously. However you can perform some asynchronous actions before declaring your tests and hooks.
test export
We're no longer exporting the test() method as a named export. Where before you could use import {test} from 'ava', you should now write import test from 'ava'.
Set default title using parameters syntax
Macros can generate a test title. Previously, AVA would call the title function with an empty string if no title was given in the test declaration. Now, it'll pass undefined instead. This means you can use default parameters. Here's an example:
This is a breaking change if you were concatenating the provided title, under the assumption that it was an empty string.
Assertions
t.throws() & t.notThrows()
Thrown exceptions (or rejection reasons) must now be error objects.
t.throws() and t.notThrows() no longer support observables or promises. For the latter, use await t.throwsAsync() and await t.notThrowsAsync() instead.
Generally speaking, you should be able to replace every occurence of await t.throws with await t.throwsAsync, and await t.notThrows with await t.notThrowsAsync. A transform file for jscodeshift is available in this Gist. Run it like:
Assertions can be skipped by using .skip at the end of the assertion, e.g. t.deepEqual.skip(). You can now safely skip snapshot tests, though not whilst updating snapshots.
t.ifError()
We've removed the t.ifError() assertion. It worked the same as t.falsy(), so if you were using it please switch to t.falsy() instead.
Configuration changes
The source option has been renamed to sources. This is now consistent with files. AVA will exit with an error if it encounters the source option.
We've also removed unintentional support for init, watch and updateSnapshot options.
Babel
The "default" and "inherit" configuration values have been removed. Babel options must now be specified in a testOptions object. This will allow us to add source related options in the future.
The powerAssert option and command line flags have been removed. You can now disable AVA's test enhancements by setting compileEnhancements to false.
The Babel recipe has been updated with the latest details.
Updated type definitions
The TypeScript and Flow definitions have been rewritten. The definitions export different interfaces so you may need to update your test code as well.
TypeScript now type-checks additional arguments used by macros. You must type the arguments used.
Internals
Some other internals have changed. You shouldn't have been relying on these, though if you did we're interested in hearing about it so we can better support your use case.
The private t._test value has been removed
Some of the communication between the main process and the test workers has changed
Access to the options object from inside a worker process has changed
Other potential breaking changes
We've removed support for @std/esm, in favor of the plain esm package.
The ava/stage-4 preset is applied after all other plugins and presets.
Test implementations are now called with null as the this value.
All reporters write to stdout. The stdout and stderroutput from workers is written to process.stderr. AVA will insert linebreaks in process.stdout after writing a chunk to process.stderrthat does not end in a line break.
The --no-cache CLI flag has been replaced by a --reset-cache command. The latter resets AVA's regular cache location. You can still disable the cache through the cache configuration option.
We've dropped support for using generator functions as test implementations. This was a remnant of the dark days before async/await support.
Snapshots need to be regenerated.
If you pre-compile your test files, the snapshot files may be created at new file paths. You'll have to manually remove any old files.
We welcome new contributors. AVA is a friendly place to get started in open source. We have a great article on getting started contributing and a comprehensive contributing guide.
Depfu will automatically keep this PR conflict-free, as long as you don't add any commits to this branch yourself. You can also trigger a rebase manually by commenting with @depfu rebase.
All Depfu comment commands
@depfu rebase
Rebases against your default branch and redoes this update
@depfu merge
Merges this PR once your tests are passing and conflicts are resolved
@depfu close
Closes this PR and deletes the branch
@depfu reopen
Restores the branch and reopens this PR (if it's closed)
@depfu pause
Ignores all future updates for this dependency and closes this PR
@depfu pause [minor|major]
Ignores all future minor/major updates for this dependency and closes this PR
@depfu resume
Future versions of this dependency will create PRs again (leaves this PR as is)
Here is everything you need to know about this upgrade. Please take a good look at what changed and the test results before merging this pull request.
What changed?
✳️ ava (0.25.0 → 2.2.0) · Repo
Release Notes
2.2.0
2.1.0
2.0.0
1.4.1
1.3.1
1.2.1
1.2.0
1.1.0
1.0.1
Does any of this look wrong? Please let us know.
Commits
See the full diff on Github. The new version differs by more commits than we can show here.
Depfu will automatically keep this PR conflict-free, as long as you don't add any commits to this branch yourself. You can also trigger a rebase manually by commenting with
@depfu rebase
.All Depfu comment commands