Skip to content
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

Jump to bottom

fix: apply [env] to target info discovery rustc #12029

Merged
merged 2 commits into from
Apr 25, 2023
Merged

fix: apply [env] to target info discovery rustc #12029

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift click to select a range
e1c7ce8
test: `[env]` isn't applied to target info discovery rustc
weihanglo Apr 24, 2023
00484fe
fix: apply `[env]` to target info discovery rustc
weihanglo Apr 24, 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
2 changes: 2 additions & 0 deletions src/cargo/core/compiler/build_context/target_info.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 7,7 @@
//! * [`RustcTargetData::info`] to get a [`TargetInfo`] for an in-depth query.
//! * [`TargetInfo::rustc_outputs`] to get a list of supported file types.

use crate::core::compiler::apply_env_config;
use crate::core::compiler::{
BuildOutput, CompileKind, CompileMode, CompileTarget, Context, CrateType,
};
Expand Down Expand Up @@ -175,6 176,7 @@ impl TargetInfo {
//
// Search `--print` to see what we query so far.
let mut process = rustc.workspace_process();
apply_env_config(config, &mut process)?;
process
.arg("-")
.arg("--crate-name")
Expand Down
15 changes: 3 additions & 12 deletions src/cargo/core/compiler/compilation.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 7,8 @@ use std::path::PathBuf;
use cargo_platform::CfgExpr;
use cargo_util::{paths, ProcessBuilder};

use super::BuildContext;
use crate::core::compiler::apply_env_config;
use crate::core::compiler::BuildContext;
use crate::core::compiler::{CompileKind, Metadata, Unit};
use crate::core::Package;
use crate::util::{config, CargoResult, Config};
Expand Down Expand Up @@ -349,17 350,7 @@ impl<'cfg> Compilation<'cfg> {
)
.cwd(pkg.root());

// Apply any environment variables from the config
for (key, value) in self.config.env_config()?.iter() {
// never override a value that has already been set by cargo
if cmd.get_envs().contains_key(key) {
continue;
}

if value.is_force() || self.config.get_env_os(key).is_none() {
cmd.env(key, value.resolve(self.config));
}
}
apply_env_config(self.config, &mut cmd)?;

Ok(cmd)
}
Expand Down
15 changes: 15 additions & 0 deletions src/cargo/core/compiler/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1805,3 1805,18 @@ fn descriptive_pkg_name(name: &str, target: &Target, mode: &CompileMode) -> Stri
};
format!("`{name}` ({desc_name}{mode})")
}

/// Applies environment variables from config `[env]` to [`ProcessBuilder`].
fn apply_env_config(config: &crate::Config, cmd: &mut ProcessBuilder) -> CargoResult<()> {
for (key, value) in config.env_config()?.iter() {
// never override a value that has already been set by cargo
if cmd.get_envs().contains_key(key) {
continue;
}

if value.is_force() || config.get_env_os(key).is_none() {
cmd.env(key, value.resolve(config));
}
}
Ok(())
}
58 changes: 58 additions & 0 deletions tests/testsuite/cargo_env_config.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 1,6 @@
//! Tests for `[env]` config.

use cargo_test_support::basic_manifest;
use cargo_test_support::{basic_bin_manifest, project};

#[cargo_test]
Expand Down Expand Up @@ -179,3 180,60 @@ fn env_no_override() {
.with_stdout_contains("CARGO_PKG_NAME:unchanged")
.run();
}

#[cargo_test]
fn env_applied_to_target_info_discovery_rustc() {
let wrapper = project()
.at("wrapper")
.file("Cargo.toml", &basic_manifest("wrapper", "1.0.0"))
.file(
"src/main.rs",
r#"
fn main() {
let mut args = std::env::args().skip(1);
let env_test = std::env::var("ENV_TEST").unwrap();
eprintln!("WRAPPER ENV_TEST:{env_test}");
let status = std::process::Command::new(&args.next().unwrap())
.args(args).status().unwrap();
std::process::exit(status.code().unwrap_or(1));
}
"#,
)
.build();
wrapper.cargo("build").run();
let wrapper = &wrapper.bin("wrapper");

let p = project()
.file("Cargo.toml", &basic_bin_manifest("foo"))
.file(
"src/main.rs",
r#"
fn main() {
eprintln!( "MAIN ENV_TEST:{}", std::env!("ENV_TEST") );
}
"#,
)
.file(
".cargo/config",
r#"
[env]
ENV_TEST = "from-config"
"#,
)
.build();

p.cargo("run")
.env("RUSTC_WORKSPACE_WRAPPER", wrapper)
.with_stderr_contains("WRAPPER ENV_TEST:from-config")
.with_stderr_contains("MAIN ENV_TEST:from-config")
.run();

// Ensure wrapper also maintains the same overridden priority for envs.
p.cargo("clean").run();
p.cargo("run")
.env("ENV_TEST", "from-env")
.env("RUSTC_WORKSPACE_WRAPPER", wrapper)
.with_stderr_contains("WRAPPER ENV_TEST:from-env")
.with_stderr_contains("MAIN ENV_TEST:from-env")
.run();
}