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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
[](https://github.com/fe-lang/dir-test/actions/workflows/ci.yml)
[](https://crates.io/crates/dir-test)
[](https://opensource.org/licenses/Apache-2.0)
`dir-test` provides a macro to generate single test cases from files in a directory.
## Usage
Add the following dependency to your `Cargo.toml`.
``` toml
[dev-dependencies]
dir-test = "0.4"
```
### Basic Usage
```rust, no_run
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()`.
```text
my-crate/
├─ fixtures/
│ ├─ foo.txt
│ ├─ fixtures_a/
│ │ ├─ bar.txt
├─ src/
│ ├─ ...
│ ├─ lib.rs
├─ Cargo.toml
├─ README.md
```
🔽
```rust, no_run
#[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.
```rust, no_run
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.
```rust, no_run
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.
```rust, no_run
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](https://doc.rust-lang.org/book/ch11-01-writing-tests.html#using-resultt-e-in-tests).
```rust, no_run
use dir_test::{dir_test, Fixture};
#[dir_test(
dir: "$CARGO_MANIFEST_DIR/fixtures",
glob: "**/*.txt",
)]
fn test(fixture: Fixture<&str>) -> std::io::Result<()> {
// ...
}
```
|
