fastxml 0.10.0

A fast, memory-efficient XML library with XPath and XSD validation support
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

//! Identity constraints, type mismatch, and namespace violation tests.

mod common;

use fastxml::schema::Schema;
use fastxml::schema::xsd::constraints::{
    ConstraintError, ConstraintValidator, IdentityConstraint, KeyValue,
};

// =============================================================================
// Identity Constraint Tests
// =============================================================================

#[test]
fn test_unique_duplicate_key() {
    let mut validator = ConstraintValidator::new();
    validator.register_key("uniqueId", 1);

    // Add first key
    let result = validator.add_key_value(
        &IdentityConstraint::unique("uniqueId", "."),
        KeyValue::single("key1"),
    );
    assert!(result.is_ok());

    // Add duplicate
    let result = validator.add_key_value(
        &IdentityConstraint::unique("uniqueId", "."),
        KeyValue::single("key1"),
    );
    assert!(
        matches!(&result, Err(ConstraintError::DuplicateKey { constraint, .. }) if constraint == "uniqueId"),
        "Expected DuplicateKey error, got: {:?}",
        result
    );
}

#[test]
fn test_key_null_value() {
    let mut validator = ConstraintValidator::new();
    validator.register_key("keyId", 1);

    // Key cannot have null values per XSD spec, but implementation is lenient
    let constraint = IdentityConstraint::key("keyId", ".");
    let result = validator.add_key_value(&constraint, KeyValue::new(vec![]));
    // Current implementation accepts empty key values
    assert!(
        result.is_ok(),
        "Implementation is lenient with empty key values"
    );
}

#[test]
fn test_composite_key() {
    let mut validator = ConstraintValidator::new();
    validator.register_key("compositeKey", 2);

    let constraint = IdentityConstraint::key("compositeKey", ".");

    // Add composite key
    let result = validator.add_key_value(&constraint, KeyValue::new(vec!["a".into(), "1".into()]));
    assert!(result.is_ok());

    // Different composite key
    let result = validator.add_key_value(&constraint, KeyValue::new(vec!["a".into(), "2".into()]));
    assert!(result.is_ok());

    // Duplicate composite key
    let result = validator.add_key_value(&constraint, KeyValue::new(vec!["a".into(), "1".into()]));
    assert!(
        matches!(&result, Err(ConstraintError::DuplicateKey { constraint, .. }) if constraint == "compositeKey"),
        "Expected DuplicateKey error for composite key, got: {:?}",
        result
    );
}

#[test]
fn test_keyref_validation() {
    let mut validator = ConstraintValidator::new();

    // Register key constraint
    validator.register_key("personId", 1);
    let key_constraint = IdentityConstraint::key("personId", ".");
    validator
        .add_key_value(&key_constraint, KeyValue::single("p1"))
        .unwrap();
    validator
        .add_key_value(&key_constraint, KeyValue::single("p2"))
        .unwrap();

    // Add keyref values
    let keyref_constraint = IdentityConstraint::keyref("personRef", ".", "personId");
    validator.add_keyref_value(&keyref_constraint, KeyValue::single("p1"));
    validator.add_keyref_value(&keyref_constraint, KeyValue::single("p3")); // Invalid reference

    let result = validator.validate_keyrefs();
    assert!(
        matches!(&result, Err(errors) if !errors.is_empty() && errors.iter().any(|e| matches!(e, ConstraintError::KeyRefNotFound { constraint, .. } if constraint == "personRef"))),
        "Expected KeyRefNotFound error, got: {:?}",
        result
    );
}

// =============================================================================
// Type Mismatch Tests
// =============================================================================

#[test]
fn test_integer_type_with_string() {
    // Create a schema with integer element
    let xsd = r#"<?xml version="1.0" encoding="UTF-8"?>
        <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
            <xs:element name="count" type="xs:integer"/>
        </xs:schema>"#;

    let schema = Schema::from_xsd(xsd.as_bytes()).unwrap();
    assert!(schema.elements.contains_key("count"));
}

#[test]
fn test_date_type_invalid_format() {
    // xs:date requires YYYY-MM-DD format
    let xsd = r#"<?xml version="1.0" encoding="UTF-8"?>
        <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
            <xs:element name="birthday" type="xs:date"/>
        </xs:schema>"#;

    let schema = Schema::from_xsd(xsd.as_bytes()).unwrap();
    assert!(schema.elements.contains_key("birthday"));
    // Validation of "invalid-date" against xs:date would fail
}

