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
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
|
// Copyright (C) 2018-2022 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
#include <config.h>
#include <gtest/gtest.h>
#include <cc/data.h>
#include <cc/dhcp_config_error.h>
#include <netconf/parser_context.h>
#include <testutils/gtest_utils.h>
#include <testutils/io_utils.h>
#include <testutils/log_utils.h>
#include <testutils/user_context_utils.h>
#include <iostream>
#include <fstream>
#include <vector>
#include <boost/algorithm/string.hpp>
using namespace isc::data;
using namespace isc::test;
using namespace std;
namespace isc {
namespace netconf {
namespace test {
/// @brief compares two JSON trees
///
/// If differences are discovered, gtest failure is reported (using EXPECT_EQ)
///
/// @param a first to be compared
/// @param b second to be compared
void compareJSON(ConstElementPtr a, ConstElementPtr b) {
ASSERT_TRUE(a);
ASSERT_TRUE(b);
EXPECT_EQ(a->str(), b->str());
}
/// @brief Tests if the input string can be parsed with specific parser
///
/// The input text will be passed to bison parser of specified type.
/// Then the same input text is passed to legacy JSON parser and outputs
/// from both parsers are compared. The legacy comparison can be disabled,
/// if the feature tested is not supported by the old parser (e.g.
/// new comment styles)
///
/// @param txt text to be compared
/// @param parser_type bison parser type to be instantiated
/// @param compare whether to compare the output with legacy JSON parser
void testParser(const string& txt, ParserContext::ParserType parser_type,
bool compare = true) {
SCOPED_TRACE("\n* Tested config: \n---\n" + txt + "\n---");
ConstElementPtr test_json;
ASSERT_NO_THROW_LOG({
try {
ParserContext ctx;
test_json = ctx.parseString(txt, parser_type);
} catch (exception const &e) {
cout << "EXCEPTION: " << e.what() << endl;
throw;
}
});
if (!compare) {
return;
}
// Now compare if both representations are the same.
ElementPtr reference_json;
ASSERT_NO_THROW_LOG(reference_json = Element::fromJSON(txt, true));
compareJSON(reference_json, test_json);
}
TEST(ParserTest, mapInMap) {
string txt = "{ \"xyzzy\": { \"foo\": 123, \"baz\": 456 } }";
testParser(txt, ParserContext::PARSER_JSON);
}
TEST(ParserTest, listInList) {
string txt = "[ [ \"Britain\", \"Wales\", \"Scotland\" ], "
"[ \"Pomorze\", \"Wielkopolska\", \"Tatry\"] ]";
testParser(txt, ParserContext::PARSER_JSON);
}
TEST(ParserTest, nestedMaps) {
string txt = "{ \"europe\": { \"UK\": { \"London\": { \"street\": \"221B Baker\" }}}}";
testParser(txt, ParserContext::PARSER_JSON);
}
TEST(ParserTest, nestedLists) {
string txt = "[ \"half\", [ \"quarter\", [ \"eighth\", [ \"sixteenth\" ]]]]";
testParser(txt, ParserContext::PARSER_JSON);
}
TEST(ParserTest, listsInMaps) {
string txt = "{ \"constellations\": { \"orion\": [ \"rigel\", \"betelgeuse\" ], "
"\"cygnus\": [ \"deneb\", \"albireo\"] } }";
testParser(txt, ParserContext::PARSER_JSON);
}
TEST(ParserTest, mapsInLists) {
string txt = "[ { \"body\": \"earth\", \"gravity\": 1.0 },"
" { \"body\": \"mars\", \"gravity\": 0.376 } ]";
testParser(txt, ParserContext::PARSER_JSON);
}
TEST(ParserTest, types) {
string txt = "{ \"string\": \"foo\","
"\"integer\": 42,"
"\"boolean\": true,"
"\"map\": { \"foo\": \"bar\" },"
"\"list\": [ 1, 2, 3 ],"
"\"null\": null }";
testParser(txt, ParserContext::PARSER_JSON);
}
TEST(ParserTest, keywordJSON) {
string txt = "{ \"name\": \"user\","
"\"type\": \"password\","
"\"user\": \"name\","
"\"password\": \"type\" }";
testParser(txt, ParserContext::PARSER_JSON);
}
// This test checks if full config (with top level and Netconf objects) can
// be parsed with syntactic checking (and as pure JSON).
TEST(ParserTest, keywordNetconf) {
string txt = "{ \"Netconf\": {\n"
" \"boot-update\": true,"
" \"subscribe-changes\": true,"
" \"validate-changes\": true,"
" \"managed-servers\": {"
" \"dhcp4\": {"
" \"model\": \"kea-dhcp4-server\","
" \"boot-update\": false,"
" \"subscribe-changes\": false,"
" \"validate-changes\": false,"
" \"control-socket\": {"
" \"socket-type\": \"unix\","
" \"socket-name\": \"/tmp/kea4-ctrl-socket\""
" }"
" },"
" \"dhcp6\": {"
" \"model\": \"kea-dhcp6-server\","
" \"boot-update\": false,"
" \"subscribe-changes\": false,"
" \"validate-changes\": false,"
" \"control-socket\": {"
" \"socket-type\": \"http\","
" \"socket-url\": \"http://127.0.0.1:12345/\""
" }"
" },"
" \"d2\": {"
" \"model\": \"kea-dhcp-ddns\","
" \"boot-update\": false,"
" \"subscribe-changes\": false,"
" \"validate-changes\": false,"
" \"control-socket\": {"
" \"socket-type\": \"stdout\""
" }"
" },"
" \"ca\": {"
" \"model\": \"kea-ctrl-agent\","
" \"boot-update\": false,"
" \"subscribe-changes\": false,"
" \"validate-changes\": false,"
" \"control-socket\": {"
" \"socket-type\": \"http\","
" \"user-context\": { \"use default\": true }"
" }"
" }"
" },"
" \"hooks-libraries\": ["
" {"
" \"library\": \"/opt/local/control-agent-commands.so\","
" \"parameters\": {"
" \"param1\": \"foo\""
" }"
" }"
" ]"
"} }";
// This is a full config, so we'll parse it as full config (PARSER_NETCONF)
testParser(txt, ParserContext::PARSER_NETCONF);
testParser(txt, ParserContext::PARSER_JSON);
}
// This test checks if simplified config (without top level and Netconf
// objects) can be parsed with syntactic checking (and as pure JSON).
TEST(ParserTest, keywordSubNetconf) {
// This is similar to previous test, but note the lack of outer
// map and Netconf.
string txt = "{\n"
" \"boot-update\": true,"
" \"subscribe-changes\": true,"
" \"validate-changes\": true,"
" \"managed-servers\": {"
" \"dhcp4\": {"
" \"model\": \"kea-dhcp4-server\","
" \"boot-update\": false,"
" \"subscribe-changes\": false,"
" \"validate-changes\": false,"
" \"control-socket\": {"
" \"socket-type\": \"unix\","
" \"socket-name\": \"/tmp/kea4-ctrl-socket\""
" }"
" },"
" \"dhcp6\": {"
" \"model\": \"kea-dhcp6-server\","
" \"boot-update\": false,"
" \"subscribe-changes\": false,"
" \"validate-changes\": false,"
" \"control-socket\": {"
" \"socket-type\": \"http\","
" \"socket-url\": \"http://127.0.0.1:12345/\""
" }"
" },"
" \"d2\": {"
" \"model\": \"kea-dhcp-ddns\","
" \"boot-update\": false,"
" \"subscribe-changes\": false,"
" \"validate-changes\": false,"
" \"control-socket\": {"
" \"socket-type\": \"stdout\""
" }"
" },"
" \"ca\": {"
" \"model\": \"kea-ctrl-agent\","
" \"boot-update\": false,"
" \"subscribe-changes\": false,"
" \"validate-changes\": false,"
" \"control-socket\": {"
" \"socket-type\": \"http\","
" \"user-context\": { \"use default\": true }"
" }"
" }"
" },"
" \"hooks-libraries\": ["
" {"
" \"library\": \"/opt/local/control-agent-commands.so\","
" \"parameters\": {"
" \"param1\": \"foo\""
" }"
" }"
" ]"
"}";
// This is only a subset of full config, so we'll parse with PARSER_SUB_NETCONF.
testParser(txt, ParserContext::PARSER_SUB_NETCONF);
testParser(txt, ParserContext::PARSER_JSON);
}
// Tests if bash (#) comments are supported. That's the only comment type that
// was supported by the old parser.
TEST(ParserTest, bashComments) {
string txt= "{ \"Netconf\": {"
" \"managed-servers\": {\n"
" \"d2\": {\n"
" \"model\": \"foo\",\n"
" \"control-socket\": {\n"
"# this is a comment\n"
"\"socket-type\": \"unix\", \n"
"# This socket is mine. I can name it whatever\n"
"# I like, ok?\n"
"\"socket-name\": \"Hector\" \n"
"} } } } }";
testParser(txt, ParserContext::PARSER_NETCONF);
}
// Tests if C++ (//) comments can start anywhere, not just in the first line.
TEST(ParserTest, cppComments) {
string txt= "{ \"Netconf\": { // the level is over 9000!\n"
" \"managed-servers\": {\n"
" // Let's try talking to D2. Sadly, it never talks"
" // to us back :( Maybe he doesn't like his name?\n"
" \"d2\": {\n"
" \"model\": \"foo\",\n"
" \"control-socket\": {\n"
"\"socket-type\": \"unix\", \n"
"\"socket-name\": \"Hector\" \n"
"} } } } }";
testParser(txt, ParserContext::PARSER_NETCONF, false);
}
// Tests if bash (#) comments can start anywhere, not just in the first line.
TEST(ParserTest, bashCommentsInline) {
string txt= "{ \"Netconf\": {"
" \"managed-servers\": {\n"
" \"d2\": {\n"
" \"model\": \"foo\",\n"
" \"control-socket\": {\n"
"\"socket-type\": \"unix\", # Maybe Hector is not really a \n"
"\"socket-name\": \"Hector\" # Unix process?\n"
"# Oh no! He's a windows one and just pretending!\n"
"} } } } }";
testParser(txt, ParserContext::PARSER_NETCONF, false);
}
// Tests if multi-line C style comments are handled correctly.
TEST(ParserTest, multilineComments) {
string txt= "{ \"Netconf\": {"
" \"managed-servers\": {\n"
" \"dhcp4\": {\n"
" \"model\": \"foo\",\n"
" \"control-socket\": {\n"
" \"socket-type\": \"stdout\"\n"
" }\n"
" }\n"
" /* Ok, forget about it. If Hector doesn't want to talk,\n"
" we won't talk to him either. We now have quiet days. */\n"
" /* \"d2\": {"
" \"model\": \"bar\",\n"
" \"control-socket\": {\n"
" \"socket-type\": \"unix\",\n"
"\"socket-name\": \"Hector\"\n"
"} }*/ } } }";
testParser(txt, ParserContext::PARSER_NETCONF, false);
}
// Tests if embedded comments are handled correctly.
TEST(ParserTest, embbededComments) {
string txt= "{ \"Netconf\": {"
" \"comment\": \"a comment\","
" \"managed-servers\": {\n"
" \"dhcp4\": {\n"
" \"control-socket\": {\n"
" \"user-context\": { \"comment\": \"indirect\" },\n"
" \"socket-type\": \"stdout\"\n"
" } } },\n"
" \"user-context\": { \"compatible\": true }\n"
"} }";
testParser(txt, ParserContext::PARSER_NETCONF, false);
}
/// @brief Loads specified example config file
///
/// This test loads specified example file twice: first, using the legacy
/// JSON file and then second time using bison parser. Two created Element
/// trees are then compared. The input is decommented before it is passed
/// to legacy parser (as legacy support for comments is very limited).
///
/// @param fname name of the file to be loaded
void testFile(const string& fname) {
ElementPtr json;
ElementPtr reference_json;
ConstElementPtr test_json;
string decommented = decommentJSONfile(fname);
cout << "Parsing file " << fname << "(" << decommented << ")" << endl;
EXPECT_NO_THROW_LOG(json = Element::fromJSONFile(decommented, true));
reference_json = moveComments(json);
// remove the temporary file
EXPECT_NO_THROW_LOG(::remove(decommented.c_str()));
EXPECT_NO_THROW_LOG(
try {
ParserContext ctx;
test_json = ctx.parseFile(fname, ParserContext::PARSER_NETCONF);
} catch (exception const &x) {
cout << "EXCEPTION: " << x.what() << endl;
throw;
});
ASSERT_TRUE(reference_json);
ASSERT_TRUE(test_json);
compareJSON(reference_json, test_json);
}
// This test loads all available existing files. Each config is loaded
// twice: first with the existing Element::fromJSONFile() and then
// the second time with NetconfParser. Both JSON trees are then compared.
// Hopefully the list of example configs will grow over time.
TEST(ParserTest, file) {
vector<string> configs;
configs.push_back("comments.json");
configs.push_back("simple-dhcp4.json");
configs.push_back("simple-dhcp6.json");
for (int i = 0; i<configs.size(); i++) {
testFile(string(CFG_EXAMPLES) + "/" + configs[i]);
}
}
/// @brief Tests error conditions in NetconfParser
///
/// @param txt text to be parsed
/// @param parser_type type of the parser to be used in the test
/// @param msg expected content of the exception
void testError(const string& txt,
ParserContext::ParserType parser_type,
const string& msg) {
SCOPED_TRACE("\n* Tested config: \n---\n" + txt + "\n---");
ParserContext ctx;
EXPECT_THROW_MSG(ctx.parseString(txt, parser_type), ParseError, msg);
}
// Verify that error conditions are handled correctly.
TEST(ParserTest, errors) {
// no input
testError("", ParserContext::PARSER_JSON,
"<string>:1.1: syntax error, unexpected end of file");
testError(" ", ParserContext::PARSER_JSON,
"<string>:1.2: syntax error, unexpected end of file");
testError("\n", ParserContext::PARSER_JSON,
"<string>:2.1: syntax error, unexpected end of file");
testError("\t", ParserContext::PARSER_JSON,
"<string>:1.2: syntax error, unexpected end of file");
testError("\r", ParserContext::PARSER_JSON,
"<string>:1.2: syntax error, unexpected end of file");
// comments
testError("# nothing\n",
ParserContext::PARSER_JSON,
"<string>:2.1: syntax error, unexpected end of file");
testError(" #\n",
ParserContext::PARSER_JSON,
"<string>:2.1: syntax error, unexpected end of file");
testError("// nothing\n",
ParserContext::PARSER_JSON,
"<string>:2.1: syntax error, unexpected end of file");
testError("/* nothing */\n",
ParserContext::PARSER_JSON,
"<string>:2.1: syntax error, unexpected end of file");
testError("/* no\nthing */\n",
ParserContext::PARSER_JSON,
"<string>:3.1: syntax error, unexpected end of file");
testError("/* no\nthing */\n\n",
ParserContext::PARSER_JSON,
"<string>:4.1: syntax error, unexpected end of file");
testError("/* nothing\n",
ParserContext::PARSER_JSON,
"Comment not closed. (/* in line 1");
testError("\n\n\n/* nothing\n",
ParserContext::PARSER_JSON,
"Comment not closed. (/* in line 4");
testError("{ /* */*/ }\n",
ParserContext::PARSER_JSON,
"<string>:1.3-8: Invalid character: *");
testError("{ /* // *// }\n",
ParserContext::PARSER_JSON,
"<string>:1.3-11: Invalid character: /");
testError("{ /* // */// }\n",
ParserContext::PARSER_JSON,
"<string>:2.1: syntax error, unexpected end of file, "
"expecting }");
// includes
testError("<?\n",
ParserContext::PARSER_JSON,
"Directive not closed.");
testError("<?include\n",
ParserContext::PARSER_JSON,
"Directive not closed.");
string file = string(CFG_EXAMPLES) + "/" + "simple-dhcp4.json";
testError("<?include \"" + file + "\"\n",
ParserContext::PARSER_JSON,
"Directive not closed.");
testError("<?include \"/foo/bar\" ?>/n",
ParserContext::PARSER_JSON,
"Can't open include file /foo/bar");
// JSON keywords
testError("{ \"foo\": True }",
ParserContext::PARSER_JSON,
"<string>:1.10-13: JSON true reserved keyword is lower case only");
testError("{ \"foo\": False }",
ParserContext::PARSER_JSON,
"<string>:1.10-14: JSON false reserved keyword is lower case only");
testError("{ \"foo\": NULL }",
ParserContext::PARSER_JSON,
"<string>:1.10-13: JSON null reserved keyword is lower case only");
testError("{ \"foo\": Tru }",
ParserContext::PARSER_JSON,
"<string>:1.10: Invalid character: T");
testError("{ \"foo\": nul }",
ParserContext::PARSER_JSON,
"<string>:1.10: Invalid character: n");
// numbers
testError("123",
ParserContext::PARSER_NETCONF,
"<string>:1.1-3: syntax error, unexpected integer, "
"expecting {");
testError("-456",
ParserContext::PARSER_NETCONF,
"<string>:1.1-4: syntax error, unexpected integer, "
"expecting {");
testError("-0001",
ParserContext::PARSER_NETCONF,
"<string>:1.1-5: syntax error, unexpected integer, "
"expecting {");
testError("1234567890123456789012345678901234567890",
ParserContext::PARSER_JSON,
"<string>:1.1-40: Failed to convert "
"1234567890123456789012345678901234567890"
" to an integer.");
testError("-3.14e+0",
ParserContext::PARSER_NETCONF,
"<string>:1.1-8: syntax error, unexpected floating point, "
"expecting {");
testError("1e50000",
ParserContext::PARSER_JSON,
"<string>:1.1-7: Failed to convert 1e50000 "
"to a floating point.");
// strings
testError("\"aabb\"",
ParserContext::PARSER_NETCONF,
"<string>:1.1-6: syntax error, unexpected constant string, "
"expecting {");
testError("{ \"aabb\"err",
ParserContext::PARSER_JSON,
"<string>:1.9: Invalid character: e");
testError("{ err\"aabb\"",
ParserContext::PARSER_JSON,
"<string>:1.3: Invalid character: e");
testError("\"a\n\tb\"",
ParserContext::PARSER_JSON,
"<string>:1.1-6 (near 2): Invalid control in \"a\n\tb\"");
testError("\"a\n\\u12\"",
ParserContext::PARSER_JSON,
"<string>:1.1-8 (near 2): Invalid control in \"a\n\\u12\"");
testError("\"a\\n\\tb\"",
ParserContext::PARSER_NETCONF,
"<string>:1.1-8: syntax error, unexpected constant string, "
"expecting {");
testError("\"a\\x01b\"",
ParserContext::PARSER_JSON,
"<string>:1.1-8 (near 3): Bad escape in \"a\\x01b\"");
testError("\"a\\u0162\"",
ParserContext::PARSER_JSON,
"<string>:1.1-9 (near 4): Unsupported unicode escape "
"in \"a\\u0162\"");
testError("\"a\\u062z\"",
ParserContext::PARSER_JSON,
"<string>:1.1-9 (near 3): Bad escape in \"a\\u062z\"");
testError("\"abc\\\"",
ParserContext::PARSER_JSON,
"<string>:1.1-6 (near 6): Overflow escape in \"abc\\\"");
testError("\"a\\u006\"",
ParserContext::PARSER_JSON,
"<string>:1.1-8 (near 3): Overflow unicode escape "
"in \"a\\u006\"");
testError("\"\\u\"",
ParserContext::PARSER_JSON,
"<string>:1.1-4 (near 2): Overflow unicode escape in \"\\u\"");
testError("\"\\u\x02\"",
ParserContext::PARSER_JSON,
"<string>:1.1-5 (near 2): Bad escape in \"\\u\x02\"");
testError("\"\\u\\\"foo\"",
ParserContext::PARSER_JSON,
"<string>:1.1-5 (near 2): Bad escape in \"\\u\\\"...");
testError("\"\x02\\u\"",
ParserContext::PARSER_JSON,
"<string>:1.1-5 (near 1): Invalid control in \"\x02\\u\"");
// from data_unittest.c
testError("\\a",
ParserContext::PARSER_JSON,
"<string>:1.1: Invalid character: \\");
testError("\\",
ParserContext::PARSER_JSON,
"<string>:1.1: Invalid character: \\");
testError("\\\"\\\"",
ParserContext::PARSER_JSON,
"<string>:1.1: Invalid character: \\");
// want a map
testError("[]\n",
ParserContext::PARSER_NETCONF,
"<string>:1.1: syntax error, unexpected [, "
"expecting {");
testError("[]\n",
ParserContext::PARSER_NETCONF,
"<string>:1.1: syntax error, unexpected [, "
"expecting {");
testError("{ 123 }\n",
ParserContext::PARSER_JSON,
"<string>:1.3-5: syntax error, unexpected integer, "
"expecting }");
testError("{ 123 }\n",
ParserContext::PARSER_NETCONF,
"<string>:1.3-5: syntax error, unexpected integer, "
"expecting Netconf");
testError("{ \"foo\" }\n",
ParserContext::PARSER_JSON,
"<string>:1.9: syntax error, unexpected }, "
"expecting :");
testError("{ \"foo\" }\n",
ParserContext::PARSER_NETCONF,
"<string>:1.3-7: syntax error, unexpected constant string, "
"expecting Netconf");
testError("{ \"foo\":null }\n",
ParserContext::PARSER_NETCONF,
"<string>:1.3-7: syntax error, unexpected constant string, "
"expecting Netconf");
testError("{ \"Logging\":null }\n",
ParserContext::PARSER_NETCONF,
"<string>:1.3-11: syntax error, unexpected constant string, "
"expecting Netconf");
testError("{ \"Netconf\" }\n",
ParserContext::PARSER_NETCONF,
"<string>:1.13: syntax error, unexpected }, "
"expecting :");
testError("{ \"Netconf\":",
ParserContext::PARSER_NETCONF,
"<string>:1.13: syntax error, unexpected end of file, "
"expecting {");
testError("{}{}\n",
ParserContext::PARSER_JSON,
"<string>:1.3: syntax error, unexpected {, "
"expecting end of file");
// duplicate in map
testError("{ \"foo\": 1, \"foo\": true }\n",
ParserContext::PARSER_JSON,
"<string>:1:13: duplicate foo entries in "
"JSON map (previous at <string>:1:10)");
// bad commas
testError("{ , }\n",
ParserContext::PARSER_JSON,
"<string>:1.3: syntax error, unexpected \",\", "
"expecting }");
testError("{ , \"foo\":true }\n",
ParserContext::PARSER_JSON,
"<string>:1.3: syntax error, unexpected \",\", "
"expecting }");
// bad type
testError("{ \"Netconf\":{\n"
" \"managed-servers\":false }}\n",
ParserContext::PARSER_NETCONF,
"<string>:2.21-25: syntax error, unexpected boolean, "
"expecting {");
// unknown keyword
testError("{ \"Netconf\":{\n"
" \"topping\": \"Mozzarella\" }}\n",
ParserContext::PARSER_NETCONF,
"<string>:2.2-10: got unexpected keyword "
"\"topping\" in Netconf map.");
// user context and embedded comments
testError("{ \"Netconf\":{\n"
" \"comment\": true } }\n",
ParserContext::PARSER_NETCONF,
"<string>:2.14-17: syntax error, unexpected boolean, "
"expecting constant string");
testError("{ \"Netconf\":{\n"
" \"user-context\": \"a comment\" } }\n",
ParserContext::PARSER_NETCONF,
"<string>:2.19-29: syntax error, unexpected constant string, "
"expecting {");
testError("{ \"Netconf\":{\n"
" \"comment\": \"a comment\",\n"
" \"comment\": \"another one\" } }\n",
ParserContext::PARSER_NETCONF,
"<string>:3.3-11: duplicate user-context/comment entries "
"(previous at <string>:2:3)");
testError("{ \"Netconf\":{\n"
" \"user-context\": { \"version\": 1 },\n"
" \"user-context\": { \"one\": \"only\" } } }\n",
ParserContext::PARSER_NETCONF,
"<string>:3.3-16: duplicate user-context entries "
"(previous at <string>:2:19)");
testError("{ \"Netconf\":{\n"
" \"user-context\": { \"comment\": \"indirect\" },\n"
" \"comment\": \"a comment\" } }\n",
ParserContext::PARSER_NETCONF,
"<string>:3.3-11: duplicate user-context/comment entries "
"(previous at <string>:2:19)");
// duplicate Netconf entries
testError("{ \"Netconf\":{\n"
" \"comment\": \"first\" },\n"
" \"Netconf\":{\n"
" \"comment\": \"second\" }}\n",
ParserContext::PARSER_NETCONF,
"<string>:3.3-11: syntax error, unexpected Netconf, expecting \",\" or }");
// duplicate of not string entries
testError("{ \"Netconf\":{\n"
" \"boot-update\": true,\n"
" \"boot-update\": false }}\n",
ParserContext::PARSER_NETCONF,
"<string>:3:2: duplicate boot-update entries in "
"Netconf map (previous at <string>:2:17)");
// duplicate of string entries
testError("{ \"Netconf\":{\n"
" \"managed-servers\": {\n"
" \"d2\": {\n"
" \"model\": \"foo\",\n"
" \"model\": \"bar\" }}}}\n",
ParserContext::PARSER_NETCONF,
"<string>:5:7: duplicate model entries in "
"managed-servers entry map (previous at <string>:4:16)");
}
// Check unicode escapes
TEST(ParserTest, unicodeEscapes) {
ConstElementPtr result;
string json;
// check we can reread output
for (char c = -128; c < 127; ++c) {
string ins(" ");
ins[1] = c;
ConstElementPtr e(new StringElement(ins));
json = e->str();
ASSERT_NO_THROW_LOG(
try {
ParserContext ctx;
result = ctx.parseString(json, ParserContext::PARSER_JSON);
} catch (exception const &x) {
cout << "EXCEPTION: " << x.what() << endl;
throw;
});
ASSERT_EQ(Element::string, result->getType());
EXPECT_EQ(ins, result->stringValue());
}
}
// This test checks that all representations of a slash is recognized properly.
TEST(ParserTest, unicodeSlash) {
// check the 4 possible encodings of solidus '/'
ConstElementPtr result;
string json = "\"/\\/\\u002f\\u002F\"";
ASSERT_NO_THROW_LOG(
try {
ParserContext ctx;
result = ctx.parseString(json, ParserContext::PARSER_JSON);
} catch (exception const &x) {
cout << "EXCEPTION: " << x.what() << endl;
throw;
});
ASSERT_EQ(Element::string, result->getType());
EXPECT_EQ("////", result->stringValue());
}
/// @brief Load a file into a JSON element.
///
/// @param fname The name of the file to load.
/// @param list The JSON element list to add the parsing result to.
void loadFile(const string& fname, ElementPtr list) {
ParserContext ctx;
ElementPtr json;
EXPECT_NO_THROW_LOG(json = ctx.parseFile(fname, ParserContext::PARSER_NETCONF));
ASSERT_TRUE(json);
list->add(json);
}
// This test checks that all map entries are in the sample file.
TEST(ParserTest, mapEntries) {
// Type of keyword set.
using KeywordSet = set<string>;
// Get keywords from the syntax file (netconf_parser.yy).
ifstream syntax_file(SYNTAX_FILE);
EXPECT_TRUE(syntax_file.is_open());
string line;
KeywordSet syntax_keys = { "user-context" };
// Code setting the map entry.
const string pattern = "ctx.stack_.back()->set(\"";
while (getline(syntax_file, line)) {
// Skip comments.
size_t comment = line.find("//");
if (comment <= pattern.size()) {
continue;
}
if (comment != string::npos) {
line.resize(comment);
}
// Search for the code pattern.
size_t key_begin = line.find(pattern);
if (key_begin == string::npos) {
continue;
}
// Extract keywords.
line = line.substr(key_begin + pattern.size());
size_t key_end = line.find_first_of('"');
EXPECT_NE(string::npos, key_end);
string keyword = line.substr(0, key_end);
// Ignore result when adding the keyword to the syntax keyword set.
static_cast<void>(syntax_keys.insert(keyword));
}
syntax_file.close();
// Get keywords from the sample file
string sample_dir(CFG_EXAMPLES);
sample_dir += "/";
ElementPtr sample_json = Element::createList();
loadFile(sample_dir + "simple-dhcp4.json", sample_json);
loadFile(sample_dir + "simple-dhcp6.json", sample_json);
KeywordSet sample_keys = {
"ca", "d2",
"hooks-libraries", "library", "parameters",
"socket-url"
};
// Recursively extract keywords.
static void (*extract)(ConstElementPtr, KeywordSet&) =
[] (ConstElementPtr json, KeywordSet& set) {
if (json->getType() == Element::list) {
// Handle lists.
for (auto elem : json->listValue()) {
extract(elem, set);
}
} else if (json->getType() == Element::map) {
// Handle maps.
for (auto elem : json->mapValue()) {
static_cast<void>(set.insert(elem.first));
// Skip entries with free content.
if ((elem.first != "user-context") &&
(elem.first != "parameters")) {
extract(elem.second, set);
}
}
}
};
extract(sample_json, sample_keys);
// Compare.
EXPECT_EQ(syntax_keys, sample_keys);
}
/// @brief Tests a duplicate entry.
///
/// The entry was duplicated by adding a new <name>DDDD entry.
/// An error is expected, usually it is a duplicate but there are
/// a few syntax errors when the syntax allows only one parameter.
///
/// @param json the JSON configuration with the duplicate entry.
void testDuplicate(ConstElementPtr json) {
string config = json->str();
SCOPED_TRACE("\n* Tested config: \n---\n" + json->str() + "\n---");
size_t where = config.find("DDDD");
ASSERT_NE(string::npos, where);
string before = config.substr(0, where);
string after = config.substr(where + 4, string::npos);
ParserContext ctx;
EXPECT_THROW(ctx.parseString(before + after, ParserContext::PARSER_NETCONF), ParseError);
}
// This test checks that duplicate entries make parsing to fail.
TEST(ParserTest, duplicateMapEntries) {
// Get the config to work with from the sample file.
string sample_fname(CFG_EXAMPLES);
sample_fname += "/simple-dhcp6.json";
ParserContext ctx;
ElementPtr sample_json;
EXPECT_NO_THROW_LOG(sample_json =
ctx.parseFile(sample_fname, ParserContext::PARSER_NETCONF));
ASSERT_TRUE(sample_json);
// Recursively check duplicates.
static void (*test)(ElementPtr, ElementPtr, size_t&) =
[] (ElementPtr config, ElementPtr json, size_t& cnt) {
if (json->getType() == Element::list) {
// Handle lists.
for (auto elem : json->listValue()) {
test(config, elem, cnt);
}
} else if (json->getType() == Element::map) {
// Handle maps.
for (auto elem : json->mapValue()) {
// Skip entries with free content.
if ((elem.first == "user-context") ||
(elem.first == "parameters")) {
continue;
}
SCOPED_TRACE("\n* Tested duplicate element: " + elem.first);
// Perform tests.
string dup = elem.first + "DDDD";
json->set(dup, elem.second);
testDuplicate(config);
json->remove(dup);
++cnt;
// Recursive call.
ElementPtr mutable_json =
boost::const_pointer_cast<Element>(elem.second);
ASSERT_TRUE(mutable_json);
test(config, mutable_json, cnt);
}
}
};
size_t cnt = 0;
test(sample_json, sample_json, cnt);
cout << "Checked " << cnt << " duplicated map entries.\n";
}
/// @brief Test fixture for trailing commas.
class TrailingCommasTest : public isc::dhcp::test::LogContentTest {
public:
/// @brief Add a log entry.
///
/// @param loc Location of the trailing comma.
void addLog(const string& loc) {
string log = "NETCONF_CONFIG_SYNTAX_WARNING NETCONF ";
log += "configuration syntax warning: " + loc;
log += ": Extraneous comma. ";
log += "A piece of configuration may have been omitted.";
addString(log);
}
}; // TrailingCommasTest
// Test that trailing commas are allowed.
TEST_F(TrailingCommasTest, tests) {
string txt(R"({
"Netconf": {
"boot-update": true,
"loggers": [
{
"name": "kea-netconf",
"severity": "DEBUG",
"debuglevel": 99,
},
],
"managed-servers": {
"dhcp4": {
"control-socket": {
"socket-name": "/tmp/kea-dhcp4-ctrl.sock",
"socket-type": "unix",
},
"model": "kea-dhcp4-server",
},
"dhcp6": {
"control-socket": {
"socket-name": "/tmp/kea-dhcp6-ctrl.sock",
"socket-type": "unix",
},
"model": "kea-dhcp6-server",
},
},
"subscribe-changes": true,
"validate-changes": true,
},
})");
testParser(txt, ParserContext::PARSER_NETCONF, false);
addLog("<string>:8.25");
addLog("<string>:9.8");
addLog("<string>:15.32");
addLog("<string>:17.36");
addLog("<string>:22.32");
addLog("<string>:24.36");
addLog("<string>:25.8");
addLog("<string>:28.29");
addLog("<string>:29.4");
EXPECT_TRUE(checkFile());
// Test with many consecutive commas.
boost::replace_all(txt, ",", ",,,,");
testParser(txt, ParserContext::PARSER_NETCONF, false);
}
} // namespace test
} // namespace netconf
} // namespace isc
|