dpcs 0.10.0

Reference implementation of the Data Pipeline Contract Standard (DPCS)
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
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

//! Contract reference validation phase.

use std::collections::BTreeSet;

use crate::diagnostics::{categories, Diagnostic, ValidationReport};
use crate::model::PipelineContract;

/// Validate that contract references are well-formed and resolvable by id.
pub fn validate(contract: &PipelineContract) -> ValidationReport {
    let mut report = ValidationReport::new();
    let known_refs: BTreeSet<&str> = contract
        .contract_references
        .iter()
        .map(|r| r.id.as_str())
        .collect();

    for (index, reference) in contract.contract_references.iter().enumerate() {
        if reference.reference_type.trim().is_empty() {
            report.push(
                Diagnostic::error(
                    "DPCS-REF-001",
                    categories::REFERENCE,
                    format!("contract reference `{}` has an empty type", reference.id),
                )
                .with_object_ref(format!("contractReferences[{index}].type")),
            );
        }
        if reference.location.trim().is_empty() {
            report.push(
                Diagnostic::error(
                    "DPCS-REF-002",
                    categories::REFERENCE,
                    format!(
                        "contract reference `{}` has an empty location",
                        reference.id
                    ),
                )
                .with_object_ref(format!("contractReferences[{index}].location")),
            );
        }
    }

    for step in &contract.steps {
        if let Some(contract_ref) = &step.contract_ref {
            if !is_resolvable(contract_ref, &known_refs) {
                report.push(
                    Diagnostic::error(
                        "DPCS-REF-003",
                        categories::REFERENCE,
                        format!(
                            "step `{}` references unknown contract `{}`",
                            step.id, contract_ref
                        ),
                    )
                    .with_object_ref(format!("steps.{}.contractRef", step.id))
                    .with_remediation(
                        "Declare the contract under contractReferences or use a direct location",
                    ),
                );
            }
        }

        if let Some(transform_ref) = &step.transform_ref {
            if !is_resolvable(transform_ref, &known_refs) {
                report.push(
                    Diagnostic::error(
                        "DPCS-REF-005",
                        categories::REFERENCE,
                        format!(
                            "step `{}` references unknown transform `{}`",
                            step.id, transform_ref
                        ),
                    )
                    .with_object_ref(format!("steps.{}.transformRef", step.id))
                    .with_remediation(
                        "Declare the transform under contractReferences or use a direct location",
                    ),
                );
            }
        }

        for port in &step.inputs {
            if let Some(contract_ref) = &port.contract_ref {
                if !is_resolvable(contract_ref, &known_refs) {
                    report.push(
                        Diagnostic::error(
                            "DPCS-REF-006",
                            categories::REFERENCE,
                            format!(
                                "step `{}` input port `{}` references unknown contract `{}`",
                                step.id, port.id, contract_ref
                            ),
                        )
                        .with_object_ref(format!("steps.{}.inputs.{}", step.id, port.id))
                        .with_remediation(
                            "Declare the contract under contractReferences or use a direct location",
                        ),
                    );
                }
            }
        }

        for port in &step.outputs {
            if let Some(contract_ref) = &port.contract_ref {
                if !is_resolvable(contract_ref, &known_refs) {
                    report.push(
                        Diagnostic::error(
                            "DPCS-REF-006",
                            categories::REFERENCE,
                            format!(
                                "step `{}` output port `{}` references unknown contract `{}`",
                                step.id, port.id, contract_ref
                            ),
                        )
                        .with_object_ref(format!("steps.{}.outputs.{}", step.id, port.id))
                        .with_remediation(
                            "Declare the contract under contractReferences or use a direct location",
                        ),
                    );
                }
            }
        }
    }

    for (side, ports) in [
        ("inputs", contract.interface.inputs.as_slice()),
        ("outputs", contract.interface.outputs.as_slice()),
    ] {
        for port in ports {
            if let Some(contract_ref) = &port.contract_ref {
                if !is_resolvable(contract_ref, &known_refs) {
                    report.push(
                        Diagnostic::error(
                            "DPCS-REF-004",
                            categories::REFERENCE,
                            format!(
                                "interface port `{}` references unknown contract `{}`",
                                port.id, contract_ref
                            ),
                        )
                        .with_object_ref(format!("interface.{side}.{}", port.id)),
                    );
                }
            }
        }
    }

    for (index, flow) in contract.data_flow.iter().enumerate() {
        if let Some(contract_ref) = &flow.contract_ref {
            if !is_resolvable(contract_ref, &known_refs) {
                report.push(
                    Diagnostic::error(
                        "DPCS-REF-003",
                        categories::REFERENCE,
                        format!("data flow references unknown contract `{contract_ref}`"),
                    )
                    .with_object_ref(format!("dataFlow[{index}].contractRef"))
                    .with_remediation(
                        "Declare the contract under contractReferences or use a direct location",
                    ),
                );
            }
        }
    }

    report
}

fn is_resolvable(value: &str, known_refs: &BTreeSet<&str>) -> bool {
    looks_like_path(value) || known_refs.contains(value)
}

fn looks_like_path(value: &str) -> bool {
    value.contains('/')
}