blob: d379a1d2fd9449b062929acc074e20a7be36dc3b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
|
# serial_test
[](https://crates.io/crates/serial_test)
[](https://crates.io/crates/serial_test)
[](https://docs.rs/serial_test/)
[](./LICENSE)
[](https://github.com/palfrey/serial_test/actions)
[](https://blog.rust-lang.org/2019/11/07/Rust-1.39.0.html)
`serial_test` allows for the creation of serialised Rust tests using the `serial` attribute
e.g.
```rust
#[test]
#[serial]
fn test_serial_one() {
// Do things
}
#[test]
#[serial]
fn test_serial_another() {
// Do things
}
#[tokio::test]
#[serial]
async fn test_serial_another() {
// Do things asynchronously
}
```
Multiple tests with the `serial` attribute are guaranteed to be executed in serial. Ordering of the tests is not guaranteed however.
Tests without the `serial` attribute may run at any time, including in parallel to tests marked as `serial`. Note that if you're using
an async test reactor attribute (e.g. `tokio::test` or `actix_rt::test`) then they should be listed *before* `serial`, otherwise we
don't get an async function and things break. There's now an error for this case to improve debugging.
## Usage
We require at least Rust 1.39 for [async/await](https://blog.rust-lang.org/2019/11/07/Async-await-stable.html) support
Add to your Cargo.toml
```toml
[dev-dependencies]
serial_test = "*"
```
plus `use serial_test::serial;` (for Rust 2018) or
```rust
#[macro_use]
extern crate serial_test;
```
for earlier versions.
You can then either add `#[serial]` or `#[serial(some_text)]` to tests as required.
|
