summaryrefslogtreecommitdiff
path: root/tests/test_core.py
blob: 4d39303317b3423919d32a662e10a050f6f5d9e1 (plain)
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
# Copyright 2012 Brian Waldon
#
# 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 copy
import json
import os
import unittest

import six

import warlock

fixture = {
    "name": "Country",
    "properties": {"name": {"type": "string"}, "population": {"type": "integer"}},
    "additionalProperties": False,
}


complex_fixture = {
    "name": "Mixmaster",
    "properties": {
        "sub": {"type": "object", "properties": {"foo": {"type": "string"}}}
    },
}

parent_fixture = {
    "name": "Parent",
    "properties": {
        "name": {"type": "string"},
        "children": {"type": "array", "items": [{"type": "object"}]},
    },
    "required": ["name", "children"],
}

child_fixture = {
    "name": "Child",
    "properties": {"age": {"type": "integer"}, "mother": {"type": "object"}},
    "required": ["age", "mother"],
}


nameless_fixture = {
    "properties": {"name": {"type": "string"}, "population": {"type": "integer"}},
    "additionalProperties": False,
}


class TestCore(unittest.TestCase):
    def test_create_invalid_object(self):
        Country = warlock.model_factory(fixture)
        self.assertRaises(ValueError, Country, name=1)

    def test_class_name_from_unicode_schema_name(self):
        fixture_copy = copy.deepcopy(fixture)
        fixture_copy["name"] = six.text_type(fixture_copy["name"])
        # Can't set class.__name__ to a unicode object, ensure warlock
        # does some magic to make it possible
        warlock.model_factory(fixture_copy)

    def test_invalid_operations(self):
        Country = warlock.model_factory(fixture)
        sweden = Country(name="Sweden", population=9379116)

        # Ensure a valid object was created
        self.assertEqual(sweden.name, "Sweden")
        self.assertEqual(sweden.population, 9379116)

        # Specific exceptions should be raised for invalid operations
        self.assertRaises(AttributeError, getattr, sweden, "overlord")
        exc = warlock.InvalidOperation
        self.assertRaises(exc, setattr, sweden, "overlord", "Bears")
        self.assertRaises(exc, setattr, sweden, "name", 5)
        self.assertRaises(exc, setattr, sweden, "population", "N/A")

    def test_no_mask_arbitrary_properties(self):
        fixture_copy = copy.deepcopy(fixture)
        fixture_copy["additionalProperties"] = {"type": "string"}
        Country = warlock.model_factory(fixture_copy)

        # We should still depend on the schema for validation
        self.assertRaises(ValueError, Country, GDP=56956)

        # But arbitrary properties should be allowed if they check out
        sweden = Country(overlord="Waldon")
        sweden.abbreviation = "SE"
        exc = warlock.InvalidOperation
        self.assertRaises(exc, setattr, sweden, "abbreviation", 0)

    def test_items(self):
        Country = warlock.model_factory(fixture)
        sweden = Country(name="Sweden", population=9379116)
        self.assertEqual(
            set(list(six.iteritems(sweden))),
            set([("name", "Sweden"), ("population", 9379116)]),
        )
        self.assertEqual(
            set(sweden.items()), set([("name", "Sweden"), ("population", 9379116)])
        )

    def test_update(self):
        Country = warlock.model_factory(fixture)
        sweden = Country(name="Sweden", population=9379116)
        exc = warlock.InvalidOperation
        self.assertRaises(exc, sweden.update, {"population": "N/A"})
        self.assertRaises(exc, sweden.update, {"overloard": "Bears"})

    def test_naming(self):
        Country = warlock.model_factory(fixture)
        self.assertEqual("Country", Country.__name__)

        Country2 = warlock.model_factory(fixture, name="Country2")
        self.assertEqual("Country2", Country2.__name__)

        nameless = warlock.model_factory(nameless_fixture)
        self.assertEqual("Model", nameless.__name__)

        nameless2 = warlock.model_factory(nameless_fixture, name="Country3")
        self.assertEqual("Country3", nameless2.__name__)

    def test_deepcopy(self):
        """Make sure we aren't leaking references."""
        Mixmaster = warlock.model_factory(complex_fixture)
        mike = Mixmaster(sub={"foo": "mike"})

        self.assertEqual("mike", mike.sub["foo"])

        mike_1 = mike.copy()
        mike_1["sub"]["foo"] = "james"
        self.assertEqual("mike", mike.sub["foo"])

        mike_2 = dict(six.iteritems(mike))
        mike_2["sub"]["foo"] = "james"
        self.assertEqual("mike", mike.sub["foo"])

        mike_2 = dict(mike.items())
        mike_2["sub"]["foo"] = "james"
        self.assertEqual("mike", mike.sub["foo"])

        mike_3_sub = list(six.itervalues(mike))[0]
        mike_3_sub["foo"] = "james"
        self.assertEqual("mike", mike.sub["foo"])

        mike_3_sub = list(mike.values())[0]
        mike_3_sub["foo"] = "james"
        self.assertEqual("mike", mike.sub["foo"])

    def test_forbidden_methods(self):
        Country = warlock.model_factory(fixture)
        sweden = Country(name="Sweden", population=9379116)
        exc = warlock.InvalidOperation
        self.assertRaises(exc, sweden.clear)
        self.assertRaises(exc, sweden.pop, 0)
        self.assertRaises(exc, sweden.popitem)

    def test_dict_syntax(self):
        Country = warlock.model_factory(fixture)
        sweden = Country(name="Sweden", population=9379116)

        sweden["name"] = "Finland"
        self.assertEqual("Finland", sweden["name"])

        del sweden["name"]
        self.assertRaises(AttributeError, getattr, sweden, "name")

    def test_attr_syntax(self):
        Country = warlock.model_factory(fixture)
        sweden = Country(name="Sweden", population=9379116)

        sweden.name = "Finland"
        self.assertEqual("Finland", sweden.name)

        delattr(sweden, "name")
        self.assertRaises(AttributeError, getattr, sweden, "name")

    def test_changes(self):
        Country = warlock.model_factory(fixture)
        sweden = Country(name="Sweden", population=9379116)
        with self.assertWarns(DeprecationWarning):
            self.assertEqual(sweden.changes, {})
        sweden["name"] = "Finland"
        with self.assertWarns(DeprecationWarning):
            self.assertEqual(sweden.changes, {"name": "Finland"})
        sweden["name"] = "Norway"
        with self.assertWarns(DeprecationWarning):
            self.assertEqual(sweden.changes, {"name": "Norway"})

    def test_patch_no_changes(self):
        Country = warlock.model_factory(fixture)
        sweden = Country(name="Sweden", population=9379116)
        self.assertEqual(sweden.patch, "[]")

    def test_patch_alter_value(self):
        Country = warlock.model_factory(fixture)
        sweden = Country(name="Sweden", population=9379116)
        sweden["name"] = "Finland"
        self.assertEqual(
            json.loads(sweden.patch),
            json.loads('[{"path": "/name", "value": "Finland", "op": "replace"}]'),
        )

    def test_patch_drop_attribute(self):
        Country = warlock.model_factory(fixture)
        sweden = Country(name="Sweden", population=9379116)
        del sweden["name"]
        self.assertEqual(
            json.loads(sweden.patch), json.loads('[{"path": "/name", "op": "remove"}]')
        )

    def test_patch_reduce_operations(self):
        Country = warlock.model_factory(fixture)
        sweden = Country(name="Sweden", population=9379116)

        sweden["name"] = "Finland"
        self.assertEqual(
            json.loads(sweden.patch),
            json.loads('[{"path": "/name", "value": "Finland", "op": "replace"}]'),
        )

        sweden["name"] = "Norway"
        self.assertEqual(
            json.loads(sweden.patch),
            json.loads('[{"path": "/name", "value": "Norway", "op": "replace"}]'),
        )

    def test_patch_multiple_operations(self):
        Country = warlock.model_factory(fixture)
        sweden = Country(name="Sweden", population=9379116)

        sweden["name"] = "Finland"
        sweden["population"] = 5387000

        self.assertEqual(len(json.loads(sweden.patch)), 2)

        patches = json.loads(
            '[{"path": "/name", "value": "Finland", "op": "replace"}, '
            '{"path": "/population", "value": 5387000, "op": "replace"}]'
        )

        for patch in json.loads(sweden.patch):
            self.assertTrue(patch in patches)

    def test_resolver(self):
        from jsonschema import RefResolver

        dirname = os.path.dirname(__file__)
        schemas_path = "file://" + os.path.join(dirname, "schemas/")
        resolver = RefResolver(schemas_path, None)

        country_schema_file = open(os.path.join(dirname, "schemas/") + "country.json")
        person_schema_file = open(os.path.join(dirname, "schemas/") + "person.json")

        country_schema = json.load(country_schema_file)
        person_schema = json.load(person_schema_file)
        Country = warlock.model_factory(country_schema, resolver=resolver)
        Person = warlock.model_factory(person_schema, resolver=resolver)

        england = Country(
            name="England",
            population=53865800,
            overlord=Person(title="Queen", firstname="Elizabeth", lastname="Windsor"),
        )
        expected = {
            "name": "England",
            "population": 53865800,
            "overlord": {
                "title": "Queen",
                "lastname": "Windsor",
                "firstname": "Elizabeth",
            },
        }
        self.assertEqual(england, expected)

    def test_recursive_models(self):
        Parent = warlock.model_factory(parent_fixture)
        Child = warlock.model_factory(child_fixture)

        mom = Parent(name="Abby", children=[])

        teenager = Child(age=15, mother=mom)
        toddler = Child(age=3, mother=mom)

        mom.children = [teenager, toddler]

        self.assertEqual(mom.children[0].age, 15)
        self.assertEqual(mom.children[1].age, 3)