/
test.py
287 lines (228 loc) · 8.17 KB
/
test.py
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
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import contextlib
import os.path
import unittest
from mypy import api
@contextlib.contextmanager
def set_env(new_env_dict):
"""Temporarily set the process environment variables"""
old_environ = dict(os.environ)
os.environ.update(new_env_dict)
try:
yield
finally:
os.environ.clear()
os.environ.update(old_environ)
class MypyTestCase(unittest.TestCase):
mypy_config = os.path.dirname(__file__) + "/mypy_test.ini"
def run_mypy(self, code):
stdout, stderr, retcode = api.run(
["--config-file", self.mypy_config, "-c", code]
)
return stdout
SIMPLE_OVO = """
from oslo_versionedobjects import base as ovo_base
from oslo_versionedobjects import fields
@ovo_base.VersionedObjectRegistry.objectify
class MyOvo(ovo_base.VersionedObject):
fields = {
'id': fields.IntegerField(),
'name': fields.StringField(),
'temperature': fields.FloatField(),
'list_of_ints': fields.ListOfIntegersField(),
'magic': fields.MagicField(),
}
def foo(self) -> None:
return None
myobj: MyOvo
"""
class OvoMypyFieldTests(MypyTestCase):
def test_basic_field_types_are_inferred(self):
self.assertIn(
"Revealed type is 'builtins.int",
self.run_mypy(SIMPLE_OVO + "reveal_type(myobj.id)"),
)
self.assertIn(
"Revealed type is 'builtins.str",
self.run_mypy(SIMPLE_OVO + "reveal_type(myobj.name)"),
)
self.assertIn(
"Revealed type is 'builtins.float",
self.run_mypy(SIMPLE_OVO + "reveal_type(myobj.temperature)"),
)
self.assertIn(
"Revealed type is 'builtins.list[builtins.int]",
self.run_mypy(SIMPLE_OVO + "reveal_type(myobj.list_of_ints)"),
)
self.assertIn(
"Incompatible types in assignment "
'(expression has type "str", variable has type "int"',
self.run_mypy(SIMPLE_OVO + "myobj.id = 'bob'"),
)
def test_undefined_type_defaulted_to_any(self):
self.assertIn(
"Revealed type is 'Any'",
self.run_mypy(SIMPLE_OVO + "reveal_type(myobj.magic)"),
)
def test_non_existent_field_usage_is_caught(self):
self.assertIn(
'"MyOvo" has no attribute "nonexistent"',
self.run_mypy(SIMPLE_OVO + "myobj.nonexistent"),
)
self.assertIn(
'"MyOvo" has no attribute "nonexistent"',
self.run_mypy(SIMPLE_OVO + "myobj.nonexistent = 12"),
)
INDIRECT_BASE = """
from oslo_versionedobjects import base as ovo_base
from oslo_versionedobjects import fields
class MyBase(ovo_base.VersionedObject):
pass
class MyOvo(MyBase):
fields = {
'id': fields.IntegerField(),
}
def foo(self) -> None:
return None
myobj: MyOvo
"""
INDIRECT_DECORATOR = """
from oslo_versionedobjects import base as ovo_base
from oslo_versionedobjects import fields
my_decorator = ovo_base.VersionedObjectRegistry.objectify
class MyBase(ovo_base.VersionedObject):
pass
@my_decorator
class MyOvo(MyBase):
fields = {
'id': fields.IntegerField(),
}
def foo(self) -> None:
return None
myobj: MyOvo
"""
class OvoMypyConfigTests(MypyTestCase):
def test_base_class_can_be_defined_in_the_env(self):
self.assertNotIn(
"Revealed type is 'builtins.int",
self.run_mypy(INDIRECT_BASE + "reveal_type(myobj.id)"),
)
with set_env({"OVO_MYPY_BASE_CLASSES": "MyBase"}):
self.assertIn(
"Revealed type is 'builtins.int",
self.run_mypy(INDIRECT_BASE + "reveal_type(myobj.id)"),
)
def test_decorator_class_can_be_defined_in_the_env(self):
self.assertNotIn(
"Revealed type is 'builtins.int",
self.run_mypy(INDIRECT_DECORATOR + "reveal_type(myobj.id)"),
)
with set_env({"OVO_MYPY_DECORATOR_CLASSES": "my_decorator"}):
self.assertIn(
"Revealed type is 'builtins.int",
self.run_mypy(INDIRECT_DECORATOR + "reveal_type(myobj.id)"),
)
INHERITED_FIELDS = """
from oslo_versionedobjects import base as ovo_base
from oslo_versionedobjects import fields
@ovo_base.VersionedObjectRegistry.objectify
class IdBase(ovo_base.VersionedObject):
fields = {
'id': fields.IntegerField(),
}
@ovo_base.VersionedObjectRegistry.objectify
class MyOvo(IdBase):
fields = {
'name': fields.StringField(),
}
def foo(self) -> None:
return None
myobj: MyOvo
"""
class OvoInheritanceTests(MypyTestCase):
def test_inherited_fields_are_known(self):
self.assertIn(
"Revealed type is 'builtins.int",
self.run_mypy(INHERITED_FIELDS + "reveal_type(myobj.id)"),
)
self.assertIn(
"Revealed type is 'builtins.str",
self.run_mypy(INHERITED_FIELDS + "reveal_type(myobj.name)"),
)
FIELD_PARAM_OVO = """
from oslo_versionedobjects import base as ovo_base
from oslo_versionedobjects import fields
@ovo_base.VersionedObjectRegistry.objectify
class MyOvo(ovo_base.VersionedObject):
fields = {
'id': fields.IntegerField(read_only=True),
'bad_read_only_field': fields.IntegerField(read_only=123),
'nullable_int': fields.IntegerField(nullable=True),
'bad_nullable_field': fields.IntegerField(nullable=123),
'defaulted_int': fields.IntegerField(default=42),
'bad_defaulted_int': fields.IntegerField(default=[42])
}
def foo(self) -> None:
return None
myobj: MyOvo
"""
class OvoFieldParameterTests(MypyTestCase):
def test_read_only_field_parameter(self):
result = self.run_mypy(FIELD_PARAM_OVO + "reveal_type(myobj.id)")
# read_only accepted
self.assertNotIn(
'error: Unexpected keyword argument "read_only"', result
)
# type of read_only is enforced
self.assertIn(
'error: Argument "read_only" to "IntegerField" has incompatible '
'type "int"; expected "bool"',
result,
)
# read_only flag does not modify the type of the field
self.assertIn("Revealed type is 'builtins.int'", result)
def test_nullable_field_parameter(self):
result = self.run_mypy(
FIELD_PARAM_OVO + "reveal_type(myobj.nullable_int)"
)
# nullable accepted
self.assertNotIn(
'error: Unexpected keyword argument "nullable"', result
)
# type of the nullable is enforced
self.assertIn(
'error: Argument "nullable" to "IntegerField" has incompatible '
'type "int"; expected "bool"',
result,
)
# A nullable=True flag makes the type of the field nullable by
# extending the type to Union[type, None]
self.assertIn("Revealed type is 'Union[builtins.int, None]", result)
def test_default_field_parameter(self):
result = self.run_mypy(
FIELD_PARAM_OVO + "reveal_type(myobj.defaulted_int)"
)
# default accepted
self.assertNotIn(
'error: Unexpected keyword argument "default"', result
)
# type of default is enforced
# TODO(gibi): the type of default should be the type of the field
# defined this needs some work in the plugin / stub
# self.assertIn(
# 'error: Argument "default" to "IntegerField" has incompatible '
# 'type "List[int]"; expected "int"',
# result
# )
# default flag does not modify the type of the field
self.assertIn("Revealed type is 'builtins.int'", result)