jsoncompat 0.3.1

JSON Schema Compatibility Checker
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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
//! Fuzzer tests.

use json_schema_ast::{
    AstError, NodeId, PatternSupport, SchemaDocument, SchemaError, SchemaNode, SchemaNodeKind,
    compile,
};
use json_schema_fuzz::{GenerateError, GenerationConfig, ValueGenerator};
use rand::{SeedableRng, rngs::StdRng};
use serde_json::Value;
use std::collections::{HashMap, HashSet};
use std::fs;
use std::path::Path;

const N_ITERATIONS: usize = 1000;
const JSON_SCHEMA_DRAFT_2020_12: &str = "https://json-schema.org/draft/2020-12/schema";
const JSON_SCHEMA_DRAFT_2020_12_WITH_FRAGMENT: &str =
    "https://json-schema.org/draft/2020-12/schema#";

/// Load the temporary whitelist that allows individual failures to be marked
/// as expected while we iteratively improve the fuzzer.
///
/// ```jsonc
/// {
///   "recursive.json": [0, 3, 4]      // skip specific schema indices
/// }
/// ```
fn load_whitelist() -> HashMap<String, HashSet<usize>> {
    let mut map: HashMap<String, HashSet<usize>> = HashMap::new();
    map.insert("not.json".to_string(), [8].iter().cloned().collect());
    map.insert(
        "unevaluatedItems.json".to_string(),
        [12, 18].iter().cloned().collect(),
    );
    map.insert(
        "unevaluatedProperties.json".to_string(),
        [12, 15].iter().cloned().collect(),
    );

    map
}

// -------------------------------------------------------------------------
// Test harness: one test per JSON file under fixtures/fuzz
// -------------------------------------------------------------------------

datatest_stable::harness! {
    { test = fixture, root = "tests/fixtures/fuzz", pattern = ".*\\.json$" },
}

