Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update dependency ava to v2 #5

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update dependency ava to v2 #5

wants to merge 1 commit into from

Conversation

kolkinn
Copy link
Owner

@kolkinn kolkinn commented Nov 19, 2019

This PR contains the following updates:

Package Type Update Change
ava (source) devDependencies major ^0.22.0 -> ^2.0.0

Release Notes

avajs/ava

v2.4.0

Compare Source

Experimental t.try() assertions

Thanks to the amazing work and patience of @​qlonik we're shipping a new assertion! t.try() lets you perform assertions and decide whether to commit or discard their outcome. All kinds of interesting things can be built on top of this, from fuzzy testers to new test interfaces and more.

We're excited to get this out there, but it's not quite done yet. For now you have to opt in to this new feature. Being opt-in, we may make changes (breaking ones even!) until we feel this is stable.

To opt in, configure AVA with the following:

package.json:

{
  "ava": {
    "nonSemVerExperiments": {
      "tryAssertion": true
    }
  }
}

ava.config.js:

export default {
	nonSemVerExperiments: {
		tryAssertion: true
	}
};

We'd love to hear your feedback. Please join us in this issue: #​2250

Also, if you're looking to help out with the remaining issues so that we can ship this without the opt-in, have a look at this project: https://github.com/orgs/avajs/projects/1

Thanks again @​qlonik!

Other changes

All changes

v2.3.0...v2.4.0

Thanks

Thank you @​jeremenichelli, @​jamesgeorge007, @​dongjae93, @​qlonik and @​tryzniak. We couldn't have done this 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.

v2.3.0

Compare Source

Changes

  • We've fixed some bugs to improve watch mode. ffa62ce 9e8d28f
  • AVA now prints an error when it receives non-existent test files on the command line. f01d05f
  • When using the TAP reporter, remaining tests are now included in failed test count. Failed hooks are no longer treated as test failures, and logs are printed. 8628976
  • Internal errors that may occur for some edge cases are now printed. b27cb8d
  • TTY in the worker processes should follow the new APIs in Node.js 12.7.0 (when used with those Node.js versions). 7dcb473
  • AVA now handles stage-4 syntax like dynamic import, and stage-3 syntax like BigInt, numeric separators and class properties that are supported by V8. 9baca8c
  • AVA now supports dynamic import through our stage-4 preset.
  • AVA now uses import-local@^3.0.2 which fixes issues with Lerna projects.
  • For our TypeScript users, we've changed the default type of t.context to unknown, in line with TypeScript's changes in their 3.5 release. 2fc7d56

All changes

v2.2.0...v2.3.0

Thanks

Thank you @​MarchWorks, @​yovasx2 and @​bobthekingofegypt. We couldn't have done this 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.

v2.2.0

Compare Source

Enhancements

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

All changes

v2.1.0...v2.2.0

Thanks

Thank you @​langri-sha, @​keyspress, @​cdaringe and @​okyantoro. We couldn't have done this 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.

v2.1.0

Compare Source

Bug fixes

  • AVA's TypeScript definition now explicitly references the Node.js definition bb44da7

Enhancements

  • Did you know you can provide human-readable timeout values? We've now documented this. 486acaf
  • We're now including all stack trace lines in the TAP output (though we still pre-process them). ac212ba
  • Logs from successful hooks are now included in the TAP output. 007c7af
  • Our ESLint plugin helper has been updated to allow extensions and glob patterns to be overridden b3c9ea7

All changes

v2.0.0...v2.1.0

Thanks

Thank you @​anishkny, @​yovasx2 and @​mihai-dinu. We couldn't have done this 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.

v2.0.0

Compare Source

Breaking changes

AVA now requires at least Node.js 8.9.4

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.

The files and sources options must now be arrays containing at least one pattern. It's no longer possible to override a default exclusion pattern, but we're looking at making these configurable separately.

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. 08e99e5 b1e54b1

The CLI now only takes file paths, not glob patterns.

We'd like some help updating our ESLint plugin as well.

Snapshots in CI

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

New features

Configurable printing depth

AVA now uses the util.inspect.defaultOptions.depth option when printing objects, so you can configure the depth. 98034fb

