Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update tests.mdx #220

Merged
merged 7 commits into from
May 4, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/contributors/integration-testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,29 @@ Examples:
This is a description.
```

### Annotation

A level 5 heading (`#####`), with the text being one of the following:

- `##### skip` -- If a test has the `skip` annotation, the runner will not run that test.

There must be either zero or one such annotation in a test.

This annotation comes handy in situation where one might need to skip the execution of some written tests temporarily due to various reasons like :

- Some functionalities which are supposed to be tested might not be implemented yet, OR
- There might be some bugs related to it.

Note: `##### only` which is used to run single test has been removed in the favour of cargo option.

To run a single test locally one can use [cargo option](https://doc.rust-lang.org/rustc/tests/index.html#--test) "--test".

Example usage of cargo option:

```sh
cargo test --test execution_spec -- --test "test_filter"
```

### Blocks

Blocks are specified along with the codeblocks next to the format of the codeblock (`@`) followed by the block type, and a code block after them. Blocks supply the runner with data, and the runner determines what to do based on the available blocks. example:
Expand Down
Loading