provenance-cli 0.2.3

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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201

use super::support::{create_system_source, export_scope, import_scope, init_repo, write_json};
use provenance_core::SUPPORTED_SCHEMA_VERSION;
use std::path::PathBuf;

#[test]
fn import_cannot_omit_existing_modern_lifecycle_chain() {
    let fixture = ModernLifecycleFixture::new();
    let mut missing_assertion = fixture.lifecycle.clone();
    missing_assertion["assertion_records"] = serde_json::json!([]);
    missing_assertion["dispositions"] = serde_json::json!([]);
    fixture
        .import_value("missing-assertion.json", &missing_assertion)
        .failure()
        .stderr(predicates::str::contains(
            "qualifying proposal proposal_a requires an assertion",
        ));

    fixture.import_lifecycle().success();
    fixture.assert_asserted_evidence_is_immutable();

    let mut omitted = fixture.lifecycle.clone();
    omitted["proposal_cards"] = serde_json::json!([]);
    omitted["assertion_records"] = serde_json::json!([]);
    omitted["dispositions"] = serde_json::json!([]);
    fixture
        .import_value("omitted.json", &omitted)
        .failure()
        .stderr(predicates::str::contains("immutable proposal proposal_a"));
}

#[test]
fn import_rejects_duplicate_evidence_record_ids() {
    let fixture = ModernLifecycleFixture::new();
    let cases = [
        (
            "contributions",
            "strongest_finding",
            "duplicate immutable contribution id contribution_a",
        ),
        (
            "synthesis_packets",
            "summary",
            "duplicate immutable synthesis packet id synthesis_a",
        ),
    ];

    for (records, divergent_field, expected) in cases {
        let mut duplicate = fixture.lifecycle.clone();
        let mut divergent = duplicate[records][0].clone();
        divergent[divergent_field] = serde_json::json!("Divergent");
        duplicate[records].as_array_mut().unwrap().push(divergent);

        fixture
            .import_value(&format!("duplicate-{records}.json"), &duplicate)
            .failure()
            .stderr(predicates::str::contains(expected));
    }
}

#[test]
fn import_accepts_rejected_or_deferred_disposition_after_assertion() {
    for decision in ["rejected", "deferred"] {
        let fixture = ModernLifecycleFixture::new();
        let mut lifecycle = fixture.lifecycle.clone();
        lifecycle["dispositions"][0]["decision"] = serde_json::json!(decision);
        fixture
            .import_value(&format!("{decision}-asserted.json"), &lifecycle)
            .success();
    }
}

#[test]
fn import_and_export_round_trip_generic_external_action() {
    let fixture = ModernLifecycleFixture::new();
    fixture.import_lifecycle().success();
    let exported = fixture.root.join("round-trip.json");
    export_scope(&fixture.repo, &exported).success();
    let value: serde_json::Value =
        serde_json::from_slice(&std::fs::read(exported).unwrap()).unwrap();

    assert_eq!(
        value["dispositions"][0]["external_action"],
        fixture.lifecycle["dispositions"][0]["external_action"]
    );
}

struct ModernLifecycleFixture {
    _directory: tempfile::TempDir,
    root: PathBuf,
    repo: PathBuf,
    lifecycle: serde_json::Value,
}

impl ModernLifecycleFixture {
    fn new() -> Self {
        let directory = tempfile::tempdir().unwrap();
        let root = directory.path().to_path_buf();
        let repo = root.join("repo");
        init_repo(&repo, Some("reviewer"));
        create_system_source(&repo);
        let baseline = root.join("baseline.json");
        export_scope(&repo, &baseline).success();
        let mut lifecycle: serde_json::Value =
            serde_json::from_slice(&std::fs::read(&baseline).unwrap()).unwrap();
        add_modern_lifecycle(&mut lifecycle);
        Self {
            _directory: directory,
            root,
            repo,
            lifecycle,
        }
    }

    fn import_lifecycle(&self) -> assert_cmd::assert::Assert {
        self.import_value("lifecycle.json", &self.lifecycle)
    }

    fn import_value(&self, name: &str, value: &serde_json::Value) -> assert_cmd::assert::Assert {
        let input = self.root.join(name);
        write_json(&input, value);
        import_scope(&self.repo, &input)
    }