Specify environment variables in your AVA config

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

All changes

v1.4.1...v2.0.0

Thanks

Thank you @​StoneCypher, @​LukasHechenberger, @​lo1tuma, @​htor, @​alexisfontaine and @​grnch. We couldn't have done this 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.

v1.4.1

Compare Source

Focusing power-assert

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:

test('enhanced assertions', t => {
	const a = /foo/;
	const b = 'bar';
	const c = 'baz';
	t.assert(a.test(b) || b === c);
});
AVA will output:
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

All changes

v1.3.1...v1.4.1

Thanks

Thank you @​eemed, @​KompKK, @​vancouverwill, @​okyantoro and @​amokmen. We couldn't have done this 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.

v1.4.0

Compare Source

v1.3.1

Compare Source

Bug fixes

  • 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 faked clearTimeout(), 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

All changes

v1.2.1...v1.3.1

Thanks

Thank you @​itaisteinherz, @​jdalton, @​kagawagao, @​KompKK, @​SleeplessByte, @​Chrisyee22 and @​qlonik for helping us with this release. We couldn't have done this 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.

v1.3.0

Compare Source

v1.2.1

Compare Source

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

All changes 📚

v1.2.0...v1.2.1

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.

v1.2.0

Compare Source

New features

You can now set a timeout for test themselves. The test will fail if this timeout is exceeded. The timeout is reset each time an assertion is made:

test('foo', t => {
	t.timeout(100); // 100 milliseconds
	// Write your assertions here
});

b65c6d7

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

Thank you @​dflupu for your hard work on this!

Bug fixes and other improvements

  • We're no longer truncating multi-line error messages 72e0762
  • Unexpected errors in the throws assertions are now reported with the correct stack trace ad087f2
  • The Debugging with VSCode recipe has been updated with the correct workspaceFolder variable 0a5fe42 and --serial argument placement edfc005

All changes 📚

v1.1.0...v1.2.0

Thanks 💌

💖 Huge thanks to @​anishkny, @​CrispusDH, @​dflupu and @​niktekusho 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.

v1.1.0

Compare Source

New features

AVA now exports a meta object. Currently, you can retrieve the path of the test file being run:

import test from 'ava';

console.log('Test currently being run: ', test.meta.file);
import {meta} from 'ava';

console.log('Test currently being run: ', meta.file);

This is useful in helpers that need to know the test file. bccd297

Bug fixes and other improvements

  • t.log() now works in hooks d187712

  • Error output for improper usage of t.throws() once again links to the correct documentation dc552bc

  • We've added a section on webpack aliases to the Babel recipe c3bcbf2

  • We've updated the Vue recipe for Babel 7, and added a section on webpack aliases c3bcbf2

All changes 📚

v1.0.1...v1.1.0

Thanks 💌

💖 Huge thanks to @​fitztrev, @​forresst, @​astrob0t, @​pearofducks, @​coreyfarrell and @​dflupu 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.

v1.0.1

Compare Source

AVA 1.0 🚀

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.

Mark & Sindre

What's new & improved

Assertions
New t.throws() behavior & t.throwsAsync()

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:

t.throws(fn, {code: 'ENOTFOUND'}) // err.code === 'ENOTFOUND'
t.throws(fn, {code: 9}) // err.code === 9
t.throws(fn, {instanceOf: SyntaxError}) // err instanceof SyntaxError
t.throws(fn, {is: expectedErrorInstance}) // err === expectedErrorInstance
t.throws(fn, {message: 'expected error message'}) // err.message === 'expected error message'
t.throws(fn, {message: /expected error message/}) // /expected error message/.test(err.message)
t.throws(fn, {name: 'SyntaxError'}) // err.name === 'SyntaxError'

This makes tests like these much easier to write:

// Old assertion
const err = t.throws(fn, TypeError)
t.is(err.message, 'Expected a string')

// New assertion
t.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:

$ npx jscodeshift -t https://gist.githubusercontent.com/novemberborn/c2cdc94020083a1cafe3f41e8276f983/raw/eaa64c55dfcda8006fc760054055372bb3109d1c/transform.js test.js

