feat: Added verify_file_layout() to CargoPathExt

Author: ranger-ross

crates/cargo-test-support/src/compare.rs

@@ -229,6 +229,11 @@ fn add_regex_redactions(subs: &mut snapbox::Redactions) {
     .unwrap();
     subs.insert("[HASH]", regex!(r"/[a-z0-9\-_]+-(?<redacted>[0-9a-f]{16})"))
         .unwrap();
+    // Match multi-part hashes like 06/b451d0d6f88b1d used in directory paths
+    subs.insert("[HASH]", regex!(r"/(?<redacted>[a-f0-9]{2}\/[0-9a-f]{14})"))
+        .unwrap();
+    subs.insert("[HASH]", regex!(r"[a-z0-9]+-(?<redacted>[a-f0-9]{16})"))
+        .unwrap();
     subs.insert(
         "[AVG_ELAPSED]",
         regex!(r"(?<redacted>[0-9]+(\.[0-9]+)?) ns/iter"),

crates/cargo-test-support/src/paths.rs

@@ -12,6 +12,8 @@ use std::sync::Mutex;
 use std::sync::OnceLock;
 use std::sync::atomic::{AtomicUsize, Ordering};
 
+use crate::compare;
+
 static CARGO_INTEGRATION_TEST_DIR: &str = "cit";
 
 static GLOBAL_ROOT: OnceLock<Mutex<Option<PathBuf>>> = OnceLock::new();
@@ -152,6 +154,8 @@ pub trait CargoPathExt {
     fn move_in_time<F>(&self, travel_amount: F)
     where
         F: Fn(i64, u32) -> (i64, u32);
+
+    fn verify_file_layout(&self, expected: impl snapbox::IntoData);
 }
 
 impl CargoPathExt for Path {
@@ -236,6 +240,18 @@ impl CargoPathExt for Path {
             });
         }
     }
+
+    #[track_caller]
+    fn verify_file_layout(&self, expected: impl snapbox::IntoData) {
+        let layout = generate_tree(&self);
+
+        let name = format!("verify_file_layout {}", self.display());
+        if let Err(err) =
+            compare::assert_ui().try_eq(Some(&name), layout.into(), expected.into_data())
+        {
+            panic!("{err}");
+        }
+    }
 }
 
 impl CargoPathExt for PathBuf {
@@ -260,6 +276,11 @@ impl CargoPathExt for PathBuf {
     {
         self.as_path().move_in_time(travel_amount)
     }
+
+    #[track_caller]
+    fn verify_file_layout(&self, expected: impl snapbox::IntoData) {
+        self.as_path().verify_file_layout(expected);
+    }
 }
 
 fn do_op<F>(path: &Path, desc: &str, mut f: F)
@@ -414,3 +435,46 @@ pub fn windows_reserved_names_are_allowed() -> bool {
         true
     }
 }
+
+pub fn generate_tree(path: &Path) -> String {
+    let mut output = format!("{}\n", path.display());
+    generate_tree_inner(path, &[], true, &mut output);
+    return output;
+}
+
+pub fn generate_tree_inner(path: &Path, prefix_state: &[bool], last: bool, output: &mut String) {
+    let file_name = path
+        .file_name()
+        .map(|s| s.to_string_lossy())
+        .unwrap_or_else(|| path.to_string_lossy());
+
+    if !prefix_state.is_empty() {
+        // Build indentation based on ancestor "lastness"
+        let mut indent = String::new();
+        for &has_more_siblings in &prefix_state[..prefix_state.len() - 1] {
+            indent.push_str(if has_more_siblings { "│   " } else { "    " });
+        }
+        let connector = if last { "└── " } else { "├── " };
+        output.push_str(&format!("{indent}{connector}{file_name}\n"));
+    }
+
+    if path.is_dir() {
+        let mut entries: Vec<_> = walkdir::WalkDir::new(path)
+            .max_depth(1)
+            .into_iter()
+            .filter_map(Result::ok)
+            .filter(|e| e.path() != path) // skip the dir itself
+            .collect();
+
+        entries.sort_by_key(|e| e.file_name().to_os_string());
+
+        let count = entries.len();
+        for (i, entry) in entries.into_iter().enumerate() {
+            let is_last = i == count - 1;
+            // push info about *this* level for children
+            let mut new_prefix_state = prefix_state.to_vec();
+            new_prefix_state.push(!is_last);
+            generate_tree_inner(entry.path(), &new_prefix_state, is_last, output);
+        }
+    }
+}