implement checks for target dir in cargo clean using CACHEDIR.TAG

Author: TanmayArya-1p

src/bin/cargo/commands/clean.rs

@@ -163,6 +163,7 @@ pub fn exec(gctx: &mut GlobalContext, args: &ArgMatches) -> CliResult {
         profile_specified: args.contains_id("profile") || args.flag("release"),
         doc: args.flag("doc"),
         dry_run: args.dry_run(),
+        explicit_target_dir_arg: args.contains_id("target-dir"),
     };
     ops::clean(&ws, &opts)?;
     Ok(())

src/cargo/ops/cargo_clean.rs

@@ -7,14 +7,16 @@ use crate::util::edit_distance;
 use crate::util::errors::CargoResult;
 use crate::util::interning::InternedString;
 use crate::util::{GlobalContext, Progress, ProgressStyle};
+use annotate_snippets::Level;
 use anyhow::bail;
 use cargo_util::paths;
 use indexmap::{IndexMap, IndexSet};
 
 use std::ffi::OsString;
-use std::fs;
+use std::io::Read;
 use std::path::{Path, PathBuf};
 use std::rc::Rc;
+use std::{fs, io};
 
 pub struct CleanOptions<'gctx> {
     pub gctx: &'gctx GlobalContext,
@@ -30,6 +32,8 @@ pub struct CleanOptions<'gctx> {
     pub doc: bool,
     /// If set, doesn't delete anything.
     pub dry_run: bool,
+    /// true if target-dir was was explicitly specified via --target-dir
+    pub explicit_target_dir_arg: bool,
 }
 
 pub struct CleanContext<'gctx> {
