Crates.io | test-group |
lib.rs | test-group |
version | 1.0.1 |
source | src |
created_at | 2023-06-17 22:04:16.025063 |
updated_at | 2023-06-17 22:34:31.264158 |
description | Organize tests into groups with macros for filtering in nextest |
homepage | https://github.com/sergiimk/test-group |
repository | https://github.com/sergiimk/test-group |
max_upload_size | |
id | 893151 |
size | 6,340 |
Cargo's built-in test runner does not support grouping tests, which can be a problem when some of your tests are reasource-intensive and you don't want to run them all at once. Nextest solves this problem by allowing you to define test groups using filter expressions in a config file and limit concurrently.
This works, but you may find yourself:
heavy
, dockerized
etc. - this is not ideal because tests for the same component may now end up in different files, based on how "heavy" they are.This tiny crate lets you group tests in code like so:
#[test_group::group(heavy)]
#[test]
async fn test_foo() {
// ...
}
#[test_group::group(heavy, flaky)]
#[test]
fn test_bar() {
// ...
}
This will result in a code like this:
mod g64dc {
use super::*;
mod heavy {
use super::*;
#[test]
async fn test_foo() {
// ...
}
}
}
mod g3d6f {
use super::*;
mod heavy {
use super::*;
mod flaky {
use super::*;
#[test]
fn test_bar() {
// ...
}
}
}
}
So that these tests will appear in nextest
as:
g3d6f::heavy::test_foo
g64dc::heavy::flaky::test_bar
Allowing you to filter tests by group in your .config/nextest.toml
as such:
[[profile.default.overrides]]
filter = 'test(::heavy::)'
max-threads = 1
[[profile.default.overrides]]
filter = 'test(::flaky::)'
retries = 3
Or when running as:
cargo nextest run -E 'test(::flaky::)'
Note: The extra modules like
g3d6f
are generated by the macro to avoid module name collisions, as unlikeimpl
blocks you cannot have more than onemod X {}
in the same file. The names are based on a SHA hash of the test content to be stable but unique-ish.