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
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
|
#!/usr/bin/env python3
#
# Copyright (C) 2018-present MongoDB, Inc.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the Server Side Public License, version 1,
# as published by MongoDB, Inc.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# Server Side Public License for more details.
#
# You should have received a copy of the Server Side Public License
# along with this program. If not, see
# <http://www.mongodb.com/licensing/server-side-public-license>.
#
# As a special exception, the copyright holders give permission to link the
# code of portions of this program with the OpenSSL library under certain
# conditions as described in each individual source file and distribute
# linked combinations including the program with the OpenSSL library. You
# must comply with the Server Side Public License in all respects for
# all of the code used other than as permitted herein. If you modify file(s)
# with this exception, you may extend this exception to your version of the
# file(s), but you are not obligated to do so. If you do not wish to do so,
# delete this exception statement from your version. If you delete this
# exception statement from all source files in the program, then also delete
# it in the license file.
#
"""Test cases for IDL parser."""
# pylint: disable=too-many-lines
import textwrap
import unittest
# import package so that it works regardless of whether we run as a module or file
if __package__ is None:
import sys
from os import path
sys.path.append(path.dirname(path.abspath(__file__)))
from context import idl
import testcase
else:
from .context import idl
from . import testcase
class TestParser(testcase.IDLTestcase):
# pylint: disable=too-many-public-methods
"""Test the IDL parser only."""
def test_empty(self):
# type: () -> None
"""Test an empty document works."""
self.assert_parse("")
def test_root_negative(self):
# type: () -> None
"""Test unknown root scalar fails."""
self.assert_parse_fail(
textwrap.dedent("""
fake:
cpp_namespace: 'foo'
"""), idl.errors.ERROR_ID_UNKNOWN_ROOT)
def test_global_positive(self):
# type: () -> None
"""Postive global tests."""
# cpp_namespace alone
self.assert_parse(textwrap.dedent("""
global:
cpp_namespace: 'foo'"""))
# cpp_includes scalar
self.assert_parse(textwrap.dedent("""
global:
cpp_includes: 'foo'"""))
# cpp_includes list
self.assert_parse(
textwrap.dedent("""
global:
cpp_includes:
- 'bar'
- 'foo'"""))
def test_global_negative(self):
# type: () -> None
"""Negative global tests."""
# Global is a scalar
self.assert_parse_fail(
textwrap.dedent("""
global: foo
"""), idl.errors.ERROR_ID_IS_NODE_TYPE)
# Duplicate globals
self.assert_parse_fail(
textwrap.dedent("""
global:
cpp_namespace: 'foo'
global:
cpp_namespace: 'bar'
"""), idl.errors.ERROR_ID_DUPLICATE_NODE)
# Duplicate cpp_namespace
self.assert_parse_fail(
textwrap.dedent("""
global:
cpp_namespace: 'foo'
cpp_namespace: 'foo'"""), idl.errors.ERROR_ID_DUPLICATE_NODE)
# Duplicate cpp_includes
self.assert_parse_fail(
textwrap.dedent("""
global:
cpp_includes: 'foo'
cpp_includes: 'foo'"""), idl.errors.ERROR_ID_DUPLICATE_NODE)
# cpp_namespace as a sequence
self.assert_parse_fail(
textwrap.dedent("""
global:
cpp_namespace:
- 'foo'
- 'bar'"""), idl.errors.ERROR_ID_IS_NODE_TYPE)
# cpp_namespace as a map
self.assert_parse_fail(
textwrap.dedent("""
global:
cpp_namespace:
name: 'foo'"""), idl.errors.ERROR_ID_IS_NODE_TYPE)
# cpp_includes as a map
self.assert_parse_fail(
textwrap.dedent("""
global:
cpp_includes:
inc1: 'foo'"""), idl.errors.ERROR_ID_IS_NODE_TYPE_SCALAR_OR_SEQUENCE)
# cpp_includes as a sequence of tuples
self.assert_parse_fail(
textwrap.dedent("""
global:
cpp_includes:
- inc1: 'foo'"""), idl.errors.ERROR_ID_IS_NODE_TYPE)
# Unknown scalar
self.assert_parse_fail(
textwrap.dedent("""
global:
bar: 'foo'
"""), idl.errors.ERROR_ID_UNKNOWN_NODE)
def test_type_positive(self):
# type: () -> None
"""Positive type test cases."""
# Test all positive fields works
self.assert_parse(
textwrap.dedent("""
types:
foo:
description: foo
cpp_type: foo
bson_serialization_type: foo
serializer: foo
deserializer: foo
default: foo
bindata_subtype: foo
"""))
# Test sequence of bson serialization types
self.assert_parse(
textwrap.dedent("""
types:
foo:
description: foo
cpp_type: foo
bson_serialization_type:
- foo
- bar
"""))
def test_type_negative(self):
# type: () -> None
"""Negative type test cases."""
# Test duplicate types
self.assert_parse_fail(
textwrap.dedent("""
types:
foo:
description: test
cpp_type: foo
bson_serialization_type: int
types:
bar:
description: test
cpp_type: foo
bson_serialization_type: int
"""), idl.errors.ERROR_ID_DUPLICATE_NODE)
# Test scalar fails
self.assert_parse_fail(
textwrap.dedent("""
types:
foo: 'bar'"""), idl.errors.ERROR_ID_IS_NODE_TYPE)
# Test unknown field
self.assert_parse_fail(
textwrap.dedent("""
types:
foo:
bogus: foo
description: test
cpp_type: foo
bson_serialization_type:
"""), idl.errors.ERROR_ID_UNKNOWN_NODE)
# test duplicate field
self.assert_parse_fail(
textwrap.dedent("""
types:
foo:
description: foo
description: test
cpp_type: foo
bson_serialization_type:
"""), idl.errors.ERROR_ID_DUPLICATE_NODE)
# test list instead of scalar
self.assert_parse_fail(
textwrap.dedent("""
types:
- foo:
"""), idl.errors.ERROR_ID_IS_NODE_TYPE, multiple=True)
# test list instead of scalar
self.assert_parse_fail(
textwrap.dedent("""
types:
foo:
- bar
"""), idl.errors.ERROR_ID_IS_NODE_TYPE, multiple=True)
# test map instead of scalar
self.assert_parse_fail(
textwrap.dedent("""
types:
foo:
description:
foo: bar
"""), idl.errors.ERROR_ID_IS_NODE_TYPE, multiple=True)
# test missing bson_serialization_type field
self.assert_parse_fail(
textwrap.dedent("""
types:
foo:
description: foo
cpp_type: foo
"""), idl.errors.ERROR_ID_MISSING_REQUIRED_FIELD)
# test missing cpp_type field
self.assert_parse_fail(
textwrap.dedent("""
types:
foo:
description: foo
bson_serialization_type: foo
"""), idl.errors.ERROR_ID_MISSING_REQUIRED_FIELD)
def test_struct_positive(self):
# type: () -> None
"""Positive struct test cases."""
# All fields with true for bools
self.assert_parse(
textwrap.dedent("""
structs:
foo:
description: foo
strict: true
immutable: true
inline_chained_structs: true
generate_comparison_operators: true
fields:
foo: bar
"""))
# All fields with false for bools
self.assert_parse(
textwrap.dedent("""
structs:
foo:
description: foo
strict: false
immutable: false
inline_chained_structs: false
generate_comparison_operators: false
fields:
foo: bar
"""))
# Missing fields
self.assert_parse(
textwrap.dedent("""
structs:
foo:
description: foo
strict: true
"""))
def test_struct_negative(self):
# type: () -> None
"""Negative struct test cases."""
# Struct as a scalar
self.assert_parse_fail(
textwrap.dedent("""
structs:
foo: foo
"""), idl.errors.ERROR_ID_IS_NODE_TYPE)
# unknown field
self.assert_parse_fail(
textwrap.dedent("""
structs:
foo:
description: foo
foo: bar
fields:
foo: bar
"""), idl.errors.ERROR_ID_UNKNOWN_NODE)
# strict is a bool
self.assert_parse_fail(
textwrap.dedent("""
structs:
foo:
description: foo
strict: bar
fields:
foo: bar
"""), idl.errors.ERROR_ID_IS_NODE_VALID_BOOL)
# immutable is a bool
self.assert_parse_fail(
textwrap.dedent("""
structs:
foo:
description: foo
immutable: bar
fields:
foo: bar
"""), idl.errors.ERROR_ID_IS_NODE_VALID_BOOL)
# inline_chained_structs is a bool
self.assert_parse_fail(
textwrap.dedent("""
structs:
foo:
description: foo
inline_chained_structs: bar
fields:
foo: bar
"""), idl.errors.ERROR_ID_IS_NODE_VALID_BOOL)
# generate_comparison_operators is a bool
self.assert_parse_fail(
textwrap.dedent("""
structs:
foo:
description: foo
generate_comparison_operators: bar
fields:
foo: bar
"""), idl.errors.ERROR_ID_IS_NODE_VALID_BOOL)
# cpp_name is not allowed
self.assert_parse_fail(
textwrap.dedent("""
structs:
foo:
description: foo
cpp_name: bar
fields:
foo: bar
"""), idl.errors.ERROR_ID_UNKNOWN_NODE)
def test_field_positive(self):
# type: () -> None
"""Positive field test cases."""
# Test short types
self.assert_parse(
textwrap.dedent("""
structs:
foo:
description: foo
fields:
foo: short
"""))
# Test all fields
self.assert_parse(
textwrap.dedent("""
structs:
foo:
description: foo
fields:
foo:
type: foo
description: foo
optional: true
ignore: true
cpp_name: bar
comparison_order: 3
"""))
# Test false bools
self.assert_parse(
textwrap.dedent("""
structs:
foo:
description: foo
strict: false
fields:
foo:
type: string
optional: false
ignore: false
"""))
def test_field_negative(self):
# type: () -> None
"""Negative field test cases."""
# Test duplicate fields
self.assert_parse_fail(
textwrap.dedent("""
structs:
foo:
description: foo
strict: false
fields:
foo: short
foo: int
"""), idl.errors.ERROR_ID_DUPLICATE_NODE)
# Test bad bool
self.assert_parse_fail(
textwrap.dedent("""
structs:
foo:
description: foo
strict: false
fields:
foo:
type: string
optional: bar
"""), idl.errors.ERROR_ID_IS_NODE_VALID_BOOL)
# Test bad bool
self.assert_parse_fail(
textwrap.dedent("""
structs:
foo:
description: foo
strict: false
fields:
foo:
type: string
ignore: bar
"""), idl.errors.ERROR_ID_IS_NODE_VALID_BOOL)
# Test bad int scalar
self.assert_parse_fail(
textwrap.dedent("""
structs:
foo:
description: foo
strict: false
fields:
foo:
type: string
comparison_order:
- a
- b
"""), idl.errors.ERROR_ID_IS_NODE_TYPE)
# Test bad int
self.assert_parse_fail(
textwrap.dedent("""
structs:
foo:
description: foo
strict: false
fields:
foo:
type: string
comparison_order: 3.14159
"""), idl.errors.ERROR_ID_IS_NODE_VALID_INT)
# Test bad negative int
self.assert_parse_fail(
textwrap.dedent("""
structs:
foo:
description: foo
strict: false
fields:
foo:
type: string
comparison_order: -1
"""), idl.errors.ERROR_ID_IS_NODE_VALID_NON_NEGATIVE_INT)
def test_name_collisions_negative(self):
# type: () -> None
"""Negative tests for type collisions."""
# Struct after type
self.assert_parse_fail(
textwrap.dedent("""
types:
foo1:
description: foo
cpp_type: foo
bson_serialization_type: string
serializer: foo
deserializer: foo
default: foo
structs:
foo1:
description: foo
strict: true
fields:
foo: string
"""), idl.errors.ERROR_ID_DUPLICATE_SYMBOL)
# Type after struct
self.assert_parse_fail(
textwrap.dedent("""
structs:
foo1:
description: foo
strict: true
fields:
foo: string
types:
foo1:
description: foo
cpp_type: foo
bson_serialization_type: string
serializer: foo
deserializer: foo
default: foo
"""), idl.errors.ERROR_ID_DUPLICATE_SYMBOL)
def test_chained_type_positive(self):
# type: () -> None
"""Positive parser chaining test cases."""
self.assert_parse(
textwrap.dedent("""
structs:
foo1:
description: foo
chained_types:
foo1: alias
foo2: alias
"""))
def test_chained_type_negative(self):
# type: () -> None
"""Negative parser chaining test cases."""
self.assert_parse_fail(
textwrap.dedent("""
structs:
foo1:
description: foo
chained_types: foo1
fields:
foo: bar
"""), idl.errors.ERROR_ID_IS_NODE_TYPE)
self.assert_parse_fail(
textwrap.dedent("""
structs:
foo1:
description: foo
chained_types:
- foo1
fields:
foo: bar
"""), idl.errors.ERROR_ID_IS_NODE_TYPE)
# Duplicate chained types
self.assert_parse_fail(
textwrap.dedent("""
structs:
bar1:
description: foo
strict: false
chained_types:
foo1: alias
foo1: alias
"""), idl.errors.ERROR_ID_DUPLICATE_NODE)
def test_chained_struct_positive(self):
# type: () -> None
"""Positive parser chaining test cases."""
self.assert_parse(
textwrap.dedent("""
structs:
foo1:
description: foo
chained_structs:
foo1: foo1_cpp
foo2: foo2_cpp
"""))
def test_chained_struct_negative(self):
# type: () -> None
"""Negative parser chaining test cases."""
self.assert_parse_fail(
textwrap.dedent("""
structs:
foo1:
description: foo
chained_structs: foo1
fields:
foo: bar
"""), idl.errors.ERROR_ID_IS_NODE_TYPE)
self.assert_parse_fail(
textwrap.dedent("""
structs:
foo1:
description: foo
chained_structs:
- foo1
fields:
foo: bar
"""), idl.errors.ERROR_ID_IS_NODE_TYPE)
# Duplicate chained structs
self.assert_parse_fail(
textwrap.dedent("""
structs:
bar1:
description: foo
strict: true
chained_structs:
chained: alias
chained: alias
"""), idl.errors.ERROR_ID_DUPLICATE_NODE)
def test_enum_positive(self):
# type: () -> None
"""Positive enum test cases."""
# Test all positive fields works
self.assert_parse(
textwrap.dedent("""
enums:
foo:
description: foo
type: foo
values:
v1: 0
"""))
def test_enum_negative(self):
# type: () -> None
"""Negative enum test cases."""
# Test duplicate enums
self.assert_parse_fail(
textwrap.dedent("""
enums:
foo:
description: test
type: int
values:
v1: 0
foo:
description: test
type: int
values:
v1: 0
"""), idl.errors.ERROR_ID_DUPLICATE_SYMBOL)
# Test scalar fails
self.assert_parse_fail(
textwrap.dedent("""
enums:
foo: 'bar'"""), idl.errors.ERROR_ID_IS_NODE_TYPE)
# Test unknown field
self.assert_parse_fail(
textwrap.dedent("""
enums:
foo:
bogus: foo
description: foo
type: foo
values:
v1: 0
"""), idl.errors.ERROR_ID_UNKNOWN_NODE)
# test duplicate field
self.assert_parse_fail(
textwrap.dedent("""
enums:
foo:
description: foo
description: test
type: foo
values:
v1: 0
"""), idl.errors.ERROR_ID_DUPLICATE_NODE)
# test list instead of scalar
self.assert_parse_fail(
textwrap.dedent("""
enums:
- foo:
"""), idl.errors.ERROR_ID_IS_NODE_TYPE, multiple=True)
# test list instead of scalar
self.assert_parse_fail(
textwrap.dedent("""
enums:
foo:
- bar
"""), idl.errors.ERROR_ID_IS_NODE_TYPE, multiple=True)
# test missing type field
self.assert_parse_fail(
textwrap.dedent("""
enums:
foo:
description: foo
values:
v1: 0
"""), idl.errors.ERROR_ID_MISSING_REQUIRED_FIELD)
# test missing values field
self.assert_parse_fail(
textwrap.dedent("""
enums:
foo:
description: foo
type: foo
"""), idl.errors.ERROR_ID_BAD_EMPTY_ENUM)
# Test no values
self.assert_parse_fail(
textwrap.dedent("""
enums:
foo:
description: foo
type: int
"""), idl.errors.ERROR_ID_BAD_EMPTY_ENUM)
# Name collision with types
self.assert_parse_fail(
textwrap.dedent("""
types:
foo:
description: foo
cpp_type: foo
bson_serialization_type: string
serializer: foo
deserializer: foo
default: foo
enums:
foo:
description: foo
type: foo
values:
v1: 0
"""), idl.errors.ERROR_ID_DUPLICATE_SYMBOL)
# Name collision with structs
self.assert_parse_fail(
textwrap.dedent("""
types:
string:
description: foo
cpp_type: foo
bson_serialization_type: string
serializer: foo
deserializer: foo
default: foo
structs:
foo:
description: foo
strict: true
fields:
foo: string
enums:
foo:
description: foo
type: foo
values:
v1: 0
"""), idl.errors.ERROR_ID_DUPLICATE_SYMBOL)
# Test int - duplicate names
self.assert_parse_fail(
textwrap.dedent("""
enums:
foo:
description: foo
type: int
values:
v1: 0
v1: 1
"""), idl.errors.ERROR_ID_DUPLICATE_NODE)
def test_command_positive(self):
# type: () -> None
"""Positive command test cases."""
# All fields with true for bools
self.assert_parse(
textwrap.dedent("""
commands:
foo:
description: foo
strict: true
command_name: foo
namespace: ignored
api_version: 1
is_deprecated: true
unstable: true
immutable: true
inline_chained_structs: true
generate_comparison_operators: true
cpp_name: foo
fields:
foo: bar
reply_type: foo_reply_struct
"""))
# All fields with false for bools, except strict
self.assert_parse(
textwrap.dedent("""
commands:
foo:
description: foo
command_name: foo
strict: true
namespace: ignored
api_version: 1
is_deprecated: false
unstable: false
immutable: false
inline_chained_structs: false
generate_comparison_operators: false
fields:
foo: bar
reply_type: foo_reply_struct
"""))
# All fields with false for bools, no api_version
self.assert_parse(
textwrap.dedent("""
commands:
foo:
description: foo
command_name: foo
strict: false
namespace: ignored
is_deprecated: false
forward_to_shards: false
forward_from_shards: false
immutable: false
inline_chained_structs: false
generate_comparison_operators: false
fields:
foo: bar
reply_type: foo_reply_struct
"""))
# Quoted api_version
self.assert_parse(
textwrap.dedent("""
commands:
foo:
description: foo
command_name: foo
namespace: ignored
api_version: "1"
fields:
foo: bar
reply_type: foo_reply_struct
"""))
# Namespace ignored
self.assert_parse(
textwrap.dedent("""
commands:
foo:
description: foo
command_name: foo
namespace: ignored
fields:
foo: bar
"""))
# Namespace concatenate_with_db
self.assert_parse(
textwrap.dedent("""
commands:
foo:
description: foo
command_name: foo
namespace: concatenate_with_db
fields:
foo: bar
"""))
# No fields
self.assert_parse(
textwrap.dedent("""
commands:
foo:
description: foo
command_name: foo
namespace: ignored
strict: true
"""))
# Reply type permitted without api_version
self.assert_parse(
textwrap.dedent("""
commands:
foo:
description: foo
command_name: foo
namespace: ignored
reply_type: foo_reply_struct
"""))
def test_command_negative(self):
# type: () -> None
"""Negative command test cases."""
# Command as a scalar
self.assert_parse_fail(
textwrap.dedent("""
commands:
foo: foo
"""), idl.errors.ERROR_ID_IS_NODE_TYPE)
# unknown field
self.assert_parse_fail(
textwrap.dedent("""
commands:
foo:
description: foo
command_name: foo
namespace: ignored
foo: bar
fields:
foo: bar
"""), idl.errors.ERROR_ID_UNKNOWN_NODE)
# strict is a bool
self.assert_parse_fail(
textwrap.dedent("""
commands:
foo:
description: foo
command_name: foo
strict: bar
namespace: ignored
fields:
foo: bar
"""), idl.errors.ERROR_ID_IS_NODE_VALID_BOOL)
# command_name is required
self.assert_parse_fail(
textwrap.dedent("""
commands:
foo:
description: foo
namespace: ignored
fields:
foo: bar
"""), idl.errors.ERROR_ID_MISSING_REQUIRED_FIELD)
# command_name is a scalar
self.assert_parse_fail(
textwrap.dedent("""
commands:
foo:
description: foo
command_name: [1]
namespace: ignored
fields:
foo: bar
"""), idl.errors.ERROR_ID_IS_NODE_TYPE, True)
self.assert_parse_fail(
textwrap.dedent("""
commands:
foo:
description: foo
command_name: ["1"]
namespace: ignored
fields:
foo: bar
"""), idl.errors.ERROR_ID_IS_NODE_TYPE, True)
# is_deprecated is a bool
self.assert_parse_fail(
textwrap.dedent("""
commands:
foo:
description: foo
command_name: foo
namespace: ignored
is_deprecated: bar
fields:
foo: bar
"""), idl.errors.ERROR_ID_IS_NODE_VALID_BOOL)
# api_version is a scalar
self.assert_parse_fail(
textwrap.dedent("""
commands:
foo:
description: foo
command_name: foo
namespace: ignored
api_version: [1]
fields:
foo: bar
reply_type: foo_reply_struct
"""), idl.errors.ERROR_ID_IS_NODE_TYPE)
self.assert_parse_fail(
textwrap.dedent("""
commands:
foo:
description: foo
command_name: foo
namespace: ignored
api_version: ["1"]
fields:
foo: bar
reply_type: foo_reply_struct
"""), idl.errors.ERROR_ID_IS_NODE_TYPE)
# strict:true required if api_version set
self.assert_parse_fail(
textwrap.dedent("""
commands:
foo:
description: foo
command_name: foo
namespace: ignored
api_version: "1"
strict: false
fields:
foo: bar
reply_type: foo_reply_struct
"""), idl.errors.ERROR_ID_API_VERSION_NO_STRICT)
# Cannot specify unstable with empty api_version
self.assert_parse_fail(
textwrap.dedent("""
commands:
foo:
description: foo
command_name: foo
namespace: ignored
api_version: ""
unstable: true
fields:
foo: bar
reply_type: foo_reply_struct
"""), idl.errors.ERROR_ID_UNSTABLE_NO_API_VERSION)
self.assert_parse_fail(
textwrap.dedent("""
commands:
foo:
description: foo
command_name: foo
namespace: ignored
api_version: ""
unstable: false
fields:
foo: bar
reply_type: foo_reply_struct
"""), idl.errors.ERROR_ID_UNSTABLE_NO_API_VERSION)
# Cannot specify unstable without an api_version
self.assert_parse_fail(
textwrap.dedent("""
commands:
foo:
description: foo
command_name: foo
namespace: ignored
unstable: true
fields:
foo: bar
"""), idl.errors.ERROR_ID_UNSTABLE_NO_API_VERSION)
self.assert_parse_fail(
textwrap.dedent("""
commands:
foo:
description: foo
command_name: foo
namespace: ignored
unstable: false
fields:
foo: bar
"""), idl.errors.ERROR_ID_UNSTABLE_NO_API_VERSION)
# Must specify reply_type if api_version is non-empty
self.assert_parse_fail(
textwrap.dedent("""
commands:
foo:
description: foo
command_name: foo
namespace: ignored
api_version: 1
fields:
foo: bar
"""), idl.errors.ERROR_ID_MISSING_REPLY_TYPE)
# Namespace is required
self.assert_parse_fail(
textwrap.dedent("""
commands:
foo:
description: foo
command_name: foo
fields:
foo: bar
"""), idl.errors.ERROR_ID_MISSING_REQUIRED_FIELD)
# Namespace is wrong
self.assert_parse_fail(
textwrap.dedent("""
commands:
foo:
description: foo
command_name: foo
namespace: foo
fields:
foo: bar
"""), idl.errors.ERROR_ID_BAD_COMMAND_NAMESPACE)
# Setup some common types
test_preamble = textwrap.dedent("""
types:
string:
description: foo
cpp_type: foo
bson_serialization_type: string
serializer: foo
deserializer: foo
default: foo
""")
# Commands and structs with same name
self.assert_parse_fail(
test_preamble + textwrap.dedent("""
commands:
foo:
description: foo
command_name: foo
namespace: ignored
fields:
foo: string
structs:
foo:
description: foo
fields:
foo: foo
"""), idl.errors.ERROR_ID_DUPLICATE_SYMBOL)
# Commands and types with same name
self.assert_parse_fail(
test_preamble + textwrap.dedent("""
commands:
string:
description: foo
command_name: foo
namespace: ignored
strict: true
fields:
foo: string
"""), idl.errors.ERROR_ID_DUPLICATE_SYMBOL)
self.assert_parse_fail(
textwrap.dedent("""
commands:
foo:
description: foo
command_name: string
namespace: ignored
strict: true
fields:
foo: string
""") + test_preamble, idl.errors.ERROR_ID_DUPLICATE_SYMBOL)
# Namespace concatenate_with_db
self.assert_parse_fail(
textwrap.dedent("""
commands:
foo:
description: foo
command_name: foo
namespace: concatenate_with_db
type: foobar
fields:
foo: bar
"""), idl.errors.ERROR_ID_IS_COMMAND_TYPE_EXTRANEOUS)
# Reply type must be a scalar, not a mapping
self.assert_parse_fail(
textwrap.dedent("""
commands:
foo:
description: foo
command_name: foo
namespace: ignored
reply_type:
arbitrary_field: foo
"""), idl.errors.ERROR_ID_IS_NODE_TYPE)
def test_command_doc_sequence_positive(self):
# type: () -> None
"""Positive supports_doc_sequence test cases."""
# pylint: disable=invalid-name
# supports_doc_sequence can be false
self.assert_parse(
textwrap.dedent("""
commands:
foo:
description: foo
command_name: foo
namespace: ignored
fields:
foo:
type: bar
supports_doc_sequence: false
"""))
# supports_doc_sequence can be true
self.assert_parse(
textwrap.dedent("""
commands:
foo:
description: foo
command_name: foo
namespace: ignored
fields:
foo:
type: bar
supports_doc_sequence: true
"""))
def test_command_doc_sequence_negative(self):
# type: () -> None
"""Negative supports_doc_sequence test cases."""
# pylint: disable=invalid-name
# supports_doc_sequence must be a bool
self.assert_parse_fail(
textwrap.dedent("""
commands:
foo:
description: foo
command_name: foo
namespace: ignored
fields:
foo:
type: bar
supports_doc_sequence: foo
"""), idl.errors.ERROR_ID_IS_NODE_VALID_BOOL)
def test_command_type_positive(self):
# type: () -> None
"""Positive command custom type test cases."""
# string
self.assert_parse(
textwrap.dedent("""
commands:
foo:
description: foo
command_name: foo
strict: true
namespace: type
type: string
fields:
foo: bar
"""))
# array of string
self.assert_parse(
textwrap.dedent("""
commands:
foo:
description: foo
command_name: foo
strict: true
namespace: type
type: array<string>
fields:
foo: bar
"""))
# no fields
self.assert_parse(
textwrap.dedent("""
commands:
foo:
description: foo
command_name: foo
strict: true
namespace: type
type: string
"""))
def test_command_type_negative(self):
# type: () -> None
"""Negative command type test cases."""
# supports_doc_sequence must be a bool
self.assert_parse_fail(
textwrap.dedent("""
commands:
foo:
description: foo
command_name: foo
namespace: type
fields:
foo: bar
"""), idl.errors.ERROR_ID_MISSING_REQUIRED_FIELD)
def test_scalar_or_mapping_negative(self):
# type: () -> None
"""Negative test for scalar_or_mapping type."""
# Test for scalar_or_mapping with a sequence.
self.assert_parse_fail(
textwrap.dedent("""
server_parameters:
foo:
set_at: startup
description: bar
cpp_varname: baz
default:
- one
- two
"""), idl.errors.ERROR_ID_IS_NODE_TYPE_SCALAR_OR_MAPPING)
def test_feature_flag(self):
# type: () -> None
"""Test feature flag."""
# Missing default
self.assert_parse_fail(
textwrap.dedent("""
feature_flags:
featureFlagToaster:
description: "Make toast"
cpp_varname: gToaster
"""), idl.errors.ERROR_ID_MISSING_REQUIRED_FIELD)
def _test_field_list(self, field_list_name, should_forward_name):
# type: (str, str) -> None
"""Positive field list test cases."""
# Generic field with no options
self.assert_parse(
textwrap.dedent(f"""
{field_list_name}:
foo:
description: foo
fields:
foo: {{}}
"""))
# All fields with true for bools
self.assert_parse(
textwrap.dedent(f"""
{field_list_name}:
foo:
description: foo
fields:
foo:
{should_forward_name}: true
"""))
# All fields with false for bools
self.assert_parse(
textwrap.dedent(f"""
{field_list_name}:
foo:
description: foo
fields:
foo:
{should_forward_name}: false
"""))
# cpp_name.
self.assert_parse(
textwrap.dedent(f"""
{field_list_name}:
foo:
description: foo
cpp_name: foo
fields:
foo: {{}}
"""))
def _test_field_list_negative(self, field_list_name, should_forward_name):
# type: (str, str) -> None
"""Negative field list test cases."""
# Field list as a scalar
self.assert_parse_fail(
textwrap.dedent(f"""
{field_list_name}:
foo: 1
"""), idl.errors.ERROR_ID_IS_NODE_TYPE)
# No description
self.assert_parse_fail(
textwrap.dedent(f"""
{field_list_name}:
foo:
fields:
foo: {{}}
"""), idl.errors.ERROR_ID_MISSING_REQUIRED_FIELD)
# Unknown option
self.assert_parse_fail(
textwrap.dedent(f"""
{field_list_name}:
foo:
description: foo
foo: bar
fields:
foo: {{}}
"""), idl.errors.ERROR_ID_UNKNOWN_NODE)
# forward_to_shards is a bool.
self.assert_parse_fail(
textwrap.dedent(f"""
{field_list_name}:
foo:
description: foo
fields:
foo:
{should_forward_name}: asdf
"""), idl.errors.ERROR_ID_IS_NODE_VALID_BOOL)
# forward_from_shards is a bool
self.assert_parse_fail(
textwrap.dedent(f"""
{field_list_name}:
foo:
description: foo
fields:
foo:
{should_forward_name}: asdf
"""), idl.errors.ERROR_ID_IS_NODE_VALID_BOOL)
def test_generic_arguments_list(self):
# type: () -> None
"""Positive generic argument list test cases."""
self._test_field_list("generic_argument_lists", "forward_to_shards")
def test_generic_arguments_list_negative(self):
# type: () -> None
"""Negative generic argument list test cases."""
self._test_field_list_negative("generic_argument_lists", "forward_to_shards")
def test_generic_reply_fields_list(self):
# type: () -> None
"""Positive generic reply fields list test cases."""
self._test_field_list("generic_reply_field_lists", "forward_from_shards")
def test_generic_reply_fields_list_negative(self):
# type: () -> None
"""Negative generic reply fields list test cases."""
self._test_field_list_negative("generic_reply_field_lists", "forward_from_shards")
if __name__ == '__main__':
unittest.main()
|