/
test_serializers.py
288 lines (216 loc) · 9.96 KB
/
test_serializers.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
288
# -*- coding: utf-8 -*-
from __future__ import absolute_import, print_function, unicode_literals
import dataclasses as da
from django.core.exceptions import ValidationError as DjangoValidationError
from django.test import SimpleTestCase
from rest_framework import fields
from rest_framework.exceptions import ValidationError
from rest_dataclasses.serializers import DataclassSerializer
@da.dataclass
class User:
id: int = da.field(default=None)
name: str = da.field(default=None)
email: str = da.field(default=None)
@da.dataclass
class Point:
x: int = da.field(default=None)
y: int = da.field(default=None)
@da.dataclass
class Line:
a: Point = da.field(default=None)
b: Point = da.field(default=None)
class TestModelSerializer(SimpleTestCase):
def test_happy_path(self):
class Serializer(DataclassSerializer):
class Meta:
model = User
fields = "__all__"
serializer = Serializer(data={"id": 1, "name": "shosca", "email": "some@email.com"})
serializer.is_valid(raise_exception=True)
user = serializer.save()
self.assertDictEqual(da.asdict(user), {"id": 1, "name": "shosca", "email": "some@email.com"})
def test_bad_fields(self):
class Serializer(DataclassSerializer):
class Meta:
model = User
fields = "id,name"
serializer = Serializer(data={"id": 1, "name": "shosca", "email": "some@email.com"})
with self.assertRaisesMessage(TypeError, 'The `fields` option must be a list or tuple or "__all__". Got str.'):
serializer.is_valid(raise_exception=True)
def test_bad_exclude(self):
class Serializer(DataclassSerializer):
class Meta:
model = User
exclude = "id,name"
serializer = Serializer(data={"id": 1, "name": "shosca", "email": "some@email.com"})
with self.assertRaisesMessage(TypeError, "The `exclude` option must be a list or tuple. Got str."):
serializer.is_valid(raise_exception=True)
def test_exclude(self):
class Serializer(DataclassSerializer):
class Meta:
model = User
exclude = ("name",)
serializer = Serializer(data={"id": 1, "name": "shosca", "email": "some@email.com"})
serializer.is_valid(raise_exception=True)
user = serializer.save()
self.assertDictEqual(da.asdict(user), {"id": 1, "name": None, "email": "some@email.com"})
def test_read_only_fields_bad(self):
class Serializer(DataclassSerializer):
class Meta:
model = User
fields = "__all__"
read_only_fields = "name"
serializer = Serializer(data={"id": 1, "name": "shosca", "email": "some@email.com"})
with self.assertRaisesMessage(TypeError, "The `read_only_fields` option must be a list or tuple. Got str."):
serializer.is_valid(raise_exception=True)
def test_read_only_fields(self):
class Serializer(DataclassSerializer):
class Meta:
model = User
fields = "__all__"
read_only_fields = ("name",)
serializer = Serializer(data={"id": 1, "name": "shosca", "email": "some@email.com"})
serializer.is_valid(raise_exception=True)
user = serializer.save()
self.assertDictEqual(da.asdict(user), {"id": 1, "name": None, "email": "some@email.com"})
def test_with_fields(self):
class Serializer(DataclassSerializer):
class Meta:
model = User
fields = ("id", "name")
serializer = Serializer(data={"id": 1, "name": "shosca", "email": "some@email.com"})
serializer.is_valid(raise_exception=True)
user = serializer.save()
self.assertDictEqual(da.asdict(user), {"id": 1, "name": "shosca", "email": None})
def test_with_missing_declared_field(self):
class Serializer(DataclassSerializer):
name = fields.CharField(required=False)
class Meta:
model = User
fields = ("id", "email")
serializer = Serializer(data={"id": 1, "name": "shosca", "email": "some@email.com"})
with self.assertRaisesMessage(
AssertionError,
"The field 'name' was declared on serializer Serializer, but has not been included in the 'fields' option.",
):
serializer.is_valid(raise_exception=True)
def test_custom_setter(self):
class Serializer(DataclassSerializer):
class Meta:
model = User
fields = ("name",)
def set_name(self, instance, field_name, value):
instance.name = value
serializer = Serializer(data={"id": 1, "name": "shosca", "email": "some@email.com"})
serializer.is_valid(raise_exception=True)
user = serializer.save()
self.assertDictEqual(da.asdict(user), {"id": None, "name": "shosca", "email": None})
def test_declared_field(self):
class Serializer(DataclassSerializer):
name = fields.CharField(required=False)
class Meta:
model = User
fields = "__all__"
serializer = Serializer(data={"id": 1, "name": "shosca", "email": "some@email.com"})
serializer.is_valid(raise_exception=True)
user = serializer.save()
self.assertDictEqual(da.asdict(user), {"id": 1, "name": "shosca", "email": "some@email.com"})
def test_nested_create(self):
class Serializer(DataclassSerializer):
class Meta:
model = Line
fields = "__all__"
serializer = Serializer(data={"a": {"x": 1, "y": 2}, "b": {"x": 3, "y": 4}})
serializer.is_valid(raise_exception=True)
line = serializer.save()
self.assertDictEqual(da.asdict(line), {"a": {"x": 1, "y": 2}, "b": {"x": 3, "y": 4}})
def test_nested_inplace_update(self):
class Serializer(DataclassSerializer):
class Meta:
model = Line
fields = "__all__"
instance = Line(a=Point(x=1, y=2), b=Point(x=3, y=4))
serializer = Serializer(instance, data={"a": {"x": 5, "y": 6}, "b": {"x": 7, "y": 8}}, partial=True)
serializer.is_valid(raise_exception=True)
line = serializer.save()
self.assertIs(instance, line)
self.assertIs(instance.a, line.a)
self.assertIs(instance.b, line.b)
self.assertDictEqual(da.asdict(line), {"a": {"x": 5, "y": 6}, "b": {"x": 7, "y": 8}})
def test_nested_inplace_with_create(self):
class Serializer(DataclassSerializer):
class Meta:
model = Line
fields = "__all__"
instance = Line()
serializer = Serializer(instance, data={"a": {"x": 1, "y": 2}, "b": {"x": 3, "y": 4}}, partial=True)
serializer.is_valid(raise_exception=True)
line = serializer.save()
self.assertIs(instance, line)
self.assertIsInstance(line.a, Point)
self.assertIsInstance(line.b, Point)
self.assertDictEqual(da.asdict(line), {"a": {"x": 1, "y": 2}, "b": {"x": 3, "y": 4}})
def test_nested_none(self):
class Serializer(DataclassSerializer):
class Meta:
model = Line
fields = "__all__"
extra_kwargs = {"a": {"allow_null": True}, "b": {"allow_null": True}}
instance = Line(a=Point(x=1, y=2), b=Point(x=3, y=4))
serializer = Serializer(instance, data={"a": None, "b": None}, partial=True)
serializer.is_valid(raise_exception=True)
line = serializer.save()
self.assertIs(instance, line)
self.assertIsNone(line.a)
self.assertIsNone(line.b)
self.assertDictEqual(da.asdict(line), {"a": None, "b": None})
def test_nested_none_allow_create_false(self):
class Serializer(DataclassSerializer):
class Meta:
model = Line
fields = "__all__"
extra_kwargs = {"a": {"allow_null": False, "allow_create": False}, "b": {"allow_null": False}}
instance = Line()
serializer = Serializer(instance, data={"a": {}, "b": {}}, partial=True)
serializer.is_valid(raise_exception=True)
with self.assertRaises(ValidationError):
serializer.save()
def test_create_star_source(self):
class Serializer(DataclassSerializer):
class Meta:
model = User
fields = ["name"]
class StarSerializer(DataclassSerializer):
user = Serializer(source="*")
class Meta:
model = User
fields = ["id", "user"]
serializer = StarSerializer(data={"user": {"name": "shosca"}, "id": 1})
serializer.is_valid(raise_exception=True)
user = serializer.save()
self.assertDictEqual(da.asdict(user), {"id": 1, "name": "shosca", "email": None})
def test_create_source_not_in_validated_data(self):
class Serializer(DataclassSerializer):
class Meta:
model = Line
fields = "__all__"
serializer = Serializer(data={})
serializer.is_valid(raise_exception=True)
line = serializer.save()
self.assertDictEqual(da.asdict(line), {"a": None, "b": None})
def test_validation_error_on_save(self):
class Serializer(DataclassSerializer):
class Meta:
model = User
fields = ["name"]
def perform_update(self, instance, validated_data, errors):
raise DjangoValidationError("test")
class StarSerializer(DataclassSerializer):
user = Serializer(source="*")
class Meta:
model = User
fields = ["id", "user"]
serializer = StarSerializer(data={"user": {"name": "shosca"}, "id": 1})
serializer.is_valid(raise_exception=True)
with self.assertRaises(ValidationError):
serializer.save()