-
Notifications
You must be signed in to change notification settings - Fork 2k
/
test_update.py
415 lines (318 loc) · 15.7 KB
/
test_update.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
'''Unit tests for ckan/logic/action/update.py.'''
import datetime
import nose.tools
import mock
import pylons.config as config
import ckan.logic as logic
import ckan.new_tests.helpers as helpers
import ckan.new_tests.factories as factories
assert_raises = nose.tools.assert_raises
def datetime_from_string(s):
'''Return a standard datetime.datetime object initialised from a string in
the same format used for timestamps in dictized activities (the format
produced by datetime.datetime.isoformat())
'''
return datetime.datetime.strptime(s, '%Y-%m-%dT%H:%M:%S.%f')
class TestUpdate(object):
@classmethod
def setup_class(cls):
# Initialize the test db (if it isn't already) and clean out any data
# left in it.
# You should only do this in your setup_class() method if your test
# class uses the db, most test classes shouldn't need to.
helpers.reset_db()
def setup(self):
import ckan.model as model
# Reset the db before each test method.
# You should only do this in your setup() method if your test class
# uses the db, most test classes shouldn't need to.
model.repo.rebuild_db()
def teardown(self):
# Since some of the test methods below use the mock module to patch
# things, we use this teardown() method to remove remove all patches.
# (This makes sure the patches always get removed even if the test
# method aborts with an exception or something.)
mock.patch.stopall()
## START-AFTER
def test_user_update_name(self):
'''Test that updating a user's name works successfully.'''
# The canonical form of a test has four steps:
# 1. Setup any preconditions needed for the test.
# 2. Call the function that's being tested, once only.
# 3. Make assertions about the return value and/or side-effects of
# of the function that's being tested.
# 4. Do nothing else!
# 1. Setup.
user = factories.User()
# 2. Call the function that's being tested, once only.
# FIXME we have to pass the email address and password to user_update
# even though we're not updating those fields, otherwise validation
# fails.
helpers.call_action('user_update', id=user['name'],
email=user['email'],
password=factories.User.attributes()['password'],
name='updated',
)
# 3. Make assertions about the return value and/or side-effects.
updated_user = helpers.call_action('user_show', id=user['id'])
# Note that we check just the field we were trying to update, not the
# entire dict, only assert what we're actually testing.
assert updated_user['name'] == 'updated'
# 4. Do nothing else!
## END-BEFORE
def test_user_update_with_id_that_does_not_exist(self):
user_dict = factories.User.attributes()
user_dict['id'] = "there's no user with this id"
assert_raises(logic.NotFound, helpers.call_action,
'user_update', **user_dict)
def test_user_update_with_no_id(self):
user_dict = factories.User.attributes()
assert 'id' not in user_dict
assert_raises(logic.ValidationError, helpers.call_action,
'user_update', **user_dict)
## START-FOR-LOOP-EXAMPLE
def test_user_update_with_invalid_name(self):
user = factories.User()
invalid_names = ('', 'a', False, 0, -1, 23, 'new', 'edit', 'search',
'a' * 200, 'Hi!', 'i++%')
for name in invalid_names:
user['name'] = name
assert_raises(logic.ValidationError,
helpers.call_action, 'user_update',
**user)
## END-FOR-LOOP-EXAMPLE
def test_user_update_to_name_that_already_exists(self):
fred = factories.User(name='fred')
bob = factories.User(name='bob')
# Try to update fred and change his user name to bob, which is already
# bob's user name
fred['name'] = bob['name']
assert_raises(logic.ValidationError, helpers.call_action,
'user_update', **fred)
def test_user_update_password(self):
'''Test that updating a user's password works successfully.'''
user = factories.User()
# FIXME we have to pass the email address to user_update even though
# we're not updating it, otherwise validation fails.
helpers.call_action('user_update', id=user['name'],
email=user['email'],
password='new password',
)
# user_show() never returns the user's password, so we have to access
# the model directly to test it.
import ckan.model as model
updated_user = model.User.get(user['id'])
assert updated_user.validate_password('new password')
def test_user_update_with_short_password(self):
user = factories.User()
user['password'] = 'xxx' # This password is too short.
assert_raises(logic.ValidationError, helpers.call_action,
'user_update', **user)
def test_user_update_with_empty_password(self):
'''If an empty password is passed to user_update, nothing should
happen.
No error (e.g. a validation error) is raised, but the password is not
changed either.
'''
user_dict = factories.User.attributes()
original_password = user_dict['password']
user_dict = factories.User(**user_dict)
user_dict['password'] = ''
helpers.call_action('user_update', **user_dict)
import ckan.model as model
updated_user = model.User.get(user_dict['id'])
assert updated_user.validate_password(original_password)
def test_user_update_with_null_password(self):
user = factories.User()
user['password'] = None
assert_raises(logic.ValidationError, helpers.call_action,
'user_update', **user)
def test_user_update_with_invalid_password(self):
user = factories.User()
for password in (False, -1, 23, 30.7):
user['password'] = password
assert_raises(logic.ValidationError,
helpers.call_action, 'user_update',
**user)
def test_user_update_without_email_address(self):
'''You have to pass an email address when you call user_update.
Even if you don't want to change the user's email address, you still
have to pass their current email address to user_update.
FIXME: The point of this feature seems to be to prevent people from
removing email addresses from user accounts, but making them post the
current email address every time they post to user update is just
annoying, they should be able to post a dict with no 'email' key to
user_update and it should simply not change the current email.
'''
user = factories.User()
del user['email']
assert_raises(logic.ValidationError,
helpers.call_action, 'user_update',
**user)
# TODO: Valid and invalid values for the rest of the user model's fields.
def test_user_update_activity_stream(self):
'''Test that the right activity is emitted when updating a user.'''
user = factories.User()
before = datetime.datetime.now()
# FIXME we have to pass the email address and password to user_update
# even though we're not updating those fields, otherwise validation
# fails.
helpers.call_action('user_update', id=user['name'],
email=user['email'],
password=factories.User.attributes()['password'],
name='updated',
)
activity_stream = helpers.call_action('user_activity_list',
id=user['id'])
latest_activity = activity_stream[0]
assert latest_activity['activity_type'] == 'changed user'
assert latest_activity['object_id'] == user['id']
assert latest_activity['user_id'] == user['id']
after = datetime.datetime.now()
timestamp = datetime_from_string(latest_activity['timestamp'])
assert timestamp >= before and timestamp <= after
def test_user_update_with_custom_schema(self):
'''Test that custom schemas passed to user_update do get used.
user_update allows a custom validation schema to be passed to it in the
context dict. This is just a simple test that if you pass a custom
schema user_update does at least call a custom method that's given in
the custom schema. We assume this means it did use the custom schema
instead of the default one for validation, so user_update's custom
schema feature does work.
'''
import ckan.logic.schema
user = factories.User()
# A mock validator method, it doesn't do anything but it records what
# params it gets called with and how many times.
mock_validator = mock.MagicMock()
# Build a custom schema by taking the default schema and adding our
# mock method to its 'id' field.
schema = ckan.logic.schema.default_update_user_schema()
schema['id'].append(mock_validator)
# Call user_update and pass our custom schema in the context.
# FIXME: We have to pass email and password even though we're not
# trying to update them, or validation fails.
helpers.call_action('user_update', context={'schema': schema},
id=user['name'], email=user['email'],
password=factories.User.attributes()['password'],
name='updated',
)
# Since we passed user['name'] to user_update as the 'id' param,
# our mock validator method should have been called once with
# user['name'] as arg.
mock_validator.assert_called_once_with(user['name'])
def test_user_update_multiple(self):
'''Test that updating multiple user attributes at once works.'''
user = factories.User()
params = {
'id': user['id'],
'name': 'updated_name',
'fullname': 'updated full name',
'about': 'updated about',
# FIXME: We shouldn't have to put email here since we're not
# updating it, but user_update sucks.
'email': user['email'],
# FIXME: We shouldn't have to put password here since we're not
# updating it, but user_update sucks.
'password': factories.User.attributes()['password'],
}
helpers.call_action('user_update', **params)
updated_user = helpers.call_action('user_show', id=user['id'])
assert updated_user['name'] == 'updated_name'
assert updated_user['fullname'] == 'updated full name'
assert updated_user['about'] == 'updated about'
def test_user_update_does_not_return_password(self):
'''The user dict that user_update returns should not include the user's
password.'''
user = factories.User()
params = {
'id': user['id'],
'name': 'updated_name',
'fullname': 'updated full name',
'about': 'updated about',
'email': user['email'],
'password': factories.User.attributes()['password'],
}
updated_user = helpers.call_action('user_update', **params)
assert 'password' not in updated_user
def test_user_update_does_not_return_apikey(self):
'''The user dict that user_update returns should not include the user's
API key.'''
user = factories.User()
params = {
'id': user['id'],
'name': 'updated_name',
'fullname': 'updated full name',
'about': 'updated about',
'email': user['email'],
'password': factories.User.attributes()['password'],
}
updated_user = helpers.call_action('user_update', **params)
assert 'apikey' not in updated_user
def test_user_update_does_not_return_reset_key(self):
'''The user dict that user_update returns should not include the user's
reset key.'''
import ckan.lib.mailer
import ckan.model
user = factories.User()
ckan.lib.mailer.create_reset_key(ckan.model.User.get(user['id']))
params = {
'id': user['id'],
'name': 'updated_name',
'fullname': 'updated full name',
'about': 'updated about',
'email': user['email'],
'password': factories.User.attributes()['password'],
}
updated_user = helpers.call_action('user_update', **params)
assert 'reset_key' not in updated_user
def test_resource_reorder(self):
resource_urls = ["http://a.html", "http://b.html", "http://c.html"]
dataset = {"name": "basic",
"resources": [{'url': url} for url in resource_urls]
}
dataset = helpers.call_action('package_create', **dataset)
created_resource_urls = [resource['url'] for resource
in dataset['resources']]
assert created_resource_urls == resource_urls
mapping = dict((resource['url'], resource['id']) for resource
in dataset['resources'])
## This should put c.html at the front
reorder = {'id': dataset['id'], 'order':
[mapping["http://c.html"]]}
helpers.call_action('package_resource_reorder', **reorder)
dataset = helpers.call_action('package_show', id=dataset['id'])
reordered_resource_urls = [resource['url'] for resource
in dataset['resources']]
assert reordered_resource_urls == ["http://c.html",
"http://a.html",
"http://b.html"]
reorder = {'id': dataset['id'], 'order': [mapping["http://b.html"],
mapping["http://c.html"],
mapping["http://a.html"]]}
helpers.call_action('package_resource_reorder', **reorder)
dataset = helpers.call_action('package_show', id=dataset['id'])
reordered_resource_urls = [resource['url'] for resource
in dataset['resources']]
assert reordered_resource_urls == ["http://b.html",
"http://c.html",
"http://a.html"]
class TestUpdateSendEmailNotifications(object):
@classmethod
def setup_class(cls):
cls._original_config = dict(config)
config['ckan.activity_streams_email_notifications'] = True
@classmethod
def teardown_class(cls):
config.clear()
config.update(cls._original_config)
@mock.patch('ckan.logic.action.update.request')
def test_calling_through_paster_doesnt_validates_auth(self, mock_request):
mock_request.environ.get.return_value = True
helpers.call_action('send_email_notifications')
@mock.patch('ckan.logic.action.update.request')
def test_not_calling_through_paster_validates_auth(self, mock_request):
mock_request.environ.get.return_value = False
assert_raises(logic.NotAuthorized, helpers.call_action,
'send_email_notifications',
context={'ignore_auth': False})