Debian Codegraph @

modules/lsp-runtime-lib/src/test/utest/fmt/xml/pullparser.cpp

raw
1 /*
2 * Copyright (C) 2020 Linux Studio Plugins Project <https://lsp-plug.in/>
3 * (C) 2020 Vladimir Sadovnikov <[email protected]>
4 *
5 * This file is part of lsp-runtime-lib
6 * Created on: 28 окт. 2019 г.
7 *
8 * lsp-runtime-lib is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU Lesser General Public License as published by
10 * the Free Software Foundation, either version 3 of the License, or
11 * any later version.
12 *
13 * lsp-runtime-lib is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU Lesser General Public License for more details.
17 *
18 * You should have received a copy of the GNU Lesser General Public License
19 * along with lsp-runtime-lib. If not, see <https://www.gnu.org/licenses/>.
20 */
21
22 #include <lsp-plug.in/test-fw/utest.h>
23 #include <lsp-plug.in/test-fw/helpers.h>
24 #include <lsp-plug.in/fmt/xml/PullParser.h>
25 #include <lsp-plug.in/stdlib/math.h>
26
27 namespace lsp
28 {
29 using namespace lsp::xml;
30 }
31
32 UTEST_BEGIN("runtime.fmt.xml", pullparser)
33
34 void check_document_start(PullParser &p, xml_version_t xversion, const char *version, const char *encoding, bool standalone)
35 {
36 printf(" START_DOCUMENT: xml_version=%d, version=%s, encoding=%s, standalone=%s\n",
37 int(xversion), version, encoding, (standalone) ? "yes" : "no");
38
39 status_t token = p.read_next();
40 UTEST_ASSERT(token == XT_START_DOCUMENT);
41 UTEST_ASSERT(p.xml_version() == xversion);
42 UTEST_ASSERT((version == NULL) ? (p.version() == NULL) : p.version()->equals_ascii(version));
43 UTEST_ASSERT((encoding == NULL) ? (p.encoding() == NULL) : p.encoding()->equals_ascii(encoding));
44 UTEST_ASSERT(p.is_standalone() == standalone);
45 UTEST_ASSERT(p.name() == NULL);
46 UTEST_ASSERT(p.value() == NULL);
47 }
48
49 void check_doctype(PullParser &p, const char *type, const char *pub, const char *sys)
50 {
51 printf(" DOCTYPE: type=%s, pub=%s, sys=%s\n", type, pub, sys);
52 status_t token = p.read_next();
53 UTEST_ASSERT(token == XT_DTD);
54 UTEST_ASSERT((p.doctype() != NULL) && (p.doctype()->equals_ascii(type)));
55 UTEST_ASSERT((p.pub_literal() != NULL) && (p.pub_literal()->equals_ascii(pub)));
56 UTEST_ASSERT((p.sys_literal() != NULL) && (p.sys_literal()->equals_ascii(sys)));
57 }
58
59 void check_document_end(PullParser &p)
60 {
61 printf(" END_DOCUMENT\n");
62 status_t token = p.read_next();
63 UTEST_ASSERT(token == XT_END_DOCUMENT);
64 UTEST_ASSERT(p.name() == NULL);
65 UTEST_ASSERT(p.value() == NULL);
66 }
67
68 void check_comment(PullParser &p, const char *comment)
69 {
70 printf(" COMMENT: %s\n", comment);
71 status_t token = p.read_next();
72 UTEST_ASSERT(token == XT_COMMENT);
73 UTEST_ASSERT(p.name() == NULL);
74 UTEST_ASSERT(p.value()->equals_ascii(comment));
75 }
76
77 status_t check_references(PullParser &p)
78 {
79 LSPString tmp;
80 while (true)
81 {
82 status_t token = p.read_next();
83 if (token != XT_ENTITY_RESOLVE)
84 return token;
85
86 UTEST_ASSERT(tmp.set(p.name()));
87 UTEST_ASSERT(p.value() == NULL);
88 tmp.toupper();
89 printf(" REFERENCE_RESOLVE: %s -> %s\n", p.name()->get_utf8(), tmp.get_utf8());
90 UTEST_ASSERT(p.set_value(&tmp) == STATUS_OK);
91 }
92 }
93
94 void check_text(PullParser &p, const char *text)
95 {
96 status_t token = check_references(p);
97 printf(" CHARACTERS: %s\n", text);
98 UTEST_ASSERT(token == XT_CHARACTERS);
99 UTEST_ASSERT(p.name() == NULL);
100 UTEST_ASSERT(p.value()->equals_ascii(text));
101 }
102
103 void check_cdata(PullParser &p, const char *cdata)
104 {
105 printf(" CDATA: %s\n", cdata);
106 status_t token = p.read_next();
107 UTEST_ASSERT(token == XT_CDATA);
108 UTEST_ASSERT(p.name() == NULL);
109 UTEST_ASSERT(p.value()->equals_ascii(cdata));
110 }
111
112 void check_attribute(PullParser &p, const char *name, const char *value)
113 {
114 LSPString tmp;
115 status_t token = check_references(p);
116 printf(" ATTRIBUTE: name=%s, value=%s\n", name, value);
117 UTEST_ASSERT(token == XT_ATTRIBUTE);
118 UTEST_ASSERT(tmp.set_utf8(value));
119 UTEST_ASSERT(p.name()->equals_ascii(name));
120 UTEST_ASSERT(p.value()->equals(&tmp));
121 }
122
123 void check_start_element(PullParser &p, const char *name)
124 {
125 printf(" START_ELEMENT: name=%s\n", name);
126 status_t token = p.read_next();
127 UTEST_ASSERT(token == XT_START_ELEMENT);
128 UTEST_ASSERT(p.name()->equals_ascii(name));
129 UTEST_ASSERT(p.value() == NULL);
130 }
131
132 void check_end_element(PullParser &p, const char *name)
133 {
134 printf(" END_ELEMENT: name=%s\n", name);
135 status_t token = p.read_next();
136 UTEST_ASSERT(token == XT_END_ELEMENT);
137 UTEST_ASSERT(p.name()->equals_ascii(name));
138 UTEST_ASSERT(p.value() == NULL);
139 }
140
141 void check_pi(PullParser &p, const char *name, const char *value)
142 {
143 printf(" PROCESSING_INSTRUCTION: name=%s, value=%s\n", name, value);
144 status_t token = p.read_next();
145 UTEST_ASSERT(token == XT_PROCESSING_INSTRUCTION);
146 UTEST_ASSERT(p.name()->equals_ascii(name));
147 UTEST_ASSERT(p.value()->equals_ascii(value));
148 }
149
150 status_t read_xml_fully(const char *xml, ssize_t last_token)
151 {
152 LSPString text, tmp;
153 status_t res;
154
155 printf("Reading document: %s\n", xml);
156
157 if (!text.set_utf8(xml))
158 return STATUS_NO_MEM;
159
160 PullParser p;
161 if ((res = p.wrap(&text)) != STATUS_OK)
162 return res;
163
164 bool start = false, end = false;
165 status_t last = -1;
166
167 while (true)
168 {
169 // Read event
170 if ((res = p.read_next()) < 0)
171 {
172 if (res == -STATUS_EOF)
173 {
174 if (end)
175 return p.close();
176
177 printf(" No END_DOCUMENT triggered\n");
178 p.close();
179 return STATUS_CORRUPTED;
180 }
181 if ((last_token >= 0) && (last_token != last))
182 {
183 printf(" Last token %d does not match required %d\n", int(last), int(last_token));
184 return STATUS_CORRUPTED;
185 }
186 return -res;
187 }
188
189 // Require START_DOCUMENT
190 if ((!start) && (res != XT_START_DOCUMENT))
191 {
192 printf(" No START_DOCUMENT triggered\n");
193 return STATUS_CORRUPTED;
194 }
195
196 last = res; // Store last token
197 switch (res)
198 {
199 case XT_START_DOCUMENT:
200 printf(" START_DOCUMENT: xml_version=%d", int(p.xml_version()));
201 if (p.version() != NULL)
202 printf(" version='%s'", p.version()->get_utf8());
203 if (p.encoding() != NULL)
204 printf(" encoding='%s'", p.encoding()->get_utf8());
205 printf(" standalone='%s'\n", p.is_standalone() ? "yes" : "no");
206 start = true;
207 break;
208
209 case XT_END_DOCUMENT:
210 printf(" END_DOCUMENT\n");
211 end = true;
212 break;
213
214 case XT_ATTRIBUTE:
215 printf(" ATTRIBUTE: name='%s', value='%s'\n", p.name()->get_utf8(), p.value()->get_utf8());
216 break;
217
218 case XT_CDATA:
219 printf(" CDATA: value='%s'\n", p.value()->get_utf8());
220 break;
221
222 case XT_CHARACTERS:
223 printf(" CHARACTERS: value='%s'\n", p.value()->get_utf8());
224 break;
225
226 case XT_COMMENT:
227 printf(" COMMENT: value='%s'\n", p.value()->get_utf8());
228 break;
229
230 case XT_END_ELEMENT:
231 printf(" END_ELEMENT: name='%s'\n", p.name()->get_utf8());
232 break;
233
234 case XT_ENTITY_RESOLVE:
235 if (!tmp.set(p.name()))
236 return STATUS_NO_MEM;
237 tmp.toupper();
238 printf(" REFERENCE_RESOLVE: name='%s', resolving to '%s'\n", p.name()->get_utf8(), tmp.get_utf8());
239 if ((res = p.set_value(&tmp)) != STATUS_OK)
240 return res;
241 break;
242
243 case XT_PROCESSING_INSTRUCTION:
244 printf(" PROCESSING_INSTRUCTION: value='%s'\n", p.value()->get_utf8());
245 break;
246
247 case XT_START_ELEMENT:
248 printf(" START_ELEMENT: name='%s'\n", p.name()->get_utf8());
249 break;
250
251 case XT_DTD:
252 printf(" DOCTYPE: type=%s, public=%s, system=%s\n",
253 (p.doctype() != NULL) ? p.doctype()->get_utf8() : NULL,
254 (p.pub_literal() != NULL) ? p.pub_literal()->get_utf8() : NULL,
255 (p.sys_literal() != NULL) ? p.sys_literal()->get_utf8() : NULL
256 );
257 break;
258
259 default:
260 printf("Unknown event: %d\n", int(res));
261 return STATUS_UNKNOWN_ERR;
262 }
263 }
264 }
265
266 void test_simple_valid_xml()
267 {
268 static const char *xml[] =
269 {
270 "",
271
272 "<?xml version='1.0'?>",
273 "<?xml version='1.1' encoding='UTF-8'?>",
274 "<?xml version='1.1' encoding='UTF-8' standalone='yes' ?>",
275 "<?xml version='1.0' standalone='yes' ?>",
276 "<?xml \n\t\r version='1.1' \n\t\r encoding='UTF-8' \n\t\r standalone='yes' \n\t\r ?>",
277
278 "<!-- Simple comment -->",
279 "<!--- comment - with - dash -->",
280 "<!-- Simple comment 1 -->\n<!-- Simple comment 2 -->",
281
282 "<!DOCTYPE greeting>",
283 "<!DOCTYPE greeting >",
284 "<!DOCTYPE greeting SYSTEM \"hello.dtd\">",
285 "<!DOCTYPE greeting SYSTEM 'hello.dtd'>",
286 "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">",
287
288 "<?xml version='1.0'?><!-- comment after header -->",
289 "<?xml version='1.0'?><!-- c1 --><?pi some text ?><!-- c2 -->",
290
291 "<?xml version='1.0'?><?pi?>",
292 "<?xml version='1.0'?><?pi arg?>",
293 "<?xml version='1.0'?><?pi arg arg ?>",
294
295 "<?xml version='1.0'?><root/>",
296 "<?xml version='1.0'?><root />",
297 "<?xml version='1.0'?><root></root>",
298 "<?xml version='1.0'?><root>&#x00000000000020;</root>",
299 "<?xml version='1.0'?><root>&reference1;</root>",
300 "<?xml version='1.0'?><root><![CDATA[data]]data]]></root>",
301
302 "<?xml version='1.0'?><root id='1' ID='2'></root>",
303 "<?xml version='1.0'?><root att1=\"value1\"></root>",
304 "<?xml version='1.0'?><root att1=\"value1\" ns:attr2='value2' ></root>",
305 "<?xml version='1.0'?><root><t1><t2></t2></t1></root>",
306 "<?xml version='1.0'?><root att1=\"value1\" ><nested id=\"&amp;&amp;&amp;\" /><nested2 x='123'><?pi2 args?><!-- comment --></nested2></root>",
307 "<?xml version='1.0'?><root>text &quot;&lt;<![CDATA[character&amp;data]]>&gt;&quot;</root>",
308 "<?xml version='1.0'?><root>&unknown_entity;<nested att='&unknown_entity2;' /></root>",
309 NULL
310 };
311
312 for (const char **p=xml; *p != NULL; ++p)
313 UTEST_ASSERT(read_xml_fully(*p, XT_END_DOCUMENT) == STATUS_OK);
314 }
315
316 void test_simple_invalid_xml()
317 {
318 static const char *xml[] =
319 {
320 "<?xml?>",
321 "<?xml vesion='1.0'>",
322 " <?xml vesion='1.0'?>",
323 "<?xml encoding='UTF-8'?>",
324 "<?xml standalone='yes'?>",
325 "<?xml version='3.1' ?>",
326 "<?xml version='1.0' encoding='#$%$^#' ?>",
327 "<?xml version='1.0' standalone='true' ?>",
328 "<?xml version='1.0' standalone='NO' ?>",
329
330 "<!DOCTYPE greeting 123>",
331 "<!DOCTYPE greeting xml>",
332 "<!DOCTYPE greeting []>",
333 "<!DOCTYPE greeting SYSTEM>",
334 "<!DOCTYPE greeting PUBLIC>",
335 "<!DOCTYPE greeting SYSTEM >",
336 "<!DOCTYPE greeting PUBLIC >",
337 "<!DOCTYPE greeting SYSTEM 'привет.dtd' []>",
338 "<!DOCTYPE greeting SYSTEM \"greeting.dtd\" []>",
339 "<!DOCTYPE HTML PUBLIC \"привет\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">",
340 "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\" []>",
341 "<!DOCTYPE greeting><!DOCTYPE xml>",
342
343 "<?xml version='1.0'?><![CDATA[1234]]>",
344
345 "<?xml version='1.0'?><!---- invalid comment -->",
346 "<?xml version='1.0'?><!-- invalid -- comment -->",
347 "<?xml version='1.0'?><!-- invalid --->",
348 "<?xml version='1.0'?><!-- invalid ",
349 "<!-- valid --><?xml version='1.0'?>",
350
351 "<?xml version='1.0'?>&amp;",
352 "<?xml version='1.0'?>&#x100;",
353 "<?xml version='1.0'?>< ? pi?>",
354 "<?xml version='1.0'?><? pi?>",
355 "<?xml version='1.0'?><?pi? >",
356
357 "<?xml version='1.0'?><root>",
358 "<?xml version='1.0'?><root/ >",
359 "<?xml version='1.0'?><root>< /root>",
360 "<?xml version='1.0'?><root></ root>",
361 "<?xml version='1.0'?><root1/><root2/>",
362 "<?xml version='1.0'?><root1></root1><root2></root2>",
363
364 "<?xml version='1.0'?><root att1></root>",
365 "<?xml version='1.0'?><root att=value></root>",
366 "<?xml version='1.0'?><root 1att='value'></root>",
367 "<?xml version='1.0'?><root att='value' att2></root>",
368 "<?xml version='1.0'?><root att='value1' att='value2'></root>",
369
370 "<?xml version='1.0'?><root><tag></root>",
371 "<?xml version='1.0'?><root><1tag /></root>",
372 "<?xml version='1.0'?><root><tag/ ></root>",
373 "<?xml version='1.0'?><root>&reference1</root>",
374 "<?xml version='1.0'?><root>&#xde00;</root>",
375 "<?xml version='1.0'?><root>&#xdf00;</root>",
376 "<?xml version='1.0'?><root>&#x110000;</root>",
377
378 "<?xml version='1.0'?><root><t1><t2></t1></t2></root>",
379
380 NULL
381 };
382
383 for (const char **p=xml; *p != NULL; ++p)
384 UTEST_ASSERT(read_xml_fully(*p, -1) != STATUS_OK);
385 }
386
387 void test_xml_parsing()
388 {
389 const char *xml =
390 "<?xml version='1.1' encoding='US-ASCII' standalone='yes'?>\n"
391 "<!DOCTYPE TEST PUBLIC 'lsp-plugin' 'http://lsp-plug.in/test.dtd'>\n"
392 "<!--c1-->\n"
393 "<?pi v1?>\n"
394 "<!--c2-->\n"
395 "<root:root xmlns:test=\"http://some test namespace\">\n"
396 "<?pi v2?>\n"
397 "<!--c3-->\n"
398 "<?pi v3?>\n"
399 "<tag1 p1='10' p2='20'>"
400 "<?pi v4?>\n"
401 "<!--c4-->\n"
402 "some text characters\n"
403 "<?pi v5?>\n"
404 "</tag1>\n"
405 "&reference1;\n"
406 "<test:tag2 attr='&amp;&quot;&apos;&lt;&gt;' attr2=\"&#x041F;&#x0440;&#x0438;&#x0432;&#x0435;&#x0442;\" />\n"
407 "<tag3 param='&#65;-&#90;' ref=\"&reference2;-&reference3;\">\n"
408 "<!--cdata-->\n"
409 "<![CDATA[175bf801fddd9ea5ded1da4e26a75ad3]]>\n"
410 "<?xi v5?>\n"
411 "</tag3>\n"
412 "</root:root>\n\n"
413 "<?pi v6?>\n"
414 "<!-- end -->\n"
415 ;
416
417 LSPString text;
418 printf("Reading document: %s\n", xml);
419 UTEST_ASSERT(text.set_utf8(xml));
420
421 PullParser p;
422 UTEST_ASSERT((p.wrap(&text)) == STATUS_OK);
423
424 check_document_start(p, XML_VERSION_1_1, "1.1", "US-ASCII", true);
425 check_doctype(p, "TEST", "lsp-plugin", "http://lsp-plug.in/test.dtd");
426 check_comment(p, "c1");
427 check_pi(p, "pi", "v1");
428 check_comment(p, "c2");
429 UTEST_ASSERT(p.level() == 0);
430
431 check_start_element(p, "root:root");
432 check_attribute(p, "xmlns:test", "http://some test namespace");
433 check_text(p, "\n");
434 UTEST_ASSERT(p.level() == 1);
435 check_pi(p, "pi", "v2");
436 check_text(p, "\n");
437 check_comment(p, "c3");
438 check_text(p, "\n");
439 check_pi(p, "pi", "v3");
440 check_text(p, "\n");
441
442 check_start_element(p, "tag1");
443 check_attribute(p, "p1", "10");
444 check_attribute(p, "p2", "20");
445 UTEST_ASSERT(p.level() == 2);
446 check_pi(p, "pi", "v4");
447 check_text(p, "\n");
448 check_comment(p, "c4");
449 check_text(p, "\nsome text characters\n");
450 check_pi(p, "pi", "v5");
451 check_text(p, "\n");
452 check_end_element(p, "tag1");
453 check_text(p, "\nREFERENCE1\n");
454 UTEST_ASSERT(p.level() == 1);
455
456 check_start_element(p, "test:tag2");
457 UTEST_ASSERT(p.level() == 2);
458 check_attribute(p, "attr", "&\"\'<>");
459 check_attribute(p, "attr2", "Привет");
460 check_end_element(p, "test:tag2");
461 UTEST_ASSERT(p.level() == 1);
462 check_text(p, "\n");
463
464 check_start_element(p, "tag3");
465 check_attribute(p, "param", "A-Z");
466 check_attribute(p, "ref", "REFERENCE2-REFERENCE3");
467 UTEST_ASSERT(p.level() == 2);
468 check_text(p, "\n");
469 check_comment(p, "cdata");
470 check_text(p, "\n");
471 check_cdata(p, "175bf801fddd9ea5ded1da4e26a75ad3");
472 check_text(p, "\n");
473 check_pi(p, "xi", "v5");
474 check_text(p, "\n");
475 check_end_element(p, "tag3");
476 check_text(p, "\n");
477 UTEST_ASSERT(p.level() == 1);
478 check_end_element(p, "root:root");
479 UTEST_ASSERT(p.level() == 0);
480 check_pi(p, "pi", "v6");
481 check_comment(p, " end ");
482 }
483
484
485 UTEST_MAIN
486 {
487 printf("Testing simple valid XML parsing...\n");
488 test_simple_valid_xml();
489 printf("Testing simple invalid XML parsing...\n");
490 test_simple_invalid_xml();
491 printf("Testing XML document parsing...\n");
492 test_xml_parsing();
493 }
494
495 UTEST_END