@fast-check/ava

!fast-check logo

Bring the power of property based testing framework fast-check into AVA.
@fast-check/ava simplifies the integration of fast-check into AVA testing framework.

---

Getting Started

Install @fast-check/ava:

``bash
npm install --save-dev @fast-check/ava
`

In order to work properly, @fast-check/ava requires ava to be installed.

Example

`typescript
import { testProp, fc } from '@fast-check/ava';

// for all a, b, c strings
// b is a substring of a + b + c
testProp('should detect the substring', [fc.string(), fc.string(), fc.string()], (t, a, b, c) => {
t.true((a + b + c).includes(b));
});
`

The property is passed AVA's t argument as its first parameter, and the value of each arbitrary for the current test case for the rest of the parameters.

@fast-check/ava supports all of AVA's assertions and like AVA, it supports synchronous and asynchronous functions, including promises, observables, and callbacks. See AVA's documentation for more information.

⚠️ WARNING: When relying on @fast-check/ava, returning true or false in your predicates is not taken into account. The library wants assertions or plans to be defined as ava itself does. Nonetheless you can still use primitives such as fc.pre to cut runs at the middle if some invariants are unmeet: the started plan (if any) will just be ignored.

Advanced

$3

testProp accepts an optional fc.Parameters for forwarding custom parameters to fast-check (more).

`typescript
import { testProp, fc } from '@fast-check/ava';

testProp(
'should detect the substring',
[fc.string(), fc.string(), fc.string()],
(t, a, b, c) => {
t.true((a + b + c).includes(b));
},
{ numRuns: 10 }, // Example of parameters
);
`

$3

@fast-check/ava also comes with [.only], [.serial] [.skip], and [.failing] modifiers from AVA.

`typescript
import { testProp, fc } from '@fast-check/ava';

testProp(
'should replay the test for the seed 4242',
[fc.nat(), fc.nat()],
(t, a, b) => {
t.is(a + b, b + a);
},
{ seed: 4242 },
);

testProp.skip('should be skipped', [fc.string()], (t, text) => {
t.is([...text].length, text.length);
});
`

[.only]: https://github.com/avajs/ava/blob/main/docs/01-writing-tests.md#running-specific-tests
[.serial]: https://github.com/avajs/ava/blob/main/docs/01-writing-tests.md#running-tests-serially
[.skip]: https://github.com/avajs/ava/blob/main/docs/01-writing-tests.md#skipping-tests
[.failing]: https://github.com/avajs/ava/blob/main/docs/01-writing-tests.md#failing-tests

$3

@fast-check/ava exposes AVA's before/after [hooks]:

`typescript
import { testProp, fc } from '@fast-check/ava';

testProp.before((t) => {
connectToDatabase();
});

testProp();
// ... omitted for brevity

testProp.after((t) => {
closeDatabaseConnection();
});
`

[hooks]: https://github.com/avajs/ava/blob/main/docs/01-writing-tests.md#before--after-hooks

$3

@fast-check/ava mirror's AVA's procedure for customizing the test [execution context]:

`typescript
import { fc, testProp as anyTestProp, PropertyTestInterface } from '@fast-check/ava';

type TestContext = {
state: string;
};

const testProp = anyTestProp as PropertyTestInterface;

testProp('should reach terminal state', [fc.string()], (t, received) => {
// here t is typed as ExecutionContext
console.log(t.context.state); // logs 'uninitialized'
// ... omitted for brevity
});
``

[execution context]: https://github.com/avajs/ava/blob/main/docs/02-execution-context.md

Minimal requirements

| @fast-check/ava | AVA | fast-check | node |
| --------------- | ------------------ | ---------- | ---------------------- |
| 2.0 | ^4 \|\| ^5 \|\| ^6 | ^3 \|\| ^4 | ≥12.22.0⁽¹⁾ |
| 1.0 | ^4 \|\| ^5 \|\| ^6 | ^3 | ≥12.22.0⁽¹⁾ |