odcs 0.9.1

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

//! Tests for validationPhase metadata on diagnostics.

use std::fs;
use std::path::PathBuf;

use odcs::{parse, DiagnosticReport, DiagnosticStage, DocumentFormat, ValidationPhase};

fn fixture_bytes(name: &str) -> Vec<u8> {
    fs::read(
        PathBuf::from(env!("CARGO_MANIFEST_DIR"))
            .join("tests/fixtures")
            .join(name),
    )
    .expect("read fixture")
}

fn parse_and_validate_fixture(name: &str) -> DiagnosticReport {
    let format = if name.ends_with(".json") {
        DocumentFormat::Json
    } else {
        DocumentFormat::Yaml
    };
    parse(&fixture_bytes(name), format).validate()
}

fn assert_validation_phase_coverage(report: &DiagnosticReport) {
    for diagnostic in &report.diagnostics {
        match diagnostic.stage {
            DiagnosticStage::Validation => {
                assert!(
                    diagnostic.validation_phase.is_some(),
                    "validation diagnostic missing validationPhase: {diagnostic:?}"
                );
            }
            DiagnosticStage::Parse => {
                assert!(
                    diagnostic.validation_phase.is_none(),
                    "parse diagnostic must omit validationPhase: {diagnostic:?}"
                );
            }
            _ => {}
        }
    }
}

/// Invalid fixtures that parse successfully and produce validation diagnostics.
const VALIDATION_FIXTURES: &[&str] = &[
    "invalid-kind.yaml",
    "invalid-empty-id.yaml",
    "invalid-quality-no-type-bad-metric.yaml",
    "invalid-quality-deprecated-rule-only.yaml",
    "invalid-quality-empty-sql-query.yaml",
    "invalid-quality-unknown-type.yaml",
    "invalid-quality-between-length.yaml",
    "invalid-quality-dimension.yaml",
    "invalid-relationship-empty-composite.yaml",
    "invalid-relationship-bad-format.yaml",
    "invalid-relationship-length-mismatch.yaml",
    "invalid-relationship-dangling.yaml",
    "invalid-relationship-from.yaml",
    "invalid-nested-property-ref.yaml",
    "invalid-server-typo.yaml",
    "invalid-server-type.yaml",
    "invalid-extension-empty-key.yaml",
    "invalid-extension-duplicate.yaml",
    "invalid-schema-array-without-items.yaml",
    "invalid-stable-id.yaml",
    "invalid-logical-type.yaml",
    "invalid-json-schema-only.yaml",
    "unsupported-version.yaml",
    "invalid-structural-duplicate-schema-name.yaml",
    "invalid-structural-duplicate-server.yaml",
    "invalid-structural-sla-element-dangling.yaml",
    "invalid-structural-sla-default-element-dangling.yaml",
    "invalid-structural-sla-default-element-partial.yaml",
    "invalid-quality-empty-rule.yaml",
    "invalid-quality-mustbe-only.yaml",
    "invalid-roles-duplicate-id.yaml",
    "invalid-support-missing-url.yaml",
    "invalid-sla-schedule-without-scheduler.yaml",
    "invalid-pricing-missing-currency.yaml",
    "invalid-pricing-negative-amount.yaml",
];

/// Fixtures that fail during parse (validationPhase must be absent).
const PARSE_ONLY_FIXTURES: &[&str] = &[
    "invalid-duplicate-key.yaml",
    "invalid-duplicate-key.json",
    "invalid-nested-duplicate-key.yaml",
    "invalid-nested-duplicate-key.json",
    "unknown-field.yaml",
    "nested-unknown-field.yaml",
    "invalid-lone-team-member.yaml",
];

#[test]
fn validation_fixtures_include_validation_phase() {
    for name in VALIDATION_FIXTURES {
        let report = parse_and_validate_fixture(name);
        assert!(!report.is_valid(), "fixture {name} should be invalid");
        assert_validation_phase_coverage(&report);
    }
}

#[test]
fn parse_only_fixtures_omit_validation_phase() {
    for name in PARSE_ONLY_FIXTURES {
        let format = if name.ends_with(".json") {
            DocumentFormat::Json
        } else {
            DocumentFormat::Yaml
        };
        let report = parse(&fixture_bytes(name), format).report;
        assert!(!report.is_valid(), "fixture {name} should be invalid");
        assert_validation_phase_coverage(&report);
    }
}

#[test]
fn invalid_kind_uses_document_phase() {
    let report = parse_and_validate_fixture("invalid-kind.yaml");
    let diagnostic = report
        .diagnostics
        .iter()
        .find(|d| d.stage == DiagnosticStage::Validation)
        .expect("validation diagnostic");
    assert_eq!(diagnostic.validation_phase, Some(ValidationPhase::Document));
}

#[test]
fn invalid_pricing_uses_sections_phase() {
    let report = parse_and_validate_fixture("invalid-pricing-negative-amount.yaml");
    assert!(
        report.diagnostics.iter().any(|d| {
            d.validation_phase == Some(ValidationPhase::Sections)
                && d.object_ref.as_deref() == Some("price.priceAmount")
        }),
        "expected sections-phase pricing diagnostic: {:?}",
        report.diagnostics
    );
}

#[test]
fn validation_phase_serializes_as_camel_case() {
    let report = parse_and_validate_fixture("invalid-kind.yaml");
    let json = serde_json::to_string(&report.diagnostics).expect("serialize diagnostics");
    assert!(json.contains("\"validationPhase\":\"document\""));
}