Skip to content
Navigation Menu
{{ message }}
forked from shotgunsoftware/python-api
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest_mockgun.py
More file actions
461 lines (387 loc) · 14.6 KB
/
Copy pathtest_mockgun.py
File metadata and controls
461 lines (387 loc) · 14.6 KB
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
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
#! /opt/local/bin/python
# -----------------------------------------------------------------------------
# Copyright (c) 2009-2017, Shotgun Software Inc
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# - Redistributions of source code must retain the above copyright notice, this
# list of conditions and the following disclaimer.
#
# - Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
# - Neither the name of the Shotgun Software Inc nor the names of its
# contributors may be used to endorse or promote products derived from this
# software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
# -----------------------------------------------------------------------------
"""
Unit tests for Mockgun. Does not require an Internet connection
and can be run on their own by typing "python test_mockgun.py".
"""
import re
import os
import unittest
from shotgun_api3.lib.mockgun import Shotgun as Mockgun
from shotgun_api3 import ShotgunError
mockgun_schema_folder = os.path.join(
os.path.dirname(__file__),
"mockgun"
)
Mockgun.set_schema_paths(
os.path.join(mockgun_schema_folder, "schema.pickle"),
os.path.join(mockgun_schema_folder, "schema_entity.pickle")
)
# FIXME: This should probably be refactored into a base class for
# all test bases
class TestBaseWithExceptionTests(unittest.TestCase):
"""
Implements a Python 2.4 compatible assertRaisesRegexp like method. This
was introduced in Python 2.7.
"""
def assertRaisesRegexp(self, exception_type, re_msg, func):
try:
func()
except exception_type as exception:
matches = re.findall(re_msg, str(exception))
if not matches:
self.fail("Expected exception to match '%s', got '%s' instead." % (
re_msg, str(exception)
))
except Exception as ex:
self.fail("Expected exception of type %s, got %s" % (exception_type, type(ex)))
else:
self.fail("Expected %s was not raised." % exception_type)
class TestMockgunModuleInterface(unittest.TestCase):
"""
mockgun.py was turned into a module. Ensure we haven't broken the interface.
"""
def test_interface_intact(self):
"""
Ensure everything that was public before still is.
"""
from shotgun_api3.lib import mockgun
# Try to access everything. If something is missing, it will raise an
# error.
mockgun.MockgunError
mockgun.generate_schema
mockgun.Shotgun
class TestValidateFilterSyntax(TestBaseWithExceptionTests):
"""
Tests filter syntax support.
"""
def setUp(self):
"""
Creates test data.
"""
super(TestValidateFilterSyntax, self).setUp()
self._mockgun = Mockgun("https://test.shotgunstudio.com", login="user", password="1234")
self._mockgun.create("Shot", {"code": "shot"})
def test_filter_array_or_dict(self):
"""
Ensure that arrays and dictionaries are supported for filters.
"""
# This should not throw.
self._mockgun.find(
"Shot",
[
{
"filter_operator": "any",
"filters": [["code", "is", "shot"]]
},
[
"code", "is", "shot"
]
]
)
# We can't have not dict/list values for filters however.
self.assertRaisesRegexp(
ShotgunError,
"Filters can only be lists or dictionaries, not int.",
lambda: self._mockgun.find(
"Shot",
[1]
)
)
class TestEntityFieldComparison(TestBaseWithExceptionTests):
"""
Checks if entity fields comparison work.
"""
def setUp(self):
"""
Creates test data.
"""
self._mockgun = Mockgun("https://test.shotgunstudio.com", login="user", password="1234")
self._project_link = self._mockgun.create("Project", {"name": "project", "archived": False})
# This entity will ensure that a populated link field will be comparable.
self._mockgun.create(
"PipelineConfiguration",
{"code": "with_project", "project": self._project_link, }
)
# This entity will ensure that an unpopulated link field will be comparable.
self._mockgun.create("PipelineConfiguration", {"code": "without_project"})
def test_searching_for_none_entity_field(self):
"""
Ensures that comparison with None work.
"""
items = self._mockgun.find("PipelineConfiguration", [["project", "is", None]])
self.assertEqual(len(items), 1)
items = self._mockgun.find("PipelineConfiguration", [["project", "is_not", None]])
self.assertEqual(len(items), 1)
def test_searching_for_initialized_entity_field(self):
"""
Ensures that comparison with an entity works.
"""
items = self._mockgun.find("PipelineConfiguration", [["project", "is", self._project_link]])
self.assertEqual(len(items), 1)
items = self._mockgun.find("PipelineConfiguration", [["project", "is_not", self._project_link]])
self.assertEqual(len(items), 1)
def test_find_entity_with_none_link(self):
"""
Make sure that we can search for sub entity fields on entities that have the field not set.
"""
# The pipeline configuration without_project doesn't have the project field set, so we're expecting
# it to not be returned here.
items = self._mockgun.find("PipelineConfiguration", [["project.Project.archived", "is", False]])
self.assertEqual(len(items), 1)
self.assertEqual(items[0]["id"], self._project_link["id"])
class TestTextFieldOperators(TestBaseWithExceptionTests):
"""
Checks if text field comparison work.
"""
def setUp(self):
"""
Creates test data.
"""
self._mockgun = Mockgun("https://test.shotgunstudio.com", login="user", password="1234")
self._user = self._mockgun.create("HumanUser", {"login": "user"})
def test_operator_contains(self):
"""
Ensures contains operator works.
"""
item = self._mockgun.find_one("HumanUser", [["login", "contains", "se"]])
self.assertTrue(item)
class TestMultiEntityFieldComparison(TestBaseWithExceptionTests):
"""
Ensures multi entity field comparison work.
"""
def setUp(self):
"""
Creates test data.
"""
self._mockgun = Mockgun("https://test.shotgunstudio.com", login="user", password="1234")
# Create two users to assign to the pipeline configurations.
self._user1 = self._mockgun.create("HumanUser", {"login": "user1"})
self._user2 = self._mockgun.create("HumanUser", {"login": "user2"})
# Create pipeline configurations that are assigned none, one or two users.
self._mockgun.create(
"PipelineConfiguration",
{"code": "with_user1", "users": [self._user1]}
)
self._mockgun.create(
"PipelineConfiguration",
{"code": "with_user2", "users": [self._user2]}
)
self._mockgun.create(
"PipelineConfiguration",
{"code": "with_both", "users": [self._user2, self._user1]}
)
self._mockgun.create(
"PipelineConfiguration",
{"code": "with_none", "users": []}
)
def test_find_by_sub_entity_field(self):
"""
Ensures that queries on linked entity fields works.
"""
items = self._mockgun.find("PipelineConfiguration", [["users.HumanUser.login", "is", "user1"]])
self.assertEqual(len(items), 2)
items = self._mockgun.find("PipelineConfiguration", [["users.HumanUser.login", "is", "user2"]])
self.assertEqual(len(items), 2)
items = self._mockgun.find("PipelineConfiguration", [["users.HumanUser.login", "contains", "ser"]])
self.assertEqual(len(items), 3)
# Lets get fancy a bit.
items = self._mockgun.find("PipelineConfiguration", [{
"filter_operator": "any",
"filters": [
["users.HumanUser.login", "is", "user1"],
["users.HumanUser.login", "is", "user2"]
]}]
)
self.assertEqual(len(items), 3)
items = self._mockgun.find("PipelineConfiguration", [{
"filter_operator": "all",
"filters": [
["users.HumanUser.login", "is", "user1"],
["users.HumanUser.login", "is", "user2"]
]}]
)
self.assertEqual(len(items), 1)
def test_find_with_none(self):
"""
Ensures comparison with multi-entity fields and None works.
"""
items = self._mockgun.find("PipelineConfiguration", [["users", "is", None]], ["users"])
self.assertEqual(len(items), 1)
self.assertEqual(items[0]["users"], [])
items = self._mockgun.find("PipelineConfiguration", [["users", "is_not", None]], ["users"])
self.assertEqual(len(items), 3)
for item in items:
self.assertTrue(len(item["users"]) > 0)
class TestFilterOperator(TestBaseWithExceptionTests):
"""
Unit tests for the filter_operator filter syntax.
"""
def setUp(self):
"""
Creates tests data.
"""
super(TestFilterOperator, self).setUp()
self._mockgun = Mockgun("https://test.shotgunstudio.com", login="user", password="1234")
self._prj1_link = self._mockgun.create(
"Project",
{
"name": "prj1"
}
)
self._prj2_link = self._mockgun.create(
"Project",
{
"name": "prj2"
}
)
self._shot1 = self._mockgun.create(
"Shot",
{
"code": "shot1",
"project": self._prj1_link
}
)
self._shot2 = self._mockgun.create(
"Shot",
{
"code": "shot2",
"project": self._prj1_link
}
)
self._shot3 = self._mockgun.create(
"Shot",
{
"code": "shot3",
"project": self._prj2_link
}
)
def test_simple_filter_operators(self):
"""
Tests a simple use of the filter_operator.
"""
shots = self._mockgun.find(
"Shot",
[{
"filter_operator": "any",
"filters": [
["code", "is", "shot1"],
["code", "is", "shot2"]
]
}]
)
self.assertEqual(len(shots), 2)
shots = self._mockgun.find(
"Shot",
[{
"filter_operator": "all",
"filters": [
["code", "is", "shot1"],
["code", "is", "shot2"]
]
}]
)
self.assertEqual(len(shots), 0)
def test_nested_filter_operators(self):
"""
Tests a the use of the filter_operator nested
inside the filter_operator.
"""
shots = self._mockgun.find(
"Shot",
[
{
"filter_operator": "any",
"filters": [
{
"filter_operator": "all",
"filters": [
["code", "is", "shot1"],
["project", "is", self._prj1_link]
]
},
{
"filter_operator": "all",
"filters": [
["code", "is", "shot3"],
["project", "is", self._prj2_link]
]
}
]
}
]
)
self.assertEqual(len(shots), 2)
def test_invalid_operator(self):
self.assertRaisesRegexp(
ShotgunError,
"Unknown filter_operator type: bad",
lambda: self._mockgun.find(
"Shot",
[
{
"filter_operator": "bad",
"filters": []
}
])
)
self.assertRaisesRegexp(
ShotgunError,
"Bad filter operator, requires keys 'filter_operator' and 'filters',",
lambda: self._mockgun.find(
"Shot",
[
{
}
])
)
class TestConfig(unittest.TestCase):
"""
Tests the shotgun._Config class
"""
def test_set_server_params_with_regular_url(self):
"""
Make sure it works with a normal URL.
"""
mockgun = Mockgun("https://server.shotgunstudio.com/")
self.assertEqual(mockgun.config.scheme, "https")
self.assertEqual(mockgun.config.server, "server.shotgunstudio.com")
self.assertEqual(mockgun.config.api_path, "/api3/json")
def test_set_server_params_with_url_with_path(self):
"""
Make sure it works with a URL with a path
"""
mockgun = Mockgun("https://local/something/")
self.assertEqual(mockgun.config.scheme, "https")
self.assertEqual(mockgun.config.server, "local")
self.assertEqual(mockgun.config.api_path, "/something/api3/json")
if __name__ == '__main__':
unittest.main()
You can’t perform that action at this time.