made-core 0.7.4

Domain core of MADE: entities, value objects, events, ports. No IO.
Documentation 
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

use serde::{Deserialize, Serialize};
use time::OffsetDateTime;

use super::{ArtifactImportRef, ArtifactSourceKind};
use crate::error::DomainError;
use crate::value_objects::ceremony::StepClaimFence;
use crate::value_objects::execution::{ExecutionOperationId, ExecutionReceiptId};

/// Typed origin of artifact metadata. Authentication joins in C5.7.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct ArtifactProvenance {
    source_kind: ArtifactSourceKind,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    execution_receipt_id: Option<ExecutionReceiptId>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    operation_id: Option<ExecutionOperationId>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    accepted_claim_fence: Option<StepClaimFence>,
    #[serde(with = "time::serde::rfc3339")]
    observed_at: OffsetDateTime,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    import_ref: Option<ArtifactImportRef>,
}

impl ArtifactProvenance {
    pub fn execution(
        source_kind: ArtifactSourceKind,
        execution_receipt_id: ExecutionReceiptId,
        operation_id: ExecutionOperationId,
        accepted_claim_fence: StepClaimFence,
        observed_at: OffsetDateTime,
    ) -> Result<Self, DomainError> {
        if !source_kind.is_execution_source() {
            return Err(DomainError::InvariantViolated {
                reason: "execution artifact provenance requires an execution source kind",
            });
        }
        Ok(Self {
            source_kind,
            execution_receipt_id: Some(execution_receipt_id),
            operation_id: Some(operation_id),
            accepted_claim_fence: Some(accepted_claim_fence),
            observed_at,
            import_ref: None,
        })
    }

    #[must_use]
    pub fn generated_report(observed_at: OffsetDateTime) -> Self {
        Self {
            source_kind: ArtifactSourceKind::GeneratedReport,
            execution_receipt_id: None,
            operation_id: None,
            accepted_claim_fence: None,
            observed_at,
            import_ref: None,
        }
    }

    #[must_use]
    pub fn imported(import_ref: ArtifactImportRef, observed_at: OffsetDateTime) -> Self {
        Self {
            source_kind: ArtifactSourceKind::Imported,
            execution_receipt_id: None,
            operation_id: None,
            accepted_claim_fence: None,
            observed_at,
            import_ref: Some(import_ref),
        }
    }

    /// Re-check invariants after a persistence or wire deserialization.
    pub fn validate(&self) -> Result<(), DomainError> {
        let has_execution = self.execution_receipt_id.is_some()
            && self.operation_id.is_some()
            && self.accepted_claim_fence.is_some();
        let has_partial_execution = self.execution_receipt_id.is_some()
            || self.operation_id.is_some()
            || self.accepted_claim_fence.is_some();
        match self.source_kind {
            ArtifactSourceKind::ExternalExecution
            | ArtifactSourceKind::Fixture
            | ArtifactSourceKind::NoOp
                if has_execution && self.import_ref.is_none() =>
            {
                Ok(())
            }
            ArtifactSourceKind::GeneratedReport
                if !has_partial_execution && self.import_ref.is_none() =>
            {
                Ok(())
            }
            ArtifactSourceKind::Imported if !has_partial_execution && self.import_ref.is_some() => {
                Ok(())
            }
            _ => Err(DomainError::InvariantViolated {
                reason: "artifact provenance fields do not match its source kind",
            }),
        }
    }

    #[must_use]
    pub const fn source_kind(&self) -> ArtifactSourceKind {
        self.source_kind
    }

    #[must_use]
    pub fn execution_receipt_id(&self) -> Option<&ExecutionReceiptId> {
        self.execution_receipt_id.as_ref()
    }

    #[must_use]
    pub fn operation_id(&self) -> Option<&ExecutionOperationId> {
        self.operation_id.as_ref()
    }

    #[must_use]
    pub fn accepted_claim_fence(&self) -> Option<&StepClaimFence> {
        self.accepted_claim_fence.as_ref()
    }

    #[must_use]
    pub const fn observed_at(&self) -> OffsetDateTime {
        self.observed_at
    }

    #[must_use]
    pub fn import_ref(&self) -> Option<&ArtifactImportRef> {
        self.import_ref.as_ref()
    }
}

#[cfg(test)]
mod tests {
    use serde_json::json;

    use super::*;

    #[test]
    fn deserialized_provenance_must_match_its_source_kind() {
        let raw = json!({
            "source_kind": "external_execution",
            "observed_at": "1970-01-01T00:00:00Z"
        });
        let provenance: ArtifactProvenance = serde_json::from_value(raw).unwrap();
        assert!(provenance.validate().is_err());
    }
}