v0.25.0: 0.25.0

Compare Source

Another small release while we're gearing up for a 1.0 built with Babel 7. This is likely to be the last 0. release, but we may go through a few beta releases for 1.0 whilst we wait for Babel 7 to get out of beta itself.

• We now detect @std/esm in AVA's "require" configuration and will use it to require subsequent modules 72c53be
• t.log() now supports multiple arguments 4f896c2
• AVA no longer globally modifies Error.stackTraceLimit in the worker processes f00f3c4
• We've improved TypeScript typings for t.snapshot(value, options) 29e5dfd
• Source maps for the test files can now be resolved if they reside on a different drive aaddc37
• Code excerpts shown for test failures now handle Windows-style linebreaks 947f207
• We've updated the Debugging tests with Visual Studio Code recipe with tips on serial debugging and skipping dependencies 4a13966 bcb77fc

All changes 📚

v0.24.0...v0.25.0

Thanks 💌

💖 Huge thanks to @​ppatel221, @​cdaringe, @​jy95, @​jamestalmage, @​okyantoro, @​ajafff, @​niftylettuce, @​kugtong33, @​troysandal, @​willnode and @​forresst for helping us with this release. We couldn’t have done it without you!

Get involved ✌️

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.

v0.24.0: 0.24.0

Compare Source

Highlights 💡

This is a pretty small release, but a great one if you're solely developing for Node.js 8.3 or above.

You can now use object rest/spread properties in test files without any further Babel configuration. Note that if you're running tests on older versions of Node.js you'll still need to add the relevant Babel plugins, since this new language feature has not yet reached stage 4. 37c9122

Miscellaneous 🕯

• Before and after hooks are no longer run when all tests are skipped 1cd3a04
• Improved output of assertion statements when tests fail 37e8b49
• Improved feedback when t.is() values are deeply equal but not the same c41b2af
• Updated the Typescript with an example of how to title macros f98a881

All changes 📚

v0.23.0...v0.24.0

Thanks 💌

💖 Huge thanks to @​jedmao, @​Lifeuser, @​mightyiam, @​ahmadawais and @​codeslikejaggars for helping us with this release. We couldn’t have done it without you!

Get involved ✌️

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.

v0.23.0: 0.23.0

Compare Source

Highlights 🕴

NODE_ENV=test ✨

AVA will now set process.env.NODE_ENV to 'test', as long as the NODE_ENV environment variable has not already been set. 42e7c74

Improved snapshot storage location 🗃

Snapshots are stored alongside your test files. This is great when your test file is executed directly but say if you're using TypeScript to precompile your test file AVA would store the snapshots in your build directory. In this release, if source maps are available, AVA determines the original test file location and uses that to store the snapshots.

You can also specify where snapshots are stored through the snapshotDir option in the package.json file. 7fadc34

Matching anonymous tests 🕵️

--match='*' now matches all tests, including those without a title. 1df502d

Miscellaneous 🎒

• The verbose logger now only displays the timestamp when in watch mode 1ea758f
• Anonymous functions are now included in stack traces c72f4f2
• Concurrency is now capped at 2 in CI environments 3f81fc4
• AVA no longer calls Bluebird.longStackTraces(). If you're using Bluebird you may want to call this yourself using a require script. ebf78b3 61101d9
• There's a new recipe for endpoint testing using Mongoose c9fe8db
• The browser testing recipe has been updated with an example of exposing global variables, such as jQuery f43d5ae
• t.log() is now supported in the Flow and TypeScript type definitions 64b7755
• t.title is now supported in the TypeScript type definitions 3c8b1be
• t.snapshot() now has a better Flow type definition ded7ab8

All changes 🛋

v0.22.0...v0.23.0

Thanks 💌

💖 Huge thanks to @​anshulwadhawan, @​mliou8, @​dehbmarques, @​forivall, @​forresst, @​Couto, @​impaler, @​kristianmandrup, @​lukechilds, @​neoeno, @​jugglinmike, @​P-Seebauer, @​philippotto, @​ptim, @​rhendric, @​ntwb, @​tdeschryver, @​timothyjellison and @​zellwk for helping us with this release. We couldn’t have done it without you!

Get involved ✌️

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.

v0.22.0: 0.22.0

Compare Source

There's but a few commits in this release, but we've made a big change to how AVA manages its test workers 👩🏼‍🔬👨🏼‍🏭👨🏿‍🚀👨🏻‍⚕️👩🏽‍💼.

Highlights

Default concurrency

