Skip to content

Commit 42b9727

Browse files
MichaReiserMichaReiser
authored
[ty] Use datatest instead of dirtest (#21937)
1 parent f7ec178 commit 42b9727

8 files changed

Lines changed: 42 additions & 117 deletions

File tree

‎Cargo.lock‎

Lines changed: 1 addition & 22 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Cargo.toml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,6 @@ criterion = { version = "0.7.0", default-features = false }
8282
crossbeam = { version = "0.8.4" }
8383
dashmap = { version = "6.0.1" }
8484
datatest-stable = { version = "0.3.3" }
85-
dir-test = { version = "0.4.0" }
8685
dunce = { version = "1.0.5" }
8786
drop_bomb = { version = "0.1.5" }
8887
etcetera = { version = "0.11.0" }

‎crates/ty_python_semantic/Cargo.toml‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ camino = { workspace = true }
3333
colored = { workspace = true }
3434
compact_str = { workspace = true }
3535
drop_bomb = { workspace = true }
36-
get-size2 = { workspace = true, features = ["indexmap", "ordermap"]}
36+
get-size2 = { workspace = true, features = ["indexmap", "ordermap"] }
3737
indexmap = { workspace = true }
3838
itertools = { workspace = true }
3939
ordermap = { workspace = true }
@@ -62,7 +62,7 @@ ty_test = { workspace = true }
6262
ty_vendored = { workspace = true }
6363

6464
anyhow = { workspace = true }
65-
dir-test = { workspace = true }
65+
datatest-stable = { workspace = true }
6666
glob = { workspace = true }
6767
indoc = { workspace = true }
6868
insta = { workspace = true }
@@ -76,5 +76,9 @@ schemars = ["dep:schemars", "dep:serde_json"]
7676
serde = ["ruff_db/serde", "dep:serde", "ruff_python_ast/serde"]
7777
testing = []
7878

79+
[[test]]
80+
name = "mdtest"
81+
harness = false
82+
7983
[lints]
8084
workspace = true

‎crates/ty_python_semantic/build.rs‎

Lines changed: 0 additions & 4 deletions
This file was deleted.

‎crates/ty_python_semantic/mdtest.py‎

Lines changed: 5 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -129,17 +129,8 @@ def _run_mdtest(
129129
check=False,
130130
)
131131

132-
def _mangle_path(self, markdown_file: Path) -> str:
133-
return (
134-
markdown_file.as_posix()
135-
.replace("/", "_")
136-
.replace("-", "_")
137-
.removesuffix(".md")
138-
)
139-
140132
def _run_mdtests_for_file(self, markdown_file: Path) -> None:
141-
path_mangled = self._mangle_path(markdown_file)
142-
test_name = f"mdtest__{path_mangled}"
133+
test_name = f"mdtest::{markdown_file}"
143134

144135
output = self._run_mdtest(["--exact", test_name], capture_output=True)
145136

@@ -245,16 +236,10 @@ def keyboard_input() -> None:
245236
if rust_code_has_changed:
246237
if self._recompile_tests("Rust code has changed, recompiling tests..."):
247238
self._run_mdtest(self.filters)
248-
elif vendored_typeshed_has_changed:
249-
if self._recompile_tests(
250-
"Vendored typeshed has changed, recompiling tests..."
251-
):
252-
self._run_mdtest(self.filters)
253-
elif new_md_files:
254-
files = " ".join(file.as_posix() for file in new_md_files)
255-
self._recompile_tests(
256-
f"New Markdown test [yellow]{files}[/yellow] detected, recompiling tests..."
257-
)
239+
elif vendored_typeshed_has_changed and self._recompile_tests(
240+
"Vendored typeshed has changed, recompiling tests..."
241+
):
242+
self._run_mdtest(self.filters)
258243

259244
for path in new_md_files | changed_md_files:
260245
self._run_mdtests_for_file(path)

‎crates/ty_python_semantic/tests/mdtest.rs‎

Lines changed: 22 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,25 @@
1+
use anyhow::anyhow;
12
use camino::Utf8Path;
2-
use dir_test::{Fixture, dir_test};
33
use ty_static::EnvVars;
44
use ty_test::OutputFormat;
55

66
/// See `crates/ty_test/README.md` for documentation on these tests.
7-
#[dir_test(
8-
dir: "$CARGO_MANIFEST_DIR/resources/mdtest",
9-
glob: "**/*.md"
10-
)]
117
#[expect(clippy::needless_pass_by_value)]
12-
fn mdtest(fixture: Fixture<&str>) {
13-
let absolute_fixture_path = Utf8Path::new(fixture.path());
8+
fn mdtest(fixture_path: &Utf8Path, content: String) -> datatest_stable::Result<()> {
9+
let short_title = fixture_path
10+
.file_name()
11+
.ok_or_else(|| anyhow!("Expected fixture path to have a file name"))?;
12+
1413
let crate_dir = Utf8Path::new(env!("CARGO_MANIFEST_DIR"));
1514
let snapshot_path = crate_dir.join("resources").join("mdtest").join("snapshots");
16-
let workspace_root = crate_dir.ancestors().nth(2).unwrap();
17-
18-
let relative_fixture_path = absolute_fixture_path.strip_prefix(workspace_root).unwrap();
19-
let short_title = absolute_fixture_path.file_name().unwrap();
15+
let absolute_fixture_path = crate_dir.join(fixture_path);
16+
let workspace_relative_fixture_path = Utf8Path::new("crates/ty_python_semantic")
17+
.join(fixture_path.strip_prefix(".").unwrap_or(fixture_path));
2018

21-
let test_name = test_name("mdtest", absolute_fixture_path);
19+
let test_name = fixture_path
20+
.strip_prefix("./resources/mdtest")
21+
.unwrap_or(fixture_path)
22+
.as_str();
2223

2324
let output_format = if std::env::var(EnvVars::MDTEST_GITHUB_ANNOTATIONS_FORMAT).is_ok() {
2425
OutputFormat::GitHub
@@ -27,43 +28,18 @@ fn mdtest(fixture: Fixture<&str>) {
2728
};
2829

2930
ty_test::run(
30-
absolute_fixture_path,
31-
relative_fixture_path,
31+
&absolute_fixture_path,
32+
&workspace_relative_fixture_path,
33+
&content,
3234
&snapshot_path,
3335
short_title,
34-
&test_name,
36+
test_name,
3537
output_format,
36-
);
37-
}
38-
39-
/// Constructs the test name used for individual markdown files
40-
///
41-
/// This code is copied from <https://github.com/fe-lang/dir-test/blob/1c0f41c480a3490bc2653a043ff6e3f8085a1f47/macros/src/lib.rs#L104-L138>
42-
/// and should be updated if they diverge
43-
fn test_name(test_func_name: &str, fixture_path: &Utf8Path) -> String {
44-
assert!(fixture_path.is_file());
38+
)?;
4539

46-
let dir_path = format!("{}/resources/mdtest", std::env!("CARGO_MANIFEST_DIR"));
47-
let rel_path = fixture_path.strip_prefix(dir_path).unwrap();
48-
assert!(rel_path.is_relative());
49-
50-
let mut test_name = test_func_name.to_owned();
51-
test_name.push_str("__");
52-
53-
for component in rel_path.parent().unwrap().components() {
54-
let component = component
55-
.as_str()
56-
.replace(|c: char| c.is_ascii_punctuation(), "_");
57-
test_name.push_str(&component);
58-
test_name.push('_');
59-
}
60-
61-
test_name.push_str(
62-
&rel_path
63-
.file_stem()
64-
.unwrap()
65-
.replace(|c: char| c.is_ascii_punctuation(), "_"),
66-
);
40+
Ok(())
41+
}
6742

68-
test_name
43+
datatest_stable::harness! {
44+
{ test = mdtest, root = "./resources/mdtest", pattern = r"\.md$" },
6945
}

‎crates/ty_test/README.md‎

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -34,19 +34,6 @@ syntax, it's just how this README embeds an example mdtest Markdown document.)
3434
See actual example mdtest suites in
3535
[`crates/ty_python_semantic/resources/mdtest`](https://github.com/astral-sh/ruff/tree/main/crates/ty_python_semantic/resources/mdtest).
3636

37-
> [!NOTE]
38-
> If you use `dir-test`, `rstest` or similar to generate a separate test for all Markdown files in a certain directory,
39-
> as with the example in `crates/ty_python_semantic/tests/mdtest.rs`,
40-
> you will likely want to also make sure that the crate the tests are in is rebuilt every time a
41-
> Markdown file is added or removed from the directory. See
42-
> [`crates/ty_python_semantic/build.rs`](https://github.com/astral-sh/ruff/tree/main/crates/ty_python_semantic/build.rs)
43-
> for an example of how to do this.
44-
>
45-
> This is because these macros generate their tests at build time rather than at runtime.
46-
> Without the `build.rs` file to force a rebuild when a Markdown file is added or removed,
47-
> a new Markdown test suite might not be run unless some other change in the crate caused a rebuild
48-
> following the addition of the new test file.
49-
5037
## Assertions
5138

5239
Two kinds of assertions are supported: `# revealed:` (shown above) and `# error:`.

‎crates/ty_test/src/lib.rs‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
use crate::config::Log;
22
use crate::db::Db;
33
use crate::parser::{BacktickOffsets, EmbeddedFileSourceMap};
4+
use anyhow::anyhow;
45
use camino::Utf8Path;
56
use colored::Colorize;
67
use config::SystemKind;
@@ -41,18 +42,14 @@ use ty_static::EnvVars;
4142
pub fn run(
4243
absolute_fixture_path: &Utf8Path,
4344
relative_fixture_path: &Utf8Path,
45+
source: &str,
4446
snapshot_path: &Utf8Path,
4547
short_title: &str,
4648
test_name: &str,
4749
output_format: OutputFormat,
48-
) {
49-
let source = std::fs::read_to_string(absolute_fixture_path).unwrap();
50-
let suite = match test_parser::parse(short_title, &source) {
51-
Ok(suite) => suite,
52-
Err(err) => {
53-
panic!("Error parsing `{absolute_fixture_path}`: {err:?}")
54-
}
55-
};
50+
) -> anyhow::Result<()> {
51+
let suite = test_parser::parse(short_title, source)
52+
.map_err(|err| anyhow!("Failed to parse fixture: {err}"))?;
5653

5754
let mut db = db::Db::setup();
5855

@@ -86,7 +83,7 @@ pub fn run(
8683
}
8784

8885
if let Err(failures) = result {
89-
let md_index = LineIndex::from_source_text(&source);
86+
let md_index = LineIndex::from_source_text(source);
9087

9188
for test_failures in failures {
9289
let source_map =
@@ -156,6 +153,8 @@ pub fn run(
156153
println!("\n{}\n", "-".repeat(50));
157154

158155
assert!(!any_failures, "Some tests failed.");
156+
157+
Ok(())
159158
}
160159

161160
/// Defines the format in which mdtest should print an error to the terminal

0 commit comments

Comments
 (0)