Change test.js to a glob pattern that matches your test files. See the jscodeshift CLI usage documentation for further details.

Bound assertion methods

Assertion methods are now bound to the test, meaning you can provide them as direct arguments to other functions. A contrived example:

const assertEach = (arr, assert) => {
  arr.forEach(value => assert(value));
};

test('all are true', t => {
  assertEach(getArray(), t.true);
});

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:

package.json:

{
  "ava": {
    "babel": {
      "testOptions": {
        "presets": [
          ["ava/stage-4", false]
        ]
    }
    }
  }
}

Or, you can disable just ES module compilation:

package.json:

{
  "ava": {
    "babel": {
      "testOptions": {
        "presets": [
          ["ava/stage-4", {"modules": false}]
        ]
      }
    }
  }
}

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:

package.json:

{
  "ava": {
    "babel": false,
    "compileEnhancements": false
  }
}
Serial hooks and context

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.

npx ava test.js -- hello world

There's a new recipe on how to use this.

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:

export default {
    babel: {
        extensions: ['js', 'jsx']
    }
};

Or export a factory function:

export default ({projectDir}) => ({
    babel: {
        extensions: ['js', 'jsx']
    }    
});

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:

package.json:

{
  "ava": {
    "babel": {
      "extensions": ["js", "jsx"]
    }
  }
}

Or define generic extensions, e.g. for use with TypeScript:

package.json:

{
  "ava": {
    "compileEnhancements": false,
    "extensions": ["ts"],
    "require": [
      "ts-node/register"
    ]
  }
}

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:

import test, {Macro} from 'ava'

const failsToParse: Macro<[Buffer]> = (t, input) => {
	t.throws(parse(input))
}

failsToParse.title = (providedTitle = 'unexpected input') => `throws when parsing ${providedTitle}`

test('malformed', failsToParse, fs.readFileSync('fixtures/malformed.txt'))
test(failsToParse, '}') // ⬅️ fails to compile
Other improvements
  • 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(function myTest (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:

import test from 'ava'

const failsToParse = (t, input) => {
	t.throws(parse(input))
}

failsToParse.title = (providedTitle = 'unexpected input') => `throws when parsing ${providedTitle}`

test('malformed', failsToParse, fs.readFileSync('fixtures/malformed.txt'))
test(failsToParse, Buffer.from('}', 'utf8'))

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:

$ npx jscodeshift -t https://gist.githubusercontent.com/novemberborn/c2cdc94020083a1cafe3f41e8276f983/raw/eaa64c55dfcda8006fc760054055372bb3109d1c/transform.js test.js

Change test.js to a glob pattern that matches your test files. See the jscodeshift CLI usage documentation for further details.

Skipping assertions

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.

New recipes

There's a new recipe on using ES modules. We've also added a recipe on setting up tests and how test webapps using AVA and Puppeteer.

All changes 📚

v0.25.0...v1.0.1

Thanks 💌

💖 Huge thanks to @​okyantoro, @​JasonRitchie, @​forresst, @​mdvorscak, @​kugtong33, @​motss, @​BusbyActual, @​billyjanitsch, @​Briantmorr, @​jdalton, @​malimichael, @​martypdx, @​clemtrek, @​samuelli, @​emilyschultz, @​hallettj, @​isnifer, @​Jaden-Giordano, @​good-idea, @​jamiebuilds, @​tobil, @​TheDancingCode, @​btkostner, @​CanRau, @​coreyfarrell, @​ivanschwarz, @​jagoda, @​padmaia, @​ronen, @​sh7dm, @​sharkykh, @​Phrynobatrachus, @​grant37, @​xxczaki, @​robertbernardbrown, @​lo1tuma, @​goooseman, @​wmik, @​vancouverwill, @​qlonik, @​vlajos and @​itskolli 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.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

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

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.


Renovate configuration

📅 Schedule: At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻️ Rebasing: Whenever PR becomes conflicted, or if you modify the PR title to begin with "rebase!".

👻 Immortal: This PR will be recreated if closed unmerged. Get config help if that's undesired.


  • If you want to rebase/retry this PR, check this box

This PR has been generated by Renovate Bot.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants