fix: reset $CARGO if the running program is real `cargo[.exe]` #15208

smoelius · 2025-02-20T11:27:16Z

Overwrite $CARGO when the current exe is detected to be a cargo binary.

opt-in behavior (set by cargo-the-bin):

from_current_exe if its cargo[EXE_SUFFIX]

from_argv if its cargo[EXE_SUFFIX]

from_env

from_current_exe

from_argv

r? @epage

smoelius · 2025-02-20T11:43:27Z

I'll fix the errors shortly.

weihanglo

Thanks for the patch!

Please allow me time to test against the dynamic linker use case.

src/cargo/util/context/mod.rs

smoelius · 2025-02-21T13:11:53Z

Just because I am curious, is the reason for the recent CI failures known?

epage · 2025-02-21T13:50:31Z

They were fixed in #15211

One was because of a short term hack until 1.85 was released which then needed to be removed
We're experimenting with automating the fix for the other one in chore(ci): Auto-update cargo-semver-checks #15212.

smoelius · 2025-02-21T14:01:29Z

We're experimenting with automating the fix for the other one in chore(ci): Auto-update cargo-semver-checks #15212.

Oh, interesting! Thank you for explaining!

Overwrite `$CARGO` when the current exe is detected to be a cargo binary. See: rust-lang#15099 (comment)

smoelius · 2025-02-21T21:07:47Z

If I'm interpreting the results right, path normalization is applied to stderr but not stdout?

~~EDIT: I did some experiments, and that seems to be how snapbox works?~~

Anyway, the PR should be ready for review.

weihanglo

Did manual tests for ld wrapper from what Joo's has described in #10113. This seems working!

One thing I am not sure is this characteristic:

We don't fix this issue for when users have an alternative name for the Cargo binary (or on some platforms, an alternative symlink name)

Should we document our heuristic rule in the CARGO env doc? I feel like it might be excessive and don't want to wait for a perfect doc to merge this fix.

tests/testsuite/freshness.rs

weihanglo · 2025-02-23T18:58:31Z

tests/testsuite/cargo_command.rs

