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_unit.py
More file actions
521 lines (446 loc) · 19.8 KB
/
Copy pathtest_unit.py
File metadata and controls
521 lines (446 loc) · 19.8 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
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
#! /opt/local/bin/python
# Copyright (c) 2019 Shotgun Software Inc.
#
# CONFIDENTIAL AND PROPRIETARY
#
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
# Source Code License included in this distribution package. See LICENSE.
# By accessing, using, copying or modifying this work you indicate your
# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights
# not expressly granted therein are reserved by Shotgun Software Inc.
import os
import unittest
from .mock import patch
import shotgun_api3 as api
from shotgun_api3.shotgun import _is_mimetypes_broken
from shotgun_api3.lib.six.moves import range, urllib
from shotgun_api3.lib.httplib2 import Http, ssl_error_classes
class TestShotgunInit(unittest.TestCase):
'''Test case for Shotgun.__init__'''
def setUp(self):
self.server_path = 'http://server_path'
self.script_name = 'script_name'
self.api_key = 'api_key'
# Proxy Server Tests
def test_http_proxy_server(self):
proxy_server = "someserver.com"
http_proxy = proxy_server
sg = api.Shotgun(self.server_path,
self.script_name,
self.api_key,
http_proxy=http_proxy,
connect=False)
self.assertEqual(sg.config.proxy_server, proxy_server)
self.assertEqual(sg.config.proxy_port, 8080)
proxy_server = "123.456.789.012"
http_proxy = proxy_server
sg = api.Shotgun(self.server_path,
self.script_name,
self.api_key,
http_proxy=http_proxy,
connect=False)
self.assertEqual(sg.config.proxy_server, proxy_server)
self.assertEqual(sg.config.proxy_port, 8080)
def test_http_proxy_server_and_port(self):
proxy_server = "someserver.com"
proxy_port = 1234
http_proxy = "%s:%d" % (proxy_server, proxy_port)
sg = api.Shotgun(self.server_path,
self.script_name,
self.api_key,
http_proxy=http_proxy,
connect=False)
self.assertEqual(sg.config.proxy_server, proxy_server)
self.assertEqual(sg.config.proxy_port, proxy_port)
proxy_server = "123.456.789.012"
proxy_port = 1234
http_proxy = "%s:%d" % (proxy_server, proxy_port)
sg = api.Shotgun(self.server_path,
self.script_name,
self.api_key,
http_proxy=http_proxy,
connect=False)
self.assertEqual(sg.config.proxy_server, proxy_server)
self.assertEqual(sg.config.proxy_port, proxy_port)
def test_http_proxy_server_and_port_with_authentication(self):
proxy_server = "someserver.com"
proxy_port = 1234
proxy_user = "user"
proxy_pass = "password"
http_proxy = "%s:%s@%s:%d" % (proxy_user, proxy_pass, proxy_server,
proxy_port)
sg = api.Shotgun(self.server_path,
self.script_name,
self.api_key,
http_proxy=http_proxy,
connect=False)
self.assertEqual(sg.config.proxy_server, proxy_server)
self.assertEqual(sg.config.proxy_port, proxy_port)
self.assertEqual(sg.config.proxy_user, proxy_user)
self.assertEqual(sg.config.proxy_pass, proxy_pass)
proxy_server = "123.456.789.012"
proxy_port = 1234
proxy_user = "user"
proxy_pass = "password"
http_proxy = "%s:%s@%s:%d" % (proxy_user, proxy_pass, proxy_server,
proxy_port)
sg = api.Shotgun(self.server_path,
self.script_name,
self.api_key,
http_proxy=http_proxy,
connect=False)
self.assertEqual(sg.config.proxy_server, proxy_server)
self.assertEqual(sg.config.proxy_port, proxy_port)
self.assertEqual(sg.config.proxy_user, proxy_user)
self.assertEqual(sg.config.proxy_pass, proxy_pass)
def test_http_proxy_with_at_in_password(self):
proxy_server = "someserver.com"
proxy_port = 1234
proxy_user = "user"
proxy_pass = "p@ssword"
http_proxy = "%s:%s@%s:%d" % (proxy_user, proxy_pass, proxy_server,
proxy_port)
sg = api.Shotgun(self.server_path,
self.script_name,
self.api_key,
http_proxy=http_proxy,
connect=False)
self.assertEqual(sg.config.proxy_server, proxy_server)
self.assertEqual(sg.config.proxy_port, proxy_port)
self.assertEqual(sg.config.proxy_user, proxy_user)
self.assertEqual(sg.config.proxy_pass, proxy_pass)
def test_malformatted_proxy_info(self):
conn_info = {
'base_url': self.server_path,
'script_name': self.script_name,
'api_key': self.api_key,
'connect': False,
}
conn_info['http_proxy'] = 'http://someserver.com'
self.assertRaises(ValueError, api.Shotgun, **conn_info)
conn_info['http_proxy'] = 'user@someserver.com'
self.assertRaises(ValueError, api.Shotgun, **conn_info)
conn_info['http_proxy'] = 'someserver.com:1234:5678'
self.assertRaises(ValueError, api.Shotgun, **conn_info)
class TestShotgunSummarize(unittest.TestCase):
'''Test case for _create_summary_request function and parameter
validation as it exists in Shotgun.summarize.
Does not require database connection or test data.'''
def setUp(self):
self.sg = api.Shotgun('http://server_path',
'script_name',
'api_key',
connect=False)
def test_filter_operator_none(self):
expected_logical_operator = 'and'
filter_operator = None
self._assert_filter_operator(expected_logical_operator, filter_operator)
def _assert_filter_operator(self, expected_logical_operator, filter_operator):
result = self.get_call_rpc_params(None, {'filter_operator': filter_operator})
actual_logical_operator = result['filters']['logical_operator']
self.assertEqual(expected_logical_operator, actual_logical_operator)
def test_filter_operator_all(self):
expected_logical_operator = 'and'
filter_operator = 'all'
self._assert_filter_operator(expected_logical_operator, filter_operator)
def test_filter_operator_or(self):
expected_logical_operator = 'or'
filter_operator = 'or'
self._assert_filter_operator(expected_logical_operator, filter_operator)
def test_filters(self):
path = 'path'
relation = 'relation'
value = 'value'
expected_condition = {'path': path, 'relation': relation, 'values': [value]}
args = ['', [[path, relation, value]], None]
result = self.get_call_rpc_params(args, {})
actual_condition = result['filters']['conditions'][0]
self.assertEqual(expected_condition, actual_condition)
@patch('shotgun_api3.Shotgun._call_rpc')
def get_call_rpc_params(self, args, kws, call_rpc):
'''Return params sent to _call_rpc from summarize.'''
if not args:
args = [None, [], None]
self.sg.summarize(*args, **kws)
return call_rpc.call_args[0][1]
def test_grouping(self):
result = self.get_call_rpc_params(None, {})
self.assertFalse('grouping' in result)
grouping = ['something']
kws = {'grouping': grouping}
result = self.get_call_rpc_params(None, kws)
self.assertEqual(grouping, result['grouping'])
def test_grouping_type(self):
'''test_grouping_type tests that grouping parameter is a list or None'''
self.assertRaises(ValueError, self.sg.summarize, '', [], [], grouping='Not a list')
class TestShotgunBatch(unittest.TestCase):
def setUp(self):
self.sg = api.Shotgun('http://server_path',
'script_name',
'api_key',
connect=False)
def test_missing_required_key(self):
req = {}
# requires keys request_type and entity_type
self.assertRaises(api.ShotgunError, self.sg.batch, [req])
req['entity_type'] = 'Entity'
self.assertRaises(api.ShotgunError, self.sg.batch, [req])
req['request_type'] = 'not_real_type'
self.assertRaises(api.ShotgunError, self.sg.batch, [req])
# create requires data key
req['request_type'] = 'create'
self.assertRaises(api.ShotgunError, self.sg.batch, [req])
# update requires entity_id and data
req['request_type'] = 'update'
req['data'] = {}
self.assertRaises(api.ShotgunError, self.sg.batch, [req])
del req['data']
req['entity_id'] = 2334
self.assertRaises(api.ShotgunError, self.sg.batch, [req])
# delete requires entity_id
req['request_type'] = 'delete'
del req['entity_id']
self.assertRaises(api.ShotgunError, self.sg.batch, [req])
class TestServerCapabilities(unittest.TestCase):
def test_no_server_version(self):
self.assertRaises(api.ShotgunError, api.shotgun.ServerCapabilities, 'host', {})
def test_bad_version(self):
'''test_bad_meta tests passing bad meta data type'''
self.assertRaises(api.ShotgunError, api.shotgun.ServerCapabilities, 'host', {'version': (0, 0, 0)})
def test_dev_version(self):
serverCapabilities = api.shotgun.ServerCapabilities('host', {'version': (3, 4, 0, 'Dev')})
self.assertEqual(serverCapabilities.version, (3, 4, 0))
self.assertTrue(serverCapabilities.is_dev)
serverCapabilities = api.shotgun.ServerCapabilities('host', {'version': (2, 4, 0)})
self.assertEqual(serverCapabilities.version, (2, 4, 0))
self.assertFalse(serverCapabilities.is_dev)
class TestClientCapabilities(unittest.TestCase):
def test_darwin(self):
self.assert_platform('Darwin', 'mac')
def test_windows(self):
self.assert_platform('win32', 'windows')
def test_linux(self):
self.assert_platform('Linux', 'linux')
def assert_platform(self, sys_ret_val, expected):
platform = api.shotgun.sys.platform
try:
api.shotgun.sys.platform = sys_ret_val
expected_local_path_field = "local_path_%s" % expected
client_caps = api.shotgun.ClientCapabilities()
self.assertEqual(client_caps.platform, expected)
self.assertEqual(client_caps.local_path_field, expected_local_path_field)
finally:
api.shotgun.sys.platform = platform
def test_no_platform(self):
platform = api.shotgun.sys.platform
try:
api.shotgun.sys.platform = "unsupported"
client_caps = api.shotgun.ClientCapabilities()
self.assertEqual(client_caps.platform, None)
self.assertEqual(client_caps.local_path_field, None)
finally:
api.shotgun.sys.platform = platform
@patch('shotgun_api3.shotgun.sys')
def test_py_version(self, mock_sys):
major = 2
minor = 7
micro = 3
mock_sys.version_info = (major, minor, micro, 'final', 0)
expected_py_version = "%s.%s" % (major, minor)
client_caps = api.shotgun.ClientCapabilities()
self.assertEqual(client_caps.py_version, expected_py_version)
class TestFilters(unittest.TestCase):
def test_empty(self):
expected = {
"logical_operator": "and",
"conditions": []
}
result = api.shotgun._translate_filters([], None)
self.assertEqual(result, expected)
def test_simple(self):
filters = [
["code", "is", "test"],
["sg_status_list", "is", "ip"]
]
expected = {
"logical_operator": "or",
"conditions": [
{"path": "code", "relation": "is", "values": ["test"]},
{"path": "sg_status_list", "relation": "is", "values": ["ip"]}
]
}
result = api.shotgun._translate_filters(filters, "any")
self.assertEqual(result, expected)
# Test both styles of passing arrays
def test_arrays(self):
expected = {
"logical_operator": "and",
"conditions": [
{"path": "code", "relation": "in", "values": ["test1", "test2", "test3"]}
]
}
filters = [
["code", "in", "test1", "test2", "test3"]
]
result = api.shotgun._translate_filters(filters, "all")
self.assertEqual(result, expected)
filters = [
["code", "in", ["test1", "test2", "test3"]]
]
result = api.shotgun._translate_filters(filters, "all")
self.assertEqual(result, expected)
def test_nested(self):
filters = [
["code", "in", "test"],
{
"filter_operator": "any",
"filters": [
["sg_status_list", "is", "ip"],
["sg_status_list", "is", "fin"],
{
"filter_operator": "all",
"filters": [
["sg_status_list", "is", "hld"],
["assets", "is", {"type": "Asset", "id": 9}]
]
}
]
}
]
expected = {
"logical_operator": "and",
"conditions": [
{"path": "code", "relation": "in", "values": ["test"]},
{
"logical_operator": "or",
"conditions": [
{"path": "sg_status_list", "relation": "is", "values": ["ip"]},
{"path": "sg_status_list", "relation": "is", "values": ["fin"]},
{
"logical_operator": "and",
"conditions": [
{"path": "sg_status_list", "relation": "is", "values": ["hld"]},
{"path": "assets", "relation": "is", "values": [{"type": "Asset", "id": 9}]},
]
}
]
}
]
}
result = api.shotgun._translate_filters(filters, "all")
self.assertEqual(result, expected)
def test_invalid(self):
self.assertRaises(api.ShotgunError, api.shotgun._translate_filters, [], "bogus")
self.assertRaises(api.ShotgunError, api.shotgun._translate_filters, ["bogus"], "all")
filters = [{
"filter_operator": "bogus",
"filters": []
}]
self.assertRaises(api.ShotgunError, api.shotgun._translate_filters, filters, "all")
filters = [{
"filters": []
}]
self.assertRaises(api.ShotgunError, api.shotgun._translate_filters, filters, "all")
filters = [{
"filter_operator": "all",
"filters": {"bogus": "bogus"}
}]
self.assertRaises(api.ShotgunError, api.shotgun._translate_filters, filters, "all")
class TestCerts(unittest.TestCase):
# A dummy bad url provided by Amazon
bad_url = "https://untrusted-root.badssl.com/"
# A list of Amazon cert URLS, taken from here:
# https://aws.amazon.com/blogs/security/how-to-prepare-for-aws-move-to-its-own-certificate-authority/
test_urls = [
"https://good.sca1a.amazontrust.com",
"https://good.sca2a.amazontrust.com",
"https://good.sca3a.amazontrust.com",
"https://good.sca4a.amazontrust.com",
"https://good.sca0a.amazontrust.com",
]
def setUp(self):
self.sg = api.Shotgun('http://server_path',
'script_name',
'api_key',
connect=False)
# Get the location of the certs file
self.certs = self.sg._get_certs_file(None)
def _check_url_with_sg_api_httplib2(self, url, certs):
"""
Given a url and the certs file, it will do a simple
request and return the result.
"""
http = Http(ca_certs=certs)
return http.request(url)
def _check_url_with_urllib(self, url):
"""
Given a url it will perform a simple request and return a result.
"""
# create a request using the opener generated by the SG API.
# The `_build_opener` method internally should use the correct certs.
opener = self.sg._build_opener(urllib.request.HTTPHandler)
request = urllib.request.Request(url)
return opener.open(request)
def test_found_correct_cert(self):
"""
Checks that the cert file the API is finding,
(when a cert path isn't passed and the SHOTGUN_API_CACERTS
isn't set), is the one bundled with this API
"""
# Get the path to the cert file we expect the Shotgun API to find
cert_path = os.path.normpath(
# Get the path relative to where we picked up the API and not relative
# to file on disk. On CI we pip install the API to run the tests
# so we have to pick the location from the installed copy.
# Call dirname to remove from __init__.py
os.path.join(os.path.dirname(api.__file__), "lib", "certifi", "cacert.pem")
)
# Now ensure that the path the SG API has found is correct.
self.assertEqual(cert_path, self.certs)
self.assertTrue(os.path.isfile(self.certs))
def test_httplib(self):
"""
Checks that we can access the amazon urls using our bundled
certificate with httplib.
"""
# First check that we get an error when trying to connect to a known dummy bad URL
self.assertRaises(ssl_error_classes, self._check_url_with_sg_api_httplib2, self.bad_url, self.certs)
# Now check that the good urls connect properly using the certs
for url in self.test_urls:
response, message = self._check_url_with_sg_api_httplib2(url, self.certs)
self.assertEqual(response["status"], "200")
def test_urlib(self):
"""
Checks that we can access the amazon urls using our bundled
certificate with urllib.
"""
# First check that we get an error when trying to connect to a known dummy bad URL
self.assertRaises(urllib.error.URLError, self._check_url_with_urllib, self.bad_url)
# Now check that the good urls connect properly using the certs
for url in self.test_urls:
response = self._check_url_with_urllib(url)
assert (response is not None)
class TestMimetypesFix(unittest.TestCase):
"""
Makes sure that the mimetypes fix will be imported.
"""
@patch('shotgun_api3.shotgun.sys')
def _test_mimetypes_import(self, platform, major, minor, patch_number, result, mock):
"""
Mocks sys.platform and sys.version_info to test the mimetypes import code.
"""
mock.version_info = [major, minor, patch_number]
mock.platform = platform
self.assertEqual(_is_mimetypes_broken(), result)
def test_correct_mimetypes_imported(self):
"""
Makes sure fix is imported for only for Python 2.7.0 to 2.7.7 on win32
"""
self._test_mimetypes_import("win32", 2, 6, 9, False)
for patch_number in range(0, 10): # 0 to 9 inclusively
self._test_mimetypes_import("win32", 2, 7, patch_number, True)
self._test_mimetypes_import("win32", 2, 7, 10, False)
self._test_mimetypes_import("win32", 3, 0, 0, False)
self._test_mimetypes_import("darwin", 2, 7, 0, False)
if __name__ == '__main__':
unittest.main()
You can’t perform that action at this time.