anyxml 0.9.0

A fully spec-conformant XML library
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
426
427
use std::{
    cell::{Cell, RefCell},
    fmt::Write as _,
    fs::read_dir,
    path::Path,
    sync::Arc,
};

use anyxml::{
    error::{XMLErrorDomain, XMLErrorLevel},
    sax::{
        Locator,
        attributes::Attributes,
        handler::{DebugHandler, EntityResolver, ErrorHandler, SAXHandler},
        parser::{ParserOption, XMLReaderBuilder},
    },
    uri::URIString,
};

#[derive(Default)]
struct TestSAXHandler {
    warning: Cell<usize>,
    error: Cell<usize>,
    fatal_error: Cell<usize>,
    ns_error: Cell<usize>,
    validity_error: Cell<usize>,
    buffer: RefCell<String>,
}

impl TestSAXHandler {
    fn new() -> Self {
        Self {
            warning: Cell::new(0),
            error: Cell::new(0),
            fatal_error: Cell::new(0),
            ns_error: Cell::new(0),
            validity_error: Cell::new(0),
            buffer: RefCell::new(String::new()),
        }
    }

    fn reset(&self) {
        self.warning.update(|_| 0);
        self.error.update(|_| 0);
        self.fatal_error.update(|_| 0);
        self.ns_error.update(|_| 0);
        self.validity_error.update(|_| 0);
        self.buffer.borrow_mut().clear();
    }
}

impl EntityResolver for TestSAXHandler {}
impl ErrorHandler for TestSAXHandler {
    fn fatal_error(&mut self, error: anyxml::sax::error::SAXParseError) {
        assert_eq!(error.level, XMLErrorLevel::FatalError);
        self.fatal_error.update(|c| c + 1);
        writeln!(self.buffer.borrow_mut(), "{}", error).ok();
    }

    fn error(&mut self, error: anyxml::sax::error::SAXParseError) {
        assert_eq!(error.level, XMLErrorLevel::Error);
        match error.domain {
            XMLErrorDomain::Parser => self.error.update(|c| c + 1),
            XMLErrorDomain::Namespace => self.ns_error.update(|c| c + 1),
            XMLErrorDomain::DTDValid => self.validity_error.update(|c| c + 1),
            XMLErrorDomain::RngParser | XMLErrorDomain::XInclude => self.error.update(|c| c + 1),
        }
        writeln!(self.buffer.borrow_mut(), "{}", error).ok();
    }

    fn warning(&mut self, error: anyxml::sax::error::SAXParseError) {
        assert_eq!(error.level, XMLErrorLevel::Warning);
        self.warning.update(|c| c + 1);
        writeln!(self.buffer.borrow_mut(), "{}", error).ok();
    }
}
impl SAXHandler for TestSAXHandler {}

#[test]
fn well_formed_tests() {
    let handler = DebugHandler {
        child: TestSAXHandler::new(),
        buffer: String::new(),
    };

    let mut reader = XMLReaderBuilder::new().set_handler(handler).build();

    for ent in read_dir("resources/well-formed").unwrap() {
        if let Ok(ent) = ent
            && ent.metadata().unwrap().is_file()
        {
            let path = ent.path();
            let uri = URIString::parse_file_path(path.canonicalize().unwrap()).unwrap();
            reader.parse_uri(&uri, None).ok();
            assert_eq!(
                reader.handler.child.fatal_error.get(),
                0,
                "uri: {}\nerrors:\n{}",
                uri.as_escaped_str(),
                reader.handler.child.buffer.borrow(),
            );

            let outname = path.file_name().unwrap().to_str().unwrap();
            let outname = format!("resources/well-formed/output/{outname}.sax");
            let outname = Path::new(outname.as_str());
            let output = std::fs::read_to_string(outname).unwrap();

            assert_eq!(
                output,
                reader.handler.buffer,
                "uri: {}\n{}",
                uri.as_escaped_str(),
                reader.handler.buffer,
            );

            reader.handler.buffer.clear();
            reader.handler.child.reset();
        }
    }
}

#[test]
fn progressive_well_formed_tests() {
    let handler = DebugHandler {
        child: TestSAXHandler::new(),
        buffer: String::new(),
    };

    let mut reader = XMLReaderBuilder::new()
        .set_handler(handler)
        .progressive_parser()
        .build();

    for ent in read_dir("resources/well-formed").unwrap() {
        if let Ok(ent) = ent
            && ent.metadata().unwrap().is_file()
        {
            let path = ent.path();
            let buffer = std::fs::read(&path).unwrap();
            let uri = URIString::parse_file_path(path.canonicalize().unwrap()).unwrap();
            reader.set_default_base_uri(uri.as_ref()).unwrap();
            reader.reset().unwrap();
            for b in buffer {
                reader.parse_chunk([b], false).unwrap();
            }
            reader.parse_chunk([], true).unwrap();
            assert_eq!(
                reader.handler.child.fatal_error.get(),
                0,
                "uri: {}\nerrors:\n{}",
                uri.as_escaped_str(),
                reader.handler.child.buffer.borrow(),
            );

            let outname = path.file_name().unwrap().to_str().unwrap();
            let outname = format!("resources/well-formed/output/{outname}.sax");
            let outname = Path::new(outname.as_str());
            let output = std::fs::read_to_string(outname).unwrap();

            assert_eq!(
                output,
                reader.handler.buffer,
                "\nuri: {}\n{}",
                uri.as_escaped_str(),
                reader.handler.buffer,
            );

            reader.handler.buffer.clear();
            reader.handler.child.reset();
        }
    }
}

