Skip to content

Commit 11d0002

Browse files
borsbors
committed
Auto merge of #13963 - epage:snapbox, r=weihanglo
chore: Update to snapbox 0.6 ### What does this PR try to resolve? This unblocks regex redactions which will help with `Finished in 3.45s` messages as well as maybe switching away from `compare.rs` generally. ### How should we test and review this PR? ### Additional information
2 parents 95eeafa + 9af864e commit 11d0002

File tree

284 files changed

+606
-601
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

284 files changed

+606
-601
lines changed

‎Cargo.lock

+5-5
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Cargo.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ sha1 = "0.10.6"
9191
sha2 = "0.10.8"
9292
shell-escape = "0.1.5"
9393
supports-hyperlinks = "3.0.0"
94-
snapbox = { version = "0.5.9", features = ["diff", "path", "term-svg"] }
94+
snapbox = { version = "0.6.5", features = ["diff", "dir", "term-svg"] }
9595
tar = { version = "0.4.40", default-features = false }
9696
tempfile = "3.10.1"
9797
thiserror = "1.0.59"

‎crates/cargo-test-support/src/compare.rs

+7-13
Original file line numberDiff line numberDiff line change
@@ -80,21 +80,15 @@ pub fn assert_ui() -> snapbox::Assert {
8080
// Use `from_file_path` instead of `from_dir_path` so the trailing slash is
8181
// put in the users output, rather than hidden in the variable
8282
let root_url = url::Url::from_file_path(&root).unwrap().to_string();
83-
let root = root.display().to_string();
8483

85-
let mut subs = snapbox::Substitutions::new();
86-
subs.extend([
87-
(
88-
"[EXE]",
89-
std::borrow::Cow::Borrowed(std::env::consts::EXE_SUFFIX),
90-
),
91-
("[ROOT]", std::borrow::Cow::Owned(root)),
92-
("[ROOTURL]", std::borrow::Cow::Owned(root_url)),
93-
])
94-
.unwrap();
84+
let mut subs = snapbox::Redactions::new();
85+
subs.extend([("[EXE]", std::env::consts::EXE_SUFFIX)])
86+
.unwrap();
87+
subs.insert("[ROOT]", root).unwrap();
88+
subs.insert("[ROOTURL]", root_url).unwrap();
9589
snapbox::Assert::new()
96-
.action_env(snapbox::DEFAULT_ACTION_ENV)
97-
.substitutions(subs)
90+
.action_env(snapbox::assert::DEFAULT_ACTION_ENV)
91+
.redact_with(subs)
9892
}
9993

10094
/// Normalizes the output so that it can be compared against the expected value.

‎crates/cargo-test-support/src/lib.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ macro_rules! t {
4040
}
4141

4242
pub use snapbox::file;
43-
pub use snapbox::path::current_dir;
4443
pub use snapbox::str;
44+
pub use snapbox::utils::current_dir;
4545

4646
#[track_caller]
4747
pub fn panic_error(what: &str, err: impl Into<anyhow::Error>) -> ! {
@@ -315,7 +315,7 @@ impl Project {
315315
pub fn from_template(template_path: impl AsRef<std::path::Path>) -> Self {
316316
let root = paths::root();
317317
let project_root = root.join("case");
318-
snapbox::path::copy_template(template_path.as_ref(), &project_root).unwrap();
318+
snapbox::dir::copy_template(template_path.as_ref(), &project_root).unwrap();
319319
Self { root: project_root }
320320
}
321321

‎crates/cargo-util-schemas/src/core/partial_version.rs

+3-2
Original file line numberDiff line numberDiff line change
@@ -186,6 +186,7 @@ enum ErrorKind {
186186
#[cfg(test)]
187187
mod test {
188188
use super::*;
189+
use snapbox::prelude::*;
189190
use snapbox::str;
190191

191192
#[test]
@@ -202,7 +203,7 @@ mod test {
202203
Ok(result) => result.to_string(),
203204
Err(err) => format!("didn't pass: {err}"),
204205
};
205-
snapbox::assert_eq(expected.clone(), actual);
206+
snapbox::assert_data_eq!(actual, expected.clone().raw());
206207
}
207208
}
208209

@@ -241,7 +242,7 @@ mod test {
241242
Ok(result) => format!("didn't fail: {result:?}"),
242243
Err(err) => err.to_string(),
243244
};
244-
snapbox::assert_eq(expected.clone(), actual);
245+
snapbox::assert_data_eq!(actual, expected.clone().raw());
245246
}
246247
}
247248
}

‎crates/cargo-util-schemas/src/manifest/rust_version.rs

+2-1
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@ enum RustVersionErrorKind {
106106
#[cfg(test)]
107107
mod test {
108108
use super::*;
109+
use snapbox::prelude::*;
109110
use snapbox::str;
110111

111112
#[test]
@@ -212,7 +213,7 @@ mod test {
212213
Ok(result) => format!("didn't fail: {result:?}"),
213214
Err(err) => err.to_string(),
214215
};
215-
snapbox::assert_eq(expected.clone(), actual);
216+
snapbox::assert_data_eq!(actual, expected.clone().raw());
216217
}
217218
}
218219
}

