odcs 0.2.0

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

//! Integration tests for the ODCS reference implementation.

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

use odcs::{codes, parse, parse_file, DocumentFormat, ParseResult, UPSTREAM_SPEC_VERSION};

fn fixture(name: &str) -> PathBuf {
    PathBuf::from(env!("CARGO_MANIFEST_DIR"))
        .join("tests/fixtures")
        .join(name)
}

fn parse_fixture(name: &str) -> ParseResult {
    let content = fs::read(fixture(name)).expect("read fixture");
    let format = if name.ends_with(".json") {
        DocumentFormat::Json
    } else {
        DocumentFormat::Yaml
    };
    parse(&content, format)
}

#[test]
fn upstream_spec_version_is_set() {
    assert_eq!(UPSTREAM_SPEC_VERSION, "3.1.0");
}

#[test]
fn parses_minimal_yaml_fixture() {
    let result = parse_fixture("minimal.odcs.yaml");
    let contract = result.into_contract().expect("parse fixture");
    assert_eq!(contract.name, "customer_data_contract");
    assert_eq!(contract.version, UPSTREAM_SPEC_VERSION);
    assert_eq!(contract.schema.len(), 1);
    assert_eq!(contract.quality.len(), 1);
}

#[test]
fn parses_minimal_json_fixture() {
    let result = parse_fixture("minimal.odcs.json");
    let contract = result.into_contract().expect("parse fixture");
    assert_eq!(contract.name, "customer_data_contract");
    assert_eq!(contract.kind, "DataContract");
}

#[test]
fn validates_minimal_fixture() {
    let result = parse_file("tests/fixtures/minimal.odcs.yaml").expect("read fixture");
    let report = result.validate();
    assert!(report.is_valid(), "{:?}", report.diagnostics);
}

#[test]
fn parses_example_yaml() {
    let result = parse_file("examples/minimal.odcs.yaml").expect("read example");
    let contract = result.into_contract().expect("parse example");
    assert_eq!(contract.kind, "DataContract");
}

#[test]
fn parses_example_json() {
    let result = parse_file("examples/minimal.odcs.json").expect("read example");
    let contract = result.into_contract().expect("parse example");
    assert_eq!(contract.name, "customer_data_contract");
}

#[test]
fn rejects_malformed_yaml() {
    let result = parse_fixture("malformed.yaml");
    assert!(result.contract.is_none());
    assert!(result
        .report
        .diagnostics
        .iter()
        .any(|d| d.id == codes::PARSE_YAML));
}

#[test]
fn rejects_malformed_json() {
    let result = parse_fixture("malformed.json");
    assert!(result.contract.is_none());
    assert!(result
        .report
        .diagnostics
        .iter()
        .any(|d| d.id == codes::PARSE_JSON));
}

#[test]
fn rejects_empty_name() {
    let report = parse_fixture("invalid-empty-name.yaml").validate();
    assert!(!report.is_valid());
    assert!(report
        .diagnostics
        .iter()
        .any(|d| d.id == codes::MISSING_REQUIRED_FIELD));
}

#[test]
fn rejects_invalid_kind() {
    let report = parse_fixture("invalid-kind.yaml").validate();
    assert!(!report.is_valid());
    assert!(report
        .diagnostics
        .iter()
        .any(|d| d.id == codes::INVALID_SCHEMA));
}

#[test]
fn rejects_unsupported_version() {
    let report = parse_fixture("unsupported-version.yaml").validate();
    assert!(!report.is_valid());
    assert!(report
        .diagnostics
        .iter()
        .any(|d| d.id == codes::UNSUPPORTED_VERSION));
}

#[test]
fn preserves_extension_fields() {
    let result = parse_fixture("with-extensions.yaml");
    let contract = result.into_contract().expect("parse extensions fixture");
    assert!(contract.extensions.contains_key("customDomain"));
    assert!(contract.extensions.contains_key("metadata"));
}

#[test]
fn diagnostics_are_deterministic_for_invalid_kind() {
    let first = parse_fixture("invalid-kind.yaml").validate();
    let second = parse_fixture("invalid-kind.yaml").validate();
    assert_eq!(first.diagnostics.len(), second.diagnostics.len());
    assert_eq!(first.diagnostics[0].id, second.diagnostics[0].id);
    assert_eq!(first.diagnostics[0].message, second.diagnostics[0].message);
}

#[test]
fn into_contract_requires_valid_parse() {
    let result = parse_fixture("malformed.yaml");
    assert!(result.into_contract().is_err());
}