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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159

use assert_cmd::Command;
use predicates::prelude::PredicateBooleanExt;
use predicates::str::contains;
use std::path::Path;

#[test]
fn check_rejects_thread_in_unknown_scope_and_names_only_the_offender() {
    let dir = tempfile::tempdir().unwrap();
    init(dir.path());
    let state = dir.path().join(".provenance/state");
    write_jsonl(
        &state.join("scopes/default/requirements/req.jsonl"),
        &requirement("req_parent"),
    );
    write_jsonl(
        &state.join("scopes/default/threads/threads.jsonl"),
        &format!(
            "{}\n{}",
            thread("thread_innocent", "default", "req_parent", 1),
            thread("thread_bad_scope", "missing", "req_parent", 2)
        ),
    );

    check(dir.path()).failure().stderr(
        contains("thread thread_bad_scope is in unknown scope missing")
            .and(contains("thread_innocent").not()),
    );
}

#[test]
fn check_rejects_thread_with_unknown_parent_and_names_only_the_offender() {
    let dir = tempfile::tempdir().unwrap();
    init(dir.path());
    let state = dir.path().join(".provenance/state");
    write_jsonl(
        &state.join("scopes/default/requirements/req.jsonl"),
        &requirement("req_parent"),
    );
    write_jsonl(
        &state.join("scopes/default/threads/threads.jsonl"),
        &format!(
            "{}\n{}",
            thread("thread_innocent", "default", "req_parent", 1),
            thread("thread_bad_parent", "default", "req_missing", 2)
        ),
    );

    check(dir.path()).failure().stderr(
        contains("thread thread_bad_parent has dangling reference: parent requirement req_missing")
            .and(contains("thread_innocent").not()),
    );
}

#[test]
fn check_rejects_thread_whose_parent_exists_only_in_another_scope() {
    let dir = tempfile::tempdir().unwrap();
    init(dir.path());
    let state = dir.path().join(".provenance/state");
    add_scope(dir.path(), "other", "other");
    write_jsonl(
        &state.join("scopes/default/requirements/req.jsonl"),
        &requirement("req_parent"),
    );
    write_jsonl(
        &state.join("scopes/other/requirements/req.jsonl"),
        &requirement_in("other", "req_other"),
    );
    write_jsonl(
        &state.join("scopes/default/threads/threads.jsonl"),
        &format!(
            "{}\n{}",
            thread("thread_innocent", "default", "req_parent", 1),
            thread("thread_cross_scope", "default", "req_other", 2)
        ),
    );

    check(dir.path()).failure().stderr(
        contains("thread thread_cross_scope has dangling reference: parent requirement req_other")
            .and(contains("thread_innocent").not()),
    );
}

#[test]
fn check_accepts_threads_with_known_scopes_and_parents() {
    let dir = tempfile::tempdir().unwrap();
    init(dir.path());
    let state = dir.path().join(".provenance/state");
    write_jsonl(
        &state.join("scopes/default/requirements/req.jsonl"),
        &requirement("req_parent"),
    );
    write_jsonl(
        &state.join("scopes/default/threads/threads.jsonl"),
        &thread("thread_valid", "default", "req_parent", 1),
    );

    check(dir.path()).success();
}

fn requirement(id: &str) -> String {
    requirement_in("default", id)
}

fn requirement_in(scope_id: &str, id: &str) -> String {
    format!(
        r#"{{"schema_version":1,"scope_id":"{scope_id}","id":"{id}","statement":"Parent","status":"active"}}"#
    )
}

fn add_scope(repo: &Path, scope_id: &str, path_prefix: &str) {
    let path = repo.join(".provenance/state/manifest.json");
    let mut manifest: serde_json::Value =
        serde_json::from_slice(&std::fs::read(&path).unwrap()).unwrap();
    manifest["scopes"]
        .as_array_mut()
        .unwrap()
        .push(serde_json::json!({"id": scope_id, "path_prefix": path_prefix}));
    std::fs::write(path, serde_json::to_vec_pretty(&manifest).unwrap()).unwrap();
}

fn thread(id: &str, scope_id: &str, parent_id: &str, created_at: i64) -> String {
    format!(
        r#"{{"schema_version":1,"scope_id":"{scope_id}","id":"{id}","parent":{{"node_type":"requirement","node_id":"{parent_id}"}},"status":"resolved","created_at":{created_at}}}"#
    )
}

fn init(repo: &Path) {
    Command::cargo_bin("provenance")
        .unwrap()
        .args([
            "init",
            "--path",
            repo.to_str().unwrap(),
            "--scope",
            "default",
            "--path-prefix",
            ".",
        ])
        .assert()
        .success();
}

fn check(repo: &Path) -> assert_cmd::assert::Assert {
    Command::cargo_bin("provenance")
        .unwrap()
        .args([
            "check",
            "--repo",
            repo.to_str().unwrap(),
            "--format",
            "json",
        ])
        .assert()
}

fn write_jsonl(path: &Path, records: &str) {
    std::fs::create_dir_all(path.parent().unwrap()).unwrap();
    std::fs::write(path, format!("{records}\n")).unwrap();
}