test: migrate serveral files to snapbox by eth3lbert · Pull Request #14180 · rust-lang/cargo

eth3lbert · 2024-07-02T21:48:42Z

What does this PR try to resolve?

Part of #14039.

Migrate following to snapbox:

tests/testsuite/read_manifest.rs
tests/testsuite/rustdoc_extern_html.rs
tests/testsuite/tool_paths.rs
tests/testsuite/warn_on_failure.rs

rustbot · 2024-07-02T21:48:46Z

rustbot has assigned @ehuss.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

eth3lbert · 2024-07-02T23:27:23Z

tests/testsuite/rustdoc_extern_html.rs

        .build()
 }

+#[allow(deprecated)]


with_stderr_does_not_contain is being used in this function.

eth3lbert · 2024-07-02T23:34:16Z

tests/testsuite/rustdoc_extern_html.rs

    assert!(gold.contains(r#"href="https://docs.rs/grimm/1.0.0/grimm/struct.Gold.html""#));
 }

+#[allow(deprecated)]


with_stderr_does_not_contain is being used in this function.

eth3lbert · 2024-07-02T23:44:49Z

tests/testsuite/warn_on_failure.rs

 #[cargo_test]
 fn warning_on_lib_failure() {
-    make_lib("err()");
+    make_lib("hi()");


Previously, the error message varied between local and CI environments. I've changed this to avoid the issue of "similar name exists".
https://github.com/rust-lang/cargo/actions/runs/9768426106/job/26965899179#step:7:4040

7 - --> [ROOT]/home/.cargo/registry/src/-[HASH]/bar-0.0.1/src/lib.rs:1:10 8 - | 9 - 1 | fn f() { err() } 10 - | ^^^ [HELP] a tuple variant with a similar name exists: `Err` 11 - | 12 - ::: [..]/lib/rustlib/src/rust/library/core/src/result.rs:536:5 13 - | 14 - 536 | Err(#[stable(feature = "rust1", since = "1.0.0")] E), 15 - | --- similarly named tuple variant `Err` defined here 7 + --> [ROOT]/home/.cargo/registry/src/-[HASH]/bar-0.0.1/src/lib.rs:1:10 8 + | 9 + 1 | fn f() { err() } 10 + | ^^^ [HELP] a tuple variant with a similar name exists: `Err` 11 + --> /rustc/129f3b9964af4d4a709d1383930ade12dfe7c081/library/core/src/result.rs:511:5 12 + | 13 + = [NOTE] similarly named tuple variant `Err` defined here

Please let me know if this change is inappropriate.

eth3lbert · 2024-07-02T23:50:16Z

tests/testsuite/warn_on_failure.rs

        .with_status(101)
-        .with_stdout_does_not_contain("hidden stdout")
-        .with_stderr_does_not_contain("hidden stderr")
-        .with_stderr_does_not_contain(&format!("[WARNING] {}", WARNING1))
-        .with_stderr_does_not_contain(&format!("[WARNING] {}", WARNING2))
-        .with_stderr_contains("[UPDATING] `[..]` index")
-        .with_stderr_contains("[DOWNLOADED] bar v0.0.1 ([..])")
-        .with_stderr_contains("[COMPILING] bar v0.0.1")
-        .with_stderr_contains("[COMPILING] foo v0.0.1 ([..])")
+        .with_stdout_data("")
+        .with_stderr_data(str![[r#"
+[UPDATING] `dummy-registry` index
+[LOCKING] 2 packages to latest compatible versions
+[DOWNLOADING] crates ...
+[DOWNLOADED] bar v0.0.1 (registry `dummy-registry`)
+[COMPILING] bar v0.0.1
+[COMPILING] foo v0.0.1 ([ROOT]/foo)
+error[E0425]: cannot find function `hi` in this scope
+ --> src/main.rs:1:13
+  |
+1 | fn main() { hi() }
+  |             ^^ not found in this scope
+
+For more information about this error, try `rustc --explain E0425`.
+[ERROR] could not compile `foo` (bin "foo") due to 1 previous error
+
+"#]])


Removing the does_not_contain assertion by directly comparing against the full output.

I think in this case it works because if something changes and, the diff for the snapshot update will be suspicious, having "hidden" stuff showing up.

eth3lbert · 2024-07-02T23:50:40Z

tests/testsuite/warn_on_failure.rs

        .with_status(101)
-        .with_stdout_does_not_contain("hidden stdout")
-        .with_stderr_does_not_contain("hidden stderr")
-        .with_stderr_does_not_contain("[COMPILING] foo v0.0.1 ([..])")
-        .with_stderr_contains("[UPDATING] `[..]` index")
-        .with_stderr_contains("[DOWNLOADED] bar v0.0.1 ([..])")
-        .with_stderr_contains("[COMPILING] bar v0.0.1")
-        .with_stderr_contains(&format!("[WARNING] bar@0.0.1: {}", WARNING1))
-        .with_stderr_contains(&format!("[WARNING] bar@0.0.1: {}", WARNING2))
+        .with_stdout_data("")
+        .with_stderr_data(str![[r#"
+[UPDATING] `dummy-registry` index
+[LOCKING] 2 packages to latest compatible versions
+[DOWNLOADING] crates ...
+[DOWNLOADED] bar v0.0.1 (registry `dummy-registry`)
+[COMPILING] bar v0.0.1
+error[E0425]: cannot find function `hi` in this scope
+ --> [ROOT]/home/.cargo/registry/src/-[HASH]/bar-0.0.1/src/lib.rs:1:10
+  |
+1 | fn f() { hi() }
+  |          ^^ not found in this scope
+
+For more information about this error, try `rustc --explain E0425`.
+The following warnings were emitted during compilation:
+
+[WARNING] bar@0.0.1: Hello! I'm a warning. :)
+[WARNING] bar@0.0.1: And one more!
+
+[ERROR] could not compile `bar` (lib) due to 1 previous error
+
+"#]])


Removing the does_not_contain assertion by directly comparing against the full output.

eth3lbert · 2024-07-02T23:57:20Z

tests/testsuite/read_manifest.rs

Modify to a snapshot-aware assertion that enables auto-updating.

eth3lbert · 2024-07-03T00:06:36Z

tests/testsuite/rustdoc_extern_html.rs

-        )
+        .with_stderr_data(str![[r#"
+...
+[RUNNING] `rustdoc [..]--crate-name foo [..]--extern-html-root-url [..]bar=https://docs.rs/bar/1.0.0/[..]`


Glob redaction is required since its not surrounded by quotes on windows.

https://github.com/rust-lang/cargo/actions/runs/9768726905/job/26966828626#step:11:4295

1 - ... 2 - [RUNNING] `rustdoc [..]--crate-name foo [..]--extern-html-root-url 'bar=https://docs.rs/bar/1.0.0/' [..]` [omit...] 8 + [RUNNING] `rustdoc --edition=2018 --crate-type lib --crate-name foo src/lib.rs -o [ROOT]/foo/target/doc --check-cfg cfg(docsrs) --check-cfg "cfg(feature, values())" --error-format=json --json=diagnostic-rendered-ansi,artifacts,future-incompat -C metadata=a7e7c9482575de28 -L dependency=[ROOT]/foo/target/debug/deps --extern bar=[ROOT]/foo/target/debug/deps/libbar-[HASH].rmeta --extern-html-root-url bar=https://docs.rs/bar/1.0.0/ -Zunstable-options --crate-version 0.1.0`

tests/testsuite/read_manifest.rs

tests/testsuite/warn_on_failure.rs

epage · 2024-07-06T03:06:20Z

@bors r+

bors · 2024-07-06T03:06:23Z

📌 Commit b11e741 has been approved by epage

It is now in the queue for this repository.

bors · 2024-07-06T03:07:30Z

⌛ Testing commit b11e741 with merge 6d68563...

bors · 2024-07-06T03:35:48Z

☀️ Test successful - checks-actions
Approved by: epage
Pushing 6d68563 to master...

Update cargo 20 commits in a515d463427b3912ec0365d106791f88c1c14e1b..154fdac39ae9629954e19e9986fd2cf2cdd8d964 2024-07-02 20:53:36 +0000 to 2024-07-07 01:28:23 +0000 - test: relax redactions for rust-lang/rust (rust-lang/cargo#14203) - use "bootstrap" instead of "rustbuild" (rust-lang/cargo#14207) - test: migrate serveral files to snapbox (rust-lang/cargo#14180) - Add rustdocflags to Unit's Debug impl (rust-lang/cargo#14201) - Allow enabling `config-include` feature in config (rust-lang/cargo#14196) - fix(test): Restore `does_not_contain` for check (rust-lang/cargo#14198) - test: migrate patch, pkgid, proc_macro and progress to snapbox (rust-lang/cargo#14181) - test: Migrate jobserver to snapbox (rust-lang/cargo#14191) - chore(deps): update msrv (3 versions) to v1.77 (rust-lang/cargo#14186) - test: migrate build_plan and build_script to snapbox (rust-lang/cargo#14193) - test: migrate cfg and check to snapbox (rust-lang/cargo#14185) - test: migrate install* and inheritable_workspace_fields to snapbox (rust-lang/cargo#14170) - Pass rustflags to artifacts built with implicit targets when using target-applies-to-host (rust-lang/cargo#13900) - test: Migrate network tests to snapbox (rust-lang/cargo#14187) - test: migrate some files to snapbox (rust-lang/cargo#14113) - test: Auto-redact `... after last build at ...`; Migrate `freshness` to Snapbox (rust-lang/cargo#14161) - chore: fix some typos (rust-lang/cargo#14182) - fix: improve message for inactive weak optional feature with edition2024 through unused dep collection (rust-lang/cargo#14026) - test：migrate `doc/directory/docscrape` to snapbox (rust-lang/cargo#14171) - test: Migrate git_auth to snapbox (rust-lang/cargo#14172)

rustbot assigned ehuss Jul 2, 2024

rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jul 2, 2024

eth3lbert force-pushed the snapbox-rrtw branch 2 times, most recently from b134964 to f171e94 Compare July 2, 2024 22:51

eth3lbert commented Jul 3, 2024

View reviewed changes

weihanglo mentioned this pull request Jul 5, 2024

Port from bespoke assertions of snapbox #14039

Closed

epage reviewed Jul 5, 2024

View reviewed changes

tests/testsuite/read_manifest.rs Show resolved Hide resolved

epage reviewed Jul 5, 2024

View reviewed changes

tests/testsuite/warn_on_failure.rs Outdated Show resolved Hide resolved

epage reviewed Jul 5, 2024

View reviewed changes

tests/testsuite/warn_on_failure.rs Outdated Show resolved Hide resolved

eth3lbert added 3 commits July 6, 2024 05:25

test: migrate read_manifest to snapbox

941b2bf

test: migrate rustdoc_extern_html to snapbox

8bdb52f

test: migrate tool_paths to snapbox

2d01f40

eth3lbert force-pushed the snapbox-rrtw branch from f171e94 to cb76935 Compare July 5, 2024 21:26

test: migrate warn_on_failure to snapbox

b11e741

eth3lbert force-pushed the snapbox-rrtw branch from cb76935 to b11e741 Compare July 5, 2024 22:46

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jul 6, 2024

bors merged commit 6d68563 into rust-lang:master Jul 6, 2024

eth3lbert deleted the snapbox-rrtw branch July 6, 2024 03:42

weihanglo mentioned this pull request Jul 7, 2024

Update cargo rust-lang/rust#127385

Merged

rustbot added this to the 1.81.0 milestone Jul 7, 2024

Conversation

eth3lbert commented Jul 2, 2024

What does this PR try to resolve?

Uh oh!

rustbot commented Jul 2, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

epage commented Jul 6, 2024

Uh oh!

bors commented Jul 6, 2024

Uh oh!

bors commented Jul 6, 2024

Uh oh!

bors commented Jul 6, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants