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

use crate::wiki::model::{
    DecisionIndexPage, GapKind, GapNotice, OrphanRecord, OrphanReport, PageKind, SearchEntry,
    SearchIndexPage, UnfinishedPage,
};

use super::fixtures::link;

pub(super) fn search_fixture() -> SearchIndexPage {
    SearchIndexPage {
        scope: "default".to_string(),
        title: "Search project records".to_string(),
        coverage: "Search covers requirements, decisions, rules, and sources.".to_string(),
        example: Some("Invoice & participant".to_string()),
        entries: vec![SearchEntry {
            link: link(
                PageKind::Requirement,
                "req_saveinvoice_split",
                "Invoice & participant",
            ),
            statement: "Invoice & participant statement".to_string(),
        }],
    }
}

pub(super) fn decisions_fixture() -> DecisionIndexPage {
    DecisionIndexPage {
        scope: "default".to_string(),
        title: "Decisions".to_string(),
        entries: vec![SearchEntry {
            link: link(PageKind::Resolution, "res_split", "Per-portion split"),
            statement: "Adopt the split".to_string(),
        }],
    }
}

pub(super) fn unfinished_fixture() -> UnfinishedPage {
    UnfinishedPage {
        scope: "default".to_string(),
        title: "Unfinished".to_string(),
        gaps: vec![
            GapNotice {
                kind: GapKind::DanglingReference,
                subject: None,
                related: None,
                detail: "A requirement points to a source that is missing.".to_string(),
            },
            GapNotice {
                kind: GapKind::MissingSourceRefs,
                subject: None,
                related: None,
                detail: "A requirement has no source references.".to_string(),
            },
            GapNotice {
                kind: GapKind::NoResolvingDecision,
                subject: None,
                related: None,
                detail: "A requirement is marked resolved but has no resolving decision."
                    .to_string(),
            },
        ],
        orphans: OrphanReport {
            rules: vec![],
            resolutions: vec![],
            sources: vec![OrphanRecord {
                link: link(PageKind::Source, "source_unused", "Unused API spec"),
                reason: "referenced by nothing".to_string(),
            }],
        },
        open_questions: vec![],
    }
}