Print environment variables for `cargo run` in extra verbose mode #12498

Kobzol · 2023-08-14T18:46:16Z

What does this PR try to resolve?

This PR changes cargo run so that it prints the environment variables that it sets for the executed binary in extra verbose mode (cargo run -vv). This is particularly useful when it sets LD_LIBRARY_PATH which is needed to actually run the binary. Because if users want to run the binary without cargo, they will need to know where should they point that variable. This is described in issue #4879.

Fixes: #4879

How should we test and review this PR?

I tried to write a functional test, but I'm not sure how to check that stderr contains only a given substring, not a whole line.

rustbot · 2023-08-14T18:46:22Z

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @weihanglo (or someone else) soon.

Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (S-waiting-on-review and S-waiting-on-author) stays updated, invoking these commands when appropriate:

@rustbot author: the review is finished, PR author should check the comments and take action accordingly
@rustbot review: the author is ready for a review, this PR will be queued again in the reviewer's queue

weihanglo

Looks good to me. Do you want to deal with cargo test as well in this pull request, or a follow-up?

(Can also leave it there. I am fine with that 😁)

weihanglo · 2023-08-14T19:01:22Z

tests/testsuite/run.rs

+        .file("src/main.rs", r#"fn main() {println!("run-a");}"#)
+        .build();
+
+    p.cargo("run -vv").with_stderr("LD_LIBRARY_PATH").run();


This contains two shortcomings:

Different platforms have different library paths. This won't pass on Windows and macOS.

This matches both rustc and the final binary invocations. We can't tell whether the env is from which.

What about this? [..] for wildcard matches, and we match one env vars to verify the behavior.

Suggested change

p.cargo("run -vv").with_stderr("LD_LIBRARY_PATH").run();

p.cargo("run -vv")

.with_stderr(

"\

[COMPILING] a v0.0.1 ([CWD])

[RUNNING] `[..]CARGO_MANIFEST_DIR=[CWD][..] rustc --crate-name a[..]`

[FINISHED] dev [unoptimized + debuginfo] target(s) in [..]

[RUNNING] `[..]CARGO_MANIFEST_DIR=[CWD][..] target/debug/a[EXE]`",

)

.run();

tests/testsuite/run.rs

Kobzol · 2023-08-15T11:44:13Z

Thanks for the hints. I added support for cargo test too. I have to say, it would be really nice if cargo had auto-blessable tests with placeholders 😆 Getting the text output right is not straightforward.

weihanglo · 2023-08-15T22:36:23Z

I believe changing to

[RUNNING] `[..] rustdoc [..]--test [..]`

would fix CI failures.

BTW, is it possible to add a similar test for cargo bench?

Kobzol · 2023-08-16T11:48:15Z

Thanks for the hint! I fixed the two failing tests and used [DOCTEST] foo in the test test, as I noticed it was used in the failing tests. I also added a test for bench.

arlosi · 2023-08-16T17:17:36Z

Thanks!

@bors r+

bors · 2023-08-16T17:17:38Z

📌 Commit 4eac5a1 has been approved by arlosi

It is now in the queue for this repository.

Print environment variables for `cargo run` in extra verbose mode

bors · 2023-08-16T17:18:59Z

⌛ Testing commit 4eac5a1 with merge 522e9fc...

bors · 2023-08-16T18:12:13Z

☀️ Test successful - checks-actions
Approved by: arlosi
Pushing 522e9fc to master...

bors · 2023-08-16T18:12:16Z

👀 Test was successful, but fast-forwarding failed: 422 Update is not a fast forward

arlosi · 2023-08-17T05:32:11Z

@bors retry

bors · 2023-08-17T05:32:18Z

⌛ Testing commit 4eac5a1 with merge 7b61184...

bors · 2023-08-17T06:26:29Z

☀️ Test successful - checks-actions
Approved by: arlosi
Pushing 7b61184 to master...

Update cargo 15 commits in 7c3904d6c3ed54e8a413023519b55a536ad44d5b..80eca0e58fb2ff52c1e94fc191b55b37ed73e0e4 2023-08-14 20:11:43 +0000 to 2023-08-19 00:52:06 +0000 - chore: Downgrade serde below the binary blob (rust-lang/cargo#12528) - Improve error message for when no credential providers are available (rust-lang/cargo#12526) - Fix typo: "use" -> "used" (rust-lang/cargo#12522) - Document layout SemVer compatibility. (rust-lang/cargo#12169) - Make cargo-credential-gnome-secret built-in as cargo:libsecret (rust-lang/cargo#12521) - login: allow passing additional args to provider (rust-lang/cargo#12499) - cargo-credential-gnome-secret: dynamically load libsecret (rust-lang/cargo#12518) - credential-providers: make 1password no longer built-in (rust-lang/cargo#12507) - Print environment variables for `cargo run` in extra verbose mode (rust-lang/cargo#12498) - chore(cargo-util): bump version to 0.2.6 (rust-lang/cargo#12517) - credential: rename cargo:basic to cargo:token-from-stdout (rust-lang/cargo#12512) - fix(xtask-bump-check): query by package name to detect changes (rust-lang/cargo#12513) - ci: use pull request head commit whenever possible (rust-lang/cargo#12508) - Update hermit-abi (rust-lang/cargo#12504) - Crate checksum lookup query should match on semver build metadata (rust-lang/cargo#11447) r? ghost

rustbot assigned weihanglo Aug 14, 2023

rustbot added Command-run S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Aug 14, 2023

weihanglo reviewed Aug 14, 2023

View reviewed changes

arlosi requested changes Aug 14, 2023

View reviewed changes

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

Kobzol force-pushed the run-verbose-print-env branch from 4807d25 to f507281 Compare August 15, 2023 11:44

rustbot added the Command-test label Aug 15, 2023

Print environment variables for cargo run in extra verbose mode

5405cd3

Kobzol force-pushed the run-verbose-print-env branch from f507281 to 2db59da Compare August 15, 2023 11:45

Kobzol added 2 commits August 16, 2023 13:41

Print environment variables for cargo test in extra verbose mode

9267277

Add test for environment variables in verbose mode for cargo bench

4eac5a1

Kobzol force-pushed the run-verbose-print-env branch from 2db59da to 4eac5a1 Compare August 16, 2023 11:48

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 Aug 16, 2023

arlosi approved these changes Aug 16, 2023

View reviewed changes

bors added a commit that referenced this pull request Aug 16, 2023

Auto merge of #12498 - Kobzol:run-verbose-print-env, r=arlosi

522e9fc

Print environment variables for `cargo run` in extra verbose mode

bors merged commit 7b61184 into rust-lang:master Aug 17, 2023
18 checks passed

weihanglo mentioned this pull request Aug 17, 2023

cargo run -v should show setting of LD_LIBRARY_PATH #4879

Closed

Kobzol deleted the run-verbose-print-env branch August 17, 2023 07:45

weihanglo mentioned this pull request Aug 18, 2023

Update cargo rust-lang/rust#114979

Merged

ehuss added this to the 1.73.0 milestone Aug 22, 2023

alexallmont mentioned this pull request Jun 11, 2024

Get cargo environment without running code #14045

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Print environment variables for `cargo run` in extra verbose mode #12498

Print environment variables for `cargo run` in extra verbose mode #12498

Kobzol commented Aug 14, 2023

rustbot commented Aug 14, 2023

weihanglo left a comment

weihanglo Aug 14, 2023

Kobzol commented Aug 15, 2023

weihanglo commented Aug 15, 2023 •

edited

Loading

Kobzol commented Aug 16, 2023

arlosi commented Aug 16, 2023

bors commented Aug 16, 2023

bors commented Aug 16, 2023

bors commented Aug 16, 2023

bors commented Aug 16, 2023

arlosi commented Aug 17, 2023

bors commented Aug 17, 2023

bors commented Aug 17, 2023

-    p.cargo("run -vv").with_stderr("LD_LIBRARY_PATH").run();
+    p.cargo("run -vv")
+        .with_stderr(
+            "\
+[COMPILING] a v0.0.1 ([CWD])
+[RUNNING] `[..]CARGO_MANIFEST_DIR=[CWD][..] rustc --crate-name a[..]`
+[FINISHED] dev [unoptimized + debuginfo] target(s) in [..]
+[RUNNING] `[..]CARGO_MANIFEST_DIR=[CWD][..] target/debug/a[EXE]`",
+        )
+        .run();

Print environment variables for cargo run in extra verbose mode #12498

Print environment variables for cargo run in extra verbose mode #12498

Conversation

Kobzol commented Aug 14, 2023

What does this PR try to resolve?

How should we test and review this PR?

rustbot commented Aug 14, 2023

weihanglo left a comment

Choose a reason for hiding this comment

weihanglo Aug 14, 2023

Choose a reason for hiding this comment

Kobzol commented Aug 15, 2023

weihanglo commented Aug 15, 2023 • edited Loading

Kobzol commented Aug 16, 2023

arlosi commented Aug 16, 2023

bors commented Aug 16, 2023

bors commented Aug 16, 2023

bors commented Aug 16, 2023

bors commented Aug 16, 2023

arlosi commented Aug 17, 2023

bors commented Aug 17, 2023

bors commented Aug 17, 2023

Print environment variables for `cargo run` in extra verbose mode #12498

Print environment variables for `cargo run` in extra verbose mode #12498

weihanglo commented Aug 15, 2023 •

edited

Loading