#directory #macro #testing #test-macro #test-cases

dir-test

Provides a macro to generate tests from files in a directory

5 unstable releases

new 0.3.0 May 16, 2024
0.2.1 Mar 2, 2024
0.2.0 Jan 4, 2024
0.1.1 Feb 4, 2023
0.1.0 Feb 4, 2023

#208 in Filesystem

Download history 391/week @ 2024-01-28 531/week @ 2024-02-04 554/week @ 2024-02-11 578/week @ 2024-02-18 675/week @ 2024-02-25 655/week @ 2024-03-03 456/week @ 2024-03-10 495/week @ 2024-03-17 498/week @ 2024-03-24 565/week @ 2024-03-31 471/week @ 2024-04-07 810/week @ 2024-04-14 609/week @ 2024-04-21 756/week @ 2024-04-28 416/week @ 2024-05-05 826/week @ 2024-05-12

2,704 downloads per month

Apache-2.0

12KB
51 lines

CI Crates.io License

dir-test provides a macro to generate single test cases from files in a directory.

Usage

Add the following dependency to your Cargo.toml.

[dev-dependencies]
dir-test = "0.1"

Basic Usage

use dir_test::{dir_test, Fixture};

#[dir_test(
    dir: "$CARGO_MANIFEST_DIR/fixtures",
    glob: "**/*.txt",
)]
fn mytest(fixture: Fixture<&str>) {
    // The file content and the absolute path of the file are available as follows.
    let content = fixture.content();
    let path = fixture.path();

    // Write your test code here.
    // ...
}

Assuming your crate is as follows, then the above code generates two test cases mytest__foo() and mytest__fixtures_a_bar().

my-crate/
├─ fixtures/
│  ├─ foo.txt
│  ├─ fixtures_a/
│  │  ├─ bar.txt
├─ src/
│  ├─ ...
│  ├─ lib.rs
├─ Cargo.toml
├─ README.md

🔽

#[test]
fn mytest__foo() {
    mytest(fixture);
}

#[test]
fn mytest__fixtures_a_bar() {
    mytest(fixture);
}

NOTE: The dir argument must be specified in an absolute path because of the limitation of the current procedural macro system. Consider using environment variables, dir-test crate resolves environment variables internally.

Custom Loader

You can specify a custom loader function to load the file content from the file path. The loader will be passed &'static str file path and can return an arbitrary type.

use dir_test::{dir_test, Fixture};

#[dir_test(
    dir: "$CARGO_MANIFEST_DIR/fixtures",
    glob: "**/*.txt",
    loader: std::fs::read_to_string,
)]
fn test(fixture: Fixture<std::io::Result<String>>) {
    let content = fixture.content().unwrap();

    // ...
}

If the loader function is not specified, the default content type is &'static str.

Custom Test Name

Test names can be customized by specifying the postfix argument. postfix is appended to the test name.

use dir_test::{dir_test, Fixture};

#[dir_test(
    dir: "$CARGO_MANIFEST_DIR/fixtures",
    glob: "**/*.txt",
    postfix: "custom", // `_custom` is appended to the test name.
)]
fn test(fixture: Fixture<std::io::Result<String>>) {
    // ...
}

Test Attributes

Test attributes can specified by the dir_test_attr attribute. The attributes inside dir_test_atrr are applied to the all generated test.

use dir_test::{dir_test, Fixture};

#[dir_test(
    dir: "$CARGO_MANIFEST_DIR/fixtures",
    glob: "**/*.txt",
)]
#[dir_test_attr(
    #[wasm_bindgen_test]
    #[cfg(target_family = "wasm")]
)]
fn wasm_test(fixture: Fixture<std::io::Result<String>>) {
    // ...
}

NOTE: The dir_test_attr attribute must be specified after the dir_test.

Return Types

Tests may have a return type, allowing for the [Result<T, E>] type to be used in the test. See the relevant book link here.

use dir_test::{dir_test, Fixture};

#[dir_test(
    dir: "$CARGO_MANIFEST_DIR/fixtures",
    glob: "**/*.txt",
)]
fn test(fixture: Fixture<&str>) -> std::io::Result<()> {
    // ...
}

Dependencies

~1.5MB
~35K SLoC