avrotize 0.1.1

Convert JSON Schema to Avro with Rust
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

#![cfg(feature = "cli")]
use assert_cmd::Command;
use insta::{assert_json_snapshot, assert_snapshot};
use rstest::rstest;
use serde_json::Value;
use similar::{ChangeTag, TextDiff};
use std::{fs, path::Path};
use tempfile::tempdir;

fn run_fixture(schema_path: &str, stem: &str) {
    let dir = tempdir().unwrap();
    let input_path = dir.path().join(format!("{stem}.json"));
    let output_path = dir.path().join(format!("{stem}.avsc"));

    // Load schema and copy into tmpdir
    let schema = fs::read_to_string(schema_path).unwrap();
    fs::write(&input_path, schema).unwrap();

    // Run CLI
    Command::cargo_bin("jsonschema2avro")
        .unwrap()
        .arg(input_path.to_str().unwrap())
        .arg(output_path.to_str().unwrap())
        .assert()
        .success();

    // Read output Avro schema
    let output = fs::read_to_string(&output_path).unwrap();
    let json: serde_json::Value = serde_json::from_str(&output).unwrap();

    // Compare with snapshot
    assert_json_snapshot!(stem, json);
}

#[rstest]
#[case("array_contains")]
#[case("array_maxitems")]
#[case("array_of_objects")]
#[case("array_uniqueitems")]
#[case("array_with_additional_items")]
#[case("basic_string_schema")]
#[case("basic_string_schema_with_title")]
#[case("boolean_false_schema")]
#[case("boolean_true_schema")]
#[case("empty_schema")]
#[case("enum_string_property")]
#[case("nested_object_and_array")]
#[case("number_exclusive_max")]
#[case("number_exclusive_min")]
#[case("number_exclusive_multipleof")]
#[case("number_with_maximum")]
#[case("object_allof")]
#[case("object_dependentrequired")]
#[case("object_dependentschemas")]
#[case("object_if_then_else")]
#[case("object_not")]
#[case("object_with_boolean_and_number")]
#[case("object_with_const_field")]
#[case("object_with_default_value")]
#[case("object_with_defs")]
#[case("object_with_enum_array")]
#[case("object_with_explicit_nullable_type")]
#[case("object_with_map_of_records")]
#[case("object_with_map_via_additional_props")]
#[case("object_with_oneof")]
#[case("object_with_optional")]
#[case("object_with_remote_ref")]
#[case("string_format_email")]
#[case("string_maxlength")]
#[case("string_minlength")]
// #[case("object_maxproperties")] // not priority?
// #[case("object_minproperties")] // not priority?
#[case("object_pattern_properties")]
// #[case("recursive_ref")] // accesses ref at URL
fn cli_fixtures(#[case] stem: &str) {
    let schema_path = format!("tests/fixtures/jsonschema/{stem}.json");
    run_fixture(&schema_path, stem);
}

fn normalize_json(input: &str) -> String {
    let value: Value = serde_json::from_str(input).unwrap();
    serde_json::to_string_pretty(&value).unwrap()
}

fn diff_fixture(stem: &str) -> Option<String> {
    let fixture_path = format!("tests/fixtures/avro/{stem}.avsc");
    let snap_path = format!("tests/snapshots/cli__{stem}.snap");

    if !Path::new(&fixture_path).exists() || !Path::new(&snap_path).exists() {
        return None;
    }

    let fixture_raw = fs::read_to_string(fixture_path).unwrap();
    let snapshot_raw = fs::read_to_string(snap_path).unwrap();

    let snapshot_stripped = snapshot_raw
        .lines()
        .skip_while(|line| !line.starts_with('{') && !line.starts_with('['))
        .collect::<Vec<_>>()
        .join("\n");

    let fixture = normalize_json(&fixture_raw);
    let snapshot = normalize_json(&snapshot_stripped);

    let diff = TextDiff::from_lines(&fixture, &snapshot);

    if diff.ratio() == 1.0 {
        // No syntactic changes: a perfect match with avrotize's output
        return Some(String::new());
    }

    let mut buf = String::new();
    for op in diff.ops() {
        for change in diff.iter_inline_changes(op) {
            let sign = match change.tag() {
                ChangeTag::Delete => "-",
                ChangeTag::Insert => "+",
                ChangeTag::Equal => " ",
            };
            buf.push_str(sign);

            for (emphasized, value) in change.values() {
                if *emphasized {
                    buf.push_str(&format!("[[{value}]]"));
                } else {
                    buf.push_str(value);
                }
            }
            buf.push('\n');
        }
    }

    Some(buf)
}

#[rstest]
#[case("array_contains")]
#[case("array_maxitems")]
#[case("array_of_objects")]
#[case("array_uniqueitems")]
#[case("array_with_additional_items")]
#[case("basic_string_schema")]
#[case("basic_string_schema_with_title")]
#[case("empty_schema")]
#[case("enum_string_property")]
#[case("nested_object_and_array")]
#[case("number_exclusive_max")]
#[case("number_exclusive_min")]
#[case("number_exclusive_multipleof")]
#[case("number_with_maximum")]
#[case("object_allof")]
#[case("object_dependentrequired")]
#[case("object_dependentschemas")]
#[case("object_if_then_else")]
#[case("object_not")]
#[case("object_with_boolean_and_number")]
#[case("object_with_const_field")]
#[case("object_with_default_value")]
#[case("object_with_defs")]
#[case("object_with_enum_array")]
#[case("object_with_explicit_nullable_type")]
#[case("object_with_map_of_records")]
#[case("object_with_map_via_additional_props")]
#[case("object_with_oneof")]
#[case("object_with_optional")]
#[case("string_format_email")]
#[case("string_maxlength")]
#[case("string_minlength")]
#[case("object_pattern_properties")]
fn diff_snapshots(#[case] stem: &str) {
    if let Some(diff) = diff_fixture(stem) {
        assert_snapshot!(format!("{stem}.diff"), diff);
    }
}