Skip to content
1        10        20        30        40        50        60        70        80        901use std::fs;2use std::path::{Path, PathBuf};3use std::process::{Command, Output};4use std::time::{SystemTime, UNIX_EPOCH};56use margaret::{audit_project, AuditError};78struct TempProject(PathBuf);910impl TempProject {11    fn new() -> Self {12        let nonce = SystemTime::now()13            .duration_since(UNIX_EPOCH)14            .expect("system clock should be after the Unix epoch")15            .as_nanos();16        let path =17            std::env::temp_dir().join(format!("margaret-cli-test-{}-{nonce}", std::process::id()));18        fs::create_dir_all(&path).expect("temporary project directory should be created");19        Self(path)20    }2122    fn path(&self) -> &Path {23        &self.024    }2526    fn run(&self, args: &[&str]) -> Output {27        Command::new(env!("CARGO_BIN_EXE_marg"))28            .args(args)29            .current_dir(self.path())30            .output()31            .expect("marg should start")32    }3334    fn write_source(&self, relative_path: &str, contents: &[u8]) {35        let path = self.path().join(relative_path);36        fs::create_dir_all(37            path.parent()38                .expect("source should have a parent directory"),39        )40        .expect("source parent should be created");41        fs::write(path, contents).expect("fixture source should be written");42    }43}4445impl Drop for TempProject {46    fn drop(&mut self) {47        let _ = fs::remove_dir_all(&self.0);48    }49}5051#[test]52fn cli_writes_a_dated_report_with_only_file_size_metrics() {53    let project = TempProject::new();54    project.write_source("src/lib.rs", "fn alpha() {}\n".as_bytes());55    project.write_source("nested/beta.rs", "pub fn beta() {}\n".as_bytes());56    project.write_source("target/ignored.rs", b"ignored");57    project.write_source(".git/ignored.rs", b"ignored");5859    let output = project.run(&[]);6061    assert!(output.status.success());62    let stdout = String::from_utf8(output.stdout).expect("stdout should be UTF-8");63    assert!(stdout.contains("Margaret file size report completed."));64    assert!(stdout.contains("Rust source files discovered: 2 (2 measured, 0 skipped)"));65    assert!(stdout.contains("Source size: 31 bytes across 2 physical lines"));6667    let report_dir = project.path().join("docs/reports");68    let reports = fs::read_dir(&report_dir)69        .expect("report directory should be created")70        .collect::<Result<Vec<_>, _>>()71        .expect("report directory should be readable");72    assert_eq!(reports.len(), 1);73    let filename = reports[0].file_name().to_string_lossy().into_owned();74    assert!(filename.starts_with("report-marge-"));75    assert!(filename.ends_with(".md"));76    assert!(stdout.contains(&format!("docs/reports/{filename}")));7778    let report = fs::read_to_string(reports[0].path()).expect("report should be readable");79    assert!(report.contains("# Margaret File Size Report"));80    assert!(report.contains("Total source size: 31 bytes"));81    assert!(report.contains("Total physical lines: 2"));82    assert!(report.contains("`src/lib.rs`"));83    assert!(report.contains("`nested/beta.rs`"));84    assert!(!report.contains("complexity"));85    assert!(!report.contains("suppression"));86    assert!(!report.contains("underscore"));87    assert!(!report.contains("ignored"));88}8990#[test]91fn audit_measures_raw_bytes_and_physical_lines_for_invalid_utf8() {92    let project = TempProject::new();93    let source = [0xff, b'\n', 0xfe];94    project.write_source("src/lib.rs", &source);9596    let report = audit_project(project.path()).expect("project should be measurable");9798    assert_eq!(report.discovered_source_count, 1);99    assert_eq!(report.files.len(), 1);100    assert_eq!(report.files[0].bytes, source.len() as u64);101    assert_eq!(report.files[0].physical_lines, 2);102    assert!(report.warnings.is_empty());103}104105#[test]106fn audit_discovers_sorted_rust_files_and_skips_build_and_git_directories() {107    let project = TempProject::new();108    project.write_source("z.rs", b"");109    project.write_source("a.rs", b"");110    project.write_source("nested/mod.rs", b"");111    project.write_source("target/ignored.rs", b"");112    project.write_source(".git/ignored.rs", b"");113114    let report = audit_project(project.path()).expect("project should be measurable");115    let paths: Vec<_> = report116        .files117        .iter()118        .map(|file| file.path.to_string_lossy().replace('\\', "/"))119        .collect();120121    assert_eq!(paths, ["a.rs", "nested/mod.rs", "z.rs"]);122}123124#[test]125fn cli_returns_an_error_when_the_report_directory_cannot_be_created() {126    let project = TempProject::new();127    project.write_source("src/good.rs", b"fn good() {}\n");128    project.write_source("docs/reports", b"this path is a file, not a directory");129130    let output = project.run(&[]);131132    assert_eq!(output.status.code(), Some(1));133    let stderr = String::from_utf8(output.stderr).expect("stderr should be UTF-8");134    assert!(stderr.contains("could not write report"));135    assert!(output.stdout.is_empty());136}137138#[test]139fn audit_returns_a_discovery_error_for_a_missing_root() {140    let project = TempProject::new();141    let missing_root = project.path().join("does-not-exist");142143    let error = audit_project(&missing_root).expect_err("missing root should fail discovery");144145    assert!(matches!(error, AuditError::Discovery { .. }));146}147148#[cfg(unix)]149#[test]150fn audit_does_not_follow_symlinked_files_or_directories() {151    use std::os::unix::fs::symlink;152153    let project = TempProject::new();154    let external = TempProject::new();155    external.write_source("outside.rs", b"outside\n");156    symlink(external.path(), project.path().join("linked-dir"))157        .expect("directory symlink should be created");158    symlink(159        external.path().join("outside.rs"),160        project.path().join("linked.rs"),161    )162    .expect("file symlink should be created");163164    let report = audit_project(project.path()).expect("project should be measurable");165166    assert!(report.files.is_empty());167    assert_eq!(report.discovered_source_count, 0);168}169170#[test]171fn cli_rejects_unexpected_arguments() {172    let project = TempProject::new();173    let output = project.run(&["--help"]);174175    assert_eq!(output.status.code(), Some(2));176    let stderr = String::from_utf8(output.stderr).expect("stderr should be UTF-8");177    assert!(stderr.starts_with("marg: "));178    assert!(stderr.contains("this command takes no arguments"));179    assert!(!project.path().join("docs/reports").exists());180}