project_model/
env.rs

1//! Cargo-like environment variables injection.
2use base_db::Env;
3use paths::Utf8Path;
4use rustc_hash::FxHashMap;
5
6use crate::{PackageData, TargetKind, cargo_config_file::CargoConfigFile};
7
8/// Recreates the compile-time environment variables that Cargo sets.
9///
10/// Should be synced with
11/// <https://doc.rust-lang.org/cargo/reference/environment-variables.html#environment-variables-cargo-sets-for-crates>
12///
13/// FIXME: ask Cargo to provide this data instead of re-deriving.
14pub(crate) fn inject_cargo_package_env(env: &mut Env, package: &PackageData) {
15    // FIXME: Missing variables:
16    // CARGO_BIN_NAME, CARGO_BIN_EXE_<name>
17
18    let manifest_dir = package.manifest.parent();
19    env.set("CARGO_MANIFEST_DIR", manifest_dir.as_str());
20    env.set("CARGO_MANIFEST_PATH", package.manifest.as_str());
21
22    env.set("CARGO_PKG_VERSION", package.version.to_string());
23    env.set("CARGO_PKG_VERSION_MAJOR", package.version.major.to_string());
24    env.set("CARGO_PKG_VERSION_MINOR", package.version.minor.to_string());
25    env.set("CARGO_PKG_VERSION_PATCH", package.version.patch.to_string());
26    env.set("CARGO_PKG_VERSION_PRE", package.version.pre.to_string());
27
28    env.set("CARGO_PKG_AUTHORS", package.authors.join(":"));
29
30    env.set("CARGO_PKG_NAME", package.name.clone());
31    env.set("CARGO_PKG_DESCRIPTION", package.description.as_deref().unwrap_or_default());
32    env.set("CARGO_PKG_HOMEPAGE", package.homepage.as_deref().unwrap_or_default());
33    env.set("CARGO_PKG_REPOSITORY", package.repository.as_deref().unwrap_or_default());
34    env.set("CARGO_PKG_LICENSE", package.license.as_deref().unwrap_or_default());
35    env.set(
36        "CARGO_PKG_LICENSE_FILE",
37        package.license_file.as_ref().map(ToString::to_string).unwrap_or_default(),
38    );
39    env.set(
40        "CARGO_PKG_README",
41        package.readme.as_ref().map(ToString::to_string).unwrap_or_default(),
42    );
43
44    env.set(
45        "CARGO_PKG_RUST_VERSION",
46        package.rust_version.as_ref().map(ToString::to_string).unwrap_or_default(),
47    );
48}
49
50pub(crate) fn inject_cargo_env(env: &mut Env, cargo_path: &Utf8Path) {
51    env.set("CARGO", cargo_path.as_str());
52}
53
54pub(crate) fn inject_rustc_tool_env(env: &mut Env, cargo_name: &str, kind: TargetKind) {
55    _ = kind;
56    // FIXME
57    // if kind.is_executable() {
58    //     env.set("CARGO_BIN_NAME", cargo_name);
59    // }
60    env.set("CARGO_CRATE_NAME", cargo_name.replace('-', "_"));
61}
62
63pub(crate) fn cargo_config_env(
64    config: &Option<CargoConfigFile>,
65    extra_env: &FxHashMap<String, Option<String>>,
66) -> Env {
67    use toml::de::*;
68
69    let mut env = Env::default();
70    env.extend(extra_env.iter().filter_map(|(k, v)| v.as_ref().map(|v| (k.clone(), v.clone()))));
71
72    let Some(config_reader) = config.as_ref().and_then(|c| c.read()) else {
73        return env;
74    };
75    let Some(env_toml) = config_reader.get(["env"]).and_then(|it| it.as_table()) else {
76        return env;
77    };
78
79    for (key, entry) in env_toml {
80        let key = key.as_ref().as_ref();
81        let value = match entry.as_ref() {
82            DeValue::String(s) => {
83                // Plain string entries have no `force` option, so they should not
84                // override existing environment variables (matching Cargo behavior).
85                if extra_env.get(key).is_some_and(Option::is_some) {
86                    continue;
87                }
88                if let Ok(val) = std::env::var(key) { val } else { String::from(s.clone()) }
89            }
90            DeValue::Table(entry) => {
91                // Each entry MUST have a `value` key.
92                let Some(map) = entry.get("value").and_then(|v| v.as_ref().as_str()) else {
93                    continue;
94                };
95                let is_forced =
96                    entry.get("force").and_then(|v| v.as_ref().as_bool()).unwrap_or(false);
97                // If the entry already exists in the environment AND the `force` key is not set
98                // to true, use the existing value instead of the config value.
99                if !is_forced {
100                    if extra_env.get(key).is_some_and(Option::is_some) {
101                        continue;
102                    }
103                    if let Ok(val) = std::env::var(key) {
104                        env.insert(key, val);
105                        continue;
106                    }
107                }
108
109                if let Some(base) = entry.get("relative").and_then(|v| {
110                    if v.as_ref().as_bool().is_some_and(std::convert::identity) {
111                        config_reader.get_origin_root(v)
112                    } else {
113                        None
114                    }
115                }) {
116                    base.join(map).to_string()
117                } else {
118                    map.to_owned()
119                }
120            }
121            _ => continue,
122        };
123
124        env.insert(key, value);
125    }
126
127    env
128}
129
130#[test]
131fn parse_output_cargo_config_env_works() {
132    use itertools::Itertools;
133
134    let cwd = paths::AbsPathBuf::try_from(
135        paths::Utf8PathBuf::try_from(std::env::current_dir().unwrap()).unwrap(),
136    )
137    .unwrap();
138    let config_path = cwd.join(".cargo").join("config.toml");
139    let raw = r#"
140env.RA_TEST_WORKSPACE_DIR.relative = true
141env.RA_TEST_WORKSPACE_DIR.value = ""
142env.RA_TEST_INVALID.relative = "invalidbool"
143env.RA_TEST_INVALID.value = "../relative"
144env.RA_TEST_RELATIVE.relative = true
145env.RA_TEST_RELATIVE.value = "../relative"
146env.RA_TEST_UNSET.value = "test"
147env.RA_TEST_FORCED.value = "test"
148env.RA_TEST_FORCED.force = true
149env.RA_TEST_UNFORCED.value = "test"
150env.RA_TEST_UNFORCED.forced = false
151env.RA_TEST_OVERWRITTEN.value = "test"
152env.RA_TEST_NOT_AN_OBJECT = "value"
153"#;
154    let raw = raw.lines().map(|l| format!("{l} # {config_path}")).join("\n");
155    let config = CargoConfigFile::from_string_for_test(raw);
156    let extra_env = [
157        ("RA_TEST_FORCED", Some("ignored")),
158        ("RA_TEST_UNFORCED", Some("newvalue")),
159        ("RA_TEST_OVERWRITTEN", Some("newvalue")),
160        ("RA_TEST_UNSET", None),
161    ]
162    .iter()
163    .map(|(k, v)| (k.to_string(), v.map(str::to_owned)))
164    .collect();
165    let env = cargo_config_env(&Some(config), &extra_env);
166    assert_eq!(env.get("RA_TEST_WORKSPACE_DIR").as_deref(), Some(cwd.join("").as_str()));
167    assert_eq!(env.get("RA_TEST_RELATIVE").as_deref(), Some(cwd.join("../relative").as_str()));
168    assert_eq!(env.get("RA_TEST_INVALID").as_deref(), Some("../relative"));
169    assert_eq!(env.get("RA_TEST_UNSET").as_deref(), Some("test"));
170    assert_eq!(env.get("RA_TEST_FORCED").as_deref(), Some("test"));
171    assert_eq!(env.get("RA_TEST_UNFORCED").as_deref(), Some("newvalue"));
172    assert_eq!(env.get("RA_TEST_OVERWRITTEN").as_deref(), Some("newvalue"));
173    assert_eq!(env.get("RA_TEST_NOT_AN_OBJECT").as_deref(), Some("value"));
174}
175
176#[test]
177fn cargo_config_env_respects_process_env() {
178    use itertools::Itertools;
179
180    let cwd = paths::AbsPathBuf::try_from(
181        paths::Utf8PathBuf::try_from(std::env::current_dir().unwrap()).unwrap(),
182    )
183    .unwrap();
184    let config_path = cwd.join(".cargo").join("config.toml");
185
186    // SAFETY: this test is not run in parallel with other tests that depend on these env vars.
187    unsafe {
188        std::env::set_var("RA_TEST_PROCESS_ENV_STRING", "from_process");
189        std::env::set_var("RA_TEST_PROCESS_ENV_TABLE", "from_process");
190        std::env::set_var("RA_TEST_PROCESS_ENV_FORCED", "from_process");
191    }
192
193    let raw = r#"
194env.RA_TEST_PROCESS_ENV_STRING = "from_config"
195env.RA_TEST_PROCESS_ENV_TABLE.value = "from_config"
196env.RA_TEST_PROCESS_ENV_FORCED.value = "from_config"
197env.RA_TEST_PROCESS_ENV_FORCED.force = true
198"#;
199    let raw = raw.lines().map(|l| format!("{l} # {config_path}")).join("\n");
200    let config = CargoConfigFile::from_string_for_test(raw);
201    let extra_env = FxHashMap::default();
202    let env = cargo_config_env(&Some(config), &extra_env);
203
204    // Plain string form should use process env value, not config value
205    assert_eq!(env.get("RA_TEST_PROCESS_ENV_STRING").as_deref(), Some("from_process"));
206    // Table form without force should use process env value, not config value
207    assert_eq!(env.get("RA_TEST_PROCESS_ENV_TABLE").as_deref(), Some("from_process"));
208    // Table form with force=true should override process env
209    assert_eq!(env.get("RA_TEST_PROCESS_ENV_FORCED").as_deref(), Some("from_config"));
210
211    unsafe {
212        std::env::remove_var("RA_TEST_PROCESS_ENV_STRING");
213        std::env::remove_var("RA_TEST_PROCESS_ENV_TABLE");
214        std::env::remove_var("RA_TEST_PROCESS_ENV_FORCED");
215    }
216}
project_model/env.rs

project_model/
env.rs
