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 pathbase.py
More file actions
344 lines (286 loc) · 13.3 KB
/
Copy pathbase.py
File metadata and controls
344 lines (286 loc) · 13.3 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
"""Base class for Shotgun API tests."""
import os
import re
import unittest
from ConfigParser import ConfigParser
import mock
import shotgun_api3 as api
from shotgun_api3.shotgun import json
from shotgun_api3.shotgun import ServerCapabilities
CONFIG_PATH = 'tests/config'
class TestBase(unittest.TestCase):
'''Base class for tests.
Sets up mocking and database test data.'''
def __init__(self, *args, **kws):
unittest.TestCase.__init__(self, *args, **kws)
self.human_user = None
self.project = None
self.shot = None
self.asset = None
self.version = None
self.note = None
self.playlist = None
self.task = None
self.ticket = None
self.human_password = None
self.server_url = None
self.server_address = None
self.session_token = None
self.connect = False
def setUp(self, auth_mode='ApiUser'):
self.config = SgTestConfig()
self.config.read_config(CONFIG_PATH)
self.human_login = self.config.human_login
self.human_password = self.config.human_password
self.server_url = self.config.server_url
self.script_name = self.config.script_name
self.api_key = self.config.api_key
self.http_proxy = self.config.http_proxy
self.session_uuid = self.config.session_uuid
if auth_mode == 'ApiUser':
self.sg = api.Shotgun(self.config.server_url,
self.config.script_name,
self.config.api_key,
http_proxy=self.config.http_proxy,
connect=self.connect )
elif auth_mode == 'HumanUser':
self.sg = api.Shotgun(self.config.server_url,
login=self.human_login,
password=self.human_password,
http_proxy=self.config.http_proxy,
connect=self.connect )
elif auth_mode == 'SessionToken':
# first make an instance based on script key/name so
# we can generate a session token
sg = api.Shotgun(self.config.server_url,
self.config.script_name,
self.config.api_key,
http_proxy=self.config.http_proxy )
self.session_token = sg.get_session_token()
# now log in using session token
self.sg = api.Shotgun(self.config.server_url,
session_token=self.session_token,
http_proxy=self.config.http_proxy,
connect=self.connect )
else:
raise ValueError("Unknown value for auth_mode: %s" % auth_mode)
if self.config.session_uuid:
self.sg.set_session_uuid(self.config.session_uuid)
def tearDown(self):
self.sg = None
class MockTestBase(TestBase):
'''Test base for tests mocking server interactions.'''
def setUp(self):
super(MockTestBase, self).setUp()
#TODO see if there is another way to stop sg connecting
self._setup_mock()
self._setup_mock_data()
def _setup_mock(self):
"""Setup mocking on the ShotgunClient to stop it calling a live server
"""
#Replace the function used to make the final call to the server
#eaiser than mocking the http connection + response
self.sg._http_request = mock.Mock(spec=api.Shotgun._http_request,
return_value=((200, "OK"), {}, None))
#also replace the function that is called to get the http connection
#to avoid calling the server. OK to return a mock as we will not use
#it
self.mock_conn = mock.Mock(spec=api.lib.httplib2.Http)
#The Http objects connection property is a dict of connections
#it is holding
self.mock_conn.connections = dict()
self.sg._connection = self.mock_conn
self.sg._get_connection = mock.Mock(return_value=self.mock_conn)
#create the server caps directly to say we have the correct version
self.sg._server_caps = ServerCapabilities(self.sg.config.server,
{"version" : [2,4,0]})
def _mock_http(self, data, headers=None, status=None):
"""Setup a mock response from the SG server.
Only has an affect if the server has been mocked.
"""
#test for a mock object rather than config.mock as some tests
#force the mock to be created
if not isinstance(self.sg._http_request, mock.Mock):
return
if not isinstance(data, basestring):
data = json.dumps(data, ensure_ascii=False, encoding="utf-8")
resp_headers = { 'cache-control': 'no-cache',
'connection': 'close',
'content-length': (data and str(len(data))) or 0 ,
'content-type': 'application/json; charset=utf-8',
'date': 'Wed, 13 Apr 2011 04:18:58 GMT',
'server': 'Apache/2.2.3 (CentOS)',
'status': '200 OK' }
if headers:
resp_headers.update(headers)
if not status:
status = (200, "OK")
#create a new mock to reset call list etc.
self._setup_mock()
self.sg._http_request.return_value = (status, resp_headers, data)
def _assert_http_method(self, method, params, check_auth=True):
"""Asserts _http_request is called with the method and params."""
args, _ = self.sg._http_request.call_args
arg_body = args[2]
assert isinstance(arg_body, basestring)
arg_body = json.loads(arg_body)
arg_params = arg_body.get("params")
self.assertEqual(method, arg_body["method_name"])
if check_auth:
auth = arg_params[0]
self.assertEqual(self.script_name, auth["script_name"])
self.assertEqual(self.api_key, auth["script_key"])
if params:
rpc_args = arg_params[len(arg_params)-1]
self.assertEqual(params, rpc_args)
def _setup_mock_data(self):
self.human_user = { 'id':1,
'login':self.config.human_login,
'type':'HumanUser' }
self.project = { 'id':2,
'name':self.config.project_name,
'type':'Project' }
self.shot = { 'id':3,
'code':self.config.shot_code,
'type':'Shot' }
self.asset = { 'id':4,
'code':self.config.asset_code,
'type':'Asset' }
self.version = { 'id':5,
'code':self.config.version_code,
'type':'Version' }
self.ticket = { 'id':6,
'title':self.config.ticket_title,
'type':'Ticket' }
self.playlist = { 'id':7,
'code':self.config.playlist_code,
'type':'Playlist'}
class LiveTestBase(TestBase):
'''Test base for tests relying on connection to server.'''
def setUp(self, auth_mode='ApiUser'):
super(LiveTestBase, self).setUp(auth_mode)
self.sg_version = tuple(self.sg.info()['version'][:3])
self._setup_db(self.config)
if self.sg.server_caps.version and \
self.sg.server_caps.version >= (3, 3, 0) and \
(self.sg.server_caps.host.startswith('0.0.0.0') or \
self.sg.server_caps.host.startswith('127.0.0.1')):
self.server_address = re.sub('^0.0.0.0|127.0.0.1', 'localhost', self.sg.server_caps.host)
else:
self.server_address = self.sg.server_caps.host
def _setup_db(self, config):
data = {'name':self.config.project_name}
self.project = _find_or_create_entity(self.sg, 'Project', data)
data = {'name':self.config.human_name,
'login':self.config.human_login,
'password_proxy':self.config.human_password}
if self.sg_version >= (3, 0, 0):
data['locked_until'] = None
self.human_user = _find_or_create_entity(self.sg, 'HumanUser', data)
data = {'code':self.config.asset_code,
'project':self.project}
keys = ['code']
self.asset = _find_or_create_entity(self.sg, 'Asset', data, keys)
data = {'project':self.project,
'code':self.config.version_code,
'entity':self.asset,
'user':self.human_user,
'sg_frames_aspect_ratio': 13.3,
'frame_count': 33}
keys = ['code','project']
self.version = _find_or_create_entity(self.sg, 'Version', data, keys)
keys = ['code','project']
data = {'code':self.config.shot_code,
'project':self.project}
self.shot = _find_or_create_entity(self.sg, 'Shot', data, keys)
keys = ['project','user']
data = {'project':self.project,
'user':self.human_user,
'content':'anything'}
self.note = _find_or_create_entity(self.sg, 'Note', data, keys)
keys = ['code','project']
data = {'project':self.project,
'code':self.config.playlist_code}
self.playlist = _find_or_create_entity(self.sg, 'Playlist', data, keys)
keys = ['code', 'entity_type']
data = {'code': 'wrapper test step',
'entity_type': 'Shot'}
self.step = _find_or_create_entity(self.sg, 'Step', data, keys)
keys = ['project', 'entity', 'content']
data = {'project':self.project,
'entity':self.asset,
'content':self.config.task_content,
'color':'Black',
'due_date':'1968-10-13',
'task_assignees': [self.human_user],
'sg_status_list': 'ip'}
self.task = _find_or_create_entity(self.sg, 'Task', data, keys)
data = {'project':self.project,
'title':self.config.ticket_title,
'sg_priority': '3'}
keys = ['title','project', 'sg_priority']
self.ticket = _find_or_create_entity(self.sg, 'Ticket', data, keys)
keys = ['code']
data = {'code':'api wrapper test storage',
'mac_path':'nowhere',
'windows_path':'nowhere',
'linux_path':'nowhere'}
self.local_storage = _find_or_create_entity(self.sg, 'LocalStorage', data, keys)
class HumanUserAuthLiveTestBase(LiveTestBase):
'''
Test base for relying on a Shotgun connection authenticate through the
configured login/password pair.
'''
def setUp(self):
super(HumanUserAuthLiveTestBase, self).setUp('HumanUser')
class SessionTokenAuthLiveTestBase(LiveTestBase):
'''
Test base for relying on a Shotgun connection authenticate through the
configured session_token parameter.
'''
def setUp(self):
super(SessionTokenAuthLiveTestBase, self).setUp('SessionToken')
class SgTestConfig(object):
'''Reads test config and holds values'''
def __init__(self):
for key in self.config_keys():
# Look for any environment variables that match our test
# configuration naming of "SG_{KEY}". Default is None.
value = os.environ.get('SG_%s' % (str(key).upper()))
if key in ['mock']:
value = (value == None) or (str(value).lower() in ['true','1'])
setattr(self, key, value)
def config_keys(self):
return [
'api_key', 'asset_code', 'http_proxy', 'human_login', 'human_name',
'human_password', 'mock', 'project_name', 'script_name',
'server_url', 'session_uuid', 'shot_code', 'task_content',
'version_code', 'playlist_code'
]
def read_config(self, config_path):
config_parser = ConfigParser()
config_parser.read(config_path)
for section in config_parser.sections():
for option in config_parser.options(section):
# We only care about the configuration file if an environment
# variable has not already been set
if not getattr(self, option, None):
value = config_parser.get(section, option)
setattr(self, option, value)
def _find_or_create_entity(sg, entity_type, data, identifyiers=None):
'''Finds or creates entities.
@params:
sg - shogun_json.Shotgun instance
entity_type - entity type
data - dictionary of data for the entity
identifyiers -list of subset of keys from data which should be used to
uniquely identity the entity
@returns dicitonary of the entity values
'''
identifyiers = identifyiers or ['name']
fields = data.keys()
filters = [[key, 'is', data[key]] for key in identifyiers]
entity = sg.find_one(entity_type, filters, fields=fields)
entity = entity or sg.create(entity_type, data, return_fields=fields)
assert(entity)
return entity
You can’t perform that action at this time.