@proof-ui/test

Writing a test using proof is very similar to how you write your stories. Typically you'd start with:

import { proofsOf } from '@proof-ui/test';

const proofs = proofsOf('Components|Button');

Look familiar? Just like when you write your stories, you can now write a proof for that story to verify everything is working as expected.

While most of your testing will probably occur at the unit-test using react-testing-library or similar -- there's no substitution for grabbing screenshots and running some testing in the browser (especially when you're responsible for supporting some of the more annoying browsers).

Writing a test

Adding a proof is very similar to adding a story. In the callback function, instead of returning a react component, you're given a browser object to interact with the page.

import { proofsOf } from '@proof-ui/test';

const proofs = proofsOf('Components|Button');

proofs.add('Simple', ({ browser }) => {});

API

The test callback function is passed the following:

| name | type | | -------- | --------------------------------------- | | browser | A webdriverio browser | | story | string | | kind | string |

Alternative API

To enable finer control of testing, you can also use the generic version of the test api:

import test from '@proof-ui/test';

test({ kind: 'Components|Button', story: 'Simple' }, ({ browser }) => {});

The test api accepts a filter for what stories to run the test on. It can filter on both the kind or story name -- using the same callback API as the proofsOf version.

If no story is provided, all stories under that kind are executed. Similarly, if neither a story or kind are provided, the test runs against every story in your storybook.