forked from dropbox/stone
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest_stone.py
More file actions
executable file
·4418 lines (3604 loc) · 135 KB
/
test_stone.py
File metadata and controls
executable file
·4418 lines (3604 loc) · 135 KB
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
#!/usr/bin/env python
from __future__ import absolute_import, division, print_function, unicode_literals
# pylint: disable=deprecated-method,useless-suppression
import datetime
import textwrap
import unittest
from stone.frontend.ast import (
AstNamespace,
AstAlias,
AstVoidField,
AstTagRef,
)
from stone.frontend.exception import InvalidSpec
from stone.frontend.frontend import specs_to_ir
from stone.frontend.parser import ParserFactory
from stone.ir import (
Alias,
is_boolean_type,
is_integer_type,
is_void_type,
Nullable,
RedactedBlot,
RedactedHash,
String,
Map
)
class TestStone(unittest.TestCase):
"""
Tests the Stone format.
"""
def setUp(self):
self.parser_factory = ParserFactory(debug=False)
def test_namespace_decl(self):
text = textwrap.dedent("""\
namespace files
""")
out = self.parser_factory.get_parser().parse(text)
self.assertIsInstance(out[0], AstNamespace)
self.assertEqual(out[0].name, 'files')
# test starting with newlines
text = textwrap.dedent("""\
namespace files
""")
out = self.parser_factory.get_parser().parse(text)
self.assertIsInstance(out[0], AstNamespace)
self.assertEqual(out[0].name, 'files')
def test_comments(self):
text = textwrap.dedent("""\
# comment at top
namespace files
# another full line comment
alias Rev = String # partial line comment
struct S # comment before INDENT
"Doc"
# inner comment
f1 UInt64 # partial line comment
# f2 UInt64
# trailing comment
struct S2 # struct def following comment
# start with comment
f1 String # end with partial-line comment
# footer comment
""")
out = self.parser_factory.get_parser().parse(text)
self.assertIsInstance(out[0], AstNamespace)
self.assertIsInstance(out[1], AstAlias)
self.assertEqual(out[2].name, 'S')
self.assertEqual(out[3].name, 'S2')
def test_line_continuations(self):
line_continuation_err = 'Line continuation must increment indent by 1.'
# Test continuation in various contexts
text = textwrap.dedent("""\
namespace test
alias U64 = UInt64(
min_value=0, max_value=10)
struct S
val UInt64(
min_value=0,
max_value=10)
val2 UInt64(
# this
# is
# a
min_value=0
# stress
# test
)
route r(
S,
S,
S
)
"Test route."
""")
specs_to_ir([('test.stone', text)])
# Try over indenting
text = textwrap.dedent("""\
namespace test
struct S
val UInt64(
# comment to throw it off
min_value=0)
""")
with self.assertRaises(InvalidSpec) as cm:
specs_to_ir([('test.stone', text)])
self.assertEqual(line_continuation_err, cm.exception.msg)
self.assertEqual(cm.exception.lineno, 6)
# Try under indenting
text = textwrap.dedent("""\
namespace test
struct S
val UInt64(
# comment to throw it off
# x2
min_value=0)
""")
with self.assertRaises(InvalidSpec) as cm:
specs_to_ir([('test.stone', text)])
self.assertEqual(line_continuation_err, cm.exception.msg)
self.assertEqual(cm.exception.lineno, 7)
def test_type_args(self):
text = textwrap.dedent("""\
namespace test
alias T = String(min_length=3)
alias F = Float64(max_value=3.2e1)
alias Numbers = List(UInt64)
""")
out = self.parser_factory.get_parser().parse(text)
self.assertIsInstance(out[1], AstAlias)
self.assertEqual(out[1].name, 'T')
self.assertEqual(out[1].type_ref.name, 'String')
self.assertEqual(out[1].type_ref.args[1]['min_length'], 3)
self.assertIsInstance(out[2], AstAlias)
self.assertEqual(out[2].name, 'F')
self.assertEqual(out[2].type_ref.name, 'Float64')
self.assertEqual(out[2].type_ref.args[1]['max_value'], 3.2e1)
self.assertIsInstance(out[3], AstAlias)
self.assertEqual(out[3].name, 'Numbers')
self.assertEqual(out[3].type_ref.name, 'List')
self.assertEqual(out[3].type_ref.args[0][0].name, 'UInt64')
def test_struct_decl(self):
# test struct decl with no docs
text = textwrap.dedent("""\
namespace files
struct QuotaInfo
quota UInt64
""")
out = self.parser_factory.get_parser().parse(text)
self.assertEqual(out[1].name, 'QuotaInfo')
self.assertEqual(out[1].fields[0].name, 'quota')
self.assertEqual(out[1].fields[0].type_ref.name, 'UInt64')
# test struct with only a top-level doc
text = textwrap.dedent("""\
namespace files
struct QuotaInfo
"The space quota info for a user."
quota UInt64
""")
out = self.parser_factory.get_parser().parse(text)
self.assertEqual(out[1].name, 'QuotaInfo')
self.assertEqual(out[1].doc, 'The space quota info for a user.')
self.assertEqual(out[1].fields[0].name, 'quota')
self.assertEqual(out[1].fields[0].type_ref.name, 'UInt64')
# test struct with field doc
text = textwrap.dedent("""\
namespace files
struct QuotaInfo
"The space quota info for a user."
quota UInt64
"The user's total quota allocation (bytes)."
""")
out = self.parser_factory.get_parser().parse(text)
self.assertEqual(out[1].name, 'QuotaInfo')
self.assertEqual(out[1].doc, 'The space quota info for a user.')
self.assertEqual(out[1].fields[0].name, 'quota')
self.assertEqual(out[1].fields[0].type_ref.name, 'UInt64')
self.assertEqual(out[1].fields[0].doc, "The user's total quota allocation (bytes).")
# test without newline after field doc
text = textwrap.dedent("""\
namespace files
struct QuotaInfo
"The space quota info for a user."
quota UInt64
"The user's total quota allocation (bytes)."
""")
out = self.parser_factory.get_parser().parse(text)
self.assertEqual(out[1].name, 'QuotaInfo')
self.assertEqual(out[1].doc, 'The space quota info for a user.')
self.assertEqual(out[1].fields[0].name, 'quota')
self.assertEqual(out[1].fields[0].type_ref.name, 'UInt64')
self.assertEqual(out[1].fields[0].doc, "The user's total quota allocation (bytes).")
# test with example
text = textwrap.dedent("""\
namespace files
struct QuotaInfo
"The space quota info for a user."
quota UInt64
"The user's total quota allocation (bytes)."
example default
quota=64000
""")
out = self.parser_factory.get_parser().parse(text)
self.assertEqual(out[1].name, 'QuotaInfo')
self.assertIn('default', out[1].examples)
# test with multiple examples
text = textwrap.dedent("""\
namespace files
struct QuotaInfo
"The space quota info for a user."
quota UInt64
"The user's total quota allocation (bytes)."
example default
quota=2000000000
example pro
quota=100000000000
""")
out = self.parser_factory.get_parser().parse(text)
self.assertEqual(out[1].name, 'QuotaInfo')
self.assertIn('default', out[1].examples)
self.assertIn('pro', out[1].examples)
# test with inheritance
text = textwrap.dedent("""\
namespace test
struct S1
f1 UInt64
struct S2 extends S1
f2 String
""")
out = self.parser_factory.get_parser().parse(text)
self.assertEqual(out[1].name, 'S1')
self.assertEqual(out[2].name, 'S2')
self.assertEqual(out[2].extends.name, 'S1')
# test with defaults
text = textwrap.dedent("""\
namespace ns
struct S
n1 Int32 = -5
n2 Int32 = 5
f1 Float64 = -1.
f2 Float64 = -4.2
f3 Float64 = -5e-3
f4 Float64 = -5.1e-3
""")
out = self.parser_factory.get_parser().parse(text)
self.assertEqual(out[1].name, 'S')
self.assertEqual(out[1].fields[0].name, 'n1')
self.assertTrue(out[1].fields[0].has_default)
self.assertEqual(out[1].fields[0].default, -5)
self.assertEqual(out[1].fields[1].default, 5)
self.assertEqual(out[1].fields[2].default, -1)
self.assertEqual(out[1].fields[3].default, -4.2)
self.assertEqual(out[1].fields[4].default, -5e-3)
self.assertEqual(out[1].fields[5].default, -5.1e-3)
# Try extending nullable type
text = textwrap.dedent("""\
namespace test
struct S
f1 String
struct S2 extends S?
f2 String
""")
with self.assertRaises(InvalidSpec) as cm:
specs_to_ir([('test.stone', text)])
self.assertEqual("Reference cannot be nullable.", cm.exception.msg)
self.assertEqual(cm.exception.lineno, 6)
def test_struct_patch_decl(self):
# test struct patch decl with no docs
text = textwrap.dedent("""\
namespace files
patch struct QuotaInfo
quota UInt64
""")
out = self.parser_factory.get_parser().parse(text)
self.assertEqual(out[1].name, 'QuotaInfo')
self.assertEqual(out[1].fields[0].name, 'quota')
self.assertEqual(out[1].fields[0].type_ref.name, 'UInt64')
# test struct patch with a top-level doc
text = textwrap.dedent("""\
namespace files
patch struct QuotaInfo
"The space quota info for a user."
quota UInt64
""")
out = self.parser_factory.get_parser().parse(text)
msg, lineno, _ = self.parser_factory.get_parser().errors[0]
# Can't parse patch with doc-string.
self.assertEqual(msg, "Unexpected STRING with value 'The " +
"space quota info for a user.'.")
self.assertEqual(lineno, 3)
# test struct patch with field doc
text = textwrap.dedent("""\
namespace files
patch struct QuotaInfo
quota UInt64
"The user's total quota allocation (bytes)."
""")
out = self.parser_factory.get_parser().parse(text)
self.assertEqual(out[1].name, 'QuotaInfo')
self.assertEqual(out[1].fields[0].name, 'quota')
self.assertEqual(out[1].fields[0].type_ref.name, 'UInt64')
self.assertEqual(out[1].fields[0].doc, "The user's total quota allocation (bytes).")
# test with example
text = textwrap.dedent("""\
namespace files
patch struct QuotaInfo
quota UInt64
"The user's total quota allocation (bytes)."
example default
quota=64000
""")
out = self.parser_factory.get_parser().parse(text)
self.assertEqual(out[1].name, 'QuotaInfo')
self.assertIn('default', out[1].examples)
# test with multiple examples
text = textwrap.dedent("""\
namespace files
patch struct QuotaInfo
quota UInt64
"The user's total quota allocation (bytes)."
example default
quota=2000000000
example pro
quota=100000000000
""")
out = self.parser_factory.get_parser().parse(text)
self.assertEqual(out[1].name, 'QuotaInfo')
self.assertIn('default', out[1].examples)
self.assertIn('pro', out[1].examples)
# test with defaults
text = textwrap.dedent("""\
namespace ns
patch struct S
n1 Int32 = -5
n2 Int32 = 5
f1 Float64 = -1.
f2 Float64 = -4.2
f3 Float64 = -5e-3
f4 Float64 = -5.1e-3
""")
out = self.parser_factory.get_parser().parse(text)
self.assertEqual(out[1].name, 'S')
self.assertEqual(out[1].fields[0].name, 'n1')
self.assertTrue(out[1].fields[0].has_default)
self.assertEqual(out[1].fields[0].default, -5)
self.assertEqual(out[1].fields[1].default, 5)
self.assertEqual(out[1].fields[2].default, -1)
self.assertEqual(out[1].fields[3].default, -4.2)
self.assertEqual(out[1].fields[4].default, -5e-3)
self.assertEqual(out[1].fields[5].default, -5.1e-3)
# test no patching enumerated subtype
text = textwrap.dedent("""\
namespace test
struct Resource
union
file File
folder Folder
struct File extends Resource
size UInt64
struct Folder extends Resource
icon String
struct Deleted extends Resource
is_folder Boolean
patch struct Resource
union
deleted Deleted
""")
with self.assertRaises(InvalidSpec) as cm:
specs_to_ir([('test.stone', text)])
self.assertEqual("Unexpected UNION with value 'union'.", cm.exception.msg)
self.assertEqual(cm.exception.lineno, 18)
def test_union_decl(self):
# test union with only symbols
text = textwrap.dedent("""\
namespace files
union Role
"The role a user may have in a shared folder."
owner
"Owner of a file."
viewer
"Read only permission."
editor
"Read and write permission."
""")
out = self.parser_factory.get_parser().parse(text)
self.assertEqual(out[1].name, 'Role')
self.assertEqual(out[1].doc, 'The role a user may have in a shared folder.')
self.assertIsInstance(out[1].fields[0], AstVoidField)
self.assertEqual(out[1].fields[0].name, 'owner')
self.assertIsInstance(out[1].fields[1], AstVoidField)
self.assertEqual(out[1].fields[1].name, 'viewer')
self.assertIsInstance(out[1].fields[2], AstVoidField)
self.assertEqual(out[1].fields[2].name, 'editor')
# TODO: Test a union that includes a struct.
text = textwrap.dedent("""\
namespace files
union Error
A
"Variant A"
B
"Variant B"
""")
self.parser_factory.get_parser().parse(text)
# test with inheritance
text = textwrap.dedent("""\
namespace test
union U1
t1 UInt64
union U2 extends U1
t2 String
""")
out = self.parser_factory.get_parser().parse(text)
self.assertEqual(out[1].name, 'U1')
self.assertEqual(out[2].name, 'U2')
self.assertEqual(out[2].extends.name, 'U1')
def test_union_patch_decl(self):
# test union with only symbols
text = textwrap.dedent("""\
namespace files
patch union Role
owner
"Owner of a file."
""")
out = self.parser_factory.get_parser().parse(text)
self.assertEqual(out[1].name, 'Role')
self.assertIsInstance(out[1].fields[0], AstVoidField)
self.assertEqual(out[1].fields[0].name, 'owner')
# test struct patch with a top-level doc
text = textwrap.dedent("""\
namespace files
patch union Role
"The role a user may have in a shared folder."
owner
"Owner of a file."
""")
out = self.parser_factory.get_parser().parse(text)
msg, lineno, _ = self.parser_factory.get_parser().errors[0]
# Can't parse patch with doc-string.
self.assertEqual(msg, "Unexpected STRING with value 'The " +
"role a user may have in a shared folder.'.")
self.assertEqual(lineno, 3)
text = textwrap.dedent("""\
namespace files
patch union Error
A
"Variant A"
""")
self.parser_factory.get_parser().parse(text)
def test_composition(self):
text = textwrap.dedent("""\
namespace files
union UploadMode
add
overwrite
struct Upload
path String
mode UploadMode = add
""")
out = self.parser_factory.get_parser().parse(text)
self.assertEqual(out[2].name, 'Upload')
self.assertIsInstance(out[2].fields[1].default, AstTagRef)
self.assertEqual(out[2].fields[1].default.tag, 'add')
def test_route_decl(self):
# Test route definition with no docstring
text = textwrap.dedent("""\
namespace users
route GetAccountInfo(Void, Void, Void)
""")
self.parser_factory.get_parser().parse(text)
text = textwrap.dedent("""\
namespace users
struct AccountInfo
email String
route GetAccountInfo(AccountInfo, Void, Void)
"Gets the account info for a user"
""")
out = self.parser_factory.get_parser().parse(text)
self.assertEqual(out[1].name, 'AccountInfo')
self.assertEqual(out[2].name, 'GetAccountInfo')
self.assertEqual(out[2].arg_type_ref.name, 'AccountInfo')
self.assertEqual(out[2].result_type_ref.name, 'Void')
self.assertEqual(out[2].error_type_ref.name, 'Void')
# Test raw documentation
text = textwrap.dedent("""\
namespace users
route GetAccountInfo(Void, Void, Void)
"0
1
2
3
"
""")
out = self.parser_factory.get_parser().parse(text)
self.assertEqual(out[1].doc, '0\n\n1\n\n2\n\n3\n')
# Test deprecation
text = textwrap.dedent("""\
namespace test
route old_route (Void, Void, Void) deprecated
""")
api = specs_to_ir([('test.stone', text)])
r = api.namespaces['test'].route_by_name['old_route']
self.assertIsNotNone(r.deprecated)
self.assertIsNone(r.deprecated.by)
# Test deprecation with target route
text = textwrap.dedent("""\
namespace test
route old_route (Void, Void, Void) deprecated by new_route
route new_route (Void, Void, Void)
""")
api = specs_to_ir([('test.stone', text)])
r_old = api.namespaces['test'].route_by_name['old_route']
r_new = api.namespaces['test'].route_by_name['new_route']
self.assertIsNotNone(r.deprecated)
self.assertEqual(r_old.deprecated.by, r_new)
# Test deprecation with target route (more complex route names)
text = textwrap.dedent("""\
namespace test
route test/old_route (Void, Void, Void) deprecated by test/new_route
route test/new_route (Void, Void, Void)
""")
api = specs_to_ir([('test.stone', text)])
r_old = api.namespaces['test'].route_by_name['test/old_route']
r_new = api.namespaces['test'].route_by_name['test/new_route']
self.assertIsNotNone(r.deprecated)
self.assertEqual(r_old.deprecated.by, r_new)
# Try deprecation by undefined route
text = textwrap.dedent("""\
namespace test
route old_route (Void, Void, Void) deprecated by unk_route
""")
with self.assertRaises(InvalidSpec) as cm:
specs_to_ir([('test.stone', text)])
self.assertEqual("Undefined route 'unk_route'.", cm.exception.msg)
self.assertEqual(cm.exception.lineno, 3)
# Try deprecation by struct
text = textwrap.dedent("""\
namespace test
route old_route (Void, Void, Void) deprecated by S
struct S
f String
""")
with self.assertRaises(InvalidSpec) as cm:
specs_to_ir([('test.stone', text)])
self.assertEqual("'S' must be a route.", cm.exception.msg)
self.assertEqual(cm.exception.lineno, 3)
def test_alphabetizing(self):
text1 = textwrap.dedent("""\
namespace ns_b
struct z
f UInt64
union x
a
b
struct y
f UInt64
route b(Void, Void, Void)
route a(Void, Void, Void)
route c(Void, Void, Void)
""")
text2 = textwrap.dedent("""\
namespace ns_a
route d (Void, Void, Void)
""")
api = specs_to_ir([('test1.stone', text1), ('test2.stone', text2)])
assert ['ns_a', 'ns_b'] == list(api.namespaces.keys())
ns_b = api.namespaces['ns_b']
assert [dt.name for dt in ns_b.data_types] == ['x', 'y', 'z']
assert [dt.name for dt in ns_b.routes] == ['a', 'b', 'c']
def test_lexing_errors(self):
text = textwrap.dedent("""\
namespace users
%
# testing line numbers
%
struct AccountInfo
email String
""")
parser = self.parser_factory.get_parser()
out = parser.parse(text)
msg, lineno = parser.lexer.errors[0]
self.assertEqual(msg, "Illegal character '%'.")
self.assertEqual(lineno, 4)
msg, lineno = parser.lexer.errors[1]
self.assertEqual(msg, "Illegal character '%'.")
self.assertEqual(lineno, 8)
# Check that despite lexing errors, parser marched on successfully.
self.assertEqual(out[1].name, 'AccountInfo')
text = textwrap.dedent("""\
namespace test
struct S
# Indent below is only 3 spaces
f String
""")
with self.assertRaises(InvalidSpec) as cm:
specs_to_ir([('test.stone', text)])
self.assertIn("Indent is not divisible by 4.", cm.exception.msg)
def test_parsing_errors(self):
text = textwrap.dedent("""\
namespace users
strct AccountInfo
email String
""")
parser = self.parser_factory.get_parser()
parser.parse(text)
msg, lineno, _ = parser.errors[0]
self.assertEqual(msg, "Unexpected ID with value 'strct'.")
self.assertEqual(lineno, 4)
text = textwrap.dedent("""\
namespace users
route test_route(Blah, Blah, Blah)
""")
with self.assertRaises(InvalidSpec) as cm:
specs_to_ir([('test.stone', text)])
self.assertIn("Symbol 'Blah' is undefined", cm.exception.msg)
def test_name_clash(self):
# namespace / type clash
text = textwrap.dedent("""\
namespace test_namespace_test
struct TestNamespaceTest
str String
""")
with self.assertRaises(InvalidSpec) as cm:
specs_to_ir([('test.stone', text)])
self.assertIn("Name of user-defined type 'TestNamespaceTest' conflicts "
"with name of namespace 'test_namespace_test'", cm.exception.msg)
# namespace / route clash
text = textwrap.dedent("""\
namespace test_namespace_test
route test_namespace_test(Void, Void, Void)
""")
with self.assertRaises(InvalidSpec) as cm:
specs_to_ir([('test.stone', text)])
self.assertIn("Name of route 'test_namespace_test' conflicts "
"with name of namespace 'test_namespace_test'", cm.exception.msg)
# namespace / alias clash
text = textwrap.dedent("""\
namespace test_namespace_test
alias TestNamespaceTest = String
""")
with self.assertRaises(InvalidSpec) as cm:
specs_to_ir([('test.stone', text)])
self.assertIn("Name of alias 'TestNamespaceTest' conflicts "
"with name of namespace 'test_namespace_test'", cm.exception.msg)
# route / type clash
text = textwrap.dedent("""\
namespace test_namespace
struct TestStructTest
str String
route test_struct_test(Void, Void, Void)
""")
with self.assertRaises(InvalidSpec) as cm:
specs_to_ir([('test.stone', text)])
self.assertIn("Name of route 'test_struct_test' conflicts "
"with name of user-defined type 'TestStructTest'", cm.exception.msg)
# alias / route clash
text = textwrap.dedent("""\
namespace test_namespace
alias TestAliasTest = String
route test_alias_test(Void, Void, Void)
""")
with self.assertRaises(InvalidSpec) as cm:
specs_to_ir([('test.stone', text)])
self.assertIn("Name of route 'test_alias_test' conflicts "
"with name of alias 'TestAliasTest'", cm.exception.msg)
def test_docstrings(self):
text = textwrap.dedent("""\
namespace test
# No docstrings at all
struct E
f String
struct S
"Only type doc"
f String
struct T
f String
"Only field doc"
union U
"Only type doc"
f String
union V
f String
"Only field doc"
# Check for inherited doc
struct W extends T
g String
""")
api = specs_to_ir([('test.stone', text)])
E_dt = api.namespaces['test'].data_type_by_name['E']
self.assertFalse(E_dt.has_documented_type_or_fields())
self.assertFalse(E_dt.has_documented_fields())
S_dt = api.namespaces['test'].data_type_by_name['S']
self.assertTrue(S_dt.has_documented_type_or_fields())
self.assertFalse(S_dt.has_documented_fields())
T_dt = api.namespaces['test'].data_type_by_name['T']
self.assertTrue(T_dt.has_documented_type_or_fields())
self.assertTrue(T_dt.has_documented_fields())
U_dt = api.namespaces['test'].data_type_by_name['U']
self.assertTrue(U_dt.has_documented_type_or_fields())
self.assertFalse(U_dt.has_documented_fields())
V_dt = api.namespaces['test'].data_type_by_name['V']
self.assertTrue(V_dt.has_documented_type_or_fields())
self.assertTrue(V_dt.has_documented_fields())
W_dt = api.namespaces['test'].data_type_by_name['W']
self.assertFalse(W_dt.has_documented_type_or_fields())
self.assertFalse(W_dt.has_documented_fields())
self.assertFalse(W_dt.has_documented_type_or_fields(), True)
self.assertFalse(W_dt.has_documented_fields(), True)
def test_alias(self):
# Test aliasing to primitive
text = textwrap.dedent("""\
namespace test
alias R = String
"This is a test
of docstrings"
""")
api = specs_to_ir([('test.stone', text)])
test_ns = api.namespaces['test']
self.assertIsInstance(test_ns.aliases[0], Alias)
self.assertEqual(test_ns.aliases[0].name, 'R')
self.assertIsInstance(test_ns.aliases[0].data_type, String)
self.assertEqual(
test_ns.aliases[0].doc, 'This is a test of docstrings')
# Test aliasing to primitive with additional attributes and nullable
text = textwrap.dedent("""\
namespace test
alias R = String(min_length=1)?
""")
api = specs_to_ir([('test.stone', text)])
test_ns = api.namespaces['test']
self.assertIsInstance(test_ns.aliases[0], Alias)
self.assertEqual(test_ns.aliases[0].name, 'R')
self.assertIsInstance(test_ns.aliases[0].data_type, Nullable)
self.assertIsInstance(test_ns.aliases[0].data_type.data_type, String)
# Test aliasing to alias
text = textwrap.dedent("""\
namespace test
alias T = String
alias R = T
""")
api = specs_to_ir([('test.stone', text)])
test_ns = api.namespaces['test']
self.assertIsInstance(test_ns.alias_by_name['T'], Alias)
self.assertIsInstance(test_ns.alias_by_name['R'], Alias)
self.assertIsInstance(test_ns.alias_by_name['R'].data_type, Alias)
self.assertEqual(test_ns.alias_by_name['R'].data_type.name, 'T')
# Test order invariance
text = textwrap.dedent("""\
namespace test
alias R = T
alias T = String
""")
api = specs_to_ir([('test.stone', text)])
# Try re-definition
text = textwrap.dedent("""\
namespace test
alias A = String
alias A = UInt64
""")
with self.assertRaises(InvalidSpec) as cm:
specs_to_ir([('test.stone', text)])
self.assertIn("Symbol 'A' already defined (test.stone:3).",
cm.exception.msg)
# Try cyclical reference
text = textwrap.dedent("""\
namespace test
alias A = B
alias B = C
alias C = A
""")
with self.assertRaises(InvalidSpec) as cm:
specs_to_ir([('test.stone', text)])
self.assertIn("Alias 'C' is part of a cycle.",
cm.exception.msg)
# Try aliasing to alias with attributes already set.
text = textwrap.dedent("""\
namespace test
alias T = String(min_length=1)
alias R = T(min_length=1)
""")
with self.assertRaises(InvalidSpec) as cm:
specs_to_ir([('test.stone', text)])
self.assertIn('Attributes cannot be specified for instantiated type',
cm.exception.msg)
# Test aliasing to composite and making it nullable
text = textwrap.dedent("""\
namespace test
struct S
f String
alias R = S?
""")
api = specs_to_ir([('test.stone', text)])
test_ns = api.namespaces['test']
S_dt = test_ns.data_type_by_name['S']
self.assertIsInstance(test_ns.alias_by_name['R'].data_type, Nullable)
self.assertEqual(test_ns.alias_by_name['R'].data_type.data_type, S_dt)
# Test aliasing to composite with attributes
text = textwrap.dedent("""\
namespace test
struct S
f String
alias R = S(min_length=1)
""")
with self.assertRaises(InvalidSpec) as cm:
specs_to_ir([('test.stone', text)])
self.assertIn('Attributes cannot be specified for instantiated type',
cm.exception.msg)
# Test aliasing from another namespace
text1 = textwrap.dedent("""\
namespace test1
struct S
f String
""")
text2 = textwrap.dedent("""\
namespace test2
import test1
alias S = test1.S
""")
api = specs_to_ir([('test1.stone', text1), ('test2.stone', text2)])
test1_ns = api.namespaces['test1']
S_dt = test1_ns.data_type_by_name['S']
test2_ns = api.namespaces['test2']
self.assertEqual(test2_ns.alias_by_name['S'].data_type, S_dt)
# Try extending an alias-ed struct
text1 = textwrap.dedent("""\
namespace test1
alias Z = S
struct S
f1 String