Skip to content

Commit

Permalink
postmerge: setup and teardown docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mishushakov committed Jun 22, 2024
1 parent a695d97 commit 5eea95c
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions docs/.vitepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,11 @@ export default {
{ text: 'Introduction', link: '/' },
{ text: 'Getting Started', link: '/guides/getting-started' },
{ text: 'Concepts', link: '/guides/concepts' },
{ text: 'Running setup and teardown steps', link: '/guides/setup-teardown' },
{ text: 'Testing HTTP APIs', link: '/guides/testing-http' },
{ text: 'Testing GraphQL APIs', link: '/guides/testing-graphql' },
{ text: 'Testing SOAP APIs', link: '/guides/testing-soap' },
{ text: 'Testing tRPC APIs', link: '/guides/testing-trpc' },
{ text: 'Testing ChatGPT <span class="badge-new">New</span>', link: '/guides/testing-gpt' },
{ text: 'Testing ChatGPT', link: '/guides/testing-gpt' },
{ text: 'Using Fake Data', link: '/guides/using-fake-data' },
{ text: 'Using Proxies <span class="badge-new">New</span>', link: '/guides/using-proxy' },
{ text: 'Fuzz Testing', link: '/guides/fuzz-testing' },
Expand All @@ -54,6 +53,7 @@ export default {
{ text: 'Testing gRPC APIs', link: '/guides/testing-grpc' },
{ text: 'Testing SSE APIs', link: '/guides/testing-sse' },
{ text: 'Using Test Data', link: '/guides/using-test-data' },
{ text: 'Setup and Teardown <span class="badge-new">New</span>', link: '/guides/setup-teardown' },
{ text: 'SSL-Testing', link: '/guides/ssl-testing' },
{ text: 'Performance Testing', link: '/guides/performance-testing' },
{ text: 'Load Testing', link: '/guides/load-testing' },
Expand Down
8 changes: 4 additions & 4 deletions docs/guides/setup-teardown.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Running setup and teardown steps
# Setup and Teardown steps

The [`before`] and [`after`] sections are optional top level sections that can be used to run steps before or after the [`tests`] section has run. These sections can be useful to set up or tear down test data.
The `before` and `after` sections are optional top level sections that can be used to run steps before or after the `tests` section has run. These sections can be useful to set up or tear down test data.

Any variable [captured][captures] in the [`before`] section will be available in the [`tests`] and [`after`] sections. However, since variables captured in individual tests are not shared to other tests, any variable [captured][captures] in the [`tests`] section will **not** be available in the [`after`] section.
Any variable captured in the `before` section will be available in the `tests` and `after` sections. However, since variables captured in individual tests are not shared to other tests, any variable captured in the `tests` section will **not** be available in the `after` section.

::: warning
Steps defined in [`before`] and [`after`] sections are ran as tests and will therefore be reported as such. Those steps will count in the overall results summary and any `check` failure will cause the entire run to report as failed.
Steps defined in `before` and `after` sections are ran as tests and will therefore be reported as such. Those steps will count in the overall results summary and any `check` failure will cause the entire run to report as failed.
:::

**Example usage**
Expand Down

0 comments on commit 5eea95c

Please sign in to comment.