// Some tests require unsupported encodings or their types do not match the actual
// error that occurs, making it difficult to pass all of them, so they are skipped.
const SKIP_TESTS: &[&str] = &[
    "pr-xml-euc-jp",               // unsupported encoding
    "pr-xml-iso-2022-jp",          // unsupported encoding
    "pr-xml-shift_jis",            // unsupported encoding
    "weekly-euc-jp",               // unsupported encoding
    "weekly-iso-2022-jp",          // unsupported encoding
    "weekly-shift_jis",            // unsupported encoding
    "ibm-not-wf-P69-ibm69n05.xml", // error type, but requires VC validation
    "invalid-bo-7",                // error type, but a Fatal Error occurs (Illegal XML character)
    "invalid-bo-8",                // error type, but a Fatal Error occurs (Illegal XML character)
    "invalid-bo-9",                // error type, but a Fatal Error occurs (Illegal XML character)
];

#[derive(Default)]
struct XMLConfWalker {
    log: RefCell<String>,
    locator: RefCell<Option<Arc<Locator>>>,
    unexpected_failure: Cell<usize>,
    unexpected_success: Cell<usize>,
    progressive: bool,
}

impl XMLConfWalker {}

impl SAXHandler for XMLConfWalker {
    fn set_document_locator(&mut self, locator: Arc<Locator>) {
        *self.locator.borrow_mut() = Some(locator);
    }

    fn start_element(
        &mut self,
        _uri: Option<&str>,
        _local_name: Option<&str>,
        qname: &str,
        atts: &Attributes,
    ) {
        match qname {
            "TESTSUITE" => {
                for att in atts.iter() {
                    if att.qname.as_ref() == "PROFILE" {
                        writeln!(
                            self.log.borrow_mut(),
                            "=== Start Test Suite '{}' ===",
                            att.value
                        )
                        .ok();
                    }
                }
            }
            "TESTCASES" => {
                for att in atts.iter() {
                    if att.qname.as_ref() == "PROFILE" {
                        writeln!(
                            self.log.borrow_mut(),
                            "--- Start Test Case '{}' in '{}' ---",
                            att.value,
                            self.locator
                                .borrow()
                                .as_ref()
                                .unwrap()
                                .system_id()
                                .as_escaped_str()
                        )
                        .ok();
                    }
                }
            }
            "TEST" => {
                let mut id = String::new();
                let mut r#type = String::new();
                let mut uri = String::new();
                let mut recommendation = String::new();
                let mut edition = String::new();
                let mut entities = String::new();
                for att in atts.iter() {
                    match att.qname.as_ref() {
                        "TYPE" => r#type = att.value.to_string(),
                        "ID" => id = att.value.to_string(),
                        "URI" => uri = att.value.to_string(),
                        "RECOMMENDATION" => recommendation = att.value.to_string(),
                        "EDITION" => edition = att.value.to_string(),
                        "ENTITIES" => entities = att.value.to_string(),
                        _ => {}
                    }
                }
                if SKIP_TESTS.contains(&id.as_str()) {
                    // skip
                    return;
                }
                if recommendation == "XML1.1" || recommendation == "NS1.1" {
                    // skip
                    // writeln!(self.log.borrow_mut(), "{id}: {recommendation} is not supported").ok();
                    return;
                }
                if !edition.is_empty() {
                    let editions = edition
                        .split_ascii_whitespace()
                        .map(|e| e.trim())
                        .collect::<Vec<_>>();
                    if !editions.contains(&"5") {
                        // skip
                        // writeln!(self.log.borrow_mut(), "{id}: skip because this is version specific test for version '{edition}'.").ok();
                        return;
                    }
                }

                let uri = self
                    .locator
                    .borrow()
                    .as_ref()
                    .unwrap()
                    .system_id()
                    .resolve(&URIString::parse(uri).unwrap());

                let mut reader = XMLReaderBuilder::new().set_handler(DebugHandler {
                    child: TestSAXHandler::new(),
                    buffer: String::new(),
                });
                if entities != "none" || matches!(r#type.as_ref(), "valid" | "invalid") {
                    reader = reader.enable_option(ParserOption::Validation)
                }
                let handler = if !self.progressive {
                    let mut reader = reader.build();
                    reader.parse_uri(uri, None).ok();
                    reader.handler.child
                } else {
                    let data = std::fs::read(uri.path()).unwrap();
                    let mut reader = reader
                        .set_default_base_uri(uri)
                        .unwrap()
                        .progressive_parser()
                        .build();
                    for b in data {
                        reader.parse_chunk([b], false).ok();
                    }
                    reader.parse_chunk([], true).ok();
                    reader.handler.child
                };
                match r#type.as_str() {
                    "not-wf" => {
                        if handler.fatal_error.get() > 0
                            || (recommendation.starts_with("NS1.0") && handler.ns_error.get() > 0)
                        {
                            // ok
                        } else {
                            self.unexpected_success.update(|c| c + 1);
                            writeln!(self.log.borrow_mut(), "{id}: unexpected success").ok();
                            writeln!(self.log.borrow_mut(), "{}", handler.buffer.borrow()).ok();
                        }
                    }
                    "error" => {
                        if (handler.error.get() == 0
                            && handler.validity_error.get() == 0
                            && handler.ns_error.get() == 0)
                            || handler.fatal_error.get() > 0
                        {
                            self.unexpected_success.update(|c| c + 1);
                            writeln!(self.log.borrow_mut(), "{id}: unexpected success").ok();
                            writeln!(self.log.borrow_mut(), "{}", handler.buffer.borrow()).ok();
                        }
                    }
                    "valid" => {
                        if handler.validity_error.get() > 0 {
                            self.unexpected_failure.update(|c| c + 1);
                            writeln!(self.log.borrow_mut(), "{id}: unexpected failure").ok();
                            writeln!(self.log.borrow_mut(), "{}", handler.buffer.borrow()).ok();
                        }
                    }
                    "invalid" => {
                        if handler.validity_error.get() == 0 {
                            self.unexpected_success.update(|c| c + 1);
                            writeln!(self.log.borrow_mut(), "{id}: unexpected success").ok();
                            writeln!(self.log.borrow_mut(), "{}", handler.buffer.borrow()).ok();
                        }
                    }
                    r#type => {
                        writeln!(
                            self.log.borrow_mut(),
                            "{id}: test type '{}' is unknown.",
                            r#type
                        )
                        .ok();
                    }
                }
            }
            _ => {}
        }
    }
}
impl EntityResolver for XMLConfWalker {}
impl ErrorHandler for XMLConfWalker {}

