test(build): add tests for .mdbookignore feature

Author: jhult

crates/mdbook-core/src/utils/fs.rs

@@ -238,6 +238,7 @@ fn copy<P: AsRef<Path>, Q: AsRef<Path>>(from: P, to: Q) -> Result<()> {
 #[cfg(test)]
 mod tests {
     use super::*;
+    use ignore::gitignore::GitignoreBuilder;
     use std::io::Result;
     use std::path::Path;
 
@@ -298,4 +299,56 @@ mod tests {
             panic!("output/symlink.png should exist")
         }
     }
+
+    #[test]
+    fn copy_files_except_ignored_test() {
+        let tmp = match tempfile::TempDir::new() {
+            Ok(t) => t,
+            Err(e) => panic!("Could not create a temp dir: {e}"),
+        };
+
+        // Create files and directories
+        write(tmp.path().join("file.txt"), "").unwrap();
+        write(tmp.path().join("file.json"), "").unwrap();
+        write(tmp.path().join("ignored_dir/nested.txt"), "").unwrap();
+        write(tmp.path().join("included_dir/file.json"), "").unwrap();
+        write(tmp.path().join("included_dir/file.txt"), "").unwrap();
+
+        // Create a gitignore that ignores *.txt and ignored_dir/
+        let mut builder = GitignoreBuilder::new(tmp.path());
+        builder.add_line(None, "*.txt").unwrap();
+        builder.add_line(None, "ignored_dir/").unwrap();
+        let ignore = builder.build().unwrap();
+
+        // Create output dir
+        create_dir_all(tmp.path().join("output")).unwrap();
+
+        copy_files_except_ignored(
+            tmp.path(),
+            &tmp.path().join("output"),
+            true,
+            None,
+            Some(&ignore),
+        )
+        .unwrap();
+
+        // Check that .txt files are ignored
+        if tmp.path().join("output/file.txt").exists() {
+            panic!("output/file.txt should not exist")
+        }
+        if tmp.path().join("output/included_dir/file.txt").exists() {
+            panic!("output/included_dir/file.txt should not exist")
+        }
+        // Check that ignored_dir is not copied
+        if tmp.path().join("output/ignored_dir").exists() {
+            panic!("output/ignored_dir should not exist")
+        }
+        // Check that non-ignored files are copied
+        if !tmp.path().join("output/file.json").exists() {
+            panic!("output/file.json should exist")
+        }
+        if !tmp.path().join("output/included_dir/file.json").exists() {
+            panic!("output/included_dir/file.json should exist")
+        }
+    }
 }

tests/testsuite/build.rs

@@ -85,3 +85,18 @@ fn dest_dir_relative_path() {
     });
     assert!(current_dir.join("foo/index.html").exists());
 }
+
+// Test that .mdbookignore files are respected (single files, glob patterns, and directories).
+#[test]
+fn mdbookignore() {
+    let mut test = BookTest::from_dir("build/mdbookignore");
+    test.build();
+    // Single file listed by name should not be copied.
+    assert!(!test.dir.join("book/ignored_file").exists());
+    // Files matching *.txt glob pattern should not be copied.
+    assert!(!test.dir.join("book/ignored.txt").exists());
+    // Directories listed in .mdbookignore should not be copied.
+    assert!(!test.dir.join("book/ignored_dir").exists());
+    // Non-ignored files should be copied.
+    assert!(test.dir.join("book/included.json").exists());
+}

tests/testsuite/build/mdbookignore/book.toml

@@ -0,0 +1,2 @@
+[book]
+title = "mdbookignore test"

tests/testsuite/build/mdbookignore/src/.mdbookignore

@@ -0,0 +1,3 @@
+ignored_file
+*.txt
+ignored_dir/

tests/testsuite/build/mdbookignore/src/SUMMARY.md

@@ -0,0 +1,3 @@
+# Summary
+
+- [Chapter 1](./chapter_1.md)

tests/testsuite/build/mdbookignore/src/chapter_1.md

@@ -0,0 +1,3 @@
+# Chapter 1
+
+This is chapter 1.

tests/testsuite/build/mdbookignore/src/ignored.txt

@@ -0,0 +1 @@
+This txt file should not be copied.

tests/testsuite/build/mdbookignore/src/ignored_dir/file.json

@@ -0,0 +1 @@
+This file in ignored dir should not be copied.

tests/testsuite/build/mdbookignore/src/ignored_file

@@ -0,0 +1 @@
+This file should not be copied.

tests/testsuite/build/mdbookignore/src/included.json

@@ -0,0 +1 @@
+This file should be copied.