‎crates/mdman/tests/compare.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ fn run(name: &str) {
2222
name,
2323
format.extension(section)
2424
));
25-
snapbox::assert_eq(snapbox::Data::read_from(&expected_path, None), result);
25+
snapbox::assert_data_eq!(result, snapbox::Data::read_from(&expected_path, None).raw());
2626
}
2727
}
2828

‎crates/mdman/tests/invalid.rs

+3-2
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,16 @@
33
use std::path::PathBuf;
44

55
use mdman::{Format, ManMap};
6+
use snapbox::prelude::*;
67

7-
fn run(name: &str, expected_error: &str) {
8+
fn run(name: &str, expected_error: impl IntoData) {
89
let input = PathBuf::from(format!("tests/invalid/{}", name));
910
match mdman::convert(&input, Format::Man, None, ManMap::new()) {
1011
Ok(_) => {
1112
panic!("expected {} to fail", name);
1213
}
1314
Err(e) => {
14-
snapbox::assert_eq(expected_error, e.to_string());
15+
snapbox::assert_data_eq!(e.to_string(), expected_error.raw());
1516
}
1617
}
1718
}

‎credential/cargo-credential/Cargo.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "cargo-credential"
3-
version = "0.4.5"
3+
version = "0.4.6"
44
rust-version.workspace = true
55
edition.workspace = true
66
license.workspace = true

‎credential/cargo-credential/src/stdio.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ mod test {
143143

144144
#[test]
145145
fn stdin() {
146-
let tempdir = snapbox::path::PathFixture::mutable_temp().unwrap();
146+
let tempdir = snapbox::dir::DirRoot::mutable_temp().unwrap();
147147
let file = tempdir.path().unwrap().join("stdin");
148148
let mut file = OpenOptions::new()
149149
.read(true)

‎credential/cargo-credential/tests/examples.rs

+5-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
use std::path::Path;
22

33
use snapbox::cmd::Command;
4+
use snapbox::prelude::*;
45

56
#[test]
67
fn stdout_redirected() {
@@ -14,8 +15,8 @@ fn stdout_redirected() {
1415
.stdin(format!("{get_request}\n"))
1516
.arg("--cargo-plugin")
1617
.assert()
17-
.stdout_eq(format!("{hello}\n{err_not_supported}\n"))
18-
.stderr_eq("message on stderr should be sent to the parent process\n")
18+
.stdout_eq(format!("{hello}\n{err_not_supported}\n").raw())
19+
.stderr_eq("message on stderr should be sent to the parent process\n".raw())
1920
.success();
2021
}
2122

@@ -38,8 +39,8 @@ fn file_provider() {
3839
.stdin(format!("{login_request}\n{get_request}\n"))
3940
.arg("--cargo-plugin")
4041
.assert()
41-
.stdout_eq(format!("{hello}\n{login_response}\n{get_response}\n"))
42-
.stderr_eq("")
42+
.stdout_eq(format!("{hello}\n{login_response}\n{get_response}\n").raw())
43+
.stderr_eq("".raw())
4344
.success();
4445
std::fs::remove_dir_all(&dir).unwrap();
4546
}

‎src/cargo/core/features.rs

+3-4
Original file line numberDiff line numberDiff line change
@@ -733,10 +733,9 @@ macro_rules! unstable_cli_options {
733733
);
734734
let mut expected = vec![$(stringify!($element)),*];
735735
expected[2..].sort();
736-
snapbox::assert_eq(
737-
format!("{:#?}", expected),
738-
format!("{:#?}", vec![$(stringify!($element)),*])
739-
);
736+
let expected = format!("{:#?}", expected);
737+
let actual = format!("{:#?}", vec![$(stringify!($element)),*]);
738+
snapbox::assert_data_eq!(actual, expected);
740739
}
741740
}
742741
}

‎src/cargo/util/toml/embedded.rs

+30-22
Original file line numberDiff line numberDiff line change
@@ -261,6 +261,8 @@ fn split_source(input: &str) -> CargoResult<Source<'_>> {
261261

262262
#[cfg(test)]
263263
mod test_expand {
264+
use snapbox::str;
265+
264266
use super::*;
265267

266268
macro_rules! si {
@@ -276,8 +278,10 @@ mod test_expand {
276278

277279
#[test]
278280
fn test_default() {
279-
snapbox::assert_eq(
280-
r#"[[bin]]
281+
snapbox::assert_data_eq!(
282+
si!(r#"fn main() {}"#),
283+
str![[r#"
284+
[[bin]]
281285
name = "test-"
282286
path = "/home/me/test.rs"
283287
@@ -294,15 +298,22 @@ name = "test-"
294298
strip = true
295299
296300
[workspace]
297-
"#,
298-
si!(r#"fn main() {}"#),
301+
302+
"#]]
299303
);
300304
}
301305

302306
#[test]
303307
fn test_dependencies() {
304-
snapbox::assert_matches(
305-
r#"[[bin]]
308+
snapbox::assert_data_eq!(
309+
si!(r#"---cargo
310+
[dependencies]
311+
time="0.1.25"
312+
---
313+
fn main() {}
314+
"#),
315+
str![[r#"
316+
[[bin]]
306317
name = "test-"
307318
path = [..]
308319
@@ -322,20 +333,22 @@ name = "test-"
322333
strip = true
323334
324335
[workspace]
325-
"#,
326-
si!(r#"---cargo
327-
[dependencies]
328-
time="0.1.25"
329-
---
330-
fn main() {}
331-
"#),
336+
337+
"#]]
332338
);
333339
}
334340

335341
#[test]
336342
fn test_no_infostring() {
337-
snapbox::assert_matches(
338-
r#"[[bin]]
343+
snapbox::assert_data_eq!(
344+
si!(r#"---
345+
[dependencies]
346+
time="0.1.25"
347+
---
348+
fn main() {}
349+
"#),
350+
str![[r#"
351+
[[bin]]
339352
name = "test-"
340353
path = [..]
341354
@@ -355,13 +368,8 @@ name = "test-"
355368
strip = true
356369
357370
[workspace]
358-
"#,
359-
si!(r#"---
360-
[dependencies]
361-
time="0.1.25"
362-
---
363-
fn main() {}
364-
"#),
371+
372+
"#]]
365373
);
366374
}
367375
}

‎tests/testsuite/cargo/help/mod.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ fn case() {
88
.arg("--help")
99
.assert()
1010
.success()
11-
.stdout_matches(file!["stdout.term.svg"])
12-
.stderr_matches(str![""]);
11+
.stdout_eq(file!["stdout.term.svg"])
12+
.stderr_eq(str![""]);
1313
}

‎tests/testsuite/cargo/z_help/mod.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,6 @@ fn case() {
99
.args(["-Z", "help"])
1010
.assert()
1111
.success()
12-
.stdout_matches(file!["stdout.term.svg"])
13-
.stderr_matches(str![""]);
12+
.stdout_eq(file!["stdout.term.svg"])
13+
.stderr_eq(str![""]);
1414
}

‎tests/testsuite/cargo_add/add_basic/mod.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ fn case() {
3030
.current_dir(cwd)
3131
.assert()
3232
.success()
33-
.stdout_matches(str![""])
34-
.stderr_matches(file!["stderr.term.svg"]);
33+
.stdout_eq(str![""])
34+
.stderr_eq(file!["stderr.term.svg"]);
3535

3636
assert_ui().subset_matches(current_dir!().join("out"), &project_root);
3737
}

‎tests/testsuite/cargo_add/add_multiple/mod.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ fn case() {
3232
.current_dir(cwd)
3333
.assert()
3434
.success()
35-
.stdout_matches(str![""])
36-
.stderr_matches(file!["stderr.term.svg"]);
35+
.stdout_eq(str![""])
36+
.stderr_eq(file!["stderr.term.svg"]);
3737

3838
assert_ui().subset_matches(current_dir!().join("out"), &project_root);
3939
}

‎tests/testsuite/cargo_add/add_no_vendored_package_with_alter_registry/mod.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ fn case() {
2929
.current_dir(cwd)
3030
.assert()
3131
.success()
32-
.stdout_matches(str![""])
33-
.stderr_matches(file!["stderr.term.svg"]);
32+
.stdout_eq(str![""])
33+
.stderr_eq(file!["stderr.term.svg"]);
3434

3535
assert_ui().subset_matches(current_dir!().join("out"), &project_root);
3636
}

‎tests/testsuite/cargo_add/add_no_vendored_package_with_vendor/mod.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ fn case() {
1717
.current_dir(cwd)
1818
.assert()
1919
.failure()
20-
.stdout_matches(str![""])
21-
.stderr_matches(file!["stderr.term.svg"]);
20+
.stdout_eq(str![""])
21+
.stderr_eq(file!["stderr.term.svg"]);
2222

2323
assert_ui().subset_matches(current_dir!().join("out"), &project_root);
2424
}

‎tests/testsuite/cargo_add/add_normalized_name_external/mod.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ fn case() {
3535
.current_dir(cwd)
3636
.assert()
3737
.success()
38-
.stdout_matches(str![""])
39-
.stderr_matches(file!["stderr.term.svg"]);
38+
.stdout_eq(str![""])
39+
.stderr_eq(file!["stderr.term.svg"]);
4040

4141
assert_ui().subset_matches(current_dir!().join("out"), &project_root);
4242
}

0 commit comments

Comments
 (0)