From 15920328d72246d947c13adc71bf8d1f6969dabf Mon Sep 17 00:00:00 2001 From: elipeter Date: Tue, 17 Jun 2025 00:02:32 +0200 Subject: [PATCH] Add unit tests for `Indexer` and update dependencies - Introduced comprehensive tests for `Indexer` to validate file scan behavior. - Added `tempfile` and `filetime` as dependencies for testing. - Removed unused dependencies (`anyhow`, `nix`, `regex`). --- Cargo.lock | 139 ++++++++++++++++++++++++++++++++++++++---------- Cargo.toml | 7 +-- src/database.rs | 89 ++++++++++++++++++++++++++++++- 3 files changed, 202 insertions(+), 33 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 47b5bb14..d082f325 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -6,17 +6,16 @@ version = 4 name = "Nano" version = "0.1.0" dependencies = [ - "anyhow", "blake3", "clap", "crossbeam-channel", "directories", + "filetime", "ignore", - "nix", "num_cpus", - "regex", "rusqlite", "serde", + "tempfile", "toml", "tracing", "tracing-subscriber", @@ -83,12 +82,6 @@ dependencies = [ "windows-sys", ] -[[package]] -name = "anyhow" -version = "1.0.98" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e16d2d3311acee920a9eb8d33b8cbc1787ce4a264e85f964c2404b969bdcd487" - [[package]] name = "arrayref" version = "0.3.9" @@ -145,12 +138,6 @@ version = "1.0.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "9555578bc9e57714c812a1f84e4fc5b4d21fcb063490c624de019f7464c91268" -[[package]] -name = "cfg_aliases" -version = "0.2.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "613afe47fcd5fac7ccf1db93babcb082c5994d996f20b8b159f2ad1658eb5724" - [[package]] name = "clap" version = "4.5.40" @@ -273,6 +260,16 @@ version = "1.0.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "877a4ace8713b0bcf2a4e7eec82529c029f1d0619886d18145fea96c3ffe5c0f" +[[package]] +name = "errno" +version = "0.3.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cea14ef9355e3beab063703aa9dab15afd25f0667c341310c1e5274bb1d0da18" +dependencies = [ + "libc", + "windows-sys", +] + [[package]] name = "fallible-iterator" version = "0.3.0" @@ -285,6 +282,24 @@ version = "0.1.9" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "7360491ce676a36bf9bb3c56c1aa791658183a54d2744120f27285738d90465a" +[[package]] +name = "fastrand" +version = "2.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "37909eebbb50d72f9059c3b6d82c0463f2ff062c9e95845c43a6c9c0355411be" + +[[package]] +name = "filetime" +version = "0.2.25" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "35c0522e981e68cbfa8c3f978441a5f34b30b96e146b33cd3359176b50fe8586" +dependencies = [ + "cfg-if", + "libc", + "libredox", + "windows-sys", +] + [[package]] name = "foldhash" version = "0.1.5" @@ -299,7 +314,19 @@ checksum = "335ff9f135e4384c8150d6f27c6daed433577f86b4750418338c01a1a2528592" dependencies = [ "cfg-if", "libc", - "wasi", + "wasi 0.11.1+wasi-snapshot-preview1", +] + +[[package]] +name = "getrandom" +version = "0.3.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "26145e563e54f2cadc477553f1ec5ee650b00862f0a58bcd12cbdc5f0ea2d2f4" +dependencies = [ + "cfg-if", + "libc", + "r-efi", + "wasi 0.14.2+wasi-0.2.4", ] [[package]] @@ -403,6 +430,7 @@ checksum = "c0ff37bd590ca25063e35af745c343cb7a0271906fb7b37e4813e8f79f00268d" dependencies = [ "bitflags", "libc", + "redox_syscall", ] [[package]] @@ -415,6 +443,12 @@ dependencies = [ "vcpkg", ] +[[package]] +name = "linux-raw-sys" +version = "0.9.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cd945864f07fe9f5371a27ad7b52a172b4b499999f1d97574c9fa68373937e12" + [[package]] name = "log" version = "0.4.27" @@ -436,18 +470,6 @@ version = "2.7.5" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "32a282da65faaf38286cf3be983213fcf1d2e2a58700e808f83f4ea9a4804bc0" -[[package]] -name = "nix" -version = "0.30.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "74523f3a35e05aba87a1d978330aef40f67b0304ac79c1c00b294c9830543db6" -dependencies = [ - "bitflags", - "cfg-if", - "cfg_aliases", - "libc", -] - [[package]] name = "nu-ansi-term" version = "0.46.0" @@ -534,13 +556,28 @@ dependencies = [ "proc-macro2", ] +[[package]] +name = "r-efi" +version = "5.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "74765f6d916ee2faa39bc8e68e4f3ed8949b48cccdac59983d287a7cb71ce9c5" + +[[package]] +name = "redox_syscall" +version = "0.5.13" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0d04b7d0ee6b4a0207a0a7adb104d23ecb0b47d6beae7152d0fa34b692b29fd6" +dependencies = [ + "bitflags", +] + [[package]] name = "redox_users" version = "0.5.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "dd6f9d3d47bdd2ad6945c5015a226ec6155d0bcdfd8f7cd29f86b71f8de99d2b" dependencies = [ - "getrandom", + "getrandom 0.2.16", "libredox", "thiserror", ] @@ -603,6 +640,19 @@ dependencies = [ "smallvec", ] +[[package]] +name = "rustix" +version = "1.0.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c71e83d6afe7ff64890ec6b71d6a69bb8a610ab78ce364b3352876bb4c801266" +dependencies = [ + "bitflags", + "errno", + "libc", + "linux-raw-sys", + "windows-sys", +] + [[package]] name = "ryu" version = "1.0.20" @@ -704,6 +754,19 @@ dependencies = [ "unicode-ident", ] +[[package]] +name = "tempfile" +version = "3.20.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e8a64e3985349f2441a1a9ef0b853f869006c3855f2cda6862a94d26ebb9d6a1" +dependencies = [ + "fastrand", + "getrandom 0.3.3", + "once_cell", + "rustix", + "windows-sys", +] + [[package]] name = "thiserror" version = "2.0.12" @@ -950,6 +1013,15 @@ version = "0.11.1+wasi-snapshot-preview1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "ccf3ec651a847eb01de73ccad15eb7d99f80485de043efb2f370cd654f4ea44b" +[[package]] +name = "wasi" +version = "0.14.2+wasi-0.2.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9683f9a5a998d873c0d21fcbe3c083009670149a8fab228644b8bd36b2c48cb3" +dependencies = [ + "wit-bindgen-rt", +] + [[package]] name = "winapi" version = "0.3.9" @@ -1062,3 +1134,12 @@ checksum = "74c7b26e3480b707944fc872477815d29a8e429d2f93a1ce000f5fa84a15cbcd" dependencies = [ "memchr", ] + +[[package]] +name = "wit-bindgen-rt" +version = "0.39.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6f42320e61fe2cfd34354ecb597f86f413484a798ba44a8ca1165c58d42da6c1" +dependencies = [ + "bitflags", +] diff --git a/Cargo.toml b/Cargo.toml index 3b53f804..9b3f94c5 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -3,6 +3,9 @@ name = "Nano" version = "0.1.0" edition = "2024" +[dev-dependencies] +tempfile = "3" + [dependencies] directories = "6.0.0" clap = { version = "4.5.40", features = ["derive"] } @@ -13,12 +16,10 @@ tracing = "0.1.41" num_cpus = "1.17.0" rusqlite = "0.36.0" -anyhow = "1.0.98" ignore = "0.4.23" tree-sitter = "0.25.6" tree-sitter-rust = "0.24.0" crossbeam-channel = "0.5.15" -regex = "1.11.1" blake3 = "1.8.2" -nix = { version = "0.30.1", features = ["signal"] } +filetime = "0.2.25" diff --git a/src/database.rs b/src/database.rs index f925d936..ccb05d4c 100644 --- a/src/database.rs +++ b/src/database.rs @@ -74,4 +74,91 @@ pub mod index { Ok(hasher.finalize().as_bytes().to_vec()) } } -} \ No newline at end of file +} + +#[cfg(test)] +mod tests { + use crate::database::index::Indexer; + use std::error::Error; + use std::io::Write; + use tempfile::tempdir; + + /// Returns a freshly‑initialised `Indexer` backed by an *in‑memory* SQLite + /// database. Using `:memory:` sidesteps file‑system lifetime issues that can + /// occur when the temporary database file is deleted while a connection is + /// still open. + fn new_indexer() -> Indexer { + Indexer::new(std::path::Path::new(":memory:")) + .expect("create in‑memory Indexer") + } + + #[test] + fn new_file_is_flagged_for_scan() -> Result<(), Box> { + let indexer = new_indexer(); + + let dir = tempdir()?; + let file_path = dir.path().join("hello.txt"); + std::fs::write(&file_path, b"hello world")?; + + // File has never been seen ⇒ should be scanned. + assert!(indexer.should_scan(&file_path)?); + Ok(()) + } + + #[test] + fn unchanged_file_is_not_flagged_again() -> Result<(), Box> { + let indexer = new_indexer(); + let dir = tempdir()?; + let file_path = dir.path().join("foo.txt"); + std::fs::write(&file_path, b"abc123")?; + + // First pass – record the scan result. + indexer.record_scan(&file_path)?; + + // Nothing changed – should_scan must return false. + assert!(!indexer.should_scan(&file_path)?); + Ok(()) + } + + #[test] + fn modified_content_triggers_rescan() -> Result<(), Box> { + let indexer = new_indexer(); + let dir = tempdir()?; + let file_path = dir.path().join("bar.txt"); + std::fs::write(&file_path, b"first")?; + indexer.record_scan(&file_path)?; + + // Append data to change the hash. + let mut file = std::fs::OpenOptions::new() + .append(true) + .open(&file_path)?; + writeln!(file, "second line")?; + + assert!(indexer.should_scan(&file_path)?); + Ok(()) + } + + #[test] + fn modified_mtime_alone_triggers_rescan() -> Result<(), Box> { + // Compile this test only when the optional `filetime` feature is enabled. + #[cfg(feature = "filetime")] { + use std::time::{Duration, SystemTime}; + use filetime::FileTime; + + let indexer = new_indexer(); + let dir = tempdir()?; + let file_path = dir.path().join("baz.txt"); + std::fs::write(&file_path, b"unchanged content")?; + indexer.record_scan(&file_path)?; + + // Bump the modification time without touching the contents. + let now_plus = SystemTime::now() + Duration::from_secs(5); + let new_mtime = FileTime::from_system_time(now_plus); + filetime::set_file_mtime(&file_path, new_mtime)?; + + assert!(indexer.should_scan(&file_path)?); + } + + Ok(()) + } +}