Open greenkeeper[bot] opened 6 years ago
Merging #43 into master will not change coverage. The diff coverage is
n/a
.
@@ Coverage Diff @@
## master #43 +/- ##
=======================================
Coverage 97.14% 97.14%
=======================================
Files 1 1
Lines 35 35
=======================================
Hits 34 34
Misses 1 1
Continue to review full report at Codecov.
Legend - Click here to learn more
ฮ = absolute <relative> (impact)
,รธ = not affected
,? = missing data
Powered by Codecov. Last update 63d2e9b...bef37f4. Read the comment docs.
devDependency
ava was updated from 0.24.0
to 1.0.1
.Update to this version instead ๐
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.
t.throws()
behavior & t.throwsAsync()
We've rewritten t.throws()
so it behaves better, has better error output and lets you write better tests:
You have a few ways of asserting that the exception is as designed. You can pass a second argument:
message
should be equal to it.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.
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.
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.
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
}
}
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.
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.
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
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.
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
.
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.
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.
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
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.ci-parallel-vars
package for a list of supported CI environments.assert
module in Node.js 10 no longer crashes.process.stderr
is now emulated in the worker processes.--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.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.
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();
});
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.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
exportWe'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'
.
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.
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.
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.
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.
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.
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.
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.
t._test
value has been removed@std/esm
, in favor of the plain esm
package.ava/stage-4
preset is applied after all other plugins and presets.null
as the this
value.stdout
. The stdout
and stderr
output from workers is written to process.stderr
. AVA will insert linebreaks in process.stdout
after writing a chunk to process.stderr
that does not end in a line break.--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.async
/await
support.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.
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.
The new version differs by 218 commits.
783944f
1.0.1
024bab7
1.0.0
aac41dc
Reword introduction
84d8fff
Bump dependencies & update documentation
c1364a1
Update the tagline and readme intro (#1983)
eed2e7a
Clarify that not all configuration options can be overridden by CLI flags
93e91c9
Fix 'sources' option in configuration docs
3bc80b0
Remove moot ESLint disable comment
311c197
Fix snapshot skip interface
0e82b04
1.0.0-rc.2
f97e277
Bump dependencies
6f54db8
Type additional arguments used by macros
a82fee5
Documentation updates
afe028a
CI updates
1ba31d8
Reorganize documentation
There are 218 commits in total.
See the full diff
devDependency
ava was updated from 0.24.0
to 1.1.0
.Update to this version instead ๐
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
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
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.
The new version differs by 9 commits.
a28094a
1.1.0
7262a78
Bump dependencies
d187712
Fix t.log() in hooks
bccd297
Expose test file path within worker process
c3bcbf2
Improve Babel and Vue recipes
dc552bc
Update link to t.throws()
assertion in AVA output
f4b2d19
Fix links to French translation of docs (#2005)
2e72fe7
Fix npm install command in readme (#2001)
7b6e578
Use newer ES syntax where possible
See the full diff
devDependency
ava was updated from 0.24.0
to 1.2.0
.Update to this version instead ๐
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
});
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!
workspaceFolder
variable 0a5fe42 and --serial
argument placement edfc005We 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.
The new version differs by 11 commits.
010914b
1.2.0
ad087f2
Fix stack traces in throw assertions
8ad5efd
Bump dependencies
2b60556
Print pending tests on interrupt, and on timeout in mini reporter
0a5fe42
Change deprecated workspaceRoot variable to the equivalent workspaceFolder
b65c6d7
Add t.timeout()
ed7807e
Linter fixes
f0a07cd
Rely on npm 6.6.0
6b10f2e
Bump XO and fix some lint issues
72e0762
Fix accidental truncation of multi-line error messages
edfc005
Fix profile.js example
See the full diff
devDependency
ava was updated from 0.24.0
to 1.2.1
.Update to this version instead ๐
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.
Version 0.25.0 of ava was just published.
The version 0.25.0 is not covered by your current version range.
If you donโt accept this pull request, your project will work just like it did before. However, you might be missing out on a bunch of new features, fixes and/or performance improvements from the dependency update.
It might be worth looking into these changes and trying to get this project onto the latest version of ava.
If you have a solid test suite and good coverage, a passing build is a strong indicator that you can take advantage of these changes directly by merging the proposed change into your project. If the build fails or you donโt have such unconditional trust in your tests, this branch is a great starting point for you to work on the update.
Commits
The new version differs by 15 commits.
a051d3e
0.25.0
4f896c2
Make
t.log()
behave more likeconsole.log()
f00f3c4
Don't set
Error.stackTraceLimit
in worker processesc2b42ec
Mention #1319 as a pitfall
bcb77fc
Recommend skipFiles for VSCode debugging
cd8c91b
Add more clarification for different Babel config in .babelrc.md (#1642)
947f207
Update code-excerpt to ^2.1.1
4a13966
Debug serially in the "Debugging tests with VS Code" recipe (#1634)
aaddc37
Use absolute source map paths in precompiled files
72c53be
support @std/esm (#1618)
29e5dfd
Add TS types for t.snapshot(content, options)
c1faf95
Fix typo in precompiling-with-webpack.md (#1625)
4e8f827
Switch time-require to @ladjs/time-require
965cbc6
Use supertap to generate TAP output (#1610)
4124d77
Update npm, test Node.js 9, detect package-lock churn in CI (#1601)
See the full diff
FAQ and help
There is a collection of [frequently asked questions](https://greenkeeper.io/faq.html). If those donโt help, you can always [ask the humans behind Greenkeeper](https://github.com/greenkeeperio/greenkeeper/issues/new).Your Greenkeeper bot :palm_tree: