|
| 1 | +from rest_framework.reverse import reverse |
| 2 | +from rest_framework.test import APITestCase |
| 3 | + |
| 4 | +from ..models import Blog, Entry |
| 5 | + |
| 6 | + |
| 7 | +class DJATestParameters(APITestCase): |
| 8 | + """ |
| 9 | + tests of JSON:API backends |
| 10 | + """ |
| 11 | + fixtures = ('blogentry',) |
| 12 | + |
| 13 | + def setUp(self): |
| 14 | + self.entries = Entry.objects.all() |
| 15 | + self.blogs = Blog.objects.all() |
| 16 | + self.url = reverse('nopage-entry-list') |
| 17 | + |
| 18 | + def test_sort(self): |
| 19 | + """ |
| 20 | + test sort |
| 21 | + """ |
| 22 | + response = self.client.get(self.url, data={'sort': 'headline'}) |
| 23 | + self.assertEqual(response.status_code, 200, |
| 24 | + msg=response.content.decode("utf-8")) |
| 25 | + dja_response = response.json() |
| 26 | + headlines = [c['attributes']['headline'] for c in dja_response['data']] |
| 27 | + sorted_headlines = sorted(headlines) |
| 28 | + self.assertEqual(headlines, sorted_headlines) |
| 29 | + |
| 30 | + def test_sort_reverse(self): |
| 31 | + """ |
| 32 | + confirm switching the sort order actually works |
| 33 | + """ |
| 34 | + response = self.client.get(self.url, data={'sort': '-headline'}) |
| 35 | + self.assertEqual(response.status_code, 200, |
| 36 | + msg=response.content.decode("utf-8")) |
| 37 | + dja_response = response.json() |
| 38 | + headlines = [c['attributes']['headline'] for c in dja_response['data']] |
| 39 | + sorted_headlines = sorted(headlines) |
| 40 | + self.assertNotEqual(headlines, sorted_headlines) |
| 41 | + |
| 42 | + def test_sort_double_negative(self): |
| 43 | + """ |
| 44 | + what if they provide multiple `-`'s? It's OK. |
| 45 | + """ |
| 46 | + response = self.client.get(self.url, data={'sort': '--headline'}) |
| 47 | + self.assertEqual(response.status_code, 200, |
| 48 | + msg=response.content.decode("utf-8")) |
| 49 | + dja_response = response.json() |
| 50 | + headlines = [c['attributes']['headline'] for c in dja_response['data']] |
| 51 | + sorted_headlines = sorted(headlines) |
| 52 | + self.assertNotEqual(headlines, sorted_headlines) |
| 53 | + |
| 54 | + def test_sort_invalid(self): |
| 55 | + """ |
| 56 | + test sort of invalid field |
| 57 | + """ |
| 58 | + response = self.client.get(self.url, |
| 59 | + data={'sort': 'nonesuch,headline,-not_a_field'}) |
| 60 | + self.assertEqual(response.status_code, 400, |
| 61 | + msg=response.content.decode("utf-8")) |
| 62 | + dja_response = response.json() |
| 63 | + self.assertEqual(dja_response['errors'][0]['detail'], |
| 64 | + "invalid sort parameters: nonesuch,-not_a_field") |
| 65 | + |
| 66 | + def test_sort_camelcase(self): |
| 67 | + """ |
| 68 | + test sort of camelcase field name |
| 69 | + """ |
| 70 | + response = self.client.get(self.url, data={'sort': 'bodyText'}) |
| 71 | + self.assertEqual(response.status_code, 200, |
| 72 | + msg=response.content.decode("utf-8")) |
| 73 | + dja_response = response.json() |
| 74 | + blog_ids = [(c['attributes']['bodyText'] or '') for c in dja_response['data']] |
| 75 | + sorted_blog_ids = sorted(blog_ids) |
| 76 | + self.assertEqual(blog_ids, sorted_blog_ids) |
| 77 | + |
| 78 | + def test_sort_underscore(self): |
| 79 | + """ |
| 80 | + test sort of underscore field name |
| 81 | + Do we allow this notation in a search even if camelcase is in effect? |
| 82 | + "Be conservative in what you send, be liberal in what you accept" |
| 83 | + -- https://en.wikipedia.org/wiki/Robustness_principle |
| 84 | + """ |
| 85 | + response = self.client.get(self.url, data={'sort': 'body_text'}) |
| 86 | + self.assertEqual(response.status_code, 200, |
| 87 | + msg=response.content.decode("utf-8")) |
| 88 | + dja_response = response.json() |
| 89 | + blog_ids = [(c['attributes']['bodyText'] or '') for c in dja_response['data']] |
| 90 | + sorted_blog_ids = sorted(blog_ids) |
| 91 | + self.assertEqual(blog_ids, sorted_blog_ids) |
| 92 | + |
| 93 | + def test_sort_related(self): |
| 94 | + """ |
| 95 | + test sort via related field using jsonapi path `.` and django orm `__` notation. |
| 96 | + ORM relations must be predefined in the View's .ordering_fields attr |
| 97 | + """ |
| 98 | + for datum in ('blog__id', 'blog.id'): |
| 99 | + response = self.client.get(self.url, data={'sort': datum}) |
| 100 | + self.assertEqual(response.status_code, 200, |
| 101 | + msg=response.content.decode("utf-8")) |
| 102 | + dja_response = response.json() |
| 103 | + blog_ids = [c['relationships']['blog']['data']['id'] for c in dja_response['data']] |
| 104 | + sorted_blog_ids = sorted(blog_ids) |
| 105 | + self.assertEqual(blog_ids, sorted_blog_ids) |
0 commit comments