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
|
from unittest import TestCase
from unittest.mock import patch, PropertyMock
from django.test import override_settings
from django.utils.datastructures import MultiValueDict
from rest_framework import serializers
from rest_flex_fields import FlexFieldsModelSerializer
class MockRequest(object):
def __init__(self, query_params=None, method="GET"):
if query_params is None:
query_params = MultiValueDict()
self.query_params = query_params
self.method = method
class TestFlexFieldModelSerializer(TestCase):
def test_field_should_not_exist_if_omitted(self):
serializer = FlexFieldsModelSerializer()
result = serializer._should_field_exist("name", ["name"], [], {})
self.assertFalse(result)
def test_field_should_not_exist_if_not_in_sparse(self):
serializer = FlexFieldsModelSerializer()
result = serializer._should_field_exist("name", [], ["age"], {})
self.assertFalse(result)
def test_field_should_exist_if_ommitted_but_is_parent_of_omit(self):
serializer = FlexFieldsModelSerializer()
result = serializer._should_field_exist(
"employer", ["employer"], [], {"employer": ["address"]}
)
self.assertTrue(result)
def test_clean_fields(self):
serializer = FlexFieldsModelSerializer()
fields = {"cat": 1, "dog": 2, "zebra": 3}
result = serializer._get_fields_names_to_remove(fields, ["cat"], [], {})
self.assertEqual(result, ["cat"])
def test_get_expanded_field_names_if_all(self):
serializer = FlexFieldsModelSerializer()
serializer.expandable_fields = {"cat": "field", "dog": "field"}
result = serializer._get_expanded_field_names("*", [], [], {})
self.assertEqual(result, ["cat", "dog"])
def test_get_expanded_names_but_not_omitted(self):
serializer = FlexFieldsModelSerializer()
serializer.expandable_fields = {"cat": "field", "dog": "field"}
result = serializer._get_expanded_field_names(["cat", "dog"], ["cat"], [], {})
self.assertEqual(result, ["dog"])
def test_get_expanded_names_but_only_sparse(self):
serializer = FlexFieldsModelSerializer()
serializer.expandable_fields = {"cat": "field", "dog": "field"}
result = serializer._get_expanded_field_names(["cat"], [], ["cat"], {})
self.assertEqual(result, ["cat"])
def test_get_expanded_names_including_omitted_when_defer_to_next_level(self):
serializer = FlexFieldsModelSerializer()
serializer.expandable_fields = {"cat": "field", "dog": "field"}
result = serializer._get_expanded_field_names(
["cat"], ["cat"], [], {"cat": ["age"]}
)
self.assertEqual(result, ["cat"])
def test_get_query_param_value_should_return_empty_if_not_root_serializer(self):
serializer = FlexFieldsModelSerializer(
context={
"request": MockRequest(
method="GET", query_params=MultiValueDict({"expand": ["cat"]})
)
},
)
serializer.parent = "Another serializer here"
self.assertFalse(serializer._get_query_param_value("expand"), [])
def test_get_omit_input_from_explicit_settings(self):
serializer = FlexFieldsModelSerializer(
omit=["fish"],
context={
"request": MockRequest(
method="GET", query_params=MultiValueDict({"omit": "cat,dog"})
)
},
)
self.assertEqual(serializer._flex_options_all["omit"], ["fish"])
def test_set_omit_input_from_query_param(self):
serializer = FlexFieldsModelSerializer(
context={
"request": MockRequest(
method="GET", query_params=MultiValueDict({"omit": ["cat,dog"]})
)
}
)
self.assertEqual(serializer._flex_options_all["omit"], ["cat", "dog"])
def test_set_fields_input_from_explicit_settings(self):
serializer = FlexFieldsModelSerializer(
fields=["fish"],
context={
"request": MockRequest(
method="GET", query_params=MultiValueDict({"fields": "cat,dog"})
)
},
)
self.assertEqual(serializer._flex_options_all["fields"], ["fish"])
def test_set_fields_input_from_query_param(self):
serializer = FlexFieldsModelSerializer(
context={
"request": MockRequest(
method="GET", query_params=MultiValueDict({"fields": ["cat,dog"]})
)
}
)
self.assertEqual(serializer._flex_options_all["fields"], ["cat", "dog"])
def test_set_expand_input_from_explicit_setting(self):
serializer = FlexFieldsModelSerializer(
fields=["cat"],
context={
"request": MockRequest(
method="GET", query_params=MultiValueDict({"fields": "cat,dog"})
)
},
)
self.assertEqual(serializer._flex_options_all["fields"], ["cat"])
def test_set_expand_input_from_query_param(self):
serializer = FlexFieldsModelSerializer(
context={
"request": MockRequest(
method="GET", query_params=MultiValueDict({"expand": ["cat,dog"]})
)
}
)
self.assertEqual(serializer._flex_options_all["expand"], ["cat", "dog"])
def test_get_expand_input_from_query_param_limit_to_list_permitted(self):
serializer = FlexFieldsModelSerializer(
context={
"request": MockRequest(
method="GET", query_params=MultiValueDict({"expand": ["cat,dog"]})
),
"permitted_expands": ["cat"],
}
)
self.assertEqual(serializer._flex_options_all["expand"], ["cat"])
def test_parse_request_list_value(self):
test_params = [
{"abc": ["cat,dog,mouse"]},
{"abc": ["cat", "dog", "mouse"]},
{"abc[]": ["cat", "dog", "mouse"]},
]
for query_params in test_params:
serializer = FlexFieldsModelSerializer(context={})
serializer.context["request"] = MockRequest(
method="GET", query_params=MultiValueDict(query_params)
)
result = serializer._get_query_param_value("abc")
self.assertEqual(result, ["cat", "dog", "mouse"])
def test_parse_request_list_value_empty_if_cannot_access_request(self):
serializer = FlexFieldsModelSerializer(context={})
result = serializer._get_query_param_value("abc")
self.assertEqual(result, [])
def test_import_serializer_class(self):
pass
def test_make_expanded_field_serializer(self):
pass
@patch("rest_flex_fields.serializers.RECURSIVE_EXPANSION_PERMITTED", False)
def test_recursive_expansion(self):
with self.assertRaises(serializers.ValidationError):
FlexFieldsModelSerializer(
context={
"request": MockRequest(
method="GET",
query_params=MultiValueDict({"expand": ["dog.leg.dog"]}),
)
}
)
@patch(
"rest_flex_fields.FlexFieldsModelSerializer.recursive_expansion_permitted",
new_callable=PropertyMock,
)
def test_recursive_expansion_serializer_level(
self, mock_recursive_expansion_permitted
):
mock_recursive_expansion_permitted.return_value = False
with self.assertRaises(serializers.ValidationError):
FlexFieldsModelSerializer(
context={
"request": MockRequest(
method="GET",
query_params=MultiValueDict({"expand": ["dog.leg.dog"]}),
)
}
)
@override_settings(REST_FLEX_FIELDS={"MAXIMUM_EXPANSION_DEPTH": 3})
def test_expansion_depth(self):
serializer = FlexFieldsModelSerializer(
context={
"request": MockRequest(
method="GET",
query_params=MultiValueDict({"expand": ["dog.leg.paws"]}),
)
}
)
self.assertEqual(serializer._flex_options_all["expand"], ["dog.leg.paws"])
@patch("rest_flex_fields.serializers.MAXIMUM_EXPANSION_DEPTH", 2)
def test_expansion_depth_exception(self):
with self.assertRaises(serializers.ValidationError):
FlexFieldsModelSerializer(
context={
"request": MockRequest(
method="GET",
query_params=MultiValueDict({"expand": ["dog.leg.paws"]}),
)
}
)
@patch(
"rest_flex_fields.FlexFieldsModelSerializer.maximum_expansion_depth",
new_callable=PropertyMock,
)
def test_expansion_depth_serializer_level(self, mock_maximum_expansion_depth):
mock_maximum_expansion_depth.return_value = 3
serializer = FlexFieldsModelSerializer(
context={
"request": MockRequest(
method="GET",
query_params=MultiValueDict({"expand": ["dog.leg.paws"]}),
)
}
)
self.assertEqual(serializer._flex_options_all["expand"], ["dog.leg.paws"])
@patch(
"rest_flex_fields.FlexFieldsModelSerializer.maximum_expansion_depth",
new_callable=PropertyMock,
)
def test_expansion_depth_serializer_level_exception(
self, mock_maximum_expansion_depth
):
mock_maximum_expansion_depth.return_value = 2
with self.assertRaises(serializers.ValidationError):
FlexFieldsModelSerializer(
context={
"request": MockRequest(
method="GET",
query_params=MultiValueDict({"expand": ["dog.leg.paws"]}),
)
}
)
|
