Skip to content

Commit

Permalink
chore: roll to Aug 08th (microsoft#305)
Browse files Browse the repository at this point in the history
  • Loading branch information
dgozman committed Aug 18, 2021
1 parent bac7e96 commit 1f4f66b
Show file tree
Hide file tree
Showing 7 changed files with 649 additions and 142 deletions.
19 changes: 19 additions & 0 deletions nodejs/docs/api/class-teststep.mdx
Expand Up @@ -8,19 +8,28 @@ import TabItem from '@theme/TabItem';
Represents a step in the [TestRun].


- [testStep.titlePath()](./api/class-teststep.mdx#test-step-title-path)
- [testStep.category](./api/class-teststep.mdx#test-step-category)
- [testStep.duration](./api/class-teststep.mdx#test-step-duration)
- [testStep.error](./api/class-teststep.mdx#test-step-error)
- [testStep.parent](./api/class-teststep.mdx#test-step-parent)
- [testStep.startTime](./api/class-teststep.mdx#test-step-start-time)
- [testStep.steps](./api/class-teststep.mdx#test-step-steps)
- [testStep.title](./api/class-teststep.mdx#test-step-title)

## testStep.titlePath() {#test-step-title-path}
- returns:<a aria-hidden="true" tabindex="-1" class="list-anchor-link" id="test-step-title-path-return"/> &#60;[Array]<[string]>&#62;<a href="#test-step-title-path-return" class="list-anchor">#</a>

Returns a list of step titles from the root step down to this step.

## testStep.category {#test-step-category}
- type: &#60;[string]&#62;

Step category to differentiate steps with different origin and verbosity. Built-in categories are:
* `hook` for fixtures and hooks initialization and teardown
* `expect` for expect calls
* `pw:api` for Playwright API calls.
* `test.step` for test.step API calls.

## testStep.duration {#test-step-duration}
- type: &#60;[number]&#62;
Expand All @@ -32,11 +41,21 @@ Running time in milliseconds.

An error thrown during the step execution, if any.

## testStep.parent {#test-step-parent}
- type: &#60;[void]|[TestStep]&#62;

Parent step, if any.

## testStep.startTime {#test-step-start-time}
- type: &#60;[Date]&#62;

Start time of this particular test step.

## testStep.steps {#test-step-steps}
- type: &#60;[Array]<[TestStep]>&#62;

List of steps inside this step.

## testStep.title {#test-step-title}
- type: &#60;[string]&#62;

Expand Down
2 changes: 1 addition & 1 deletion nodejs/docs/test-advanced.mdx
Expand Up @@ -48,7 +48,7 @@ These options would be typically different between local development and CI oper
- `quiet: boolean` - Whether to suppress stdout and stderr from the tests.
- `reporter: 'list' | 'line' | 'dot' | 'json' | 'junit'` - The reporter to use. See [reporters](./test-reporters.mdx) for details.
- `reportSlowTests: { max: number, threshold: number } | null` - Whether to report slow tests. When `null`, slow tests are not reported. Otherwise, tests that took more than `threshold` milliseconds are reported as slow, but no more than `max` number of them. Passing zero as `max` reports all slow tests that exceed the threshold.
- `shard: { total: number, current: number } | null` - [Shard](./test-parallel.mdx#shards) information.
- `shard: { total: number, current: number } | null` - [Shard](./test-parallel.mdx#shard-tests-between-multiple-machines) information.
- `updateSnapshots: boolean` - Whether to update expected snapshots with the actual results produced by the test run.
- `workers: number` - The maximum number of concurrent worker processes to use for parallelizing tests.
- `webServer: { command: string, port: number, timeout?: number, reuseExistingServer?: boolean, cwd?: string, env?: object }` - Launch a process and wait that it's ready before the tests will start. See [launch web server](#launching-a-development-web-server-during-the-tests) configuration for examples.
Expand Down
2 changes: 1 addition & 1 deletion nodejs/docs/test-cli.mdx
Expand Up @@ -29,7 +29,7 @@ All the options are available in the [configuration file](./test-advanced.mdx).
- `--repeat-each <N>`: Run each test `N` times, defaults to one.
- `--reporter <reporter>`: Choose a reporter: minimalist `dot`, concise `line` or detailed `list`. See [reporters](./test-reporters.mdx) for more information.
- `--retries <number>`: The maximum number of [retries](./test-retries.mdx) for flaky tests, defaults to zero (no retries).
- `--shard <shard>`: [Shard](./test-parallel.mdx#shards) tests and execute only selected shard, specified in the form `current/all`, 1-based, for example `3/5`.
- `--shard <shard>`: [Shard](./test-parallel.mdx#shard-tests-between-multiple-machines) tests and execute only selected shard, specified in the form `current/all`, 1-based, for example `3/5`.
- `--timeout <number>`: Maximum timeout in milliseconds for each test, defaults to 30 seconds.
- `--update-snapshots` or `-u`: Whether to update [snapshots](./test-snapshots.mdx) with actual results instead of comparing them. Use this when snapshot expectations have changed.
- `--workers <number>` or `-j <number>`: The maximum number of concurrent worker processes that run in [parallel](./test-parallel.mdx).
Expand Down

0 comments on commit 1f4f66b

Please sign in to comment.