fn fixture(file: &Path) -> Result<(), Box<dyn std::error::Error>> {
    let bytes = fs::read(file)?;
    let root: Value = serde_json::from_slice(&bytes)?;
    let schemas = collect_fixture_schemas(&root);

    // Deterministic RNG per file for reproducibility.
    let seed = 0xBADBABE + file.to_string_lossy().len() as u64;
    let mut rng = StdRng::seed_from_u64(seed);

    // Whitelist lookup key – path relative to the fixtures root.
    let rel_path = file.strip_prefix("tests/fixtures/fuzz").unwrap_or(file);
    let rel_str = rel_path.to_string_lossy().replace('\\', "/");
    let validate_fixture_tests = rel_str.starts_with("custom/");

    let whitelist = load_whitelist();
    let allowed = whitelist.get::<str>(rel_str.as_ref());

    for (idx, fixture_schema) in schemas.iter().enumerate() {
        let schema_json = &fixture_schema.schema;
        // Skip `false` schemas – they have an empty instance set by design.
        if schema_json == &Value::Bool(false) {
            continue;
        }

        let is_whitelisted = allowed.map(|set| set.contains(&idx)).unwrap_or(false);

        let schema = match SchemaDocument::from_json(schema_json) {
            Ok(schema) => schema,
            Err(error)
                if !validate_fixture_tests
                    && schema_declares_unsupported_schema_uri(schema_json) =>
            {
                assert!(
                    matches!(
                        error,
                        AstError::Schema(
                            SchemaError::UnsupportedSchemaDialect {
                                ref pointer,
                                expected_uri: JSON_SCHEMA_DRAFT_2020_12,
                                ..
                            }
                        ) if pointer == "#/$schema"
                    ),
                    "unexpected unsupported-$schema error for {rel_str} schema #{idx}: {error}"
                );
                continue;
            }
            Err(
                error @ (AstError::UnsupportedReference { .. }
                | AstError::UnresolvedReference { .. }),
            ) if !validate_fixture_tests => {
                assert!(
                    !validate_fixture_tests,
                    "schema #{idx} in {rel_str} failed with an expected resolver error: {error}"
                );
                continue;
            }
            Err(error) => return Err(error.into()),
        };

        let root = match schema.root() {
            Ok(root) => root,
            Err(
                error @ (AstError::UnsupportedReference { .. }
                | AstError::UnresolvedReference { .. }),
            ) if !validate_fixture_tests => {
                assert!(
                    !validate_fixture_tests,
                    "schema #{idx} in {rel_str} failed with an expected resolver error: {error}"
                );
                continue;
            }
            Err(error) => return Err(error.into()),
        };

        if matches!(root.kind(), SchemaNodeKind::BoolSchema(false))
            && !fixture_schema
                .tests
                .iter()
                .any(|fixture_test| fixture_test.valid)
        {
            continue;
        }

        let generation_config = GenerationConfig::new(6);
        let evaluator_should_be_exact =
            internal_evaluator_should_be_exact(root, schema.canonical_schema_json()?);
        let canonical_validator = compile(schema.canonical_schema_json()?)?;

        if validate_fixture_tests {
            for fixture_test in &fixture_schema.tests {
                let raw_valid = schema.is_valid(&fixture_test.data)?;
                let canonicalized_valid = canonical_validator.is_valid(&fixture_test.data);
                assert_eq!(
                    raw_valid,
                    canonicalized_valid,
                    "{} schema #{idx} ({}) fixture test {:?} validates differently after canonicalization\n\nRaw schema:\n{}\n\nCanonicalized schema:\n{}\n\nInstance:\n{}",
                    rel_str,
                    fixture_schema.description,
                    fixture_test.description,
                    serde_json::to_string_pretty(schema_json)?,
                    serde_json::to_string_pretty(schema.canonical_schema_json()?)?,
                    serde_json::to_string_pretty(&fixture_test.data)?,
                );
                assert_eq!(
                    raw_valid,
                    fixture_test.valid,
                    "{} schema #{idx} ({}) fixture test {:?} returned the wrong validation result\n\nSchema:\n{}\n\nInstance:\n{}",
                    rel_str,
                    fixture_schema.description,
                    fixture_test.description,
                    serde_json::to_string_pretty(schema_json)?,
                    serde_json::to_string_pretty(&fixture_test.data)?,
                );
                if evaluator_should_be_exact {
                    assert_eq!(
                        root.accepts_value(&fixture_test.data),
                        canonicalized_valid,
                        "{} schema #{idx} ({}) fixture test {:?} is handled differently by the internal evaluator\n\nCanonicalized schema:\n{}\n\nInstance:\n{}",
                        rel_str,
                        fixture_schema.description,
                        fixture_test.description,
                        serde_json::to_string_pretty(schema.canonical_schema_json()?)?,
                        serde_json::to_string_pretty(&fixture_test.data)?,
                    );
                }
            }
        }

        let mut success = true;
        for _ in 0..N_ITERATIONS {
            let candidate = match ValueGenerator::generate(&schema, generation_config, &mut rng) {
                Ok(candidate) => candidate,
                Err(GenerateError::ExhaustedAttempts { .. }) => {
                    if !allowed.map(|set| set.contains(&idx)).unwrap_or(false) {
                        panic!(
                            "{}",
                            &format!(
                                "Failed to generate a valid instance for schema #{idx} in {}\n\nSchema:\n{}",
                                rel_str,
                                serde_json::to_string_pretty(schema_json)?,
                            )
                        );
                    }
                    success = false;
                    break;
                }
                Err(GenerateError::Schema(error)) => return Err(error.into()),
                Err(error) => return Err(error.into()),
            };

            let raw_valid = schema.is_valid(&candidate)?;
            let canonicalized_valid = canonical_validator.is_valid(&candidate);
            assert_eq!(
                raw_valid,
                canonicalized_valid,
                "{} schema #{idx} generated candidate validates differently after canonicalization\n\nRaw schema:\n{}\n\nCanonicalized schema:\n{}\n\nInstance:\n{}",
                rel_str,
                serde_json::to_string_pretty(schema_json)?,
                serde_json::to_string_pretty(schema.canonical_schema_json()?)?,
                serde_json::to_string_pretty(&candidate)?,
            );
            assert!(
                raw_valid,
                "generator returned a value rejected by the raw schema for {rel_str} schema #{idx}: {}",
                serde_json::to_string_pretty(&candidate)?,
            );
            if evaluator_should_be_exact {
                assert_eq!(
                    root.accepts_value(&candidate),
                    canonicalized_valid,
                    "{rel_str} schema #{idx} generated candidate is handled differently by the internal evaluator\n\nCanonicalized schema:\n{}\n\nInstance:\n{}",
                    serde_json::to_string_pretty(schema.canonical_schema_json()?)?,
                    serde_json::to_string_pretty(&candidate)?,
                );
            }
        }

        match (success, is_whitelisted) {
            (true, false) => { /* success as expected */ }
            (true, true) => {
                // This schema was previously whitelisted but now passes – flag it.
                panic!(
                    "Whitelisted failure now passes; please remove entry for schema #{idx} in {rel_str}"
                );
            }
            (false, true) => {
                // Allowed failure – proceed.
            }
            (false, false) => {
                panic!("Should have panicked above, but didn't: schema #{idx} in {rel_str}");
            }
        }
    }

    Ok(())
}

#[derive(Debug)]
struct FixtureSchema {
    description: String,
    schema: Value,
    tests: Vec<FixtureTest>,
}

#[derive(Debug)]
struct FixtureTest {
    description: String,
    data: Value,
    valid: bool,
}

