provenance-cli 0.2.1

Command-line interface for Provenance requirements traceability
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

use super::{current_git_commit, scan_commit};
use camino::Utf8PathBuf;

#[test]
fn coverage_commit_is_read_from_the_selected_repository() {
    let dir = tempfile::tempdir().unwrap();
    let repo = Utf8PathBuf::from_path_buf(dir.path().join("repo")).unwrap();
    run_git(["init", repo.as_str()]);
    std::fs::write(repo.join("tracked.txt"), "tracked\n").unwrap();
    run_git(["-C", repo.as_str(), "add", "tracked.txt"]);
    run_git([
        "-C",
        repo.as_str(),
        "-c",
        "user.name=Provenance Test",
        "-c",
        "user.email=test@example.invalid",
        "commit",
        "-m",
        "fixture",
    ]);

    let expected = git_stdout(["-C", repo.as_str(), "rev-parse", "HEAD"]);

    assert_eq!(current_git_commit(&repo).unwrap(), expected);
    let scan = provenance_scanner::scan_file(
        &repo.join("tracked.txt"),
        provenance_scanner::Language::Rust,
        "tracked\n",
    );
    assert_eq!(
        scan_commit(&repo, &[scan]).as_deref(),
        Some(expected.as_str())
    );
}

#[test]
fn a_scan_of_modified_files_has_no_commit_pin() {
    let dir = tempfile::tempdir().unwrap();
    let repo = Utf8PathBuf::from_path_buf(dir.path().join("repo")).unwrap();
    run_git(["init", repo.as_str()]);
    std::fs::write(repo.join("tracked.rs"), "fn original() {}\n").unwrap();
    run_git(["-C", repo.as_str(), "add", "tracked.rs"]);
    run_git([
        "-C",
        repo.as_str(),
        "-c",
        "user.name=Provenance Test",
        "-c",
        "user.email=test@example.invalid",
        "commit",
        "-m",
        "fixture",
    ]);
    std::fs::write(repo.join("tracked.rs"), "fn changed() {}\n").unwrap();

    let scan = provenance_scanner::scan_file(
        &repo.join("tracked.rs"),
        provenance_scanner::Language::Rust,
        "fn changed() {}\n",
    );
    assert!(scan_commit(&repo, &[scan]).is_none());
}

#[test]
fn a_scan_of_ignored_source_files_has_no_commit_pin() {
    let dir = tempfile::tempdir().unwrap();
    let repo = Utf8PathBuf::from_path_buf(dir.path().join("repo")).unwrap();
    run_git(["init", repo.as_str()]);
    std::fs::write(repo.join(".gitignore"), "ignored.rs\n").unwrap();
    run_git(["-C", repo.as_str(), "add", ".gitignore"]);
    run_git([
        "-C",
        repo.as_str(),
        "-c",
        "user.name=Provenance Test",
        "-c",
        "user.email=test@example.invalid",
        "commit",
        "-m",
        "fixture",
    ]);
    std::fs::write(repo.join("ignored.rs"), "fn ignored() {}\n").unwrap();
    let scan = provenance_scanner::scan_file(
        &repo.join("ignored.rs"),
        provenance_scanner::Language::Rust,
        "fn ignored() {}\n",
    );

    assert!(scan_commit(&repo, &[scan]).is_none());
}

fn run_git<const N: usize>(args: [&str; N]) {
    let output = std::process::Command::new("git")
        .args(args)
        .output()
        .unwrap();
    assert!(
        output.status.success(),
        "{}",
        String::from_utf8_lossy(&output.stderr)
    );
}

fn git_stdout<const N: usize>(args: [&str; N]) -> String {
    let output = std::process::Command::new("git")
        .args(args)
        .output()
        .unwrap();
    assert!(
        output.status.success(),
        "{}",
        String::from_utf8_lossy(&output.stderr)
    );
    String::from_utf8(output.stdout).unwrap().trim().to_string()
}