#1615: each generated-docs test gets its own temporary directory, removed when it ends

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: GPT-6.1 Sol <noreply@openai.com>

apps/figcraft-cli/tests/it/generated_docs.rs

@@ -1,22 +1,45 @@
 //! Generated CLI documentation uses the parser's command definition, without running commands.
 
 use std::fs;
-use std::path::PathBuf;
+use std::path::{Path, PathBuf};
+use std::sync::atomic::{AtomicUsize, Ordering};
 
 #[path = "../../examples/man-and-completions.rs"]
 #[expect(dead_code, reason = "These tests call generate directly; the example's main is smoke-tested separately.")]
 mod generator;
 
-fn tmp(name: &str) -> std::io::Result<PathBuf> {
-    let dir = std::env::temp_dir().join(format!("figcraft-cli-test-{}-{name}", std::process::id()));
-    fs::create_dir_all(&dir)?;
-    Ok(dir)
+struct TempDir(PathBuf);
+
+impl TempDir {
+    fn path(&self) -> &Path {
+        &self.0
+    }
+}
+
+impl Drop for TempDir {
+    fn drop(&mut self) {
+        let _ = fs::remove_dir_all(&self.0);
+    }
+}
+
+fn tmp(name: &str) -> std::io::Result<TempDir> {
+    static NEXT: AtomicUsize = AtomicUsize::new(0);
+    loop {
+        let n = NEXT.fetch_add(1, Ordering::Relaxed);
+        let dir = std::env::temp_dir().join(format!("figcraft-cli-test-{}-{n}-{name}", std::process::id()));
+        match fs::create_dir(&dir) {
+            Ok(()) => return Ok(TempDir(dir)),
+            Err(e) if e.kind() == std::io::ErrorKind::AlreadyExists => continue,
+            Err(e) => return Err(e),
+        }
+    }
 }
 
 #[test]
 fn completions_name_the_cli_its_subcommands_and_options() -> std::io::Result<()> {
-    let dir = tmp("completions")?;
-    generator::generate(&dir)?;
+    let temp = tmp("completions")?;
+    let dir = temp.path();
+    generator::generate(dir)?;
     for name in ["figcraft-cli.bash", "figcraft-cli.elv", "figcraft-cli.fish", "_figcraft-cli.ps1", "_figcraft-cli"] {
         let text = fs::read_to_string(dir.join(name))?;
         for word in [
@@ -40,13 +63,14 @@ fn completions_name_the_cli_its_subcommands_and_options() -> std::io::Result<()>
         }
         assert!(!text.contains("man-and-completions"), "{name} names the example instead of the CLI");
     }
-    fs::remove_dir_all(dir)
+    Ok(())
 }
 
 #[test]
 fn bash_dispatch_states_have_matching_option_blocks() -> std::io::Result<()> {
-    let dir = tmp("bash-completion-states")?;
-    generator::generate(&dir)?;
+    let temp = tmp("bash-completion-states")?;
+    let dir = temp.path();
+    generator::generate(dir)?;
     let text = fs::read_to_string(dir.join("figcraft-cli.bash"))?;
     let states: Vec<_> =
         text.lines().filter_map(|line| line.trim().strip_prefix("cmd=\"")?.strip_suffix('"')).filter(|state| !state.is_empty()).collect();
@@ -55,15 +79,16 @@ fn bash_dispatch_states_have_matching_option_blocks() -> std::io::Result<()> {
         let block = format!("{state})");
         assert!(text.lines().any(|line| line.trim() == block), "Bash dispatch state {state} has no option block");
     }
-    fs::remove_dir_all(dir)
+    Ok(())
 }
 
 #[test]
 fn man_pages_cover_every_subcommand_without_synthetic_help_pages() -> std::io::Result<()> {
-    let dir = tmp("man-pages")?;
-    generator::generate(&dir)?;
+    let temp = tmp("man-pages")?;
+    let dir = temp.path();
+    generator::generate(dir)?;
     let mut pages = Vec::new();
-    for entry in fs::read_dir(&dir)? {
+    for entry in fs::read_dir(dir)? {
         let path = entry?.path();
         if path.extension().is_some_and(|ext| ext == "1") {
             pages.push(path.file_name().unwrap_or_default().to_string_lossy().into_owned());
@@ -101,12 +126,13 @@ fn man_pages_cover_every_subcommand_without_synthetic_help_pages() -> std::io::R
         let text = fs::read_to_string(dir.join(page))?.replace("\\-", "-");
         assert!(text.contains(option), "{page} does not contain {option}");
     }
-    fs::remove_dir_all(dir)
+    Ok(())
 }
 
 #[test]
 fn generation_creates_the_output_directory_and_can_run_again() -> std::io::Result<()> {
-    let dir = tmp("generated-docs-repeat")?;
+    let temp = tmp("generated-docs-repeat")?;
+    let dir = temp.path();
     let output = dir.join("new").join("docs");
     assert!(!output.exists());
     generator::generate(&output)?;
@@ -117,18 +143,19 @@ fn generation_creates_the_output_directory_and_can_run_again() -> std::io::Resul
     generator::generate(&output)?;
     assert_eq!(fs::read(page)?, first);
     assert_eq!(fs::read_dir(output)?.count(), 16);
-    fs::remove_dir_all(dir)
+    Ok(())
 }
 
 #[test]
 fn generation_returns_filesystem_errors() -> std::io::Result<()> {
-    let dir = tmp("generated-docs-errors")?;
+    let temp = tmp("generated-docs-errors")?;
+    let dir = temp.path();
     let file = dir.join("not-a-directory");
     fs::write(&file, "keep me")?;
     assert!(generator::generate(&file).is_err());
     assert_eq!(fs::read_to_string(&file)?, "keep me");
     // A valid directory can still fail when writing one of the generated pages.
     fs::create_dir(dir.join("figcraft-cli.1"))?;
-    assert!(generator::generate(&dir).is_err());
-    fs::remove_dir_all(dir)
+    assert!(generator::generate(dir).is_err());
+    Ok(())
 }