fn collect_fixture_schemas(root: &Value) -> Vec<FixtureSchema> {
    match root {
        Value::Array(groups) => groups
            .iter()
            .enumerate()
            .filter_map(|(index, item)| {
                let schema = item.get("schema")?.clone();
                let description = item
                    .get("description")
                    .and_then(Value::as_str)
                    .map(str::to_owned)
                    .unwrap_or_else(|| format!("schema #{index}"));
                let tests = item
                    .get("tests")
                    .and_then(Value::as_array)
                    .map(|tests| {
                        tests
                            .iter()
                            .enumerate()
                            .filter_map(|(test_index, test)| {
                                Some(FixtureTest {
                                    description: test
                                        .get("description")
                                        .and_then(Value::as_str)
                                        .map(str::to_owned)
                                        .unwrap_or_else(|| format!("test #{test_index}")),
                                    data: test.get("data")?.clone(),
                                    valid: test.get("valid")?.as_bool()?,
                                })
                            })
                            .collect()
                    })
                    .unwrap_or_default();
                Some(FixtureSchema {
                    description,
                    schema,
                    tests,
                })
            })
            .collect(),
        schema => vec![FixtureSchema {
            description: "root schema".to_owned(),
            schema: schema.clone(),
            tests: Vec::new(),
        }],
    }
}

fn schema_declares_unsupported_schema_uri(schema: &Value) -> bool {
    match schema {
        Value::Object(object) => {
            if let Some(schema_uri) = object.get("$schema")
                && !matches!(
                    schema_uri.as_str(),
                    Some(JSON_SCHEMA_DRAFT_2020_12 | JSON_SCHEMA_DRAFT_2020_12_WITH_FRAGMENT)
                )
            {
                return true;
            }
            object.values().any(schema_declares_unsupported_schema_uri)
        }
        Value::Array(items) => items.iter().any(schema_declares_unsupported_schema_uri),
        _ => false,
    }
}

fn internal_evaluator_should_be_exact(schema: &SchemaNode, canonical_schema: &Value) -> bool {
    canonical_keywords_are_supported_by_internal_evaluator(canonical_schema)
        && schema_is_supported_by_internal_evaluator(schema, &mut HashSet::new())
}

fn canonical_keywords_are_supported_by_internal_evaluator(schema: &Value) -> bool {
    let Value::Object(object) = schema else {
        return true;
    };

    if object.contains_key("unevaluatedItems")
        || object.contains_key("unevaluatedProperties")
        || object.contains_key("dependentSchemas")
    {
        return false;
    }

    object.values().all(|value| match value {
        Value::Array(values) => values
            .iter()
            .all(canonical_keywords_are_supported_by_internal_evaluator),
        Value::Object(_) => canonical_keywords_are_supported_by_internal_evaluator(value),
        _ => true,
    })
}

fn schema_is_supported_by_internal_evaluator(
    schema: &SchemaNode,
    seen: &mut HashSet<NodeId>,
) -> bool {
    if !seen.insert(schema.id()) {
        return true;
    }

    use SchemaNodeKind::*;

    match schema.kind() {
        BoolSchema(_) | Any | Boolean { .. } | Null { .. } | Const(_) | Enum(_) => true,
        String {
            pattern, format, ..
        } => {
            format.is_none()
                && pattern
                    .as_ref()
                    .is_none_or(|pattern| pattern.support() == PatternSupport::Supported)
        }
        Number { .. } | Integer { .. } => true,
        Object {
            properties,
            pattern_properties,
            additional,
            property_names,
            ..
        } => {
            properties
                .values()
                .all(|schema| schema_is_supported_by_internal_evaluator(schema, seen))
                && pattern_properties.values().all(|pattern_property| {
                    pattern_property.pattern.support() == PatternSupport::Supported
                        && schema_is_supported_by_internal_evaluator(&pattern_property.schema, seen)
                })
                && schema_is_supported_by_internal_evaluator(additional, seen)
                && schema_is_supported_by_internal_evaluator(property_names, seen)
        }
        Array {
            prefix_items,
            items,
            contains,
            ..
        } => {
            prefix_items
                .iter()
                .all(|schema| schema_is_supported_by_internal_evaluator(schema, seen))
                && schema_is_supported_by_internal_evaluator(items, seen)
                && contains.as_ref().is_none_or(|contains| {
                    schema_is_supported_by_internal_evaluator(&contains.schema, seen)
                })
        }
        AllOf(children) | AnyOf(children) | OneOf(children) => children
            .iter()
            .all(|schema| schema_is_supported_by_internal_evaluator(schema, seen)),
        Not(schema) => schema_is_supported_by_internal_evaluator(schema, seen),
        IfThenElse {
            if_schema,
            then_schema,
            else_schema,
        } => {
            schema_is_supported_by_internal_evaluator(if_schema, seen)
                && then_schema
                    .as_ref()
                    .is_none_or(|schema| schema_is_supported_by_internal_evaluator(schema, seen))
                && else_schema
                    .as_ref()
                    .is_none_or(|schema| schema_is_supported_by_internal_evaluator(schema, seen))
        }
        _ => false,
    }
}