@@ -49,6 +53,35 @@ pub fn clean(ws: &Workspace<'_>, opts: &CleanOptions<'_>) -> CargoResult<()> {
     let mut clean_ctx = CleanContext::new(gctx);
     clean_ctx.dry_run = opts.dry_run;
 
+    if opts.explicit_target_dir_arg {
+        // if target_dir was passed explicitly via --target-dir, then hard error if validation fails
+        if let Err(err) = validate_target_dir_tag(target_dir.as_path_unlocked()) {
+            let title = format!("cannot clean `{}`: {err:#}", target_dir.display());
+            let note =
+                "cleaning has been aborted to prevent accidental deletion of unrelated files";
+
+            let report = [Level::ERROR
+                .primary_title(title)
+                .element(Level::NOTE.message(note))];
+            gctx.shell().print_report(&report, false)?;
+            return Err(crate::AlreadyPrintedError::new(anyhow::anyhow!("")).into());
+        }
+    } else if gctx.target_dir()?.is_some() {
+        // target_dir was set via env or build config
+        if let Err(err) = validate_target_dir_tag(target_dir.as_path_unlocked()) {
+            let title = format!(
+                "`{}` does not appear to be a valid Cargo target directory: {err:#}",
+                target_dir.display()
+            );
+            let note = "this may become a hard error in the future; see <https://github.com/rust-lang/cargo/issues/9192>";
+
+            let report = [Level::WARNING
+                .primary_title(title)
+                .element(Level::NOTE.message(note))];
+            gctx.shell().print_report(&report, false)?;
+        }
+    }
+
     if opts.doc {
         if !opts.spec.is_empty() {
             // FIXME: https://github.com/rust-lang/cargo/issues/8790
@@ -105,6 +138,42 @@ pub fn clean(ws: &Workspace<'_>, opts: &CleanOptions<'_>) -> CargoResult<()> {
     Ok(())
 }
 
+fn validate_target_dir_tag(target_dir_path: &Path) -> CargoResult<()> {
+    const TAG_SIGNATURE: &[u8] = b"Signature: 8a477f597d28d172789f06886806bc55";
+
+    // if the path is not a dir then don't do anything
+    if !target_dir_path.is_dir() {
+        return Ok(());
+    }
+
+    let tag_path = target_dir_path.join("CACHEDIR.TAG");
+
+    // per https://bford.info/cachedir the tag file must not be a symlink
+    if tag_path.is_symlink() {
+        bail!("expect `CACHEDIR.TAG` to be a regular file, got a symlink");
+    }
+
+    if !tag_path.is_file() {
+        bail!("missing or invalid `CACHEDIR.TAG` file");
+    }
+
+    let mut file = fs::File::open(&tag_path)
+        .map_err(|err| anyhow::anyhow!("failed to open `{}`: {}", tag_path.display(), err))?;
+
+    let mut buf = [0u8; TAG_SIGNATURE.len()];
+    match file.read_exact(&mut buf) {
+        Ok(()) if &buf[..] == TAG_SIGNATURE => {}
+        Err(e) if e.kind() != io::ErrorKind::UnexpectedEof => {
+            bail!("failed to read `{}`: {e}", tag_path.display());
+        }
+        _ => {
+            bail!("invalid signature in `CACHEDIR.TAG` file");
+        }
+    }
+
+    Ok(())
+}
+
 fn clean_specs(
     clean_ctx: &mut CleanContext<'_>,
     ws: &Workspace<'_>,

tests/testsuite/clean.rs

@@ -1071,7 +1071,13 @@ fn explicit_target_dir_tag_not_present() {
 
     p.cargo("clean --target-dir bar")
         .with_stdout_data("")
-        .with_status(0)
+        .with_stderr_data(str![[r#"
+[ERROR] cannot clean `[ROOT]/foo/bar`: missing or invalid `CACHEDIR.TAG` file
+  |
+  = [NOTE] cleaning has been aborted to prevent accidental deletion of unrelated files
+
+"#]])
+        .with_status(101)
         .run();
 }
 
@@ -1085,7 +1091,13 @@ fn explicit_target_dir_tag_invalid_signature() {
 
     p.cargo("clean --target-dir bar")
         .with_stdout_data("")
-        .with_status(0)
+        .with_stderr_data(str![[r#"
+[ERROR] cannot clean `[ROOT]/foo/bar`: invalid signature in `CACHEDIR.TAG` file
+  |
+  = [NOTE] cleaning has been aborted to prevent accidental deletion of unrelated files
+
+"#]])
+        .with_status(101)
         .run();
 }
 
@@ -1103,7 +1115,13 @@ fn explicit_target_dir_tag_symlink() {
 
     p.cargo("clean --target-dir bar")
         .with_stdout_data("")
-        .with_status(0)
+        .with_stderr_data(str![[r#"
+[ERROR] cannot clean `[ROOT]/foo/bar`: expect `CACHEDIR.TAG` to be a regular file, got a symlink
+  |
+  = [NOTE] cleaning has been aborted to prevent accidental deletion of unrelated files
+
+"#]])
+        .with_status(101)
         .run();
 }
 
@@ -1131,7 +1149,15 @@ fn env_target_dir_tag_not_present() {
         .file("src/foo.rs", &main_file(r#""i am foo""#, &[]))
         .build();
 
-    p.cargo("clean").env("CARGO_TARGET_DIR", "bar").run();
+    p.cargo("clean")
+        .env("CARGO_TARGET_DIR", "bar")
+        .with_stderr_data(str![[r#"
+[WARNING] `[ROOT]/foo/bar` does not appear to be a valid Cargo target directory: missing or invalid `CACHEDIR.TAG` file
+  |
+  = [NOTE] this may become a hard error in the future; see <https://github.com/rust-lang/cargo/issues/9192>
+[REMOVED] [FILE_NUM] files, [FILE_SIZE]B total
+
+"#]]).run();
 }
 
 #[cargo_test]
@@ -1142,7 +1168,15 @@ fn env_target_dir_tag_invalid_signature() {
         .file("bar/CACHEDIR.TAG", "Signature: 1234")
         .build();
 
-    p.cargo("clean").env("CARGO_TARGET_DIR", "bar").run();
+    p.cargo("clean")
+        .env("CARGO_TARGET_DIR", "bar")
+        .with_stderr_data(str![[r#"
+[WARNING] `[ROOT]/foo/bar` does not appear to be a valid Cargo target directory: invalid signature in `CACHEDIR.TAG` file
+  |
+  = [NOTE] this may become a hard error in the future; see <https://github.com/rust-lang/cargo/issues/9192>
+[REMOVED] [FILE_NUM] files, [FILE_SIZE]B total
+
+"#]]).run();
 }
 
 #[cargo_test]
@@ -1157,7 +1191,15 @@ fn env_target_dir_tag_symlink() {
         .symlink("src/CACHEDIR.TAG", "bar/CACHEDIR.TAG")
         .build();
 
-    p.cargo("clean").env("CARGO_TARGET_DIR", "bar").run();
+    p.cargo("clean")
+        .env("CARGO_TARGET_DIR", "bar")
+        .with_stderr_data(str![[r#"
+[WARNING] `[ROOT]/foo/bar` does not appear to be a valid Cargo target directory: expect `CACHEDIR.TAG` to be a regular file, got a symlink
+  |
+  = [NOTE] this may become a hard error in the future; see <https://github.com/rust-lang/cargo/issues/9192>
+[REMOVED] [FILE_NUM] files, [FILE_SIZE]B total
+
+"#]]).run();
 }
 
 #[cargo_test]
@@ -1189,7 +1231,14 @@ fn config_target_dir_tag_not_present() {
         )
         .build();
 
-    p.cargo("clean").run();
+    p.cargo("clean")
+        .with_stderr_data(str![[r#"
+[WARNING] `[ROOT]/foo/bar` does not appear to be a valid Cargo target directory: missing or invalid `CACHEDIR.TAG` file
+  |
+  = [NOTE] this may become a hard error in the future; see <https://github.com/rust-lang/cargo/issues/9192>
+[REMOVED] [FILE_NUM] files, [FILE_SIZE]B total
+
+"#]]).run();
 }
 
 #[cargo_test]
@@ -1205,7 +1254,14 @@ fn config_target_dir_tag_invalid_signature() {
         )
         .build();
 
-    p.cargo("clean").run();
+    p.cargo("clean")
+        .with_stderr_data(str![[r#"
+[WARNING] `[ROOT]/foo/bar` does not appear to be a valid Cargo target directory: invalid signature in `CACHEDIR.TAG` file
+  |
+  = [NOTE] this may become a hard error in the future; see <https://github.com/rust-lang/cargo/issues/9192>
+[REMOVED] [FILE_NUM] files, [FILE_SIZE]B total
+
+"#]]).run();
 }
 
 #[cargo_test]
@@ -1225,7 +1281,14 @@ fn config_target_dir_tag_symlink() {
         )
         .build();
 
-    p.cargo("clean").run();
+    p.cargo("clean")
+        .with_stderr_data(str![[r#"
+[WARNING] `[ROOT]/foo/bar` does not appear to be a valid Cargo target directory: expect `CACHEDIR.TAG` to be a regular file, got a symlink
+  |
+  = [NOTE] this may become a hard error in the future; see <https://github.com/rust-lang/cargo/issues/9192>
+[REMOVED] [FILE_NUM] files, [FILE_SIZE]B total
+
+"#]]).run();
 }
 
 #[cargo_test]