#[test]
fn xmlconf_tests() {
    const XMLCONF_DIR: &str = concat!(env!("CARGO_MANIFEST_DIR"), "/resources/xmlconf");
    assert!(
        std::fs::exists(XMLCONF_DIR).unwrap_or(false),
        "Please execute `deno run -A resources/get-xmlconf.ts` on the crate root."
    );

    let xmlconf = URIString::parse_file_path(format!("{XMLCONF_DIR}/xmlconf.xml")).unwrap();
    let mut reader = XMLReaderBuilder::new()
        .set_handler(XMLConfWalker::default())
        .enable_option(ParserOption::ExternalGeneralEntities)
        .build();
    reader.parse_uri(xmlconf, None).unwrap();

    let handler = reader.take_handler();
    assert!(
        handler.unexpected_success.get() == 0 && handler.unexpected_failure.get() == 0,
        "{}\n=== Unexpected Success: {}, Unexpected Failure: {} ===\n",
        handler.log.borrow(),
        handler.unexpected_success.get(),
        handler.unexpected_failure.get(),
    );
}

#[test]
fn progressive_xmlconf_tests() {
    const XMLCONF_DIR: &str = concat!(env!("CARGO_MANIFEST_DIR"), "/resources/xmlconf");
    assert!(
        std::fs::exists(XMLCONF_DIR).unwrap_or(false),
        "Please execute `deno run -A resources/get-xmlconf.ts` on the crate root."
    );

    let path = format!("{XMLCONF_DIR}/xmlconf.xml");
    let handler = XMLConfWalker {
        progressive: true,
        ..Default::default()
    };
    let xmlconf = URIString::parse_file_path(path.as_str()).unwrap();
    let mut reader = XMLReaderBuilder::new()
        .set_handler(handler)
        .enable_option(ParserOption::ExternalGeneralEntities)
        .set_default_base_uri(xmlconf)
        .unwrap()
        .progressive_parser()
        .build();
    for chunk in std::fs::read_to_string(path).unwrap().bytes() {
        reader.parse_chunk([chunk], false).unwrap();
    }
    reader.parse_chunk([], true).unwrap();

    let handler = reader.take_handler();
    assert!(
        handler.unexpected_success.get() == 0 && handler.unexpected_failure.get() == 0,
        "{}\n=== Unexpected Success: {}, Unexpected Failure: {} ===\n",
        handler.log.borrow(),
        handler.unexpected_success.get(),
        handler.unexpected_failure.get(),
    );
}