spec-drift 0.2.0

Semantic coherence analysis between specification and implementation for Rust projects.
Documentation 
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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

use std::path::Path;
use std::process::Command;

fn spec_drift_bin() -> &'static str {
    env!("CARGO_BIN_EXE_spec-drift")
}

fn run_git(root: &Path, args: &[&str]) {
    let out = Command::new("git")
        .current_dir(root)
        .args(args)
        .output()
        .expect("git should launch");
    assert!(
        out.status.success(),
        "git {:?} failed\nstdout:\n{}\nstderr:\n{}",
        args,
        String::from_utf8_lossy(&out.stdout),
        String::from_utf8_lossy(&out.stderr)
    );
}

#[test]
fn diff_reports_doc_drift_induced_by_changed_rust() {
    if Command::new("git").arg("--version").output().is_err() {
        return;
    }

    let tmp = tempfile::tempdir().unwrap();
    let root = tmp.path();
    std::fs::create_dir(root.join("src")).unwrap();
    std::fs::write(
        root.join("Cargo.toml"),
        "[package]\nname = \"demo\"\nversion = \"0.1.0\"\nedition = \"2024\"\n",
    )
    .unwrap();
    std::fs::write(root.join("README.md"), "Use `old_name()` to start.\n").unwrap();
    std::fs::write(root.join("src/lib.rs"), "pub fn old_name() {}\n").unwrap();

    run_git(root, &["init"]);
    run_git(root, &["config", "user.email", "test@example.com"]);
    run_git(root, &["config", "user.name", "Test User"]);
    run_git(root, &["add", "."]);
    run_git(
        root,
        &["-c", "commit.gpgsign=false", "commit", "-m", "init"],
    );

    std::fs::write(root.join("src/lib.rs"), "pub fn new_name() {}\n").unwrap();

    let out = Command::new(spec_drift_bin())
        .args([
            "--root",
            root.to_str().unwrap(),
            "--docs",
            "--diff",
            "HEAD",
            "--format",
            "json",
            "--deny",
            "critical",
        ])
        .output()
        .expect("spec-drift should launch");

    assert_eq!(
        out.status.code(),
        Some(1),
        "stdout:\n{}\nstderr:\n{}",
        String::from_utf8_lossy(&out.stdout),
        String::from_utf8_lossy(&out.stderr)
    );

    let json: serde_json::Value = serde_json::from_slice(&out.stdout).unwrap();
    let first = json.as_array().unwrap().first().unwrap();
    assert_eq!(first["rule"], "symbol_absence");
    assert_eq!(first["location"]["file"], "README.md");
}

#[test]
fn diff_reports_drift_in_untracked_markdown() {
    if Command::new("git").arg("--version").output().is_err() {
        return;
    }

    let tmp = tempfile::tempdir().unwrap();
    let root = tmp.path();
    std::fs::create_dir(root.join("src")).unwrap();
    std::fs::write(
        root.join("Cargo.toml"),
        "[package]\nname = \"demo\"\nversion = \"0.1.0\"\nedition = \"2024\"\n",
    )
    .unwrap();
    std::fs::write(root.join("src/lib.rs"), "pub fn existing() {}\n").unwrap();

    run_git(root, &["init"]);
    run_git(root, &["config", "user.email", "test@example.com"]);
    run_git(root, &["config", "user.name", "Test User"]);
    run_git(root, &["add", "."]);
    run_git(
        root,
        &["-c", "commit.gpgsign=false", "commit", "-m", "init"],
    );

    std::fs::write(root.join("README.md"), "Use `missing()` to start.\n").unwrap();

    let out = Command::new(spec_drift_bin())
        .args([
            "--root",
            root.to_str().unwrap(),
            "--docs",
            "--diff",
            "HEAD",
            "--format",
            "json",
            "--deny",
            "critical",
        ])
        .output()
        .expect("spec-drift should launch");

    assert_eq!(
        out.status.code(),
        Some(1),
        "stdout:\n{}\nstderr:\n{}",
        String::from_utf8_lossy(&out.stdout),
        String::from_utf8_lossy(&out.stderr)
    );

    let json: serde_json::Value = serde_json::from_slice(&out.stdout).unwrap();
    let first = json.as_array().unwrap().first().unwrap();
    assert_eq!(first["rule"], "symbol_absence");
    assert_eq!(first["location"]["file"], "README.md");
}