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

use super::{
    publish, publish_with, replace_output_with, write_page, PublicationOutput, PublishError,
    TransactionPaths, OWNERSHIP_MANIFEST,
};
use crate::wiki::model::{
    CorpusCounts, DecisionIndexPage, DomainIndexPage, OrphanReport, PageId, RecordKind,
    RequirementPage, ScopeIndexPage, SearchIndexPage, UnfinishedPage, WikiCorpus,
};
use camino::Utf8PathBuf;
use provenance_core::RequirementStatus;

mod ownership_output_validation;
#[cfg(unix)]
mod preflight_domain;
mod replacement_rollback;
mod route_safety;
mod route_staging;
mod staging_artifact_safety;

fn empty_corpus() -> WikiCorpus {
    WikiCorpus {
        scope: "default".to_string(),
        index: ScopeIndexPage {
            scope: "default".to_string(),
            title: "Provenance Wiki".to_string(),
            counts: CorpusCounts::default(),
            search_coverage: "Search covers requirements, decisions, rules, and sources."
                .to_string(),
            search_example: None,
            domains: Vec::new(),
            authored_domain_count: 0,
            unfinished_count: 0,
        },
        domains: DomainIndexPage {
            scope: "default".to_string(),
            title: "Requirements and rules by domain".to_string(),
            authored_group_count: 0,
            groups: Vec::new(),
            all_requirements: Vec::new(),
            all_rules: Vec::new(),
        },
        search: SearchIndexPage {
            scope: "default".to_string(),
            title: "Search project records".to_string(),
            coverage: "Search covers requirements, decisions, rules, and sources.".to_string(),
            example: None,
            entries: Vec::new(),
        },
        decisions: DecisionIndexPage {
            scope: "default".to_string(),
            title: "Decisions".to_string(),
            entries: Vec::new(),
        },
        unfinished: UnfinishedPage {
            scope: "default".to_string(),
            title: "Unfinished".to_string(),
            gaps: Vec::new(),
            orphans: OrphanReport::default(),
            open_questions: Vec::new(),
        },
        requirements: Vec::new(),
        resolutions: Vec::new(),
        rules: Vec::new(),
        sources: Vec::new(),
    }
}

fn assert_no_transaction_artifacts(output: &camino::Utf8Path) {
    for role in ["lock", "lock.cleanup", "stage", "stage.cleanup", "backup"] {
        assert!(!artifact(output, role).exists());
    }
}

fn artifact(output: &camino::Utf8Path, role: &str) -> Utf8PathBuf {
    let parent = output.parent().unwrap();
    let leaf = output.file_name().unwrap();
    parent.join(format!(".{leaf}.provenance-wiki.{role}"))
}

fn utf8(path: std::path::PathBuf) -> Utf8PathBuf {
    Utf8PathBuf::from_path_buf(path).unwrap()
}