3 releases

Uses new Rust 2021

0.1.3 Aug 15, 2022
0.1.2 May 22, 2022
0.1.1 Apr 17, 2021
0.1.0 Apr 17, 2021

#52 in Testing

Download history 7817/week @ 2022-08-15 12404/week @ 2022-08-22 5378/week @ 2022-08-29 7101/week @ 2022-09-05 7536/week @ 2022-09-12 5132/week @ 2022-09-19 7864/week @ 2022-09-26 11748/week @ 2022-10-03 10858/week @ 2022-10-10 10388/week @ 2022-10-17 10227/week @ 2022-10-24 10252/week @ 2022-10-31 8436/week @ 2022-11-07 8579/week @ 2022-11-14 7022/week @ 2022-11-21 7569/week @ 2022-11-28

32,610 downloads per month
Used in fewer than 23 crates

MIT/Apache

13KB
131 lines

datatest-stable

datatest-stable on crates.io Documentation (latest release) Documentation (main) License License

datatest-stable is a very simple test harness intended to write data-driven tests, where individual test cases are specified as files and not as code. Given:

  • a test my_test that accepts a path as input
  • a directory to look for files in
  • a pattern to match files on

datatest-stable will call the my_test function once per matching file in the directory.

datatest-stable works with cargo nextest, and is part of the nextest-rs organization on GitHub.

Usage

  1. Configure the test target by setting harness = false in Cargo.toml:
[[test]]
name = "<test target name>"
harness = false
  1. Call the datatest_stable::harness!(testfn, root, pattern) macro with the following parameters:
  • testfn - The test function to be executed on each matching input. This function must have the type fn(&Path) -> datatest_stable::Result<()>
  • root - The path to the root directory where the input files (fixtures) live. This path is relative to the root of the crate.
  • pattern - the regex used to match against and select each file to be tested.

The three parameters can be repeated if you have multiple sets of data-driven tests to be run: datatest_stable::harness!(testfn1, root1, pattern1, testfn2, root2, pattern2)

Examples

This is an example test. Use it with harness = false.

use std::path::Path;

fn my_test(path: &Path) -> datatest_stable::Result<()> {
    // ... write test here

    Ok(())
}

datatest_stable::harness!(my_test, "path/to/fixtures", r"^.*/*");

Minimum supported Rust version (MSRV)

The minimum supported Rust version is Rust 1.58. MSRV bumps may be accompanied by a minor version update; at any time, at least the last 3 stable versions of Rust will be supported.

See also

License

This project is available under the terms of either the Apache 2.0 license or the MIT license.

Dependencies

~3–4MB
~89K SLoC