Debian Codegraph @

tests/serializers/test_deserialization.py

raw
1 import json
2 import time
3 import unittest
4
5 from django.core.serializers.base import DeserializationError, DeserializedObject
6 from django.core.serializers.json import Deserializer as JsonDeserializer
7 from django.core.serializers.jsonl import Deserializer as JsonlDeserializer
8 from django.core.serializers.python import Deserializer
9 from django.core.serializers.xml_serializer import Deserializer as XMLDeserializer
10 from django.db import models
11 from django.test import SimpleTestCase
12 from django.test.utils import garbage_collect
13
14 from .models import Author
15
16 try:
17 import yaml # NOQA
18
19 HAS_YAML = True
20 except ImportError:
21 HAS_YAML = False
22
23
24 class TestDeserializer(SimpleTestCase):
25 def setUp(self):
26 self.object_list = [
27 {"pk": 1, "model": "serializers.author", "fields": {"name": "Jane"}},
28 {"pk": 2, "model": "serializers.author", "fields": {"name": "Joe"}},
29 ]
30 self.deserializer = Deserializer(self.object_list)
31 self.jane = Author(name="Jane", pk=1)
32 self.joe = Author(name="Joe", pk=2)
33
34 def test_deserialized_object_repr(self):
35 deserial_obj = DeserializedObject(obj=self.jane)
36 self.assertEqual(
37 repr(deserial_obj), "<DeserializedObject: serializers.Author(pk=1)>"
38 )
39
40 def test_next_functionality(self):
41 first_item = next(self.deserializer)
42
43 self.assertEqual(first_item.object, self.jane)
44
45 second_item = next(self.deserializer)
46 self.assertEqual(second_item.object, self.joe)
47
48 with self.assertRaises(StopIteration):
49 next(self.deserializer)
50
51 def test_invalid_model_identifier(self):
52 invalid_object_list = [
53 {"pk": 1, "model": "serializers.author2", "fields": {"name": "Jane"}}
54 ]
55 self.deserializer = Deserializer(invalid_object_list)
56 with self.assertRaises(DeserializationError):
57 next(self.deserializer)
58
59 deserializer = Deserializer(object_list=[])
60 with self.assertRaises(StopIteration):
61 next(deserializer)
62
63 def test_custom_deserializer(self):
64 class CustomDeserializer(Deserializer):
65 @staticmethod
66 def _get_model_from_node(model_identifier):
67 return Author
68
69 deserializer = CustomDeserializer(self.object_list)
70 result = next(iter(deserializer))
71 deserialized_object = result.object
72 self.assertEqual(
73 self.jane,
74 deserialized_object,
75 )
76
77 def test_empty_object_list(self):
78 deserializer = Deserializer(object_list=[])
79 with self.assertRaises(StopIteration):
80 next(deserializer)
81
82 def test_json_bytes_input(self):
83 test_string = json.dumps(self.object_list)
84 stream = test_string.encode("utf-8")
85 deserializer = JsonDeserializer(stream_or_string=stream)
86
87 first_item = next(deserializer)
88 second_item = next(deserializer)
89
90 self.assertEqual(first_item.object, self.jane)
91 self.assertEqual(second_item.object, self.joe)
92
93 def test_jsonl_bytes_input(self):
94 test_string = """
95 {"pk": 1, "model": "serializers.author", "fields": {"name": "Jane"}}
96 {"pk": 2, "model": "serializers.author", "fields": {"name": "Joe"}}
97 {"pk": 3, "model": "serializers.author", "fields": {"name": "John"}}
98 {"pk": 4, "model": "serializers.author", "fields": {"name": "Smith"}}"""
99 stream = test_string.encode("utf-8")
100 deserializer = JsonlDeserializer(stream_or_string=stream)
101
102 first_item = next(deserializer)
103 second_item = next(deserializer)
104
105 self.assertEqual(first_item.object, self.jane)
106 self.assertEqual(second_item.object, self.joe)
107
108 @unittest.skipUnless(HAS_YAML, "No yaml library detected")
109 def test_yaml_bytes_input(self):
110 from django.core.serializers.pyyaml import Deserializer as YamlDeserializer
111
112 test_string = """- pk: 1
113 model: serializers.author
114 fields:
115 name: Jane
116
117 - pk: 2
118 model: serializers.author
119 fields:
120 name: Joe
121
122 - pk: 3
123 model: serializers.author
124 fields:
125 name: John
126
127 - pk: 4
128 model: serializers.author
129 fields:
130 name: Smith
131 """
132 stream = test_string.encode("utf-8")
133 deserializer = YamlDeserializer(stream_or_string=stream)
134
135 first_item = next(deserializer)
136 second_item = next(deserializer)
137
138 self.assertEqual(first_item.object, self.jane)
139 self.assertEqual(second_item.object, self.joe)
140
141 def test_crafted_xml_performance(self):
142 """The time to process invalid inputs is not quadratic."""
143
144 def build_crafted_xml(depth, leaf_text_len):
145 nested_open = "<nested>" * depth
146 nested_close = "</nested>" * depth
147 leaf = "x" * leaf_text_len
148 field_content = f"{nested_open}{leaf}{nested_close}"
149 return f"""
150 <django-objects version="1.0">
151 <object model="contenttypes.contenttype" pk="1">
152 <field name="app_label">{field_content}</field>
153 <field name="model">m</field>
154 </object>
155 </django-objects>
156 """
157
158 def deserialize(crafted_xml):
159 iterator = XMLDeserializer(crafted_xml)
160 garbage_collect()
161
162 start_time = time.perf_counter()
163 result = list(iterator)
164 end_time = time.perf_counter()
165
166 self.assertEqual(len(result), 1)
167 self.assertIsInstance(result[0].object, models.Model)
168 return end_time - start_time
169
170 def assertFactor(label, params, factor=2):
171 factors = []
172 prev_time = None
173 for depth, length in params:
174 crafted_xml = build_crafted_xml(depth, length)
175 elapsed = deserialize(crafted_xml)
176 if prev_time is not None:
177 factors.append(elapsed / prev_time)
178 prev_time = elapsed
179
180 with self.subTest(label):
181 # Assert based on the average factor to reduce test flakiness.
182 self.assertLessEqual(sum(factors) / len(factors), factor)
183
184 assertFactor(
185 "varying depth, varying length",
186 [(50, 2000), (100, 4000), (200, 8000), (400, 16000), (800, 32000)],
187 2,
188 )
189 assertFactor("constant depth, varying length", [(100, 1), (100, 1000)], 2)