wyvern-schema 0.5.0

Wyvern JSON types, validation, and error messages
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

//! Integration coverage for wizard validation rules (d.1).

use serde_json::json;
use wyvern_schema::{validate, Command, ValidationError, WizardCommand, WizardPageLayout};

#[test]
fn validation_wizard_minimal_passes() {
    let cmd = validate(&json!({
        "type": "wizard",
        "page": {
            "id": "start",
            "title": "Start",
            "html": "pages/start.html"
        }
    }))
    .expect("valid");
    match cmd {
        Command::Wizard(WizardCommand {
            page,
            config,
            width,
            height,
            workflow,
        }) => {
            assert_eq!(page.id, "start");
            assert_eq!(page.title, "Start");
            assert_eq!(page.html, "pages/start.html");
            assert!(page.layout.is_none());
            assert_eq!(config, json!({}));
            assert!(width.is_none());
            assert!(height.is_none());
            assert!(workflow.is_none());
        }
        other => panic!("expected Wizard, got {other:?}"),
    }
}

#[test]
fn validation_wizard_layout_dialog_and_workspace() {
    for (wire, expected) in [
        ("dialog", WizardPageLayout::Dialog),
        ("workspace", WizardPageLayout::Workspace),
    ] {
        let cmd = validate(&json!({
            "type": "wizard",
            "page": {
                "id": "p",
                "title": "P",
                "html": "p.html",
                "layout": wire
            },
            "config": { "theme": "dark" },
            "width": 640,
            "height": 480
        }))
        .expect("valid");
        let Command::Wizard(w) = cmd else {
            panic!("expected Wizard");
        };
        assert_eq!(w.page.layout, Some(expected));
        assert_eq!(w.config["theme"], "dark");
        assert_eq!(w.width, Some(640));
        assert_eq!(w.height, Some(480));
    }
}

#[test]
fn validation_wizard_missing_page_fails() {
    let err = validate(&json!({"type": "wizard"})).unwrap_err();
    assert!(matches!(
        err,
        ValidationError::Validation { ref field, .. } if field == "page"
    ));
}

#[test]
fn validation_wizard_missing_page_id_fails() {
    let err = validate(&json!({
        "type": "wizard",
        "page": { "title": "T", "html": "a.html" }
    }))
    .unwrap_err();
    assert!(matches!(
        err,
        ValidationError::Validation { ref field, .. } if field == "page.id"
    ));
}

#[test]
fn validation_wizard_empty_html_fails() {
    let err = validate(&json!({
        "type": "wizard",
        "page": { "id": "a", "title": "T", "html": "" }
    }))
    .unwrap_err();
    assert!(matches!(
        err,
        ValidationError::Validation { ref field, .. } if field == "page.html"
    ));
}

#[test]
fn validation_wizard_invalid_layout_fails() {
    let err = validate(&json!({
        "type": "wizard",
        "page": {
            "id": "a",
            "title": "T",
            "html": "a.html",
            "layout": "fullscreen"
        }
    }))
    .unwrap_err();
    match err {
        ValidationError::Validation { field, message } => {
            assert_eq!(field, "page.layout");
            assert!(message.contains("dialog") && message.contains("workspace"));
        }
        other => panic!("unexpected {other:?}"),
    }
}

#[test]
fn validation_wizard_workflow_optional_and_populated() {
    let missing = validate(&json!({
        "type": "wizard",
        "page": { "id": "a", "title": "T", "html": "a.html" }
    }))
    .expect("valid without workflow");
    let Command::Wizard(without) = missing else {
        panic!("expected Wizard");
    };
    assert!(without.workflow.is_none());

    let with = validate(&json!({
        "type": "wizard",
        "page": { "id": "a", "title": "T", "html": "a.html" },
        "workflow": {
            "pre": "{wyvern_share}/scripts/ext/pre.py",
            "post": "{wyvern_share}/scripts/ext/post.py"
        }
    }))
    .expect("valid with workflow");
    let Command::Wizard(with) = with else {
        panic!("expected Wizard");
    };
    let workflow = with.workflow.expect("workflow present");
    assert_eq!(
        workflow.pre.as_deref(),
        Some("{wyvern_share}/scripts/ext/pre.py")
    );
    assert_eq!(
        workflow.post.as_deref(),
        Some("{wyvern_share}/scripts/ext/post.py")
    );
}

#[test]
fn validation_wizard_unknown_field_fails() {
    let err = validate(&json!({
        "type": "wizard",
        "page": { "id": "a", "title": "T", "html": "a.html" },
        "page_html": "nope"
    }))
    .unwrap_err();
    assert!(matches!(
        err,
        ValidationError::Validation { ref field, .. } if field == "page_html"
    ));
}