serial_test allows for the creation of serialised Rust tests using the serial attribute
e.g.
```rust
fn testserialone() { // Do things }
fn testserialanother() { // Do things }
async fn testserialanother() {
// Do things asynchronously
}
``
Multiple tests with theserialattribute are guaranteed to be executed in serial. Ordering of the tests is not guaranteed however. Other tests with theparallelattribute may run at the same time as each other, but not at the same time as a test withserial`. Tests with neither attribute may run at any time and no guarantees are made about their timing!
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.
For cases like doctests and integration tests where the tests are run as separate processes, we also support file_serial, with
similar properties but based off file locking. Note that there are no guarantees about one test with serial and another with
file_serial as they lock using different methods, and parallel doesn't support file_serial yet (patches welcomed!).
We require at least Rust 1.51. Upgrades to this will require at least a minor version bump (while in 0.x versions) and a major version bump post-1.0.
Add to your Cargo.toml
toml
[dev-dependencies]
serial_test = "*"
plus use serial_test::serial; (for Rust 2018) or
```rust
extern crate serial_test; ``` for earlier versions.
You can then either add #[serial] or #[serial(some_text)] to tests as required.