Merge ignoring config files.

Alexhuszagh · Alexhuszagh · commit 8db82e4f0491 · 2022-07-12T20:05:52.000-05:00
diff --git a/.changes/931.json b/.changes/931.json
@@ -1,5 +1,12 @@
-{
-    "description": "add support for cargo aliases.",
-    "type": "added",
-    "issues": [562],
-}
+[
+    {
+        "description": "add support for cargo aliases.",
+        "type": "added",
+        "issues": [562],
+    },
+    {
+        "description": "allow users to ignore config files in the package.",
+        "type": "added",
+        "issues": [621]
+    }
+]
diff --git a/docs/cross_toml.md b/docs/cross_toml.md
@@ -21,6 +21,7 @@ For example:
 
 ```toml
 [build.env]
+ignore-cargo-config = false
 volumes = ["VOL1_ARG", "VOL2_ARG"]
 passthrough = ["IMPORTANT_ENV_VARIABLES"]
 ```
diff --git a/src/cargo_config.rs b/src/cargo_config.rs
@@ -1,7 +1,7 @@
 use std::collections::HashMap;
 
 use crate::cargo_toml::CargoToml;
-use crate::config::Environment;
+use crate::config::{split_to_cloned_by_ws, Environment};
 use crate::errors::*;
 
 pub const CARGO_NO_PREFIX_ENVVARS: &[&str] = &[
@@ -27,7 +27,7 @@ impl CargoEnvironment {
         let key = format!("ALIAS_{name}");
         self.0
             .get_var(&self.0.var_name(&key))
-            .map(|x| x.split_whitespace().map(ToOwned::to_owned).collect())
+            .map(|x| split_to_cloned_by_ws(&x))
     }
 }
 
diff --git a/src/cargo_toml.rs b/src/cargo_toml.rs
@@ -2,6 +2,7 @@ use std::collections::BTreeSet;
 use std::env;
 use std::path::Path;
 
+use crate::config::split_to_cloned_by_ws;
 use crate::errors::*;
 use crate::file;
 
