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

use crate::{
    cli::ideation::IdeationArtifactKind,
    output::{self, OutputFormat},
};
use anyhow::Context;
use camino::Utf8Path;
// Validating one artifact file asks the same question the ideation aggregate
// asks of a whole scope, so it is the same function: the rule lives in
// `provenance-core` and the message names the record kind.
use provenance_core::{
    ensure_supported_schema_version as ensure_schema_version, validate_optional_confidence_score,
    AssertionRecord, Contribution, DispositionRecord, ProposalCard, SynthesisPacket,
};
use provenance_store::graph_reference::{ExactExport, GraphReference};
use serde::Serialize;

#[derive(Serialize)]
struct ValidationReport {
    artifact: &'static str,
    input: String,
    valid: bool,
}

pub(super) fn handle(
    artifact: IdeationArtifactKind,
    input: &Utf8Path,
    format: OutputFormat,
) -> anyhow::Result<()> {
    validate_file(artifact, input)?;
    output::print(
        format,
        &ValidationReport {
            artifact: artifact.name(),
            input: input.to_string(),
            valid: true,
        },
    )
}

pub(super) fn validate_file(
    artifact: IdeationArtifactKind,
    input: &Utf8Path,
) -> anyhow::Result<()> {
    let json = std::fs::read_to_string(input).with_context(|| format!("failed to read {input}"))?;
    match artifact {
        IdeationArtifactKind::Contribution => {
            let contribution: Contribution = serde_json::from_str(&json)?;
            validate_contribution_record(&contribution)?;
        }
        IdeationArtifactKind::SynthesisPacket => {
            let synthesis_packet: SynthesisPacket = serde_json::from_str(&json)?;
            validate_synthesis_packet_record(&synthesis_packet)?;
        }
        IdeationArtifactKind::Proposal => {
            let proposal: ProposalCard = serde_json::from_str(&json)?;
            validate_proposal_card_record(&proposal)?;
        }
        IdeationArtifactKind::Assertion => {
            let assertion: AssertionRecord = serde_json::from_str(&json)?;
            ensure_schema_version("assertion", assertion.schema_version)?;
            provenance_core::validate_assertion_intrinsic(&assertion)?;
        }
        IdeationArtifactKind::Disposition => {
            let disposition: DispositionRecord = serde_json::from_str(&json)?;
            ensure_schema_version("disposition", disposition.schema_version)?;
            provenance_core::validate_disposition_intrinsic(&disposition)?;
        }
        IdeationArtifactKind::GraphReference => {
            GraphReference::from_json(json.as_bytes())?;
        }
        IdeationArtifactKind::GraphReferenceExport => {
            let value = serde_json::from_str(&json)?;
            super::schema::validate_graph_reference_export(&value)?;
            ExactExport::from_json(json.as_bytes())?;
        }
    }
    Ok(())
}

pub(super) fn validate_contribution_record(contribution: &Contribution) -> anyhow::Result<()> {
    ensure_schema_version("contribution", contribution.schema_version)?;
    for claim in &contribution.material_claims {
        validate_optional_confidence_score(claim.confidence).with_context(|| {
            format!(
                "material claim {} confidence is invalid",
                claim.claim_id.as_str()
            )
        })?;
    }
    Ok(())
}

pub(super) fn validate_synthesis_packet_record(
    synthesis_packet: &SynthesisPacket,
) -> anyhow::Result<()> {
    ensure_schema_version("synthesis", synthesis_packet.schema_version)
}

pub(super) fn validate_proposal_card_record(proposal: &ProposalCard) -> anyhow::Result<()> {
    ensure_schema_version("proposal", proposal.schema_version)?;
    provenance_core::validate_proposal_intrinsic(proposal)?;
    validate_optional_confidence_score(proposal.confidence)
        .with_context(|| format!("proposal {} confidence is invalid", proposal.id.as_str()))?;
    Ok(())
}