Repository navigation
Expand file tree
/
Copy pathtest_properties.py
More file actions
949 lines (720 loc) · 37.2 KB
/
Copy pathtest_properties.py
File metadata and controls
949 lines (720 loc) · 37.2 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
import pytest
import openapi_python_client.schema as oai
from openapi_python_client.parser.errors import PropertyError, ValidationError
MODULE_NAME = "openapi_python_client.parser.properties"
class TestProperty:
def test___post_init(self, mocker):
from openapi_python_client.parser.properties import Property
validate_default = mocker.patch(f"{MODULE_NAME}.Property._validate_default")
Property(name="a name", required=True, default=None, nullable=False)
validate_default.assert_not_called()
Property(name="a name", required=True, default="the default value", nullable=False)
validate_default.assert_called_with(default="the default value")
def test_get_type_string(self):
from openapi_python_client.parser.properties import Property
p = Property(name="test", required=True, default=None, nullable=False)
p._type_string = "TestType"
assert p.get_type_string() == "TestType"
p.required = False
assert p.get_type_string() == "Optional[TestType]"
assert p.get_type_string(True) == "TestType"
p.required = False
p.nullable = True
assert p.get_type_string() == "Optional[TestType]"
def test_to_string(self, mocker):
from openapi_python_client.parser.properties import Property
name = mocker.MagicMock()
snake_case = mocker.patch("openapi_python_client.utils.snake_case")
p = Property(name=name, required=True, default=None, nullable=False)
get_type_string = mocker.patch.object(p, "get_type_string")
assert p.to_string() == f"{snake_case(name)}: {get_type_string()}"
p.required = False
assert p.to_string() == f"{snake_case(name)}: {get_type_string()} = None"
p.default = "TEST"
assert p.to_string() == f"{snake_case(name)}: {get_type_string()} = TEST"
def test_get_imports(self, mocker):
from openapi_python_client.parser.properties import Property
name = mocker.MagicMock()
mocker.patch("openapi_python_client.utils.snake_case")
p = Property(name=name, required=True, default=None, nullable=False)
assert p.get_imports(prefix="") == set()
p.required = False
assert p.get_imports(prefix="") == {"from typing import Optional"}
def test__validate_default(self):
from openapi_python_client.parser.properties import Property
# should be okay if default isn't specified
p = Property(name="a name", required=True, default=None, nullable=False)
with pytest.raises(ValidationError):
p._validate_default("a default value")
with pytest.raises(ValidationError):
Property(name="a name", required=True, default="", nullable=False)
class TestStringProperty:
def test_get_type_string(self):
from openapi_python_client.parser.properties import StringProperty
p = StringProperty(name="test", required=True, default=None, nullable=False)
assert p.get_type_string() == "str"
p.required = False
assert p.get_type_string() == "Optional[str]"
def test__validate_default(self):
from openapi_python_client.parser.properties import StringProperty
p = StringProperty(name="a name", required=True, default="the default value", nullable=False)
assert p.default == '"the default value"'
class TestDateTimeProperty:
def test_get_imports(self, mocker):
from openapi_python_client.parser.properties import DateTimeProperty
name = mocker.MagicMock()
mocker.patch("openapi_python_client.utils.snake_case")
p = DateTimeProperty(name=name, required=True, default=None, nullable=False)
assert p.get_imports(prefix="") == {
"import datetime",
"from typing import cast",
}
p.required = False
assert p.get_imports(prefix="") == {
"from typing import Optional",
"import datetime",
"from typing import cast",
}
def test__validate_default(self):
from openapi_python_client.parser.properties import DateTimeProperty
with pytest.raises(ValidationError):
DateTimeProperty(name="a name", required=True, default="not a datetime", nullable=False)
p = DateTimeProperty(name="a name", required=True, default="2017-07-21T17:32:28Z", nullable=False)
assert p.default == "datetime.datetime(2017, 7, 21, 17, 32, 28, tzinfo=datetime.timezone.utc)"
class TestDateProperty:
def test_get_imports(self, mocker):
from openapi_python_client.parser.properties import DateProperty
name = mocker.MagicMock()
mocker.patch("openapi_python_client.utils.snake_case")
p = DateProperty(name=name, required=True, default=None, nullable=False)
assert p.get_imports(prefix="") == {
"import datetime",
"from typing import cast",
}
p.required = False
assert p.get_imports(prefix="") == {
"from typing import Optional",
"import datetime",
"from typing import cast",
}
def test__validate_default(self):
from openapi_python_client.parser.properties import DateProperty
with pytest.raises(ValidationError):
DateProperty(name="a name", required=True, default="not a date", nullable=False)
p = DateProperty(name="a name", required=True, default="1010-10-10", nullable=False)
assert p.default == "datetime.date(1010, 10, 10)"
class TestFileProperty:
def test_get_imports(self, mocker):
from openapi_python_client.parser.properties import FileProperty
name = mocker.MagicMock()
mocker.patch("openapi_python_client.utils.snake_case")
prefix = "blah"
p = FileProperty(name=name, required=True, default=None, nullable=False)
assert p.get_imports(prefix=prefix) == {f"from {prefix}.types import File", "from dataclasses import astuple"}
p.required = False
assert p.get_imports(prefix=prefix) == {
"from typing import Optional",
f"from {prefix}.types import File",
"from dataclasses import astuple",
}
def test__validate_default(self):
from openapi_python_client.parser.properties import FileProperty
# should be okay if default isn't specified
FileProperty(name="a name", required=True, default=None, nullable=False)
with pytest.raises(ValidationError):
FileProperty(name="a name", required=True, default="", nullable=False)
class TestFloatProperty:
def test__validate_default(self):
from openapi_python_client.parser.properties import FloatProperty
# should be okay if default isn't specified
FloatProperty(name="a name", required=True, default=None, nullable=False)
p = FloatProperty(name="a name", required=True, default="123.123", nullable=False)
assert p.default == 123.123
with pytest.raises(ValidationError):
FloatProperty(name="a name", required=True, default="not a float", nullable=False)
class TestIntProperty:
def test__validate_default(self):
from openapi_python_client.parser.properties import IntProperty
# should be okay if default isn't specified
IntProperty(name="a name", required=True, default=None, nullable=False)
p = IntProperty(name="a name", required=True, default="123", nullable=False)
assert p.default == 123
with pytest.raises(ValidationError):
IntProperty(name="a name", required=True, default="not an int", nullable=False)
class TestBooleanProperty:
def test__validate_default(self):
from openapi_python_client.parser.properties import BooleanProperty
# should be okay if default isn't specified
BooleanProperty(name="a name", required=True, default=None, nullable=False)
p = BooleanProperty(name="a name", required=True, default="Literally anything will work", nullable=False)
assert p.default == True
class TestListProperty:
def test_get_type_string(self, mocker):
from openapi_python_client.parser.properties import ListProperty
inner_property = mocker.MagicMock()
inner_type_string = mocker.MagicMock()
inner_property.get_type_string.return_value = inner_type_string
p = ListProperty(name="test", required=True, default=None, inner_property=inner_property, nullable=False)
assert p.get_type_string() == f"List[{inner_type_string}]"
p.required = False
assert p.get_type_string() == f"Optional[List[{inner_type_string}]]"
p = ListProperty(name="test", required=True, default=[], inner_property=inner_property, nullable=False)
assert p.default == f"field(default_factory=lambda: cast(List[{inner_type_string}], []))"
def test_get_type_imports(self, mocker):
from openapi_python_client.parser.properties import ListProperty
inner_property = mocker.MagicMock()
inner_import = mocker.MagicMock()
inner_property.get_imports.return_value = {inner_import}
prefix = mocker.MagicMock()
p = ListProperty(name="test", required=True, default=None, inner_property=inner_property, nullable=False)
assert p.get_imports(prefix=prefix) == {
inner_import,
"from typing import List",
}
p.required = False
assert p.get_imports(prefix=prefix) == {
inner_import,
"from typing import List",
"from typing import Optional",
}
p.default = mocker.MagicMock()
assert p.get_imports(prefix=prefix) == {
inner_import,
"from typing import Optional",
"from typing import List",
"from typing import cast",
"from dataclasses import field",
}
def test__validate_default(self, mocker):
from openapi_python_client.parser.properties import ListProperty
inner_property = mocker.MagicMock()
inner_type_string = mocker.MagicMock()
inner_property.get_type_string.return_value = inner_type_string
inner_property._validate_default.return_value = "y"
p = ListProperty(name="a name", required=True, default=["x"], inner_property=inner_property, nullable=False)
assert p.default == f"field(default_factory=lambda: cast(List[{inner_type_string}], ['y']))"
with pytest.raises(ValidationError):
ListProperty(name="a name", required=True, default="x", inner_property=inner_property, nullable=False)
def test__validate_default_enum_items(self, mocker):
from openapi_python_client.parser.properties import ListProperty, RefProperty
inner_enum_property = mocker.MagicMock(spec=RefProperty)
inner_enum_property.get_type_string.return_value = "AnEnum"
inner_enum_property._validate_default.return_value = "AnEnum.val1"
p = ListProperty(
name="a name", required=True, default=["val1"], inner_property=inner_enum_property, nullable=False
)
assert p.default == "field(default_factory=lambda: cast(List[AnEnum], [AnEnum.val1]))"
class TestUnionProperty:
def test_get_type_string(self, mocker):
from openapi_python_client.parser.properties import UnionProperty
inner_property_1 = mocker.MagicMock()
inner_property_1.get_type_string.return_value = "inner_type_string_1"
inner_property_2 = mocker.MagicMock()
inner_property_2.get_type_string.return_value = "inner_type_string_2"
p = UnionProperty(
name="test",
required=True,
default=None,
inner_properties=[inner_property_1, inner_property_2],
nullable=False,
)
assert p.get_type_string() == "Union[inner_type_string_1, inner_type_string_2]"
p.required = False
assert p.get_type_string() == "Optional[Union[inner_type_string_1, inner_type_string_2]]"
def test_get_type_imports(self, mocker):
from openapi_python_client.parser.properties import UnionProperty
inner_property_1 = mocker.MagicMock()
inner_import_1 = mocker.MagicMock()
inner_property_1.get_imports.return_value = {inner_import_1}
inner_property_2 = mocker.MagicMock()
inner_import_2 = mocker.MagicMock()
inner_property_2.get_imports.return_value = {inner_import_2}
prefix = mocker.MagicMock()
p = UnionProperty(
name="test",
required=True,
default=None,
inner_properties=[inner_property_1, inner_property_2],
nullable=False,
)
assert p.get_imports(prefix=prefix) == {
inner_import_1,
inner_import_2,
"from typing import Union",
}
p.required = False
assert p.get_imports(prefix=prefix) == {
inner_import_1,
inner_import_2,
"from typing import Union",
"from typing import Optional",
}
def test__validate_default(self, mocker):
from openapi_python_client.parser.properties import UnionProperty
inner_property_1 = mocker.MagicMock()
inner_property_1.get_type_string.return_value = "inner_type_string_1"
inner_property_1._validate_default.side_effect = ValidationError()
inner_property_2 = mocker.MagicMock()
inner_property_2.get_type_string.return_value = "inner_type_string_2"
inner_property_2._validate_default.return_value = "the default value"
p = UnionProperty(
name="test",
required=True,
default="a value",
inner_properties=[inner_property_1, inner_property_2],
nullable=False,
)
assert p.default == "the default value"
inner_property_2._validate_default.side_effect = ValidationError()
with pytest.raises(ValidationError):
UnionProperty(
name="test",
required=True,
default="a value",
inner_properties=[inner_property_1, inner_property_2],
nullable=False,
)
class TestEnumProperty:
def test___post_init__(self, mocker):
name = mocker.MagicMock()
snake_case = mocker.patch("openapi_python_client.utils.snake_case")
fake_reference = mocker.MagicMock(class_name="MyTestEnum")
deduped_reference = mocker.MagicMock(class_name="Deduped")
from_ref = mocker.patch(
f"{MODULE_NAME}.Reference.from_ref", side_effect=[fake_reference, deduped_reference, deduped_reference]
)
from openapi_python_client.parser import properties
fake_dup_enum = mocker.MagicMock()
properties._existing_enums = {"MyTestEnum": fake_dup_enum}
values = {"FIRST": "first", "SECOND": "second"}
enum_property = properties.EnumProperty(
name=name, required=True, default="second", values=values, title="a_title", nullable=False
)
assert enum_property.default == "Deduped.SECOND"
assert enum_property.python_name == snake_case(name)
from_ref.assert_has_calls([mocker.call("a_title"), mocker.call("MyTestEnum1")])
assert enum_property.reference == deduped_reference
assert properties._existing_enums == {"MyTestEnum": fake_dup_enum, "Deduped": enum_property}
# Test encountering exactly the same Enum again
assert (
properties.EnumProperty(
name=name, required=True, default="second", values=values, title="a_title", nullable=False
)
== enum_property
)
assert properties._existing_enums == {"MyTestEnum": fake_dup_enum, "Deduped": enum_property}
# What if an Enum exists with the same name, but has the same values? Don't dedupe that.
fake_dup_enum.values = values
from_ref.reset_mock()
from_ref.side_effect = [fake_reference]
enum_property = properties.EnumProperty(
name=name, required=True, default="second", values=values, title="a_title", nullable=False
)
assert enum_property.default == "MyTestEnum.SECOND"
assert enum_property.python_name == snake_case(name)
from_ref.assert_called_once_with("a_title")
assert enum_property.reference == fake_reference
assert len(properties._existing_enums) == 2
properties._existing_enums = {}
def test_get_type_string(self, mocker):
fake_reference = mocker.MagicMock(class_name="MyTestEnum")
mocker.patch(f"{MODULE_NAME}.Reference.from_ref", return_value=fake_reference)
from openapi_python_client.parser import properties
enum_property = properties.EnumProperty(
name="test", required=True, default=None, values={}, title="a_title", nullable=False
)
assert enum_property.get_type_string() == "MyTestEnum"
enum_property.required = False
assert enum_property.get_type_string() == "Optional[MyTestEnum]"
properties._existing_enums = {}
def test_get_imports(self, mocker):
fake_reference = mocker.MagicMock(class_name="MyTestEnum", module_name="my_test_enum")
mocker.patch(f"{MODULE_NAME}.Reference.from_ref", return_value=fake_reference)
prefix = mocker.MagicMock()
from openapi_python_client.parser import properties
enum_property = properties.EnumProperty(
name="test", required=True, default=None, values={}, title="a_title", nullable=False
)
assert enum_property.get_imports(prefix=prefix) == {
f"from {prefix}.{fake_reference.module_name} import {fake_reference.class_name}"
}
enum_property.required = False
assert enum_property.get_imports(prefix=prefix) == {
f"from {prefix}.{fake_reference.module_name} import {fake_reference.class_name}",
"from typing import Optional",
}
properties._existing_enums = {}
def test_values_from_list(self):
from openapi_python_client.parser.properties import EnumProperty
data = ["abc", "123", "a23", "1bc"]
result = EnumProperty.values_from_list(data)
assert result == {
"ABC": "abc",
"VALUE_1": "123",
"A23": "a23",
"VALUE_3": "1bc",
}
def test_values_from_list_duplicate(self):
from openapi_python_client.parser.properties import EnumProperty
data = ["abc", "123", "a23", "abc"]
with pytest.raises(ValueError):
EnumProperty.values_from_list(data)
def test_get_all_enums(self, mocker):
from openapi_python_client.parser import properties
properties._existing_enums = mocker.MagicMock()
assert properties.EnumProperty.get_all_enums() == properties._existing_enums
properties._existing_enums = {}
def test_get_enum(self):
from openapi_python_client.parser import properties
properties._existing_enums = {"test": "an enum"}
assert properties.EnumProperty.get_enum("test") == "an enum"
properties._existing_enums = {}
def test__validate_default(self, mocker):
fake_reference = mocker.MagicMock(class_name="MyTestEnum", module_name="my_test_enum")
mocker.patch(f"{MODULE_NAME}.Reference.from_ref", return_value=fake_reference)
from openapi_python_client.parser import properties
enum_property = properties.EnumProperty(
name="test", required=True, default="test", values={"TEST": "test"}, title="a_title", nullable=False
)
assert enum_property.default == "MyTestEnum.TEST"
with pytest.raises(ValidationError):
properties.EnumProperty(
name="test", required=True, default="bad_val", values={"TEST": "test"}, title="a_title", nullable=False
)
properties._existing_enums = {}
class TestRefProperty:
def test_template(self, mocker):
from openapi_python_client.parser.properties import RefProperty
ref_property = RefProperty(
name="test",
required=True,
default=None,
reference=mocker.MagicMock(class_name="MyRefClass"),
nullable=False,
)
assert ref_property.template == "ref_property.pyi"
mocker.patch(f"{MODULE_NAME}.EnumProperty.get_enum", return_value="an enum")
assert ref_property.template == "enum_property.pyi"
def test_get_type_string(self, mocker):
from openapi_python_client.parser.properties import RefProperty
ref_property = RefProperty(
name="test",
required=True,
default=None,
reference=mocker.MagicMock(class_name="MyRefClass"),
nullable=False,
)
assert ref_property.get_type_string() == "MyRefClass"
ref_property.required = False
assert ref_property.get_type_string() == "Optional[MyRefClass]"
def test_get_imports(self, mocker):
fake_reference = mocker.MagicMock(class_name="MyRefClass", module_name="my_test_enum")
prefix = mocker.MagicMock()
from openapi_python_client.parser.properties import RefProperty
p = RefProperty(name="test", required=True, default=None, reference=fake_reference, nullable=False)
assert p.get_imports(prefix=prefix) == {
f"from {prefix}.{fake_reference.module_name} import {fake_reference.class_name}",
"from typing import Dict",
"from typing import cast",
}
p.required = False
assert p.get_imports(prefix=prefix) == {
f"from {prefix}.{fake_reference.module_name} import {fake_reference.class_name}",
"from typing import Dict",
"from typing import cast",
"from typing import Optional",
}
def test__validate_default(self, mocker):
from openapi_python_client.parser.properties import RefProperty
with pytest.raises(ValidationError):
RefProperty(name="a name", required=True, default="", reference=mocker.MagicMock(), nullable=False)
enum_property = mocker.MagicMock()
enum_property._validate_default.return_value = "val1"
mocker.patch(f"{MODULE_NAME}.EnumProperty.get_enum", return_value=enum_property)
p = RefProperty(name="a name", required=True, default="", reference=mocker.MagicMock(), nullable=False)
assert p.default == "val1"
class TestDictProperty:
def test_get_imports(self, mocker):
from openapi_python_client.parser.properties import DictProperty
name = mocker.MagicMock()
mocker.patch("openapi_python_client.utils.snake_case")
prefix = mocker.MagicMock()
p = DictProperty(name=name, required=True, default=None, nullable=False)
assert p.get_imports(prefix=prefix) == {
"from typing import Dict",
}
p.required = False
assert p.get_imports(prefix=prefix) == {
"from typing import Optional",
"from typing import Dict",
}
p.default = mocker.MagicMock()
assert p.get_imports(prefix=prefix) == {
"from typing import Optional",
"from typing import Dict",
"from typing import cast",
"from dataclasses import field",
}
def test__validate_default(self):
from openapi_python_client.parser.properties import DictProperty
DictProperty(name="a name", required=True, default={"key": "value"}, nullable=False)
with pytest.raises(ValidationError):
DictProperty(name="a name", required=True, default="not a dict", nullable=False)
class TestPropertyFromData:
def test_property_from_data_enum(self, mocker):
name = mocker.MagicMock()
required = mocker.MagicMock()
data = mocker.MagicMock(title=None)
EnumProperty = mocker.patch(f"{MODULE_NAME}.EnumProperty")
mocker.patch("openapi_python_client.utils.remove_string_escapes", return_value=name)
from openapi_python_client.parser.properties import property_from_data
p = property_from_data(name=name, required=required, data=data)
EnumProperty.values_from_list.assert_called_once_with(data.enum)
EnumProperty.assert_called_once_with(
name=name,
required=required,
values=EnumProperty.values_from_list(),
default=data.default,
title=name,
nullable=data.nullable,
)
assert p == EnumProperty()
EnumProperty.reset_mock()
data.title = mocker.MagicMock()
property_from_data(
name=name, required=required, data=data,
)
EnumProperty.assert_called_once_with(
name=name,
required=required,
values=EnumProperty.values_from_list(),
default=data.default,
title=data.title,
nullable=data.nullable,
)
def test_property_from_data_ref(self, mocker):
name = mocker.MagicMock()
required = mocker.MagicMock()
data = oai.Reference.construct(ref=mocker.MagicMock())
from_ref = mocker.patch(f"{MODULE_NAME}.Reference.from_ref")
RefProperty = mocker.patch(f"{MODULE_NAME}.RefProperty")
mocker.patch("openapi_python_client.utils.remove_string_escapes", return_value=name)
from openapi_python_client.parser.properties import property_from_data
p = property_from_data(name=name, required=required, data=data)
from_ref.assert_called_once_with(data.ref)
RefProperty.assert_called_once_with(
name=name, required=required, reference=from_ref(), default=None, nullable=False
)
assert p == RefProperty()
def test_property_from_data_string(self, mocker):
_string_based_property = mocker.patch(f"{MODULE_NAME}._string_based_property")
name = mocker.MagicMock()
required = mocker.MagicMock()
data = oai.Schema.construct(type="string")
mocker.patch("openapi_python_client.utils.remove_string_escapes", return_value=name)
from openapi_python_client.parser.properties import property_from_data
p = property_from_data(name=name, required=required, data=data)
assert p == _string_based_property.return_value
_string_based_property.assert_called_once_with(name=name, required=required, data=data)
@pytest.mark.parametrize(
"openapi_type,python_type",
[
("number", "FloatProperty"),
("integer", "IntProperty"),
("boolean", "BooleanProperty"),
("object", "DictProperty"),
],
)
def test_property_from_data_simple_types(self, mocker, openapi_type, python_type):
name = mocker.MagicMock()
required = mocker.MagicMock()
data = oai.Schema.construct(type=openapi_type)
clazz = mocker.patch(f"{MODULE_NAME}.{python_type}")
mocker.patch("openapi_python_client.utils.remove_string_escapes", return_value=name)
from openapi_python_client.parser.properties import property_from_data
p = property_from_data(name=name, required=required, data=data)
clazz.assert_called_once_with(name=name, required=required, default=None, nullable=False)
assert p == clazz()
# Test optional values
clazz.reset_mock()
data.default = mocker.MagicMock()
data.nullable = mocker.MagicMock()
property_from_data(
name=name, required=required, data=data,
)
clazz.assert_called_once_with(name=name, required=required, default=data.default, nullable=data.nullable)
def test_property_from_data_array(self, mocker):
name = mocker.MagicMock()
required = mocker.MagicMock()
data = oai.Schema(type="array", items={"type": "number", "default": "0.0"},)
ListProperty = mocker.patch(f"{MODULE_NAME}.ListProperty")
FloatProperty = mocker.patch(f"{MODULE_NAME}.FloatProperty")
mocker.patch("openapi_python_client.utils.remove_string_escapes", return_value=name)
from openapi_python_client.parser.properties import property_from_data
p = property_from_data(name=name, required=required, data=data)
FloatProperty.assert_called_once_with(name=name, required=True, default="0.0", nullable=False)
ListProperty.assert_called_once_with(
name=name, required=required, default=None, inner_property=FloatProperty.return_value, nullable=False
)
assert p == ListProperty.return_value
def test_property_from_data_array_no_items(self, mocker):
name = mocker.MagicMock()
required = mocker.MagicMock()
data = oai.Schema(type="array")
from openapi_python_client.parser.properties import property_from_data
p = property_from_data(name=name, required=required, data=data)
assert p == PropertyError(data=data, detail="type array must have items defined")
def test_property_from_data_array_invalid_items(self, mocker):
name = mocker.MagicMock()
required = mocker.MagicMock()
data = oai.Schema(type="array", items={},)
mocker.patch("openapi_python_client.utils.remove_string_escapes", return_value=name)
from openapi_python_client.parser.properties import property_from_data
p = property_from_data(name=name, required=required, data=data)
assert p == PropertyError(data=oai.Schema(), detail=f"invalid data in items of array {name}")
def test_property_from_data_union(self, mocker):
name = mocker.MagicMock()
required = mocker.MagicMock()
data = oai.Schema(anyOf=[{"type": "number", "default": "0.0"}], oneOf=[{"type": "integer", "default": "0"},])
UnionProperty = mocker.patch(f"{MODULE_NAME}.UnionProperty")
FloatProperty = mocker.patch(f"{MODULE_NAME}.FloatProperty")
IntProperty = mocker.patch(f"{MODULE_NAME}.IntProperty")
mocker.patch("openapi_python_client.utils.remove_string_escapes", return_value=name)
from openapi_python_client.parser.properties import property_from_data
p = property_from_data(name=name, required=required, data=data)
FloatProperty.assert_called_once_with(name=name, required=required, default="0.0", nullable=False)
IntProperty.assert_called_once_with(name=name, required=required, default="0", nullable=False)
UnionProperty.assert_called_once_with(
name=name,
required=required,
default=None,
inner_properties=[FloatProperty.return_value, IntProperty.return_value],
nullable=False,
)
assert p == UnionProperty.return_value
def test_property_from_data_union_bad_type(self, mocker):
name = mocker.MagicMock()
required = mocker.MagicMock()
data = oai.Schema(anyOf=[{}])
mocker.patch("openapi_python_client.utils.remove_string_escapes", return_value=name)
from openapi_python_client.parser.properties import property_from_data
p = property_from_data(name=name, required=required, data=data)
assert p == PropertyError(detail=f"Invalid property in union {name}", data=oai.Schema())
def test_property_from_data_unsupported_type(self, mocker):
name = mocker.MagicMock()
required = mocker.MagicMock()
data = oai.Schema.construct(type=mocker.MagicMock())
from openapi_python_client.parser.errors import PropertyError
from openapi_python_client.parser.properties import property_from_data
assert property_from_data(name=name, required=required, data=data) == PropertyError(
data=data, detail=f"unknown type {data.type}"
)
def test_property_from_data_no_valid_props_in_data(self):
from openapi_python_client.parser.errors import PropertyError
from openapi_python_client.parser.properties import property_from_data
data = oai.Schema()
assert property_from_data(name="blah", required=True, data=data) == PropertyError(
data=data, detail="Schemas must either have one of enum, anyOf, or type defined."
)
def test_property_from_data_validation_error(self, mocker):
from openapi_python_client.parser.errors import PropertyError
from openapi_python_client.parser.properties import property_from_data
mocker.patch(f"{MODULE_NAME}._property_from_data").side_effect = ValidationError()
data = oai.Schema()
assert property_from_data(name="blah", required=True, data=data) == PropertyError(
detail="Failed to validate default value", data=data
)
class TestStringBasedProperty:
def test__string_based_property_no_format(self, mocker):
name = mocker.MagicMock()
required = mocker.MagicMock()
data = oai.Schema.construct(type="string", nullable=mocker.MagicMock())
StringProperty = mocker.patch(f"{MODULE_NAME}.StringProperty")
from openapi_python_client.parser.properties import _string_based_property
p = _string_based_property(name=name, required=required, data=data)
StringProperty.assert_called_once_with(
name=name, required=required, pattern=None, default=None, nullable=data.nullable
)
assert p == StringProperty.return_value
# Test optional values
StringProperty.reset_mock()
data.default = mocker.MagicMock()
data.pattern = mocker.MagicMock()
_string_based_property(
name=name, required=required, data=data,
)
StringProperty.assert_called_once_with(
name=name, required=required, pattern=data.pattern, default=data.default, nullable=data.nullable
)
def test__string_based_property_datetime_format(self, mocker):
name = mocker.MagicMock()
required = mocker.MagicMock()
data = oai.Schema.construct(type="string", schema_format="date-time", nullable=mocker.MagicMock())
DateTimeProperty = mocker.patch(f"{MODULE_NAME}.DateTimeProperty")
from openapi_python_client.parser.properties import _string_based_property
p = _string_based_property(name=name, required=required, data=data)
DateTimeProperty.assert_called_once_with(name=name, required=required, default=None, nullable=data.nullable)
assert p == DateTimeProperty.return_value
# Test optional values
DateTimeProperty.reset_mock()
data.default = mocker.MagicMock()
_string_based_property(
name=name, required=required, data=data,
)
DateTimeProperty.assert_called_once_with(
name=name, required=required, default=data.default, nullable=data.nullable
)
def test__string_based_property_date_format(self, mocker):
name = mocker.MagicMock()
required = mocker.MagicMock()
data = oai.Schema.construct(type="string", schema_format="date", nullable=mocker.MagicMock())
DateProperty = mocker.patch(f"{MODULE_NAME}.DateProperty")
from openapi_python_client.parser.properties import _string_based_property
p = _string_based_property(name=name, required=required, data=data)
DateProperty.assert_called_once_with(name=name, required=required, default=None, nullable=data.nullable)
assert p == DateProperty.return_value
# Test optional values
DateProperty.reset_mock()
data.default = mocker.MagicMock()
_string_based_property(
name=name, required=required, data=data,
)
DateProperty.assert_called_once_with(name=name, required=required, default=data.default, nullable=data.nullable)
def test__string_based_property_binary_format(self, mocker):
name = mocker.MagicMock()
required = mocker.MagicMock()
data = oai.Schema.construct(type="string", schema_format="binary", nullable=mocker.MagicMock())
FileProperty = mocker.patch(f"{MODULE_NAME}.FileProperty")
from openapi_python_client.parser.properties import _string_based_property
p = _string_based_property(name=name, required=required, data=data)
FileProperty.assert_called_once_with(name=name, required=required, default=None, nullable=data.nullable)
assert p == FileProperty.return_value
# Test optional values
FileProperty.reset_mock()
data.default = mocker.MagicMock()
_string_based_property(
name=name, required=required, data=data,
)
FileProperty.assert_called_once_with(name=name, required=required, default=data.default, nullable=data.nullable)
def test__string_based_property_unsupported_format(self, mocker):
name = mocker.MagicMock()
required = mocker.MagicMock()
data = oai.Schema.construct(type="string", schema_format=mocker.MagicMock())
data.nullable = mocker.MagicMock()
StringProperty = mocker.patch(f"{MODULE_NAME}.StringProperty")
from openapi_python_client.parser.properties import _string_based_property
p = _string_based_property(name=name, required=required, data=data)
StringProperty.assert_called_once_with(
name=name, required=required, pattern=None, default=None, nullable=data.nullable
)
assert p == StringProperty.return_value
# Test optional values
StringProperty.reset_mock()
data.default = mocker.MagicMock()
data.pattern = mocker.MagicMock()
_string_based_property(
name=name, required=required, data=data,
)
StringProperty.assert_called_once_with(
name=name, required=required, pattern=data.pattern, default=data.default, nullable=data.nullable
)