Skip to content

Disallow RUSTUP_HOME in the [env] table. #12101

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 7, 2023
Merged

Disallow RUSTUP_HOME in the [env] table. #12101

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4ec06f4
Disallow RUSTUP_HOME in the [env] table.
ehuss May 7, 2023
2fce10d
Add a comment describing why these are disallowed.
ehuss May 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions src/cargo/util/config/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1745,8 +1745,13 @@ impl Config {
.env_config
.try_borrow_with(|| self.get::<EnvConfig>("env"))?;

if env_config.get("CARGO_HOME").is_some() {
bail!("setting the `CARGO_HOME` environment variable is not supported in the `[env]` configuration table")
for disallowed in &["CARGO_HOME", "RUSTUP_HOME"] {
if env_config.contains_key(*disallowed) {
bail!(
"setting the `{disallowed}` environment variable is not supported \
in the `[env]` configuration table"
);
}
}

Ok(env_config)
Expand Down
42 changes: 22 additions & 20 deletions tests/testsuite/cargo_env_config.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,29 +59,31 @@ fn env_invalid() {
}

#[cargo_test]
fn env_no_cargo_home() {
fn env_no_disallowed() {
// Checks for keys that are not allowed in the [env] table.
let p = project()
.file("Cargo.toml", &basic_bin_manifest("foo"))
.file(
"src/main.rs",
r#"
fn main() {
}
"#,
)
.file(
".cargo/config",
r#"
[env]
CARGO_HOME = "/"
"#,
)
.file("Cargo.toml", &basic_manifest("foo", "1.0.0"))
.file("src/lib.rs", "")
.build();

p.cargo("check")
.with_status(101)
.with_stderr_contains("[..]setting the `CARGO_HOME` environment variable is not supported in the `[env]` configuration table")
.run();
for disallowed in &["CARGO_HOME", "RUSTUP_HOME"] {
p.change_file(
".cargo/config",
&format!(
r#"
[env]
{disallowed} = "foo"
"#
),
);
p.cargo("check")
.with_status(101)
.with_stderr(&format!(
"[ERROR] setting the `{disallowed}` environment variable \
is not supported in the `[env]` configuration table"
))
.run();
}
}

#[cargo_test]
Expand Down