    fn assert_asserted_evidence_is_immutable(&self) {
        let mut changed_contribution = self.lifecycle.clone();
        changed_contribution["contributions"][0]["strongest_finding"] =
            serde_json::json!("Rewritten");
        self.import_value("changed-contribution.json", &changed_contribution)
            .failure()
            .stderr(predicates::str::contains(
                "contribution contribution_a is referenced by an assertion and cannot be replaced",
            ));

        // The stored contribution is not in the incoming scope at all, so it
        // is dropped rather than replaced.
        let mut retargeted_claim = self.lifecycle.clone();
        retargeted_claim["contributions"][0]["id"] = serde_json::json!("contribution_b");
        self.import_value("retargeted-claim.json", &retargeted_claim)
            .failure()
            .stderr(predicates::str::contains(
                "contribution contribution_a is referenced by an assertion and cannot be deleted",
            ));

        let mut changed_synthesis = self.lifecycle.clone();
        changed_synthesis["synthesis_packets"][0]["summary"] = serde_json::json!("Rewritten");
        self.import_value("changed-synthesis.json", &changed_synthesis)
            .failure()
            .stderr(predicates::str::contains(
                "synthesis packet synthesis_a is referenced by an assertion and cannot be replaced",
            ));

        // Dropping the packet has no import that reaches it: the assertion
        // naming the packet is immutable, so an import that drops the packet
        // either keeps the assertion and fails the aggregate, or drops it and
        // fails the immutable-record check first. The deletion rule stands
        // behind both; `handlers::import`'s unit test walks it for both kinds.
        let mut dropped_synthesis = self.lifecycle.clone();
        dropped_synthesis["synthesis_packets"] = serde_json::json!([]);
        self.import_value("dropped-synthesis.json", &dropped_synthesis)
            .failure()
            .stderr(predicates::str::contains(
                "assertion synthesis packet does not exist",
            ));
    }
}

fn add_modern_lifecycle(lifecycle: &mut serde_json::Value) {
    lifecycle["contributions"] = serde_json::json!([{
        "schema_version": SUPPORTED_SCHEMA_VERSION.0, "scope_id": "default", "id": "contribution_a",
        "target": {"artifact_type": "source", "artifact_id": "source_a"},
        "participant_slot": "reviewer", "stance": "support", "strongest_finding": "Observed",
        "evidence_references": [{"reference_id": "evidence_a", "evidence_type": "source", "summary": "Pinned"}],
        "material_claims": [{"claim_id": "claim_a", "statement": "Observed", "evidence_type": "source", "evidence_reference_ids": ["evidence_a"]}],
        "risks": [], "objections": [], "challenges": [], "suggested_artifact_changes": [],
        "unsupported_recommendations": [], "uncertainty": {"level": "low", "rationale": "Direct"}, "open_questions": []
    }]);
    lifecycle["synthesis_packets"] = serde_json::json!([{
        "schema_version": SUPPORTED_SCHEMA_VERSION.0, "scope_id": "default", "id": "synthesis_a",
        "target": {"artifact_type": "source", "artifact_id": "source_a"}, "summary": "Adjudicated",
        "consensus": [], "contested_claims": [], "minority_objections": [], "evidence_gaps": [],
        "unsupported_speculation": [], "open_questions": [],
        "suggested_artifacts": [{"proposal_id": "proposal_a", "proposal_key": "proposal-a", "proposal_type": "requirement_candidate", "summary": "Candidate", "origin_participant_slots": ["reviewer"]}],
        "required_human_decisions": []
    }]);
    lifecycle["proposal_cards"] = serde_json::json!([{
        "schema_version": SUPPORTED_SCHEMA_VERSION.0, "scope_id": "default", "id": "proposal_a", "proposal_key": "proposal-a",
        "proposal_type": "requirement_candidate", "title": "Candidate", "summary": "Candidate",
        "traceability": {"target": {"artifact_type": "source", "artifact_id": "source_a"}, "source_ids": ["source_a"], "evidence_references": [], "supporting_claim_ids": ["claim_a"]},
        "promotion_state": "proposed"
    }]);
    lifecycle["assertion_records"] = serde_json::json!([{
        "schema_version": SUPPORTED_SCHEMA_VERSION.0, "scope_id": "default", "id": "assertion_a", "proposal_id": "proposal_a",
        "synthesis_packet_id": "synthesis_a", "supporting_claim_ids": ["claim_a"]
    }]);
    lifecycle["dispositions"] = serde_json::json!([{
        "schema_version": SUPPORTED_SCHEMA_VERSION.0, "scope_id": "default", "id": "disposition_a", "proposal_id": "proposal_a",
        "decision": "accepted", "rationale": "Reviewed", "actor": {"identity_type": "human", "id": "reviewer"},
        "canonical_artifact": {"artifact_type": "source", "artifact_id": "source_a"},
        "external_action": {"system": "github", "scope": "acme/payroll", "kind": "deployment", "key": "prod-44"}
    }]);
}