Clear RUSTFLAGS when building workspace metadata entries

trailofbits · Jan 3, 2023 · a5f0d4f · a5f0d4f
1 parent c8d0256
commit a5f0d4f
Show file tree

Hide file tree

Showing 3 changed files with 51 additions and 2 deletions.
diff --git a/cargo-dylint/tests/metadata.rs b/cargo-dylint/tests/metadata.rs
@@ -1,5 +1,5 @@
 use assert_cmd::prelude::*;
-use dylint_internal::packaging::isolate;
+use dylint_internal::{env, packaging::isolate};
 use predicates::prelude::*;
 use std::{fs::OpenOptions, io::Write};
 use tempfile::{tempdir, tempdir_in};
@@ -107,3 +107,48 @@ path = "../../examples/general/nonexistent_library"
         .failure()
         .stderr(predicate::str::contains("No paths matched"));
 }
+
+#[test]
+fn rustflags_change() {
+    let tempdir = tempdir_in(".").unwrap();
+
+    dylint_internal::cargo::init("package `rustflags_change_test`", false)
+        .current_dir(&tempdir)
+        .args(["--name", "rustflags_change_test"])
+        .success()
+        .unwrap();
+
+    isolate(tempdir.path()).unwrap();
+
+    let mut file = OpenOptions::new()
+        .write(true)
+        .append(true)
+        .open(tempdir.path().join("Cargo.toml"))
+        .unwrap();
+
+    write!(
+        file,
+        r#"
+[[workspace.metadata.dylint.libraries]]
+path = "../../examples/general/crate_wide_allow"
+"#
+    )
+    .unwrap();
+
+    std::process::Command::cargo_bin("cargo-dylint")
+        .unwrap()
+        .current_dir(&tempdir)
+        .args(["dylint", "--all"])
+        .assert()
+        .success()
+        .stderr(predicate::str::contains("Compiling"));
+
+    std::process::Command::cargo_bin("cargo-dylint")
+        .unwrap()
+        .current_dir(&tempdir)
+        .env(env::RUSTFLAGS, "--verbose")
+        .args(["dylint", "--all"])
+        .assert()
+        .success()
+        .stderr(predicate::str::contains("Compiling").not());
+}
diff --git a/dylint/src/metadata.rs b/dylint/src/metadata.rs
@@ -10,7 +10,7 @@ use cargo::{
     util::Config,
 };
 use cargo_metadata::{Error, Metadata, MetadataCommand};
-use dylint_internal::rustup::SanitizeEnvironment;
+use dylint_internal::{env, rustup::SanitizeEnvironment};
 use glob::glob;
 use if_chain::if_chain;
 use serde::Deserialize;
@@ -314,11 +314,14 @@ fn package_library_path(
     let target_dir = target_dir(metadata, package_root, package_id)?;
 
     if !opts.no_build {
+        // smoelius: Clear `RUSTFLAGS` so that changes to it do not cause workspace metadata entries
+        // to be rebuilt.
         dylint_internal::cargo::build(
             &format!("workspace metadata entry `{}`", package_id.name()),
             opts.quiet,
         )
         .sanitize_environment()
+        .env_remove(env::RUSTFLAGS)
         .current_dir(package_root)
         .args(["--release", "--target-dir", &target_dir.to_string_lossy()])
         .success()?;

diff --git a/examples/general/crate_wide_allow/src/lib.rs b/examples/general/crate_wide_allow/src/lib.rs
@@ -111,6 +111,7 @@ mod test {
     // smoelius: The real reason this test is slow is that setting `RUSTFLAGS` causes the metadata
     // entries to be rebuilt. Running `clippy` once and passing `--no-build` thereafter avoids this
     // problem.
+    // smoelius: Metadata entries are no longer rebuilt when `RUSTFLAGS` changes.
 
     fn test(rustflags: &str, assert: impl Fn(Assert) -> Assert) {
         let _lock = MUTEX.lock().unwrap();