Repository navigation
Expand file tree
/
Copy pathtest_comment.py
More file actions
537 lines (452 loc) · 21.7 KB
/
Copy pathtest_comment.py
File metadata and controls
537 lines (452 loc) · 21.7 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
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
# Patchwork - automated patch tracking system
# Copyright (C) 2018 Red Hat
#
# SPDX-License-Identifier: GPL-2.0-or-later
from django.test import override_settings
from django.urls import NoReverseMatch
from django.urls import reverse
from rest_framework import status
from patchwork.models import PatchComment
from patchwork.models import CoverComment
from patchwork.tests.unit.api import utils
from patchwork.tests.utils import create_cover
from patchwork.tests.utils import create_cover_comment
from patchwork.tests.utils import create_patch
from patchwork.tests.utils import create_patch_comment
from patchwork.tests.utils import create_maintainer
from patchwork.tests.utils import create_project
from patchwork.tests.utils import create_person
from patchwork.tests.utils import create_user
from patchwork.tests.utils import SAMPLE_CONTENT
@override_settings(ENABLE_REST_API=True)
class TestCoverComments(utils.APITestCase):
@staticmethod
def api_url(cover, version=None, item=None):
kwargs = {'cover_id': cover.id}
if version:
kwargs['version'] = version
if item is None:
return reverse('api-cover-comment-list', kwargs=kwargs)
kwargs['comment_id'] = item.id
return reverse('api-cover-comment-detail', kwargs=kwargs)
def setUp(self):
super(TestCoverComments, self).setUp()
self.project = create_project()
self.user = create_maintainer(self.project)
self.cover = create_cover(project=self.project)
def assertSerialized(self, comment_obj, comment_json):
self.assertEqual(comment_obj.id, comment_json['id'])
self.assertEqual(
comment_obj.submitter.id, comment_json['submitter']['id']
)
self.assertEqual(comment_obj.addressed, comment_json['addressed'])
self.assertIn(SAMPLE_CONTENT, comment_json['content'])
def test_list_empty(self):
"""List cover letter comments when none are present."""
cover = create_cover()
resp = self.client.get(self.api_url(cover))
self.assertEqual(status.HTTP_200_OK, resp.status_code)
self.assertEqual(0, len(resp.data))
@utils.store_samples('cover-comment-list')
def test_list(self):
"""List cover letter comments."""
comment = create_cover_comment(cover=self.cover)
resp = self.client.get(self.api_url(self.cover))
self.assertEqual(status.HTTP_200_OK, resp.status_code)
self.assertEqual(1, len(resp.data))
self.assertSerialized(comment, resp.data[0])
self.assertIn('list_archive_url', resp.data[0])
self.assertIn('addressed', resp.data[0])
def test_list_query_count(self):
self.project.list_archive_url_format = 'https://example.com/{}'
self.project.save()
comments = [create_cover_comment(cover=self.cover) for _ in range(10)]
for version in ('1.1', '1.2', None):
with self.assertNumQueries(3):
response = self.client.get(
self.api_url(self.cover, version=version)
)
self.assertEqual(status.HTTP_200_OK, response.status_code)
self.assertEqual(len(comments), len(response.data))
for comment, data in zip(comments, response.data):
self.assertIn(SAMPLE_CONTENT, data['content'])
if version == '1.1':
self.assertNotIn('list_archive_url', data)
else:
self.assertEqual(
f'https://example.com/{comment.url_msgid}',
data['list_archive_url'],
)
def test_list_version_1_2(self):
"""List cover letter comments using API v1.2."""
create_cover_comment(cover=self.cover)
resp = self.client.get(self.api_url(self.cover, version='1.2'))
self.assertEqual(status.HTTP_200_OK, resp.status_code)
self.assertEqual(1, len(resp.data))
self.assertIn('list_archive_url', resp.data[0])
self.assertNotIn('addressed', resp.data[0])
def test_list_version_1_1(self):
"""List cover letter comments using API v1.1."""
create_cover_comment(cover=self.cover)
resp = self.client.get(self.api_url(self.cover, version='1.1'))
self.assertEqual(status.HTTP_200_OK, resp.status_code)
self.assertEqual(1, len(resp.data))
self.assertNotIn('list_archive_url', resp.data[0])
self.assertNotIn('addressed', resp.data[0])
def test_list_version_1_0(self):
"""List cover letter comments using API v1.0.
Ensure we can't access cover comments using the old version of the API.
"""
with self.assertRaises(NoReverseMatch):
self.client.get(self.api_url(self.cover, version='1.0'))
def test_list_non_existent_cover(self):
"""Ensure we get a 404 for a non-existent cover letter."""
resp = self.client.get(
reverse('api-cover-comment-list', kwargs={'cover_id': '99999'})
)
self.assertEqual(status.HTTP_404_NOT_FOUND, resp.status_code)
def test_list_invalid_cover(self):
"""Ensure we get a 404 for an invalid cover letter ID."""
with self.assertRaises(NoReverseMatch):
self.client.get(
reverse('api-cover-comment-list', kwargs={'pk': 'foo'}),
)
@utils.store_samples('cover-comment-detail')
def test_detail(self):
"""Show a cover letter comment."""
comment = create_cover_comment(cover=self.cover)
resp = self.client.get(self.api_url(self.cover, item=comment))
self.assertEqual(status.HTTP_200_OK, resp.status_code)
self.assertSerialized(comment, resp.data)
def test_detail_version_1_2(self):
"""Show a cover letter comment using API v1.2."""
comment = create_cover_comment(cover=self.cover)
with self.assertRaises(NoReverseMatch):
self.client.get(
self.api_url(self.cover, version='1.2', item=comment)
)
def test_detail_version_1_1(self):
"""Show a cover letter comment using API v1.1."""
comment = create_cover_comment(cover=self.cover)
with self.assertRaises(NoReverseMatch):
self.client.get(
self.api_url(self.cover, version='1.1', item=comment)
)
def test_detail_version_1_0(self):
"""Show a cover letter comment using API v1.0."""
comment = create_cover_comment(cover=self.cover)
with self.assertRaises(NoReverseMatch):
self.client.get(
self.api_url(self.cover, version='1.0', item=comment)
)
@utils.store_samples('cover-comment-detail-error-not-found')
def test_detail_invalid_cover(self):
"""Ensure we handle non-existent cover letters."""
comment = create_cover_comment()
resp = self.client.get(
reverse(
'api-cover-comment-detail',
kwargs={'cover_id': '99999', 'comment_id': comment.id},
),
)
self.assertEqual(status.HTTP_404_NOT_FOUND, resp.status_code)
def _test_update(self, person, **kwargs):
submitter = kwargs.get('submitter', person)
cover = kwargs.get('cover', self.cover)
comment = create_cover_comment(submitter=submitter, cover=cover)
if kwargs.get('authenticate', True):
self.client.authenticate(user=person.user)
return self.client.patch(
self.api_url(cover, item=comment),
{'addressed': kwargs.get('addressed', True)},
validate_request=kwargs.get('validate_request', True),
)
@utils.store_samples('cover-comment-detail-update-authorized')
def test_update_authorized(self):
"""Update an existing cover letter comment as an authorized user.
To be authorized users must meet at least one of the following:
- project maintainer, cover letter submitter, or cover letter
comment submitter
Ensure updates can only be performed by authorized users.
"""
# Update as maintainer
person = create_person(user=self.user)
resp = self._test_update(person=person)
self.assertEqual(1, CoverComment.objects.all().count())
self.assertEqual(status.HTTP_200_OK, resp.status_code)
self.assertTrue(resp.data['addressed'])
# Update as cover letter submitter
person = create_person(name='cover-submitter', user=create_user())
cover = create_cover(submitter=person)
resp = self._test_update(person=person, cover=cover)
self.assertEqual(2, CoverComment.objects.all().count())
self.assertEqual(status.HTTP_200_OK, resp.status_code)
self.assertTrue(resp.data['addressed'])
# Update as cover letter comment submitter
person = create_person(name='comment-submitter', user=create_user())
cover = create_cover()
resp = self._test_update(person=person, cover=cover, submitter=person)
self.assertEqual(3, CoverComment.objects.all().count())
self.assertEqual(status.HTTP_200_OK, resp.status_code)
self.assertTrue(resp.data['addressed'])
@utils.store_samples('cover-comment-detail-update-not-authorized')
def test_update_not_authorized(self):
"""Update an existing cover letter comment when not signed in and
not authorized.
To be authorized users must meet at least one of the following:
- project maintainer, cover letter submitter, or cover letter
comment submitter
Ensure updates can only be performed by authorized users.
"""
person = create_person(user=self.user)
resp = self._test_update(person=person, authenticate=False)
self.assertEqual(status.HTTP_403_FORBIDDEN, resp.status_code)
person = create_person() # normal user without edit permissions
resp = self._test_update(person=person) # signed-in
self.assertEqual(status.HTTP_403_FORBIDDEN, resp.status_code)
@utils.store_samples('cover-comment-detail-update-error-bad-request')
def test_update_invalid_addressed(self):
"""Update an existing cover letter comment using invalid values.
Ensure we handle invalid cover letter comment addressed values.
"""
person = create_person(name='cover-submitter', user=create_user())
cover = create_cover(submitter=person)
resp = self._test_update(
person=person,
cover=cover,
addressed='not-valid',
validate_request=False,
)
self.assertEqual(status.HTTP_400_BAD_REQUEST, resp.status_code)
self.assertFalse(
getattr(CoverComment.objects.all().first(), 'addressed')
)
def test_create_delete(self):
"""Ensure creates and deletes aren't allowed"""
comment = create_cover_comment(cover=self.cover)
self.user.is_superuser = True
self.user.save()
self.client.authenticate(user=self.user)
resp = self.client.post(self.api_url(self.cover, item=comment))
self.assertEqual(status.HTTP_405_METHOD_NOT_ALLOWED, resp.status_code)
resp = self.client.delete(self.api_url(self.cover, item=comment))
self.assertEqual(status.HTTP_405_METHOD_NOT_ALLOWED, resp.status_code)
@override_settings(ENABLE_REST_API=True)
class TestPatchComments(utils.APITestCase):
@staticmethod
def api_url(patch, version=None, item=None):
kwargs = {'patch_id': patch.id}
if version:
kwargs['version'] = version
if item is None:
return reverse('api-patch-comment-list', kwargs=kwargs)
kwargs['comment_id'] = item.id
return reverse('api-patch-comment-detail', kwargs=kwargs)
def setUp(self):
super(TestPatchComments, self).setUp()
self.project = create_project()
self.user = create_maintainer(self.project)
self.patch = create_patch(project=self.project)
def assertSerialized(self, comment_obj, comment_json):
self.assertEqual(comment_obj.id, comment_json['id'])
self.assertEqual(
comment_obj.submitter.id, comment_json['submitter']['id']
)
self.assertEqual(comment_obj.addressed, comment_json['addressed'])
self.assertIn(SAMPLE_CONTENT, comment_json['content'])
def test_list_empty(self):
"""List patch comments when none are present."""
resp = self.client.get(self.api_url(self.patch))
self.assertEqual(status.HTTP_200_OK, resp.status_code)
self.assertEqual(0, len(resp.data))
@utils.store_samples('patch-comment-list')
def test_list(self):
"""List patch comments."""
comment = create_patch_comment(patch=self.patch)
resp = self.client.get(self.api_url(self.patch))
self.assertEqual(status.HTTP_200_OK, resp.status_code)
self.assertEqual(1, len(resp.data))
self.assertSerialized(comment, resp.data[0])
self.assertIn('list_archive_url', resp.data[0])
self.assertIn('addressed', resp.data[0])
def test_list_query_count(self):
self.project.list_archive_url_format = 'https://example.com/{}'
self.project.save()
comments = [create_patch_comment(patch=self.patch) for _ in range(10)]
for version in ('1.1', '1.2', None):
with self.assertNumQueries(3):
response = self.client.get(
self.api_url(self.patch, version=version)
)
self.assertEqual(status.HTTP_200_OK, response.status_code)
self.assertEqual(len(comments), len(response.data))
for comment, data in zip(comments, response.data):
self.assertIn(SAMPLE_CONTENT, data['content'])
if version == '1.1':
self.assertNotIn('list_archive_url', data)
else:
self.assertEqual(
f'https://example.com/{comment.url_msgid}',
data['list_archive_url'],
)
def test_list_version_1_2(self):
"""List patch comments using API v1.2."""
create_patch_comment(patch=self.patch)
resp = self.client.get(self.api_url(self.patch, version='1.2'))
self.assertEqual(status.HTTP_200_OK, resp.status_code)
self.assertEqual(1, len(resp.data))
self.assertIn('list_archive_url', resp.data[0])
self.assertNotIn('addressed', resp.data[0])
def test_list_version_1_1(self):
"""List patch comments using API v1.1."""
create_patch_comment(patch=self.patch)
resp = self.client.get(self.api_url(self.patch, version='1.1'))
self.assertEqual(status.HTTP_200_OK, resp.status_code)
self.assertEqual(1, len(resp.data))
self.assertNotIn('list_archive_url', resp.data[0])
self.assertNotIn('addressed', resp.data[0])
def test_list_version_1_0(self):
"""List patch comments using API v1.0.
Ensure we can't access comments using the old version of the API.
"""
with self.assertRaises(NoReverseMatch):
self.client.get(self.api_url(self.patch, version='1.0'))
def test_list_non_existent_patch(self):
"""Ensure we get a 404 for a non-existent patch."""
resp = self.client.get(
reverse('api-patch-comment-list', kwargs={'patch_id': '99999'})
)
self.assertEqual(status.HTTP_404_NOT_FOUND, resp.status_code)
def test_list_invalid_patch(self):
"""Ensure we get a 404 for an invalid patch ID."""
with self.assertRaises(NoReverseMatch):
self.client.get(
reverse('api-patch-comment-list', kwargs={'patch_id': 'foo'}),
)
@utils.store_samples('patch-comment-detail')
def test_detail(self):
"""Show a patch comment."""
comment = create_patch_comment(patch=self.patch)
resp = self.client.get(self.api_url(self.patch, item=comment))
self.assertEqual(status.HTTP_200_OK, resp.status_code)
self.assertSerialized(comment, resp.data)
def test_detail_version_1_2(self):
"""Show a patch comment using API v1.2."""
comment = create_patch_comment(patch=self.patch)
with self.assertRaises(NoReverseMatch):
self.client.get(
self.api_url(self.patch, version='1.2', item=comment)
)
def test_detail_version_1_1(self):
"""Show a patch comment using API v1.1."""
comment = create_patch_comment(patch=self.patch)
with self.assertRaises(NoReverseMatch):
self.client.get(
self.api_url(self.patch, version='1.1', item=comment)
)
def test_detail_version_1_0(self):
"""Show a patch comment using API v1.0."""
comment = create_patch_comment(patch=self.patch)
with self.assertRaises(NoReverseMatch):
self.client.get(
self.api_url(self.patch, version='1.0', item=comment)
)
@utils.store_samples('patch-comment-detail-error-not-found')
def test_detail_invalid_patch(self):
"""Ensure we handle non-existent patches."""
comment = create_patch_comment()
resp = self.client.get(
reverse(
'api-patch-comment-detail',
kwargs={'patch_id': '99999', 'comment_id': comment.id},
),
)
self.assertEqual(status.HTTP_404_NOT_FOUND, resp.status_code)
def _test_update(self, person, **kwargs):
submitter = kwargs.get('submitter', person)
patch = kwargs.get('patch', self.patch)
comment = create_patch_comment(submitter=submitter, patch=patch)
if kwargs.get('authenticate', True):
self.client.authenticate(user=person.user)
return self.client.patch(
self.api_url(patch, item=comment),
{'addressed': kwargs.get('addressed', True)},
validate_request=kwargs.get('validate_request', True),
)
@utils.store_samples('patch-comment-detail-update-authorized')
def test_update_authorized(self):
"""Update an existing patch comment as an authorized user.
To be authorized users must meet at least one of the following:
- project maintainer, patch submitter, patch delegate, or
patch comment submitter
Ensure updates can only be performed by authorized users.
"""
# Update as maintainer
person = create_person(user=self.user)
resp = self._test_update(person=person)
self.assertEqual(1, PatchComment.objects.all().count())
self.assertEqual(status.HTTP_200_OK, resp.status_code)
self.assertTrue(resp.data['addressed'])
# Update as patch submitter
person = create_person(name='patch-submitter', user=create_user())
patch = create_patch(submitter=person)
resp = self._test_update(person=person, patch=patch)
self.assertEqual(2, PatchComment.objects.all().count())
self.assertEqual(status.HTTP_200_OK, resp.status_code)
self.assertTrue(resp.data['addressed'])
# Update as patch delegate
person = create_person(name='patch-delegate', user=create_user())
patch = create_patch(delegate=person.user)
resp = self._test_update(person=person, patch=patch)
self.assertEqual(3, PatchComment.objects.all().count())
self.assertEqual(status.HTTP_200_OK, resp.status_code)
self.assertTrue(resp.data['addressed'])
# Update as patch comment submitter
person = create_person(name='comment-submitter', user=create_user())
patch = create_patch()
resp = self._test_update(person=person, patch=patch, submitter=person)
self.assertEqual(4, PatchComment.objects.all().count())
self.assertEqual(status.HTTP_200_OK, resp.status_code)
self.assertTrue(resp.data['addressed'])
@utils.store_samples('patch-comment-detail-update-not-authorized')
def test_update_not_authorized(self):
"""Update an existing patch comment when not signed in and not
authorized.
To be authorized users must meet at least one of the following:
- project maintainer, patch submitter, patch delegate, or
patch comment submitter
Ensure updates can only be performed by authorized users.
"""
person = create_person(user=self.user)
resp = self._test_update(person=person, authenticate=False)
self.assertEqual(status.HTTP_403_FORBIDDEN, resp.status_code)
person = create_person() # normal user without edit permissions
resp = self._test_update(person=person) # signed-in
self.assertEqual(status.HTTP_403_FORBIDDEN, resp.status_code)
@utils.store_samples('patch-comment-detail-update-error-bad-request')
def test_update_invalid_addressed(self):
"""Update an existing patch comment using invalid values.
Ensure we handle invalid patch comment addressed values.
"""
person = create_person(name='patch-submitter', user=create_user())
patch = create_patch(submitter=person)
resp = self._test_update(
person=person,
patch=patch,
addressed='not-valid',
validate_request=False,
)
self.assertEqual(status.HTTP_400_BAD_REQUEST, resp.status_code)
self.assertFalse(
getattr(PatchComment.objects.all().first(), 'addressed')
)
def test_create_delete(self):
"""Ensure creates and deletes aren't allowed"""
comment = create_patch_comment(patch=self.patch)
self.user.is_superuser = True
self.user.save()
self.client.authenticate(user=self.user)
resp = self.client.post(self.api_url(self.patch, item=comment))
self.assertEqual(status.HTTP_405_METHOD_NOT_ALLOWED, resp.status_code)
resp = self.client.delete(self.api_url(self.patch, item=comment))
self.assertEqual(status.HTTP_405_METHOD_NOT_ALLOWED, resp.status_code)