agtestcheck 0.1.1

Cargo subcommand checking the structure of Rust tests
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

mod check;
mod source_map;
mod sources;

use std::io::Write;
use std::process::ExitCode;

use agplatform::Platform;
use agplatform::platform;

use crate::check::check;
use crate::source_map::source_map;
use crate::sources::sources;

fn main() -> ExitCode {
    run(&platform(), &mut std::io::stdout())
}

fn run(p: &impl Platform, out: &mut dyn Write) -> ExitCode {
    let issues = check(&source_map(p, &sources(p)));

    for issue in &issues {
        writeln!(
            out,
            "{}:{}: {}",
            issue.file.display(),
            issue.line,
            issue.kind
        )
        .expect("writing the issue should succeed");
    }

    if issues.is_empty() {
        ExitCode::SUCCESS
    } else {
        ExitCode::FAILURE
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use agplatform::test_platform::test_platform;

    mod main {
        use super::*;

        #[test]
        fn main_should_check_current_dir() {
            let _ = main();
        }
    }

    mod run {
        use super::*;
        use agplatform::Fs;

        #[test]
        fn run_without_issues_should_succeed_and_print_nothing() {
            let mut platform = test_platform();
            platform.fs_mut().create_dir_all("src").unwrap();
            platform
                .fs_mut()
                .write(
                    "src/lib.rs",
                    "fn f() {}\n#[cfg(test)]\nmod tests {\n    mod f {\n        #[test]\n        fn f_should_work() {}\n    }\n}\n",
                )
                .unwrap();
            let mut out = Vec::new();

            assert_eq!(run(&platform, &mut out), ExitCode::SUCCESS);
            assert_eq!(String::from_utf8(out).unwrap(), "");
        }

        #[test]
        fn run_with_issues_should_fail_and_print_them() {
            let mut platform = test_platform();
            platform
                .fs_mut()
                .write(
                    "lib.rs",
                    "#[cfg(test)]\nmod tests {\n    #[test]\n    fn t() {}\n}\n",
                )
                .unwrap();
            let mut out = Vec::new();

            assert_eq!(run(&platform, &mut out), ExitCode::FAILURE);
            assert_eq!(
                String::from_utf8(out).unwrap(),
                "lib.rs:4: test `t` should be in the module of its type, trait, function or method\n",
            );
        }
    }
}