-
Notifications
You must be signed in to change notification settings - Fork 2k
/
base.py
426 lines (357 loc) · 14.7 KB
/
base.py
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
import re
try:
from cStringIO import StringIO
except ImportError:
from StringIO import StringIO
import urllib
from pylons import config
import webhelpers.util
from nose.tools import assert_equal
from paste.fixture import TestRequest
from ckan.tests import *
import ckan.model as model
from ckan.lib.create_test_data import CreateTestData
from ckan.lib.helpers import json, url_escape
from ckan.tests import TestController as ControllerTestCase
ACCESS_DENIED = [403]
class ApiTestCase(object):
STATUS_200_OK = 200
STATUS_201_CREATED = 201
STATUS_400_BAD_REQUEST = 400
STATUS_403_ACCESS_DENIED = 403
STATUS_404_NOT_FOUND = 404
STATUS_409_CONFLICT = 409
send_authorization_header = True
extra_environ = {}
api_version = None
ref_package_by = ''
ref_group_by = ''
def get(self, offset, status=[200]):
response = self.app.get(offset, status=status,
extra_environ=self.get_extra_environ())
return response
def post(self, offset, data, status=[200,201], *args, **kwds):
params = '%s=1' % url_escape(self.dumps(data))
if 'extra_environ' in kwds:
self.extra_environ = kwds['extra_environ']
response = self.app.post(offset, params=params, status=status,
extra_environ=self.get_extra_environ())
return response
def app_delete(self, offset, status=[200,201], *args, **kwds):
response = self.app.delete(offset, status=status,
extra_environ=self.get_extra_environ())
return response
def get_extra_environ(self):
extra_environ = {}
for (key,value) in self.extra_environ.items():
if key == 'Authorization':
if self.send_authorization_header == True:
extra_environ[key] = value
else:
extra_environ[key] = value
return extra_environ
@classmethod
def offset(self, path):
"""
Returns the full path to the resource identified in path.
Performs necessary url-encodings, ie:
- encodes unicode to utf8
- urlencodes the resulting byte array
This process is described in [1], and has also been confirmed by
inspecting what a browser does.
[1] http://www.w3.org/International/articles/idn-and-iri/
"""
assert self.api_version != None, "API version is missing."
base = '/api'
if self.api_version:
base += '/%s' % self.api_version
utf8_encoded = (u'%s%s' % (base, path)).encode('utf8')
url_encoded = urllib.quote(utf8_encoded)
return url_encoded
def assert_msg_represents_anna(self, msg):
assert 'annakarenina' in msg, msg
data = self.loads(msg)
self.assert_equal(data['name'], 'annakarenina')
self.assert_equal(data['license_id'], 'other-open')
assert '"license_id": "other-open"' in msg, str(msg)
assert 'russian' in msg, msg
assert 'tolstoy' in msg, msg
assert '"extras": {' in msg, msg
assert '"genre": "romantic novel"' in msg, msg
assert '"original media": "book"' in msg, msg
assert 'annakarenina.com/download' in msg, msg
assert '"plain text"' in msg, msg
assert '"Index of the novel"' in msg, msg
assert '"id": "%s"' % self.anna.id in msg, msg
expected = '"groups": ['
assert expected in msg, (expected, msg)
expected = self.group_ref_from_name('roger')
assert expected in msg, (expected, msg)
expected = self.group_ref_from_name('david')
assert expected in msg, (expected, msg)
# Todo: What is the deal with ckan_url? And should this use IDs rather than names?
assert 'ckan_url' in msg
assert '"ckan_url": "http://test.ckan.net/dataset/annakarenina"' in msg, msg
assert 'tags' in data, "Expected a tags list in json payload"
assert self.russian.name in data['tags'], data['tags']
assert self.tolstoy.name in data['tags'], data['tags']
assert self.flexible_tag.name in data['tags'], data['tags']
def assert_msg_represents_roger(self, msg):
assert 'roger' in msg, msg
data = self.loads(msg)
keys = set(data.keys())
expected_keys = set(['id', 'name', 'title', 'description', 'created',
'state', 'revision_id', 'packages'])
missing_keys = expected_keys - keys
assert not missing_keys, missing_keys
assert_equal(data['name'], 'roger')
assert_equal(data['title'], 'Roger\'s books')
assert_equal(data['description'], 'Roger likes these books.')
assert_equal(data['state'], 'active')
assert_equal(data['packages'], [self._ref_package(self.anna)])
def assert_msg_represents_russian(self, msg):
data = self.loads(msg)
pkgs = set(data)
expected_pkgs = set([self.package_ref_from_name('annakarenina'),
self.package_ref_from_name('warandpeace')])
differences = expected_pkgs ^ pkgs
assert not differences, '%r != %r' % (pkgs, expected_pkgs)
def assert_msg_represents_flexible_tag(self, msg):
"""
Asserts the correct packages are associated with the flexible tag.
Namely, 'annakarenina' and 'warandpeace'.
"""
data = self.loads(msg)
pkgs = set(data)
expected_pkgs = set([self.package_ref_from_name('annakarenina'),
self.package_ref_from_name('warandpeace')])
differences = expected_pkgs ^ pkgs
assert not differences, '%r != %r' % (pkgs, expected_pkgs)
def data_from_res(self, res):
return self.loads(res.body)
def package_ref_from_name(self, package_name):
package = self.get_package_by_name(unicode(package_name))
if package is None:
return package_name
else:
return self.ref_package(package)
def package_id_from_ref(self, package_name):
package = self.get_package_by_name(unicode(package_name))
if package is None:
return package_name
else:
return self.ref_package(package)
def ref_package(self, package):
assert self.ref_package_by in ['id', 'name']
return getattr(package, self.ref_package_by)
def get_expected_api_version(self):
return self.api_version
def dumps(self, data):
return json.dumps(data)
def loads(self, chars):
try:
return json.loads(chars)
except ValueError, inst:
raise Exception, "Couldn't loads string '%s': %s" % (chars, inst)
def assert_json_response(self, res, expected_in_body=None):
content_type = res.header_dict['Content-Type']
assert 'application/json' in content_type, content_type
res_json = self.loads(res.body)
if expected_in_body:
assert expected_in_body in res_json or \
expected_in_body in str(res_json), \
'Expected to find %r in JSON response %r' % \
(expected_in_body, res_json)
class Api1and2TestCase(object):
''' Utils for v1 and v2 API.
* RESTful URL utils
'''
def package_offset(self, package_name=None):
if package_name is None:
# Package Register
return self.offset('/rest/dataset')
else:
# Package Entity
package_ref = self.package_ref_from_name(package_name)
return self.offset('/rest/dataset/%s' % package_ref)
def group_offset(self, group_name=None):
if group_name is None:
# Group Register
return self.offset('/rest/group')
else:
# Group Entity
group_ref = self.group_ref_from_name(group_name)
return self.offset('/rest/group/%s' % group_ref)
def group_ref_from_name(self, group_name):
group = self.get_group_by_name(unicode(group_name))
if group is None:
return group_name
else:
return self.ref_group(group)
def ref_group(self, group):
assert self.ref_group_by in ['id', 'name']
return getattr(group, self.ref_group_by)
def revision_offset(self, revision_id=None):
if revision_id is None:
# Revision Register
return self.offset('/rest/revision')
else:
# Revision Entity
return self.offset('/rest/revision/%s' % revision_id)
def rating_offset(self, package_name=None):
if package_name is None:
# Revision Register
return self.offset('/rest/rating')
else:
# Revision Entity
package_ref = self.package_ref_from_name(package_name)
return self.offset('/rest/rating/%s' % package_ref)
def anna_offset(self, postfix=''):
return self.package_offset('annakarenina') + postfix
def tag_offset(self, tag_name=None):
if tag_name is None:
# Tag Register
return self.offset('/rest/tag')
else:
# Tag Entity
tag_ref = self.tag_ref_from_name(tag_name)
return self.offset('/rest/tag/%s' % tag_ref)
def tag_ref_from_name(self, tag_name):
tag = self.get_tag_by_name(unicode(tag_name))
if tag is None:
return tag_name
else:
return self.ref_tag(tag)
def ref_tag(self, tag):
assert self.ref_tag_by in ['id', 'name']
return getattr(tag, self.ref_tag_by)
@classmethod
def _ref_package(cls, package):
assert cls.ref_package_by in ['id', 'name']
return getattr(package, cls.ref_package_by)
@classmethod
def _ref_group(cls, group):
assert cls.ref_group_by in ['id', 'name']
return getattr(group, cls.ref_group_by)
class Api1TestCase(Api1and2TestCase):
api_version = 1
ref_package_by = 'name'
ref_group_by = 'name'
ref_tag_by = 'name'
def assert_msg_represents_anna(self, msg):
super(Api1TestCase, self).assert_msg_represents_anna(msg)
assert '"download_url": "http://www.annakarenina.com/download/x=1&y=2"' in msg, msg
class Api2TestCase(Api1and2TestCase):
api_version = 2
ref_package_by = 'id'
ref_group_by = 'id'
ref_tag_by = 'id'
def assert_msg_represents_anna(self, msg):
super(Api2TestCase, self).assert_msg_represents_anna(msg)
assert 'download_url' not in msg, msg
class Api3TestCase(ApiTestCase):
api_version = 3
ref_package_by = 'name'
ref_group_by = 'name'
ref_tag_by = 'name'
def assert_msg_represents_anna(self, msg):
super(Api2TestCase, self).assert_msg_represents_anna(msg)
assert 'download_url' not in msg, msg
class BaseModelApiTestCase(ApiTestCase, ControllerTestCase):
testpackage_license_id = u'gpl-3.0'
package_fixture_data = {
'name' : u'testpkg',
'title': u'Some Title',
'url': u'http://blahblahblah.mydomain',
'resources': [{
u'url':u'http://blah.com/file.xml',
u'format':u'xml',
u'description':u'Main file',
u'hash':u'abc123',
u'alt_url':u'alt_url',
u'size_extra':u'200',
}, {
u'url':u'http://blah.com/file2.xml',
u'format':u'xml',
u'description':u'Second file',
u'hash':u'def123',
u'alt_url':u'alt_url',
u'size_extra':u'200',
}],
'tags': [u'russion', u'novel'],
'license_id': testpackage_license_id,
'extras': {
'genre' : u'horror',
'media' : u'dvd',
},
}
testgroupvalues = {
'name' : u'testgroup',
'title' : u'Some Group Title',
'description' : u'Great group!',
'packages' : [u'annakarenina', u'warandpeace'],
}
user_name = u'http://myrandom.openidservice.org/'
def setup(self):
super(BaseModelApiTestCase, self).setup()
# self.conditional_create_common_fixtures()
# self.init_extra_environ()
def teardown(self):
model.Session.remove()
# model.repo.rebuild_db()
super(BaseModelApiTestCase, self).teardown()
@classmethod
def init_extra_environ(cls, user_name):
# essentially 'logs you in', so the http_request methods
# called elsewhere in this class are run with the specified
# user logged in.
cls.user = model.User.by_name(user_name)
cls.extra_environ={'Authorization' : str(cls.user.apikey)}
cls.adminuser = model.User.by_name('testsysadmin')
cls.admin_extra_environ={'Authorization' : str(cls.adminuser.apikey)}
def post_json(self, offset, data, status=None, extra_environ=None):
''' Posts data in the body in application/json format, used by
javascript libraries.
(rather than Paste Fixture\'s default format of
application/x-www-form-urlencoded)
'''
return self.http_request(offset, data, content_type='application/json',
request_method='POST',
content_length=len(data),
status=status, extra_environ=extra_environ)
def delete_request(self, offset, status=None, extra_environ=None):
''' Sends a delete request. Similar to the paste.delete but it
does not send the content type or content length.
'''
return self.http_request(offset, data='', content_type=None,
request_method='DELETE',
content_length=None,
status=status,
extra_environ=extra_environ)
def http_request(self, offset, data,
content_type='application/json',
request_method='POST',
content_length=None,
status=None,
extra_environ=None):
''' Posts data in the body in a user-specified format.
(rather than Paste Fixture\'s default Content-Type of
application/x-www-form-urlencoded)
'''
environ = self.app._make_environ()
if content_type:
environ['CONTENT_TYPE'] = content_type
if content_length is not None:
environ['CONTENT_LENGTH'] = str(content_length)
environ['REQUEST_METHOD'] = request_method
environ['QUERY_STRING'] = '' # avoids a warning
environ['wsgi.input'] = StringIO(data)
if extra_environ:
environ.update(extra_environ)
self.app._set_headers({}, environ)
req = TestRequest(offset, environ, expect_errors=False)
return self.app.do_request(req, status=status)
def set_env(self, extra_environ):
''' used to reset env when admin has been forced etc '''
environ = self.app._make_environ()
environ.update(extra_environ)