@@ -123,7 +124,7 @@ impl CargoToml {
     pub fn alias(&self, name: &str) -> Result<Option<Vec<String>>> {
         let parse_alias = |value: &Value| -> Result<Vec<String>> {
             if let Some(s) = value.as_str() {
-                Ok(s.split_whitespace().map(ToOwned::to_owned).collect())
+                Ok(split_to_cloned_by_ws(s))
             } else if let Some(a) = value.as_array() {
                 a.iter()
                     .map(|i| {
diff --git a/src/cli.rs b/src/cli.rs
@@ -182,7 +182,7 @@ fn parse_subcommand(
     config: &CargoConfig,
     seen: &mut Vec<String>,
 ) -> Result<()> {
-    if seen.iter().position(|x| x == &arg).is_some() {
+    if seen.iter().any(|x| x == &arg) {
         let chain = seen.join(" -> ");
         MessageInfo::default().fatal(
             format_args!("alias {arg} has unresolvable recursive definition: {chain} -> {arg}"),
@@ -203,7 +203,7 @@ fn parse_subcommand(
     }
 
     // fallthrough
-    result.all.push(arg.clone());
+    result.all.push(arg);
     result.subcommand = Some(subcommand);
 
     Ok(())
diff --git a/src/config.rs b/src/config.rs
@@ -15,6 +15,10 @@ pub fn bool_from_envvar(envvar: &str) -> bool {
     }
 }
 
+pub fn split_to_cloned_by_ws(string: &str) -> Vec<String> {
+    string.split_whitespace().map(String::from).collect()
+}
+
 #[derive(Debug)]
 pub struct Environment(&'static str, Option<HashMap<&'static str, &'static str>>);
 
diff --git a/src/cross_config.rs b/src/cross_config.rs
@@ -1,6 +1,6 @@
 use std::collections::HashMap;
 
-use crate::config::{bool_from_envvar, Environment};
+use crate::config::{bool_from_envvar, split_to_cloned_by_ws, Environment};
 use crate::docker::custom::PreBuild;
 use crate::shell::MessageInfo;
 use crate::{CrossToml, Result, Target, TargetList};
@@ -84,6 +84,10 @@ impl CrossEnvironment {
         self.get_target_var(target, "RUNNER")
     }
 
+    fn ignore_cargo_config(&self, target: &Target) -> (Option<bool>, Option<bool>) {
+        self.get_values_for("ENV_IGNORE_CARGO_CONFIG", target, bool_from_envvar)
+    }
+
     fn passthrough(&self, target: &Target) -> (Option<Vec<String>>, Option<Vec<String>>) {
         self.get_values_for("ENV_PASSTHROUGH", target, split_to_cloned_by_ws)
     }
@@ -108,10 +112,6 @@ impl CrossEnvironment {
     }
 }
 
-fn split_to_cloned_by_ws(string: &str) -> Vec<String> {
-    string.split_whitespace().map(String::from).collect()
-}
-
 #[derive(Debug)]
 pub struct CrossConfig {
     toml: Option<CrossToml>,
@@ -272,6 +272,14 @@ impl CrossConfig {
         self.env.custom_toolchain()
     }
 
+    pub fn env_ignore_cargo_config(&self, target: &Target) -> Option<bool> {
+        self.bool_from_config(
+            target,
+            CrossEnvironment::ignore_cargo_config,
+            CrossToml::env_ignore_cargo_config,
+        )
+    }
+
     pub fn env_passthrough(&self, target: &Target) -> Result<Option<Vec<String>>> {
         self.vec_from_config(
             target,
diff --git a/src/cross_toml.rs b/src/cross_toml.rs
@@ -15,7 +15,9 @@ use serde::{Deserialize, Deserializer, Serialize};
 
 /// Environment configuration
 #[derive(Debug, Serialize, Deserialize, PartialEq, Eq, Default)]
+#[serde(rename_all = "kebab-case")]
 pub struct CrossEnvConfig {
+    ignore_cargo_config: Option<bool>,
     volumes: Option<Vec<String>>,
     passthrough: Option<Vec<String>>,
 }
@@ -74,6 +76,7 @@ impl FromStr for CrossTargetDockerfileConfig {
 
 /// Cross configuration
 #[derive(Debug, Serialize, Deserialize, PartialEq, Eq, Default)]
+#[serde(rename_all = "kebab-case")]
 pub struct CrossToml {
     #[serde(default, rename = "target")]
     pub targets: HashMap<Target, CrossTargetConfig>,
@@ -321,6 +324,15 @@ impl CrossToml {
         self.get_value(target, |b| b.build_std, |t| t.build_std)
     }
 
+    /// Returns the whether to ignore cargo config files.
+    pub fn env_ignore_cargo_config(&self, target: &Target) -> (Option<bool>, Option<bool>) {
+        self.get_value(
+            target,
+            |b| b.env.ignore_cargo_config,
+            |t| t.env.ignore_cargo_config,
+        )
+    }
+
     /// Returns the list of environment variables to pass through for `build` and `target`
     pub fn env_passthrough(&self, target: &Target) -> (Option<&[String]>, Option<&[String]>) {
         self.get_ref(
@@ -537,6 +549,7 @@ mod tests {
             targets: HashMap::new(),
             build: CrossBuildConfig {
                 env: CrossEnvConfig {
+                    ignore_cargo_config: Some(false),
                     volumes: Some(vec![s!("VOL1_ARG"), s!("VOL2_ARG")]),
                     passthrough: Some(vec![s!("VAR1"), s!("VAR2")]),
                 },
@@ -554,6 +567,7 @@ mod tests {
           pre-build = ["echo 'Hello World!'"]
 
           [build.env]
+          ignore-cargo-config = false
           volumes = ["VOL1_ARG", "VOL2_ARG"]
           passthrough = ["VAR1", "VAR2"]
         "#;
@@ -574,6 +588,7 @@ mod tests {
             },
             CrossTargetConfig {
                 env: CrossEnvConfig {
+                    ignore_cargo_config: None,
                     passthrough: Some(vec![s!("VAR1"), s!("VAR2")]),
                     volumes: Some(vec![s!("VOL1_ARG"), s!("VOL2_ARG")]),
                 },
@@ -628,6 +643,7 @@ mod tests {
                 pre_build: Some(PreBuild::Lines(vec![s!("echo 'Hello'")])),
                 runner: None,
                 env: CrossEnvConfig {
+                    ignore_cargo_config: None,
                     passthrough: None,
                     volumes: Some(vec![s!("VOL")]),
                 },
@@ -638,6 +654,7 @@ mod tests {
             targets: target_map,
             build: CrossBuildConfig {
                 env: CrossEnvConfig {
+                    ignore_cargo_config: Some(true),
                     volumes: None,
                     passthrough: Some(vec![]),
                 },
@@ -655,6 +672,7 @@ mod tests {
             pre-build = []
 
             [build.env]
+            ignore-cargo-config = true
             passthrough = []
 
             [target.aarch64-unknown-linux-gnu]
@@ -696,6 +714,7 @@ mod tests {
             targets: HashMap::new(),
             build: CrossBuildConfig {
                 env: CrossEnvConfig {
+                    ignore_cargo_config: None,
                     passthrough: None,
                     volumes: None,
                 },
diff --git a/src/docker/local.rs b/src/docker/local.rs
@@ -55,7 +55,7 @@ pub(crate) fn run(
     docker
         .args(&["-v", &format!("{}:/rust:Z,ro", dirs.sysroot.to_utf8()?)])
         .args(&["-v", &format!("{}:/target:Z", dirs.target.to_utf8()?)]);
-    docker_cwd(&mut docker, &paths)?;
+    docker_cwd(&mut docker, &paths, options.ignore_cargo_config)?;
 
     // When running inside NixOS or using Nix packaging we need to add the Nix
     // Store to the running container so it can load the needed binaries.
diff --git a/src/docker/remote.rs b/src/docker/remote.rs
@@ -1170,7 +1170,7 @@ symlink_recurse \"${{prefix}}\"
     let mut docker = subcommand(engine, "exec");
     docker_user_id(&mut docker, engine.kind);
     docker_envvars(&mut docker, &options.config.cross, target, msg_info)?;
-    docker_cwd(&mut docker, &paths)?;
+    docker_cwd(&mut docker, &paths, options.ignore_cargo_config)?;
     docker.arg(&container);
     docker.args(&["sh", "-c", &format!("PATH=$PATH:/rust/bin {:?}", cmd)]);
     bail_container_exited!();
diff --git a/src/docker/shared.rs b/src/docker/shared.rs
@@ -11,7 +11,7 @@ use crate::config::{bool_from_envvar, Config};
 use crate::cross_config::CrossConfig;
 use crate::errors::*;
 use crate::extensions::{CommandExt, SafeCommand};
-use crate::file::{self, write_file, ToUtf8};
+use crate::file::{self, write_file, PathExt, ToUtf8};
 use crate::id;
 use crate::rustc::{self, VersionMetaExt};
 use crate::shell::{MessageInfo, Verbosity};
@@ -39,15 +39,23 @@ pub struct DockerOptions {
     pub target: Target,
     pub config: Config,
     pub uses_xargo: bool,
+    pub ignore_cargo_config: bool,
 }
 
 impl DockerOptions {
-    pub fn new(engine: Engine, target: Target, config: Config, uses_xargo: bool) -> DockerOptions {
+    pub fn new(
+        engine: Engine,
+        target: Target,
+        config: Config,
+        uses_xargo: bool,
+        ignore_cargo_config: bool,
+    ) -> DockerOptions {
         DockerOptions {
             engine,
             target,
             config,
             uses_xargo,
+            ignore_cargo_config,
         }
     }
 
@@ -225,10 +233,18 @@ impl DockerPaths {
         self.workspace_from_cwd().is_ok()
     }
 
+    pub fn cargo_home(&self) -> &Path {
+        &self.directories.cargo
+    }
+
     pub fn mount_cwd(&self) -> &str {
         &self.directories.mount_cwd
     }
 
+    pub fn mount_root(&self) -> &str {
+        &self.directories.mount_root
+    }
+
     pub fn host_root(&self) -> &Path {
         &self.directories.host_root
     }
@@ -494,8 +510,44 @@ pub(crate) fn docker_envvars(
     Ok(())
 }
 
-pub(crate) fn docker_cwd(docker: &mut Command, paths: &DockerPaths) -> Result<()> {
+fn mount_to_ignore_cargo_config(
+    docker: &mut Command,
+    paths: &DockerPaths,
+    ignore_cargo_config: bool,
+) -> Result<()> {
+    let check_mount =
+        |cmd: &mut Command, host: &Path, mount: &Path, relpath: &Path| -> Result<()> {
+            let cargo_dir = relpath.join(".cargo");
+            if host.join(&cargo_dir).exists() {
+                // this is fine, since it has to be a POSIX path on the mount.
+                cmd.args(&["-v", &mount.join(&cargo_dir).as_posix()?]);
+            }
+
+            Ok(())
+        };
+    if ignore_cargo_config {
+        let mount_root = Path::new(paths.mount_root());
+        let mount_cwd = Path::new(paths.mount_cwd());
+        check_mount(docker, &paths.cwd, mount_cwd, Path::new(""))?;
+        // CWD isn't guaranteed to be a subdirectory of the mount root.
+        if let Ok(mut relpath) = mount_cwd.strip_prefix(mount_root) {
+            while let Some(parent) = relpath.parent() {
+                check_mount(docker, paths.host_root(), mount_root, parent)?;
+                relpath = parent;
+            }
+        }
+    }
+
+    Ok(())
+}
+
+pub(crate) fn docker_cwd(
+    docker: &mut Command,
+    paths: &DockerPaths,
+    ignore_cargo_config: bool,
+) -> Result<()> {
     docker.args(&["-w", paths.mount_cwd()]);
+    mount_to_ignore_cargo_config(docker, paths, ignore_cargo_config)?;
 
     Ok(())
 }
diff --git a/src/lib.rs b/src/lib.rs

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`use std::collections::HashMap;`
`2`	`2`
`3`	`3`	`use crate::cargo_toml::CargoToml;`
`4`		`-use crate::config::Environment;`
	`4`	`+use crate::config::{split_to_cloned_by_ws, Environment};`
`5`	`5`	`use crate::errors::*;`
`6`	`6`
`7`	`7`	`pub const CARGO_NO_PREFIX_ENVVARS: &[&str] = &[`
`@@ -27,7 +27,7 @@ impl CargoEnvironment {`
`27`	`27`	`let key = format!("ALIAS_{name}");`
`28`	`28`	`self.0`
`29`	`29`	`.get_var(&self.0.var_name(&key))`
`30`		`- .map(\|x\| x.split_whitespace().map(ToOwned::to_owned).collect())`
	`30`	`+ .map(\|x\| split_to_cloned_by_ws(&x))`
`31`	`31`	`}`
`32`	`32`	`}`
`33`	`33`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,10 @@ pub fn bool_from_envvar(envvar: &str) -> bool {`
`15`	`15`	`}`
`16`	`16`	`}`
`17`	`17`
	`18`	`+pub fn split_to_cloned_by_ws(string: &str) -> Vec<String> {`
	`19`	`+ string.split_whitespace().map(String::from).collect()`
	`20`	`+}`
	`21`	`+`
`18`	`22`	`#[derive(Debug)]`
`19`	`23`	`pub struct Environment(&'static str, Option<HashMap<&'static str, &'static str>>);`
`20`	`24`