qubit-metadata 0.7.2

Type-safe metadata model with schemas and composable filters
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

// =============================================================================
//    Copyright (c) 2025 - 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Tests for [`qubit_metadata::MetadataValidationError`].

#![cfg(feature = "schema")]

use std::fmt::Write;

use qubit_datatype::DataType;
use qubit_metadata::MetadataError;
use qubit_metadata::MetadataValidationError;
use support::counting_writer::CountingWriter;

mod support;

#[test]
fn test_validation_error_exposes_collected_issues() {
    let issues = vec![
        MetadataError::MissingRequiredField {
            key: "id".to_string(),
            expected: DataType::String,
        },
        MetadataError::UnknownField {
            key: "extra".to_string(),
        },
    ];

    let error = MetadataValidationError::from_issues(issues.clone()).unwrap();

    assert_eq!(error.issues(), issues.as_slice());
    assert_eq!(error.len(), 2);
    assert_eq!(
        error.to_string(),
        "2 metadata validation issue(s): [MissingRequiredField { key: \"id\", expected: String }, UnknownField { key: \"extra\" }]"
    );
    assert!(std::error::Error::source(&error).is_none());
    assert_eq!(error.into_issues(), issues);
    assert!(MetadataValidationError::from_issues(Vec::new()).is_none());
}

#[test]
fn test_validation_error_can_wrap_single_issue() {
    let issue = MetadataError::UnknownFilterField {
        key: "missing".to_string(),
    };

    let error = MetadataValidationError::from_issue(issue.clone());

    assert_eq!(error.issues(), std::slice::from_ref(&issue));
    assert_eq!(error.len(), 1);
    assert_eq!(error.into_issues(), vec![issue]);
    assert_eq!(
        MetadataValidationError::from_issue(MetadataError::UnknownFilterField {
            key: "missing".to_string(),
        })
        .to_string(),
        "1 metadata validation issue(s): [UnknownFilterField { key: \"missing\" }]"
    );
}

#[test]
fn test_validation_error_display_streams_formatter_writes() {
    let error = MetadataValidationError::from_issue(MetadataError::UnknownField {
        key: "extra".to_string(),
    });
    let mut writer = CountingWriter::new(None);

    write!(&mut writer, "{error}").unwrap();

    assert!(writer.write_count() > 1);
}

#[test]
fn test_validation_error_display_propagates_formatter_errors() {
    let error = MetadataValidationError::from_issue(MetadataError::UnknownField {
        key: "extra".to_string(),
    });
    let mut writer = CountingWriter::new(Some(2));

    assert!(write!(&mut writer, "{error}").is_err());
}

#[test]
fn test_validation_diagnostics_have_a_cumulative_bound() {
    let issue = MetadataError::UnknownField { key: "x".repeat(256) };
    let error = MetadataValidationError::from_issues(vec![issue; 32_640]).unwrap();
    for text in [error.to_string(), format!("{error:?}")] {
        assert!(
            text.len() < 16_384,
            "aggregate diagnostic exceeded its budget: {}",
            text.len()
        );
        assert!(text.contains("incomplete"), "truncation must be explicit");
    }
    assert_eq!(error.issues().len(), 32_640);
}

#[test]
fn test_validation_diagnostics_bound_one_large_issue() {
    let error = MetadataValidationError::from_issue(MetadataError::UnknownField {
        key: "secret\n".repeat(100_000),
    });
    assert!(error.to_string().len() < 16_384);
    assert!(format!("{error:?}").contains("incomplete"));
    assert_eq!(error.issues().len(), 1);
}

#[test]
fn test_validation_diagnostics_share_the_callers_collection_budget() {
    let error = MetadataValidationError::from_issues(vec![
        MetadataError::UnknownField {
            key: "example".to_owned()
        };
        10
    ])
    .unwrap();
    let policy = qubit_redact::RedactionPolicy::builder()
        .limits(|limits| {
            limits.max_collection_items(1);
        })
        .unwrap()
        .build()
        .unwrap();
    let output = qubit_redact::Redactor::new(policy).redact_text(&error);
    assert!(output.text_or_marker("incomplete").contains("incomplete"));
    assert_eq!(error.into_issues().len(), 10);
}