panproto-cli 0.58.0

Schematic version control CLI for panproto
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

//! Integration tests for the `schema compat` subcommand.
//!
//! Exercises the CI-usable exit codes (0 = compatible, 1 = breaking,
//! 2 = usage/load error) and the `--format json` output.

#![allow(clippy::unwrap_used)]

use assert_cmd::Command;
use std::path::Path;

fn schema_cmd() -> Command {
    Command::cargo_bin("schema").unwrap()
}

/// Write a schema JSON file with the full field set so it deserialises
/// into `panproto_schema::Schema`.
fn write_schema(dir: &Path, name: &str, vertices: &[(&str, &str)]) {
    let mut verts = serde_json::Map::new();
    for (id, kind) in vertices {
        verts.insert(
            (*id).to_string(),
            serde_json::json!({ "id": id, "kind": kind, "nsid": null }),
        );
    }
    let schema = serde_json::json!({
        "protocol": "atproto",
        "vertices": verts,
        "edges": [],
        "hyper_edges": {},
        "constraints": {},
        "required": {},
        "nsids": {},
        "variants": {},
        "orderings": [],
        "recursion_points": {},
        "spans": {},
        "usage_modes": [],
        "nominal": {},
        "outgoing": {},
        "incoming": {},
        "between": []
    });
    std::fs::write(
        dir.join(name),
        serde_json::to_string_pretty(&schema).unwrap(),
    )
    .unwrap();
}

#[test]
fn compat_breaking_pair_exits_1() {
    let dir = tempfile::tempdir().unwrap();
    // Removing the `post` vertex is a breaking change.
    write_schema(dir.path(), "old.json", &[("post", "record")]);
    write_schema(dir.path(), "new.json", &[]);

    schema_cmd()
        .args(["compat", "old.json", "new.json", "--protocol", "atproto"])
        .current_dir(dir.path())
        .assert()
        .code(1)
        .stdout(predicates::str::contains("breaking"));
}

#[test]
fn compat_compatible_pair_exits_0() {
    let dir = tempfile::tempdir().unwrap();
    // Adding a vertex is backward-compatible.
    write_schema(dir.path(), "old.json", &[]);
    write_schema(dir.path(), "new.json", &[("post", "record")]);

    schema_cmd()
        .args(["compat", "old.json", "new.json", "--protocol", "atproto"])
        .current_dir(dir.path())
        .assert()
        .code(0)
        .stdout(predicates::str::contains("COMPATIBLE"));
}

#[test]
fn compat_json_format_reports_classification() {
    let dir = tempfile::tempdir().unwrap();
    write_schema(dir.path(), "old.json", &[("post", "record")]);
    write_schema(dir.path(), "new.json", &[]);

    let output = schema_cmd()
        .args([
            "compat",
            "old.json",
            "new.json",
            "--protocol",
            "atproto",
            "--format",
            "json",
        ])
        .current_dir(dir.path())
        .output()
        .unwrap();

    assert_eq!(output.status.code(), Some(1));
    let value: serde_json::Value = serde_json::from_slice(&output.stdout).unwrap();
    assert_eq!(value["classification"], "breaking");
    assert!(value["breaking_count"].as_u64().unwrap() >= 1);
}

#[test]
fn compat_missing_file_exits_2() {
    let dir = tempfile::tempdir().unwrap();
    write_schema(dir.path(), "old.json", &[("post", "record")]);

    schema_cmd()
        .args([
            "compat",
            "old.json",
            "does-not-exist.json",
            "--protocol",
            "atproto",
        ])
        .current_dir(dir.path())
        .assert()
        .code(2);
}

#[test]
fn compat_bad_format_exits_2() {
    let dir = tempfile::tempdir().unwrap();
    write_schema(dir.path(), "old.json", &[("post", "record")]);
    write_schema(dir.path(), "new.json", &[("post", "record")]);

    schema_cmd()
        .args([
            "compat",
            "old.json",
            "new.json",
            "--protocol",
            "atproto",
            "--format",
            "toml",
        ])
        .current_dir(dir.path())
        .assert()
        .code(2);
}