@@ -391,10 +391,13 @@ fn cargo_subcommand_env() {
        .canonicalize()
        .unwrap();
    let envtest_bin = envtest_bin.to_str().unwrap();
+    // Previously, `$CARGO` would be left at `envtest_bin`. However, with the


Seeing this test change and I wonder if using $CARGO as a Cargo wrapper is a supported use case, and we don't want to reset it.

Maybe we can detect iff the current $CARGO is cargo[.exe] and then we reset?

cc @epage as you proposed the current solution

I have no problem with implementing this if @epage agrees.

CARGO was originally not intended for purposes of being a wrapper. That people could do it was a byproduct of the implementation that was done but it wasn't intentional. I wouldn't worry too much about it.

That is fair. Thanks Ed.

smoelius · 2025-02-23T23:24:36Z

One thing I am not sure is this characteristic:

We don't fix this issue for when users have an alternative name for the Cargo binary (or on some platforms, an alternative symlink name)

Should we document our heuristic rule in the CARGO env doc? I feel like it might be excessive and don't want to wait for a perfect doc to merge this fix.

I would just point out that the current description of each variable is light on details: https://doc.rust-lang.org/cargo/reference/environment-variables.html#environment-variables-cargo-sets-for-crates

I think there some benefit to this, as it makes the list easy to scan.

weihanglo

Thanks for working with us for this fix!

Update cargo 22 commits in 2622e844bc1e2e6123e54e94e4706f7b6195ce3d..ab1463d632528e39daf35f263e10c14cbe590ce8 2025-02-28 12:33:57 +0000 to 2025-03-08 01:45:05 +0000 - test: redact host target when comparing CARGO_ENV path (rust-lang/cargo#15279) - feat: add completions for install --path (rust-lang/cargo#15266) - fix(package): report lockfile / workspace manifest is dirty (rust-lang/cargo#15276) - feat(tree): Add `--depth public` behind `-Zunstable-options` (rust-lang/cargo#15243) - Don't use `$CARGO_BUILD_TARGET` in `cargo metadata` (rust-lang/cargo#15271) - feat: show extra build description from bootstrap (rust-lang/cargo#15269) - Upgrade to `rustc-stable-hash v0.1.2` (rust-lang/cargo#15268) - fix: Respect --frozen everywhere --offline or --locked is accepted (rust-lang/cargo#15263) - feat(tree): Color the output (rust-lang/cargo#15242) - fix(vendor): dont remove non-cached source (rust-lang/cargo#15260) - docs: lockfile is always included since 1.84 (rust-lang/cargo#15257) - Remove `Cargo.toml` from `package.include` in example (rust-lang/cargo#15253) - Small cleanup: remove unneeded result (rust-lang/cargo#15256) - Fix typo in build-scripts.md (rust-lang/cargo#15254) - chore(deps): update rust crate pulldown-cmark to 0.13.0 (rust-lang/cargo#15250) - chore(deps): update compatible (rust-lang/cargo#15249) - feat(cli): forward bash completions of third party subcommands (rust-lang/cargo#15247) - feat: add completions for `--lockfile-path` (rust-lang/cargo#15238) - fix: reset $CARGO if the running program is real `cargo[.exe]` (rust-lang/cargo#15208) - Get all members as `available targets` even though default-members was specified. (rust-lang/cargo#15199) - refactor: control byte display precision with std::fmt options (rust-lang/cargo#15246) - fix(package): Ensure we can package directories ending with '.rs' (rust-lang/cargo#15240)

rustbot assigned epage Feb 20, 2025

rustbot added A-configuration Area: cargo config files and env vars S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Feb 20, 2025

smoelius marked this pull request as draft February 20, 2025 11:45

weihanglo reviewed Feb 20, 2025

View reviewed changes

src/cargo/util/context/mod.rs Outdated Show resolved Hide resolved

src/cargo/util/context/mod.rs Show resolved Hide resolved

weihanglo changed the title ~~Fix #15099~~ fix: reset $CARGO if the running program is real cargo[.exe] Feb 20, 2025

smoelius force-pushed the fix-15099 branch 2 times, most recently from 9c65e60 to 2c7e098 Compare February 20, 2025 18:14

smoelius force-pushed the fix-15099 branch 2 times, most recently from 0a8a248 to 0ce3f9e Compare February 21, 2025 18:12

Fix rust-lang#15099

44970a8

Overwrite `$CARGO` when the current exe is detected to be a cargo binary. See: rust-lang#15099 (comment)

smoelius force-pushed the fix-15099 branch from 0ce3f9e to 44970a8 Compare February 21, 2025 20:33

smoelius marked this pull request as ready for review February 21, 2025 21:04

weihanglo reviewed Feb 23, 2025

View reviewed changes

Move test to cargo_command.rs

a6fdc01

weihanglo added A-environment-variables Area: environment variables A-custom-subcommands Area: custom 3rd party subcommand plugins labels Feb 24, 2025

weihanglo approved these changes Feb 28, 2025

View reviewed changes

weihanglo added this pull request to the merge queue Feb 28, 2025

Merged via the queue into rust-lang:master with commit 58cfd96 Feb 28, 2025
21 checks passed

weihanglo linked an issue Feb 28, 2025 that may be closed by this pull request

$CARGO passed to external subcommands can point to the wrong cargo if already set #15099

Closed

weihanglo mentioned this pull request Feb 28, 2025

$CARGO passed to external subcommands can point to the wrong cargo if already set #15099

Closed

smoelius mentioned this pull request Feb 28, 2025

Warn about CARGO environment variable in cargo proxy rust-lang/rustup#4175

Closed

weihanglo mentioned this pull request Mar 8, 2025

Update cargo rust-lang/rust#138200

Merged

rustbot added this to the 1.87.0 milestone Mar 10, 2025

Alexendoo mentioned this pull request Apr 9, 2025

Weird behavior of clippy in qualification script rust-lang/rust-clippy#14045

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: reset $CARGO if the running program is real `cargo[.exe]` #15208

fix: reset $CARGO if the running program is real `cargo[.exe]` #15208

smoelius commented Feb 20, 2025

smoelius commented Feb 20, 2025

weihanglo left a comment

smoelius commented Feb 21, 2025

epage commented Feb 21, 2025

smoelius commented Feb 21, 2025

smoelius commented Feb 21, 2025 •

edited

Loading

weihanglo left a comment

weihanglo Feb 23, 2025

weihanglo Feb 23, 2025

smoelius Feb 23, 2025 •

edited

Loading

epage Feb 28, 2025

weihanglo Feb 28, 2025

smoelius commented Feb 23, 2025

weihanglo left a comment

fix: reset $CARGO if the running program is real cargo[.exe] #15208

fix: reset $CARGO if the running program is real cargo[.exe] #15208

Conversation

smoelius commented Feb 20, 2025

smoelius commented Feb 20, 2025

weihanglo left a comment

Choose a reason for hiding this comment

smoelius commented Feb 21, 2025

epage commented Feb 21, 2025

smoelius commented Feb 21, 2025

smoelius commented Feb 21, 2025 • edited Loading

weihanglo left a comment

Choose a reason for hiding this comment

weihanglo Feb 23, 2025

Choose a reason for hiding this comment

weihanglo Feb 23, 2025

Choose a reason for hiding this comment

smoelius Feb 23, 2025 • edited Loading

Choose a reason for hiding this comment

epage Feb 28, 2025

Choose a reason for hiding this comment

weihanglo Feb 28, 2025

Choose a reason for hiding this comment

smoelius commented Feb 23, 2025

weihanglo left a comment

Choose a reason for hiding this comment

fix: reset $CARGO if the running program is real `cargo[.exe]` #15208

fix: reset $CARGO if the running program is real `cargo[.exe]` #15208

smoelius commented Feb 21, 2025 •

edited

Loading

smoelius Feb 23, 2025 •

edited

Loading