thunderstrike/puppeteer
thunderstrike/puppeteer
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(contributing): update testing section (#5657)

Browse Source 
This was missed in the Mocha migration.

The options I've removed from the docs were removed from the code; I didn't think it worth implementing them in Mocha land until we definitely needed them. So shout if you miss any of the options!

Co-authored-by: Mathias Bynens <mathias@qiwi.be>
This commit is contained in:
Jack Franklin 2020-04-17 10:33:47 +01:00 committed by GitHub
parent 1a57ba22a8
commit 49ca00f16a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
CONTRIBUTING.md
View File

@ -171,12 +171,11 @@ npm run unit -- --verbose
npm run unit -- --break-on-failure npm run unit -- --break-on-failure
``` ```
- To run a specific test, substitute the `it` with `fit` (mnemonic rule: '*focus it*'): - To run a specific test, substitute the `it` with `it.only`:
```js ```js
... ...
// Using "fit" to run specific test it.only('should work', async function({server, page}) {
fit('should work', async function({server, page}) {
const response = await page.goto(server.EMPTY_PAGE); const response = await page.goto(server.EMPTY_PAGE);
expect(response.ok).toBe(true); expect(response.ok).toBe(true);
}); });
@ -205,25 +204,6 @@ HEADLESS=false npm run unit
BINARY=<path-to-executable> npm run unit BINARY=<path-to-executable> npm run unit
``` ```
- To run tests in slow-mode:
```bash
HEADLESS=false SLOW_MO=500 npm run unit
```
- To run tests with additional Launcher options:
```bash
EXTRA_LAUNCH_OPTIONS='{"args": ["--user-data-dir=some/path"], "handleSIGINT": true}' npm run unit
```
- To debug a test, "focus" a test first and then run:
```bash
node --inspect-brk test/test.js
```
## Public API Coverage ## Public API Coverage
Every public API method or event should be called at least once in tests. To ensure this, there's a `coverage` command which tracks calls to public API and reports back if some methods/events were not called. Every public API method or event should be called at least once in tests. To ensure this, there's a `coverage` command which tracks calls to public API and reports back if some methods/events were not called.