forked from django-json-api/django-rest-framework-json-api
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathtest_views.py
580 lines (504 loc) · 21.8 KB
/
test_views.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
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
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
import json
from django.test import RequestFactory, override_settings
from django.utils import timezone
from rest_framework.exceptions import NotFound
from rest_framework.request import Request
from rest_framework.reverse import reverse
from rest_framework.test import APIRequestFactory, APITestCase, force_authenticate
from rest_framework_json_api.utils import format_resource_type
from example.factories import AuthorFactory, CommentFactory, EntryFactory
from example.models import Author, Blog, Comment, Entry
from example.serializers import (
AuthorBioSerializer,
AuthorTypeSerializer,
EntrySerializer,
)
from example.tests import TestBase
from example.views import AuthorViewSet, BlogViewSet
class TestRelationshipView(APITestCase):
def setUp(self):
self.author = Author.objects.create(
name="Super powerful superhero", email="[email protected]"
)
self.blog = Blog.objects.create(name="Some Blog", tagline="It's a blog")
self.other_blog = Blog.objects.create(
name="Other blog", tagline="It's another blog"
)
self.first_entry = Entry.objects.create(
blog=self.blog,
headline="headline one",
body_text="body_text two",
pub_date=timezone.now(),
mod_date=timezone.now(),
n_comments=0,
n_pingbacks=0,
rating=3,
)
self.second_entry = Entry.objects.create(
blog=self.blog,
headline="headline two",
body_text="body_text one",
pub_date=timezone.now(),
mod_date=timezone.now(),
n_comments=0,
n_pingbacks=0,
rating=1,
)
self.first_comment = Comment.objects.create(
entry=self.first_entry, body="This entry is cool", author=None
)
self.second_comment = Comment.objects.create(
entry=self.second_entry, body="This entry is not cool", author=self.author
)
def test_get_entry_relationship_blog(self):
url = reverse(
"entry-relationships",
kwargs={"pk": self.first_entry.id, "related_field": "blog"},
)
response = self.client.get(url)
expected_data = {
"type": format_resource_type("Blog"),
"id": str(self.first_entry.blog.id),
}
assert response.data == expected_data
def test_get_entry_relationship_invalid_field(self):
response = self.client.get(
f"/entries/{self.first_entry.id}/relationships/invalid_field"
)
assert response.status_code == 404
def test_get_blog_relationship_entry_set(self):
response = self.client.get(f"/blogs/{self.blog.id}/relationships/entry_set")
expected_data = [
{"type": format_resource_type("Entry"), "id": str(self.first_entry.id)},
{"type": format_resource_type("Entry"), "id": str(self.second_entry.id)},
]
assert response.data == expected_data
@override_settings(JSON_API_FORMAT_RELATED_LINKS="dasherize")
def test_get_blog_relationship_entry_set_with_formatted_link(self):
response = self.client.get(f"/blogs/{self.blog.id}/relationships/entry-set")
expected_data = [
{"type": format_resource_type("Entry"), "id": str(self.first_entry.id)},
{"type": format_resource_type("Entry"), "id": str(self.second_entry.id)},
]
assert response.data == expected_data
def test_put_entry_relationship_blog_returns_405(self):
url = f"/entries/{self.first_entry.id}/relationships/blog"
response = self.client.put(url, data={})
assert response.status_code == 405
def test_patch_invalid_entry_relationship_blog_returns_400(self):
url = f"/entries/{self.first_entry.id}/relationships/blog"
response = self.client.patch(url, data={"data": {"invalid": ""}})
assert response.status_code == 400
def test_relationship_view_errors_format(self):
url = f"/entries/{self.first_entry.id}/relationships/blog"
response = self.client.patch(url, data={"data": {"invalid": ""}})
assert response.status_code == 400
result = json.loads(response.content.decode("utf-8"))
assert "data" not in result
assert "errors" in result
def test_get_empty_to_one_relationship(self):
url = f"/comments/{self.first_entry.id}/relationships/author"
response = self.client.get(url)
expected_data = None
assert response.data == expected_data
def test_get_to_many_relationship_self_link(self):
url = f"/authors/{self.author.id}/relationships/comments"
response = self.client.get(url)
expected_data = {
"links": {"self": "http://testserver/authors/1/relationships/comments"},
"data": [
{
"id": str(self.second_comment.id),
"type": format_resource_type("Comment"),
}
],
}
assert json.loads(response.content.decode("utf-8")) == expected_data
def test_patch_to_one_relationship(self):
url = f"/entries/{self.first_entry.id}/relationships/blog"
request_data = {
"data": {
"type": format_resource_type("Blog"),
"id": str(self.other_blog.id),
}
}
response = self.client.patch(url, data=request_data)
assert response.status_code == 200, response.content.decode()
assert response.data == request_data["data"]
response = self.client.get(url)
assert response.data == request_data["data"]
def test_patch_one_to_many_relationship(self):
url = f"/blogs/{self.first_entry.id}/relationships/entry_set"
request_data = {
"data": [
{"type": format_resource_type("Entry"), "id": str(self.first_entry.id)},
]
}
response = self.client.patch(url, data=request_data)
assert response.status_code == 200, response.content.decode()
assert response.data == request_data["data"]
response = self.client.get(url)
assert response.data == request_data["data"]
# retry a second time should end up with same result
response = self.client.patch(url, data=request_data)
assert response.status_code == 200, response.content.decode()
assert response.data == request_data["data"]
response = self.client.get(url)
assert response.data == request_data["data"]
def test_patch_one_to_many_relaitonship_with_none(self):
url = f"/blogs/{self.first_entry.id}/relationships/entry_set"
request_data = {"data": None}
response = self.client.patch(url, data=request_data)
assert response.status_code == 200, response.content.decode()
assert response.data == []
response = self.client.get(url)
assert response.data == []
def test_patch_many_to_many_relationship(self):
url = f"/entries/{self.first_entry.id}/relationships/authors"
request_data = {
"data": [
{"type": format_resource_type("Author"), "id": str(self.author.id)},
]
}
response = self.client.patch(url, data=request_data)
assert response.status_code == 200, response.content.decode()
assert response.data == request_data["data"]
response = self.client.get(url)
assert response.data == request_data["data"]
# retry a second time should end up with same result
response = self.client.patch(url, data=request_data)
assert response.status_code == 200, response.content.decode()
assert response.data == request_data["data"]
response = self.client.get(url)
assert response.data == request_data["data"]
def test_post_to_one_relationship_should_fail(self):
url = f"/entries/{self.first_entry.id}/relationships/blog"
request_data = {
"data": {
"type": format_resource_type("Blog"),
"id": str(self.other_blog.id),
}
}
response = self.client.post(url, data=request_data)
assert response.status_code == 405, response.content.decode()
def test_post_to_many_relationship_with_no_change(self):
url = f"/entries/{self.first_entry.id}/relationships/comments"
request_data = {
"data": [
{
"type": format_resource_type("Comment"),
"id": str(self.first_comment.id),
},
]
}
response = self.client.post(url, data=request_data)
assert response.status_code == 204, response.content.decode()
assert len(response.rendered_content) == 0, response.rendered_content.decode()
def test_post_to_many_relationship_with_change(self):
url = f"/entries/{self.first_entry.id}/relationships/comments"
request_data = {
"data": [
{
"type": format_resource_type("Comment"),
"id": str(self.second_comment.id),
},
]
}
response = self.client.post(url, data=request_data)
assert response.status_code == 200, response.content.decode()
assert request_data["data"][0] in response.data
def test_delete_to_one_relationship_should_fail(self):
url = f"/entries/{self.first_entry.id}/relationships/blog"
request_data = {
"data": {
"type": format_resource_type("Blog"),
"id": str(self.other_blog.id),
}
}
response = self.client.delete(url, data=request_data)
assert response.status_code == 405, response.content.decode()
def test_delete_relationship_overriding_with_none(self):
url = f"/comments/{self.second_comment.id}"
request_data = {
"data": {
"type": "comments",
"id": self.second_comment.id,
"relationships": {"author": {"data": None}},
}
}
response = self.client.patch(url, data=request_data)
assert response.status_code == 200, response.content.decode()
assert response.data["author"] is None
def test_delete_to_many_relationship_with_no_change(self):
url = f"/entries/{self.first_entry.id}/relationships/comments"
request_data = {
"data": [
{
"type": format_resource_type("Comment"),
"id": str(self.second_comment.id),
},
]
}
response = self.client.delete(url, data=request_data)
assert response.status_code == 204, response.content.decode()
assert len(response.rendered_content) == 0, response.rendered_content.decode()
def test_delete_one_to_many_relationship_with_not_null_constraint(self):
url = f"/entries/{self.first_entry.id}/relationships/comments"
request_data = {
"data": [
{
"type": format_resource_type("Comment"),
"id": str(self.first_comment.id),
},
]
}
response = self.client.delete(url, data=request_data)
assert response.status_code == 409, response.content.decode()
def test_delete_to_many_relationship_with_change(self):
url = f"/authors/{self.author.id}/relationships/comments"
request_data = {
"data": [
{
"type": format_resource_type("Comment"),
"id": str(self.second_comment.id),
},
]
}
response = self.client.delete(url, data=request_data)
assert response.status_code == 200, response.content.decode()
def test_new_comment_data_patch_to_many_relationship(self):
entry = EntryFactory(blog=self.blog, authors=(self.author,))
comment = CommentFactory(entry=entry)
url = f"/authors/{self.author.id}/relationships/comments"
request_data = {
"data": [
{"type": format_resource_type("Comment"), "id": str(comment.id)},
]
}
previous_response = {
"data": [{"type": "comments", "id": str(self.second_comment.id)}],
"links": {
"self": "http://testserver/authors/{}/relationships/comments".format(
self.author.id
)
},
}
response = self.client.get(url)
assert response.status_code == 200
assert response.json() == previous_response
new_patched_response = {
"data": [{"type": "comments", "id": str(comment.id)}],
"links": {
"self": "http://testserver/authors/{}/relationships/comments".format(
self.author.id
)
},
}
response = self.client.patch(url, data=request_data)
assert response.status_code == 200
assert response.json() == new_patched_response
assert Comment.objects.filter(id=self.second_comment.id).exists()
def test_options_entry_relationship_blog(self):
url = reverse(
"entry-relationships",
kwargs={"pk": self.first_entry.id, "related_field": "blog"},
)
response = self.client.options(url)
expected_data = {
"data": {
"name": "Entry Relationship",
"description": "",
"renders": ["application/vnd.api+json", "text/html"],
"parses": [
"application/vnd.api+json",
"application/x-www-form-urlencoded",
"multipart/form-data",
],
"allowed_methods": [
"GET",
"POST",
"PATCH",
"DELETE",
"HEAD",
"OPTIONS",
],
"actions": {"POST": {}},
}
}
assert response.json() == expected_data
class TestRelatedMixin(APITestCase):
def setUp(self):
self.author = AuthorFactory()
def _get_view(self, kwargs):
factory = APIRequestFactory()
request = Request(factory.get("", content_type="application/vnd.api+json"))
return AuthorViewSet(request=request, kwargs=kwargs)
def test_get_related_field_name(self):
kwargs = {"pk": self.author.id, "related_field": "bio"}
view = self._get_view(kwargs)
got = view.get_related_field_name()
self.assertEqual(got, kwargs["related_field"])
def test_get_related_instance_serializer_field(self):
kwargs = {"pk": self.author.id, "related_field": "bio"}
view = self._get_view(kwargs)
got = view.get_related_instance()
self.assertEqual(got, self.author.bio)
def test_get_related_instance_model_field(self):
kwargs = {"pk": self.author.id, "related_field": "id"}
view = self._get_view(kwargs)
got = view.get_related_instance()
self.assertEqual(got, self.author.id)
def test_get_related_serializer_class(self):
kwargs = {"pk": self.author.id, "related_field": "bio"}
view = self._get_view(kwargs)
got = view.get_related_serializer_class()
self.assertEqual(got, AuthorBioSerializer)
def test_get_related_serializer_class_many(self):
kwargs = {"pk": self.author.id, "related_field": "entries"}
view = self._get_view(kwargs)
got = view.get_related_serializer_class()
self.assertEqual(got, EntrySerializer)
def test_get_serializer_comes_from_included_serializers(self):
kwargs = {"pk": self.author.id, "related_field": "author_type"}
view = self._get_view(kwargs)
related_serializers = view.get_serializer_class().related_serializers
delattr(view.get_serializer_class(), "related_serializers")
got = view.get_related_serializer_class()
self.assertEqual(got, AuthorTypeSerializer)
view.get_serializer_class().related_serializers = related_serializers
def test_get_related_serializer_class_raises_error(self):
kwargs = {"pk": self.author.id, "related_field": "unknown"}
view = self._get_view(kwargs)
self.assertRaises(NotFound, view.get_related_serializer_class)
def test_retrieve_related_single_reverse_lookup(self):
url = reverse(
"author-related", kwargs={"pk": self.author.pk, "related_field": "bio"}
)
resp = self.client.get(url, data={"include": "metadata"})
expected = {
"data": {
"type": "authorBios",
"id": str(self.author.bio.id),
"relationships": {
"author": {"data": {"type": "authors", "id": str(self.author.id)}},
"metadata": {
"data": {
"id": str(self.author.bio.metadata.id),
"type": "authorBioMetadata",
}
},
},
"attributes": {"body": str(self.author.bio.body)},
},
"included": [
{
"attributes": {"body": str(self.author.bio.metadata.body)},
"id": str(self.author.bio.metadata.id),
"type": "authorBioMetadata",
}
],
}
self.assertEqual(resp.status_code, 200)
self.assertEqual(resp.json(), expected)
def test_retrieve_related_single(self):
url = reverse(
"author-related",
kwargs={"pk": self.author.author_type.pk, "related_field": "author_type"},
)
resp = self.client.get(url)
expected = {
"data": {
"type": "authorTypes",
"id": str(self.author.author_type.id),
"attributes": {"name": str(self.author.author_type.name)},
}
}
self.assertEqual(resp.status_code, 200)
self.assertEqual(resp.json(), expected)
def test_retrieve_related_many(self):
entry = EntryFactory(authors=self.author)
url = reverse(
"author-related", kwargs={"pk": self.author.pk, "related_field": "entries"}
)
resp = self.client.get(url)
self.assertEqual(resp.status_code, 200)
self.assertTrue(isinstance(resp.json()["data"], list))
self.assertEqual(len(resp.json()["data"]), 1)
self.assertEqual(resp.json()["data"][0]["id"], str(entry.id))
def test_retrieve_related_many_hyperlinked(self):
comment = CommentFactory(author=self.author)
url = reverse(
"author-related", kwargs={"pk": self.author.pk, "related_field": "comments"}
)
resp = self.client.get(url)
self.assertEqual(resp.status_code, 200)
self.assertTrue(isinstance(resp.json()["data"], list))
self.assertEqual(len(resp.json()["data"]), 1)
self.assertEqual(resp.json()["data"][0]["id"], str(comment.id))
def test_retrieve_related_None(self):
kwargs = {"pk": self.author.pk, "related_field": "first_entry"}
url = reverse("author-related", kwargs=kwargs)
resp = self.client.get(url)
self.assertEqual(resp.status_code, 200)
self.assertEqual(resp.json(), {"data": None})
@override_settings(JSON_API_FORMAT_RELATED_LINKS="dasherize")
def test_retrieve_related_with_formatted_link(self):
first_entry = EntryFactory(authors=(self.author,))
kwargs = {"pk": self.author.pk, "related_field": "first-entry"}
url = reverse("author-related", kwargs=kwargs)
resp = self.client.get(url)
self.assertEqual(resp.status_code, 200)
self.assertEqual(resp.json()["data"]["id"], str(first_entry.id))
class TestValidationErrorResponses(TestBase):
def test_if_returns_error_on_empty_post(self):
view = BlogViewSet.as_view({"post": "create"})
response = self._get_create_response("{}", view)
self.assertEqual(400, response.status_code)
expected = [
{
"detail": "Received document does not contain primary data",
"status": "400",
"source": {"pointer": "/data"},
"code": "parse_error",
}
]
self.assertEqual(expected, response.data)
def test_if_returns_error_on_missing_form_data_post(self):
view = BlogViewSet.as_view({"post": "create"})
response = self._get_create_response(
'{"data":{"attributes":{},"type":"blogs"}}', view
)
self.assertEqual(400, response.status_code)
expected = [
{
"status": "400",
"detail": "This field is required.",
"source": {"pointer": "/data/attributes/name"},
"code": "required",
}
]
self.assertEqual(expected, response.data)
def test_if_returns_error_on_bad_endpoint_name(self):
view = BlogViewSet.as_view({"post": "create"})
response = self._get_create_response(
'{"data":{"attributes":{},"type":"bad"}}', view
)
self.assertEqual(409, response.status_code)
expected = [
{
"detail": (
"The resource object's type (bad) is not the type that constitute the collection "
"represented by the endpoint (blogs)."
),
"source": {"pointer": "/data"},
"status": "409",
"code": "error",
}
]
self.assertEqual(expected, response.data)
def _get_create_response(self, data, view):
factory = RequestFactory()
request = factory.post("/", data, content_type="application/vnd.api+json")
user = self.create_user("user", "pass")
force_authenticate(request, user)
return view(request)