#[test]
fn test_boolean_type_invalid_value() {
    // xs:boolean only allows true, false, 1, 0
    let xsd = r#"<?xml version="1.0" encoding="UTF-8"?>
        <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
            <xs:element name="flag" type="xs:boolean"/>
        </xs:schema>"#;

    let schema = Schema::from_xsd(xsd.as_bytes()).unwrap();
    assert!(schema.elements.contains_key("flag"));
    // Validation of "yes" against xs:boolean would fail
}

#[test]
fn test_decimal_type_precision() {
    let xsd = r#"<?xml version="1.0" encoding="UTF-8"?>
        <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
            <xs:simpleType name="Price">
                <xs:restriction base="xs:decimal">
                    <xs:totalDigits value="10"/>
                    <xs:fractionDigits value="2"/>
                </xs:restriction>
            </xs:simpleType>
        </xs:schema>"#;

    let schema = Schema::from_xsd(xsd.as_bytes()).unwrap();
    assert!(schema.types.contains_key("Price"));
}

// =============================================================================
// Namespace Violation Tests
// =============================================================================

#[test]
fn test_wrong_namespace() {
    let xsd = r#"<?xml version="1.0" encoding="UTF-8"?>
        <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
                   targetNamespace="http://example.com/correct"
                   elementFormDefault="qualified">
            <xs:element name="item" type="xs:string"/>
        </xs:schema>"#;

    let schema = Schema::from_xsd(xsd.as_bytes()).unwrap();
    assert_eq!(
        schema.target_namespace,
        Some("http://example.com/correct".to_string())
    );
}

#[test]
fn test_missing_namespace_declaration() {
    // Using prefix without declaration
    let xsd = r#"<?xml version="1.0" encoding="UTF-8"?>
        <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
            <xs:element name="item" type="custom:Type"/>
        </xs:schema>"#;

    let result = Schema::from_xsd(xsd.as_bytes());
    // A QName with an undeclared prefix cannot denote any component; the
    // reference-integrity pass rejects the schema at compile time.
    assert!(
        result.is_err(),
        "undeclared prefix in a type reference must be rejected"
    );
}

// =============================================================================
// Per-scope uniqueness (streaming/DOM parity)
// =============================================================================

/// A `unique` (or `key`) constraint is scoped to the element instance that
/// declares it. The same field value may legally repeat under *sibling*
/// scoping elements. The streaming engine previously tracked uniqueness in a
/// single table keyed by constraint name, so a value appearing once in each
/// sibling scope was falsely reported as a duplicate (the DOM engine scoped
/// correctly). Both engines must accept this document. Regression for the
/// W3C `uniqueTestName` (introspection test-set) cluster.
#[test]
fn unique_is_scoped_per_declaring_element_instance() {
    use std::sync::Arc;
    const SCHEMA: &[u8] = br#"<?xml version="1.0"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="root">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="group" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="group">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="item" maxOccurs="unbounded">
          <xs:complexType>
            <xs:attribute name="name" type="xs:string"/>
          </xs:complexType>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
    <xs:unique name="uniqueItemName">
      <xs:selector xpath="item"/>
      <xs:field xpath="@name"/>
    </xs:unique>
  </xs:element>
</xs:schema>"#;
    // "a" and "b" repeat across the two groups (legal), unique within each.
    const VALID: &str = r#"<root>
  <group><item name="a"/><item name="b"/></group>
  <group><item name="a"/><item name="b"/></group>
</root>"#;
    // "a" repeats *within* the first group (illegal).
    const INVALID: &str = r#"<root>
  <group><item name="a"/><item name="a"/></group>
  <group><item name="b"/></group>
</root>"#;

    let schema = Arc::new(Schema::from_xsd(SCHEMA).expect("schema"));

    for (xml, want_valid) in [(VALID, true), (INVALID, false)] {
        let doc = fastxml::Parser::from(xml).parse().expect("parse");
        let dom = fastxml::schema::Validator::from(&doc)
            .schema(Arc::clone(&schema))
            .run()
            .expect("dom")
            .into_entries()
            .is_empty();
        let stream = fastxml::schema::Validator::from(xml.as_bytes())
            .schema(Arc::clone(&schema))
            .run()
            .expect("stream")
            .into_entries()
            .is_empty();
        assert_eq!(dom, want_valid, "DOM verdict wrong for: {xml}");
        assert_eq!(stream, want_valid, "streaming verdict wrong for: {xml}");
    }
}