We now cap the number of concurrent workers to the number of CPU cores on your machine. Previously AVA started workers for each test file, so if you had many test files this could actually bring things to a halt. 465fcec

You can still customize the concurrency by setting the concurrency option in AVA's package.json configuration, or by passing the --concurrency flag. We've also beefed up input validation on that flag. b6eef5a

Unfortunately this does change how test.only() behaves. AVA can no longer guarantee that normal tests won't run. For now, if you want to use test.only(), you should run tests from just that file. We have an open issue to add an --only flag, which will ensure that AVA runs just the test.only() tests. If you'd like to help us with that please head on over to #​1472.

t.log()

We've also added t.log(), which lets you print a log message contextually alongside the test result, instead of immediately printing it to stdout like console.log. 14f7095

Miscellaneous

• The WebStorm recipe has been updated with instructions on how to enable the Node.js inspector. d8c21a6
• The app setup in the endpoint testing recipe has been fixed e28be05
• The t.notThrows() example has been clarified 57f5007

All changes

v0.21.0...v0.22.0

Thanks

💖 Huge thanks to @​abouthiroppy, @​ydaniv, @​nowells, @​melisoner2006, @​clayzermk1 and @​tdeschryver for helping us with this release. We couldn’t have done it without you!

Get involved

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.

v0.21.0: 0.21.0

Compare Source

This is primarily a bug fix release, but some features did sneak in:

• Additional arguments can be passed when profiling 05bfafe
• Though not officially supported, AVA now works better with Wallaby.js’ diff view 3f6e134
• Expanded the Webstorm recipe to include setup instructions using npm 2b4e35d

This release includes the following patches:

• Fixes for t.deepEqual() and magic assert diffs 9e4ee3f
• Ensure AVA doesn’t use Buffer APIs that are unavailable in Node.js releases older than 4.5 d0fc8c9
• Changed Flow typing of the t.throws() promise return value to be any 4a769f8
• Update Flow typing of test() so macros are compatible with the latest flow-bin e794e73

Thanks

💖 Huge thanks to @​wprater, @​HippoDippo, @​roperzh, @​ArtemGovorov, @​dancoates, @​suchmaske, @​ajtorres9 and @​guillaumevincent for helping us with this release. We couldn’t have done it without you!

Get involved

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.

v0.20.0: 0.20.0

Compare Source

Today’s release is very exciting. After adding magic assert and snapshot testing we found that these features sometimes disagreed with each other. t.deepEqual() would return false, yet AVA wouldn’t show a diff. Snapshot tests cared about Set order but t.deepEqual() didn’t. @​novemberborn came to the realization that comparing and diffing object trees, and doing so over time with snapshots, are variations on the same problem. Thus he started ConcordanceJS, a new project that lets you compare, format, diff and serialize any JavaScript value. This AVA release reaps the fruits of his labor.

Highlights

More magical asserts

Magic assert will now always show the difference between actual and expected values. If an unexpected error occurs it’ll print all (enumerable) properties of the error which can make it easier to debug your program.

More details of an object are printed, like the constructor name and the string tag. Buffers are hex-encoded with line breaks so they’re easy to read:

t.deepEqual() improvements

t.deepEqual() and t.notDeepEqual() now use concordance, rather than lodash.isequal. This changes what values AVA considers to be equal, making the t.deepEqual() assertion more predictable. You can now trust that all aspects of your objects are compared.

Object wrappers are no longer equal. The following assertion will now fail:

t.deepEqual(Object(1), 1); // fails

For Map and Set objects to be equal, their elements must now be in the same order:

const actual = new Set(['hello', 'world']);
t.deepEqual(actual, new Set(['hello', 'world'])); // passes
t.deepEqual(actual, new Set(['world', 'hello']) // fails

With this release AVA will compare all enumerable properties of an object. For an array this means that the comparison considers not just the array elements. The following are no longer considered equal:

const actual = [1, 2, 3];
const expected = [1, 2, 3];
expected.also = 'a property';
t.deepEqual(actual, expected); // fails

The same goes for Map and Set objects, errors, and so forth:

const actual = new TypeError('Bad value');
const expected = new TypeError('Bad value');
expected.value = 41;
t.deepEqual(actual, expected); // fails

You used to be able to compare Arguments object to an object literal:

const args = (function() { return arguments; })('hello', 'world');
t.deepEqual(args, {0: 'hello', 1: 'world'}); // now fails

Instead you must now use:

const args = (function() { return arguments; })('hello', 'world');
t.deepEqual(args, ['hello', 'world']); // passes

(Of course you can still compare Arguments objects to each other.)

New in this release is the ability to compare React elements:

t.deepEqual(<HelloWorld/>, <HelloWorld/>);

const renderer = require('react-test-renderer');
t.deepEqual(renderer.create(<HelloWorld/>).toJSON(), <h1>Hello World</h1>);

Snapshot improvements

Snapshots too now use concordance. This means values are compared with the snapshot according to the same rules as t.deepEqual(), albeit with some minor differences:

• Argument objects can only be compared to Argument objects
• Functions are compared by name and other enumerable properties
• Promises are compared by their constructor and additional enumerable properties
• Symbols are compared by their string serialization. Registered and well-known symbols will never equal symbols with similar descriptions

Note that Node.js versions before 6.5 cannot infer names of all functions . AVA will pass a snapshot assertion if it determines the name information is unreliable.

AVA now saves two files when snapshotting. One, ending in the .snap extension, contains a compressed serialization of the expected value. The other is a readable Markdown file that contains the snapshot report. You should commit both to source control. The report file can be used to see what is in your snapshots and to compare snapshot changes over time.

Try it out with our snapshot example! Or check out an example snapshot report.

The snapshot file location now follows your test layout. If you use a test folder, they’ll be placed in test/snapshots. With __tests__ they’ll be placed in __tests__/__snapshots__. And if you just have a test.js in your project root the snapshot files will be written to test.js.snap and test.js.md. You may have to manually remove old snapshot files after installing this new AVA version. ebd572a

Improved snapshot support in watch mode

In watch mode, AVA now watches for changes to snapshot files. This is handy when you revert changes while the watcher is running. Snapshot files are correctly tracked as test dependencies, so the right tests are rerun. Typing u, followed by Enter updates the snapshots in the tests that just ran. (And the watcher won’t rerun tests when snapshots are updated.) 87eef84 dbc78dc f507e36 50b60a1

Node.js 8 support

AVA 0.19 already worked great with Node.js 8, and we’ve made it even better by removing unnecessary Babel transpilations in our stage-4 preset. We’re now also forwarding the --inspect-brk flag for debugging purposes. e456951 a868b02

New and improved recipes

We’ve added new recipes and improved others:

• Learn how to debug tests with Visual Studio Code 1d04153 140c0e0
• Test MongoDB integrations with per-test isolation 970872c
• Using AVA with Vue.js ff3bba9
• There’s several ways of using webpack to precompile tests and sources. We’ve broken down the pros and cons f228401
• We’ve added a note to the browser testing recipe, discouraging the use of browser-env c01ac05

Miscellaneous

• Specifying --concurrency without a value now causes AVA to exit with an error 8c35a1a
• Using t.throws() with a resolved promise now prints a helpful error message dfca2d9
• The t.title accessor has been documented. 549e99b

All changes

v0.19.1...v0.20.0

Thanks

💖 Huge thanks to @​lukechilds, @​alexrussell, @​zs-zs, @​cncolder, @​JPeer264, @​CImrie, @​blake-newman, @​yatharthk, @​bfred-it, @​tdeschryver, @​sudo-suhas, @​dohomi, @​efegurkan and @​forresst for helping us with this release. We couldn’t have done it without you!

Get involved

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.

v0.19.1: 0.19.1

Compare Source

A bugfix release. See 0.19.0 for full release notes.

• Prevent MaxListenersExceededWarning from being emitted if a test file contains more than 10 tests d27bc8f
• Fix t.end() not being available in the TypeScript definition for callback tests bd81ef4
• Fix t.context not being available in the Flow definition for beforeEach() and afterEach() hooks d169f0e

v0.19.0: 0.19.0

Compare Source

Since our last minor release, @​novemberborn has worked tirelessly on refactoring big parts of the codebase to be more correct and readable, while squashing many bugs. We've also added multiple detections that will prevent user mistakes.

Highlights

Working snapshots

We released snapshot support with v0.18.0, but unfortunately it didn’t work. That’s fixed now. Since we’re using jest-snapshot the output will look a little different from AVA’s other assertions. Most notably the output will not be colored.

57fd051

Tests fail if no assertions are run (BREAKING)

Sometimes you write a test that accidentally passes, because your assertion was never run. For example, the following test passes if getAnimals() returns an empty array:

test('unicorn', t => {
  for (const animal of getAnimals()) {
    t.is(animal, 'unicorn');
  }
});

AVA now fails your test if no assertions were run. This can be a problem if you use third-party assertion libraries, since AVA cannot detect when those assertions pass. You can disable this behavior by setting the failWithoutAssertions option to false in AVA's package.json configuration.

3a4553c

Improved t.throws() and t.notThrows() assertions (BREAKING)

Various improvements have been made to these assertions. Unfortunately this does include some breaking changes.

Calling these assertions with an observable or promise makes them asynchronous. You now need to await them:

const promise = Promise.reject(new TypeError('🦄'));

test('rejects', async t => {
  await t.throws(promise);
});

Previously, these would return a promise that was rejected if the assertion failed. This leaked AVA’s internal assertion error. Now they’ll fulfill their returned promise with undefined instead (d56db75). You typically won’t notice this in your test.

We’ve improved how we detect when t.throws() and t.notThrows() are used incorrectly (d924045). This might be when, rather than passing a function, you call it:

test('throws', t => {
  t.throws(throwingFunction());
});

You can now use await and yield in the argument expressions (e.g. t.throws(await createThrowingFunction()). The instructions on how to use these assertions correctly are now shown with the test failure, instead of being written to the console as your tests run.

Incorrectly using these assertions now always causes your test to fail.

Stack traces are now correct, even if used asynchronously (f6a42ba). The error messages have been improved for when t.throws() fails to encounter an error, or if t.notThrows() does (4463f38). If t.notThrows() fails, the encountered error is shown (22c93ed).

Improved magic assert output

Actual and/or expected values are now included in the magic assert output, with helpful labels that are relevant to the failing assertion.

4f87f32

Detect hanging tests

AVA can now detect when an asynchronous test is hanging (880e87e).

Note that this may not work if your code is listening on a socket or is using a timer or interval.

Better Babel option resolution

We’re now resolving Babel options ahead of time, using hullabaloo-config-manager. This fixes long-standing issues with relative paths in AVA’s "babel" options in package.json files (#​707). It also means we’re better at recompiling test and helper files if your Babel config changes or you update plugins or presets.

0464b14

Miscellaneous

• There is a new recipe for precompiling source files with webpack. a49f66b
• You can now type the test context when using TypeScript. 50ad213
• The color of text diff output has been fixed. 9f2ff09
• Text diffs are now faster. bd5ed60
• Values are no longer highlighted if colors are disabled. b581983
• AVA no longer crashes if tests fail with non-errors. 157ef25
• YAML blocks in the TAP output have been improved. 3279336
• We’re now printing assertion statements with less depth. 0510d80
• Arguments to t.regex() and t.notRegex() are now validated. f062981

All changes

v0.18.2…v0.19.0

Thanks

💖 Huge thanks to @​Wp1987, @​lukechilds, @​jakwuh, @​danny-andrews, @​mmkal, @​yatharthk, @​klauscfhq, @​screendriver, @​jhnns, @​danez and @​florianb for helping us with this release. We couldn’t have done it without you!

Get involved

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.

v0.18.2: 0.18.2

Compare Source

Many bug fixes for snapshot testing, magic assert, and the type definitions: avajs/ava@v0.18.1...v0.18.2

v0.18.1: 0.18.1

Compare Source

Quick bug fix: Remove t.is and t.not from enhanced assertion patterns to provide correct output on assertion failure.

v0.18.0: 0.18.0

Compare Source

This release is one of the biggest, most feature-packed release we’ve had in a long time. We have prepared lots of tasty things for you - snapshot testing, magic assert, precompiling test helpers, improvements to Babel transpilation, and more. Our team and contributors have been working hard to deliver all this goodness. We can’t wait to hear your feedback and don’t hesitate to suggest new ideas and report bugs!

Highlights

Dropped support for Node.js 0.10 and 0.12

As mentioned in the 0.17.0 release notes, we’re dropping support for Node.js 0.10 and 0.12 in this release. They’re both out of maintenance mode. Time to upgrade!

Magic assert

We completely overhauled the error output to make it as easy and fast as possible to detect the source of the failure. Magic assert, as we call it internally, adds code excerpts and clean diffs for actual and expected values. If values in the assertion are objects or arrays, only a difference is displayed to remove the noise and focus on the problem. Oh, and the diff is syntax-highlighted too! If you are comparing strings, both single and multi line, AVA displays a different kind of output, highlighting the added or missing characters. Last but not least, you don’t have to update any of your tests to take advantage of this! Third-party assertion libraries, like expect, chai and others, are supported out-of-the-box as well.

c9e6e6f

Snapshot testing

We now have snapshot testing, thanks to @​lithin ✨

Snapshot testing simply saves a stringified state of some data structure and compares it on the next run. It was popularized with React component testing, but you can use it with anything that can be stringified. For example, ensuring API responses stay the same.
ee65b6d

Precompile helper files

Previously, AVA transpiled your test files, but not your test helpers. Now we transpile helper files too! Helpers are files starting with _ or any files in a helpers directory inside the test directory. These are usually used for utilities and shared logic between test files.
410cb8d

Improving language support

We’ve come up with a specification for how AVA handles Babel projects and may better support other languages like TypeScript. Customizing transpilation of test and helper files will be easier, and AVA will start transpiling source files too. We’ve started work on this, but there are no user-facing changes yet.
076eb81

Miscellaneous

• Removed deprecated assertions (t.ok, t.notOk, t.same, t.notSame). If you haven’t migrated yet, you can do so automagically with our codemod. c010fd7
• Removed the --source flag. Use the package.json config instead. 34bebc4
• Support symlinked test files. 033d4dc
• No longer using babel-runtime. Built-ins like Map and Promise are no longer replaced with polyfills. ad5122d
• Prints a warning when test.only() is used, so you don’t mistakenly think you’re running all the tests. 22a6081
• Prints a warning when --fail-fast is enabled, so you’re aware AVA didn’t run all your tests. 09d23f5
• Exits with an error when --watch is used in CI, as otherwise the process would never exit, since watch mode is persistent. 0606ff7
• Only transpile what’s needed on Node.js 6. We already did that for Node.js 4. 5158ac8
• Flow type definition improvements: ce42fcb 314f7a0
• TypeScript type definition improvement: 0603edc

All changes

Thanks

💖 Huge thanks to @​lithin, @​ThomasBem, @​leebyron, @​rnkdev, @​sebald, @​gconaty, @​jarlehansen, @​LasaleFamine, @​asafigan, for helping us with this release. We couldn’t have done it without you!

Get involved

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.

v0.17.0: 0.17.0

Compare Source

The current working directory in test files changed (BREAKING)

We made the hard decision of changing the current working directory (process.cwd()) in test files to be the same directory as package.json. It was previously the same as __dirname (the directory of the test file). Having process.cwd() equal __dirname felt like a good idea at the time, but as the popularity of AVA grew, people started hitting issues with it.

This affects users that have test files in a sub-folder and are using relative paths. If you have your test files in the same directory as package.json, you're fine.

The fix is to wrap all relative paths in path.join(__dirname, 'relative-path') to make them absolute.

Here's an example of what needs changing. The below file and unicorn.txt are both in ./test/.

-t.true(fs.existsSync('unicorn.txt'));
+t.true(fs.existsSync(path.join(__dirname, 'unicorn.txt')));

Let us know if anything is unclear or if you're having problems.

Commit: 476c653

Node.js version support

The next minor version of AVA, 0.18.0, will drop support for Node.js v0.10 and v0.12. We'll continue fixing critical issues for this version until the end of the year. Time to upgrade if you haven't. (Discussion: #​1051)

Highlights

• We now have a script to automatically migrate from tape to AVA.
• Our ESLint plugin received two new rules:
  • avajs/eslint-plugin-ava@7cfdf34
  • avajs/eslint-plugin-ava@a443d7a
• Reduced transpilation on Node.js >=4. AVA now only transpiles what's needed for Node.js 4 when on it or higher, which should result in better performance and stacktraces. 4025d81
• Removed the --require CLI flag. Configure it in package.json instead. 17119bc
• Switched to lodash.isEqual for deep equality checking (t.deepEqual() & t.notDeepEqual()). This might make your test fail if our previous deep equality check was too loose. 8856684
• Improvements to the test failure output. e4f90e0 (We're currently working on many more improvements in this area. Stay tuned.)
• Added option to disable power-assert. 24a38ac
• Correctly clean up stacktraces on Node.js 6 and higher. 26bcab0
• Removed t.doesNotThrow() as it was renamed to t.notThrows(). It was deprecated far back in AVA 0.12.0. e448798
• Deprecated t.error() alias for t.ifError(). It will be removed in AVA 1.0.0. Just use t.ifError(). 28bb0d5 (We have an automatic migration script if you're using t.error())
• Ensures test files load correct AVA installation. This means you can now run AVA with an absolute path and it will still use the local AVA installation at that path if available. 3ea2ba1
• Added support for debugging tests with WebStorm and added a recipe. c268c8d
• Added Flow type defintion. 6458454
• Improvements to the TypeScript type definition. 4baa170 8816faf c40477a
• We started exploring browser support. 204f2be

All Changes