refactored some tests from PR django-json-api#310

abdulhaq-e · abdulhaq-e · commit de0910af4db7 · 2017-02-03T08:17:27.000+02:00
diff --git a/docs/usage.md b/docs/usage.md
@@ -307,7 +307,7 @@ from rest_framework_json_api.relations import ResourceRelatedField
 from myapp.models import Order, LineItem, Customer
 
 
-class OrderSerializer(serializers.ModelSerializer):
+class OrderSerializer(serializers.HyperlinkedModelSerializer):
     class Meta:
         model = Order
 
@@ -371,7 +371,7 @@ class LineItemViewSet(viewsets.ModelViewSet):
         # unnested '/lineitems' route, the queryset should include all LineItems
         if 'order_pk' in self.kwargs:
             order_pk = self.kwargs['order_pk']
-            queryset = queryset.filter(order__pk=order_pk])
+            queryset = queryset.filter(order__pk=order_pk)
 
         return queryset
 ```
diff --git a/example/serializers.py b/example/serializers.py
@@ -44,7 +44,11 @@ def __init__(self, *args, **kwargs):
             source='comment_set', many=True, read_only=True)
     # many related from serializer
     suggested = relations.SerializerMethodResourceRelatedField(
-            source='get_suggested', model=Entry, many=True, read_only=True)
+            source='get_suggested', model=Entry, many=True, read_only=True,
+            related_link_view_name='entry-suggested',
+            related_link_url_kwarg='entry_pk',
+            self_link_view_name='entry-relationships',
+    )
     # single related from serializer
     featured = relations.SerializerMethodResourceRelatedField(
             source='get_featured', model=Entry, read_only=True)
diff --git a/example/tests/integration/test_meta.py b/example/tests/integration/test_meta.py
@@ -2,7 +2,7 @@
 from django.core.urlresolvers import reverse
 
 import pytest
-from example.tests.utils import dump_json, redump_json
+from example.tests.utils import load_json
 
 pytestmark = pytest.mark.django_db
 
@@ -36,10 +36,9 @@ def test_top_level_meta_for_list_view(blog, client):
     }
 
     response = client.get(reverse("blog-list"))
-    content_dump = redump_json(response.content)
-    expected_dump = dump_json(expected)
+    parsed_content = load_json(response.content)
 
-    assert content_dump == expected_dump
+    assert expected == parsed_content
 
 
 def test_top_level_meta_for_detail_view(blog, client):
@@ -64,7 +63,6 @@ def test_top_level_meta_for_detail_view(blog, client):
     }
 
     response = client.get(reverse("blog-detail", kwargs={'pk': blog.pk}))
-    content_dump = redump_json(response.content)
-    expected_dump = dump_json(expected)
+    parsed_content = load_json(response.content)
 
-    assert content_dump == expected_dump
+    assert expected == parsed_content
diff --git a/example/tests/integration/test_non_paginated_responses.py b/example/tests/integration/test_non_paginated_responses.py
@@ -6,7 +6,7 @@
 from example.views import EntryViewSet
 from rest_framework_json_api.pagination import PageNumberPagination
 
-from example.tests.utils import dump_json, redump_json
+from example.tests.utils import load_json
 
 pytestmark = pytest.mark.django_db
 
@@ -43,7 +43,11 @@ def test_multiple_entries_no_pagination(multiple_entries, rf):
                         "data": [{"type": "comments", "id": "1"}]
                     },
                     "suggested": {
-                        "data": [{"type": "entries", "id": "2"}]
+                        "data": [{"type": "entries", "id": "2"}],
+                        "links": {
+                            "related": "http://testserver/entries/1/suggested/",
+                            "self": "http://testserver/entries/1/relationships/suggested"
+                        }
                     }
                 }
             },
@@ -74,7 +78,11 @@ def test_multiple_entries_no_pagination(multiple_entries, rf):
                         "data": [{"type": "comments", "id": "2"}]
                     },
                     "suggested": {
-                        "data": [{"type": "entries", "id": "1"}]
+                        "data": [{"type": "entries", "id": "1"}],
+                        "links": {
+                            "related": "http://testserver/entries/2/suggested/",
+                            "self": "http://testserver/entries/2/relationships/suggested"
+                        }
                     }
                 }
             },
@@ -93,7 +101,6 @@ class NonPaginatedEntryViewSet(EntryViewSet):
     response = view(request)
     response.render()
 
-    content_dump = redump_json(response.content)
-    expected_dump = dump_json(expected)
+    parsed_content = load_json(response.content)
 
-    assert content_dump == expected_dump
+    assert expected == parsed_content
diff --git a/example/tests/integration/test_pagination.py b/example/tests/integration/test_pagination.py
@@ -1,7 +1,7 @@
 from django.core.urlresolvers import reverse
 
 import pytest
-from example.tests.utils import dump_json, redump_json
+from example.tests.utils import load_json
 
 pytestmark = pytest.mark.django_db
 
@@ -37,7 +37,11 @@ def test_pagination_with_single_entry(single_entry, client):
                         "data": [{"type": "comments", "id": "1"}]
                     },
                     "suggested": {
-                        "data": []
+                        "data": [],
+                        "links": {
+                            "related": "http://testserver/entries/1/suggested/",
+                            "self": "http://testserver/entries/1/relationships/suggested"
+                        }
                     }
                 }
             }],
@@ -59,7 +63,6 @@ def test_pagination_with_single_entry(single_entry, client):
     }
 
     response = client.get(reverse("entry-list"))
-    content_dump = redump_json(response.content)
-    expected_dump = dump_json(expected)
+    parsed_content = load_json(response.content)
 
-    assert content_dump == expected_dump
+    assert expected == parsed_content
diff --git a/example/tests/test_format_keys.py b/example/tests/test_format_keys.py
@@ -1,10 +1,9 @@
 from django.contrib.auth import get_user_model
 from django.core.urlresolvers import reverse
-from django.conf import settings
 from django.utils import encoding
 
 from example.tests import TestBase
-from example.tests.utils import dump_json, redump_json
+from example.tests.utils import load_json
 
 
 class FormatKeysSetTests(TestBase):
@@ -53,7 +52,6 @@ def test_camelization(self):
             }
         }
 
-        content_dump = redump_json(response.content)
-        expected_dump = dump_json(expected)
+        parsed_content = load_json(response.content)
 
-        assert expected_dump == content_dump
+        assert expected == parsed_content
diff --git a/example/tests/test_generic_validation.py b/example/tests/test_generic_validation.py
@@ -6,7 +6,7 @@
 from rest_framework.serializers import ValidationError
 
 from example.tests import TestBase
-from example.tests.utils import dump_json, redump_json
+from example.tests.utils import load_json
 
 
 class GenericValidationTest(TestBase):
@@ -34,7 +34,6 @@ def test_generic_validation_error(self):
             }]
         }
 
-        content_dump = redump_json(response.content)
-        expected_dump = dump_json(expected)
+        parsed_content = load_json(response.content)
 
-        assert expected_dump == content_dump
+        assert expected == parsed_content
diff --git a/example/tests/test_generic_viewset.py b/example/tests/test_generic_viewset.py
@@ -4,7 +4,7 @@
 from django.conf import settings
 
 from example.tests import TestBase
-from example.tests.utils import dump_json, redump_json
+from example.tests.utils import load_json
 
 
 class GenericViewSet(TestBase):
@@ -38,10 +38,9 @@ def test_default_rest_framework_behavior(self):
             'email': 'miles@example.com'
         }
 
-        content_dump = redump_json(response.content)
-        expected_dump = dump_json(expected)
+        parsed_content = load_json(response.content)
 
-        assert expected_dump == content_dump
+        assert expected == parsed_content
 
 
     def test_ember_expected_renderer(self):
@@ -66,10 +65,9 @@ def test_ember_expected_renderer(self):
             }
         }
 
-        content_dump = redump_json(response.content)
-        expected_dump = dump_json(expected)
+        parsed_content = load_json(response.content)
 
-        assert expected_dump == content_dump
+        assert expected == parsed_content
 
     def test_default_validation_exceptions(self):
         """
@@ -96,10 +94,9 @@ def test_default_validation_exceptions(self):
         response = self.client.post('/identities', {
             'email': 'bar', 'first_name': 'alajflajaljalajlfjafljalj'})
 
-        content_dump = redump_json(response.content)
-        expected_dump = dump_json(expected)
+        parsed_content = load_json(response.content)
 
-        assert expected_dump == content_dump
+        assert expected == parsed_content
 
     def test_custom_validation_exceptions(self):
         """
@@ -124,7 +121,6 @@ def test_custom_validation_exceptions(self):
         response = self.client.post('/identities', {
             'email': 'bar', 'last_name': 'alajflajaljalajlfjafljalj'})
 
-        content_dump = redump_json(response.content)
-        expected_dump = dump_json(expected)
+        parsed_content = load_json(response.content)
 
-        assert expected_dump == content_dump
+        assert expected == parsed_content
diff --git a/example/tests/test_model_viewsets.py b/example/tests/test_model_viewsets.py
@@ -6,7 +6,7 @@
 from django.conf import settings
 
 from example.tests import TestBase
-from example.tests.utils import dump_json, redump_json
+from example.tests.utils import dump_json, load_json
 
 
 class ModelViewSetTests(TestBase):
@@ -64,10 +64,9 @@ def test_key_in_list_result(self):
             }
         }
 
-        content_dump = redump_json(response.content)
-        expected_dump = dump_json(expected)
+        parsed_content = load_json(response.content)
 
-        assert expected_dump == content_dump
+        assert expected == parsed_content
 
     def test_page_two_in_list_result(self):
         """
@@ -104,10 +103,9 @@ def test_page_two_in_list_result(self):
             }
         }
 
-        content_dump = redump_json(response.content)
-        expected_dump = dump_json(expected)
+        parsed_content = load_json(response.content)
 
-        assert expected_dump == content_dump
+        assert expected == parsed_content
 
     def test_page_range_in_list_result(self):
         """
@@ -155,10 +153,9 @@ def test_page_range_in_list_result(self):
             }
         }
 
-        content_dump = redump_json(response.content)
-        expected_dump = dump_json(expected)
+        parsed_content = load_json(response.content)
 
-        assert expected_dump == content_dump
+        assert expected == parsed_content
 
     def test_key_in_detail_result(self):
         """
@@ -179,10 +176,9 @@ def test_key_in_detail_result(self):
             }
         }
 
-        content_dump = redump_json(response.content)
-        expected_dump = dump_json(expected)
+        parsed_content = load_json(response.content)
 
-        assert expected_dump == content_dump
+        assert expected == parsed_content
 
     def test_patch_requires_id(self):
         """
@@ -224,10 +220,9 @@ def test_key_in_post(self):
                                    content_type='application/vnd.api+json',
                                    data=dump_json(data))
 
-        content_dump = redump_json(response.content)
-        expected_dump = dump_json(data)
+        parsed_content = load_json(response.content)
 
-        assert expected_dump == content_dump
+        assert data == parsed_content
 
         # is it updated?
         self.assertEqual(
diff --git a/example/tests/test_parsers.py b/example/tests/test_parsers.py
@@ -1,3 +1,4 @@
+<<<<<<< HEAD
 # import json
 # 
 # from django.test import TestCase
@@ -35,4 +36,4 @@
 #         stream = BytesIO(self.string.encode('utf-8'))
 #         data = parser.parse(stream, None, self.parser_context)
 # 
-#         self.assertEqual(data['_meta'], {'random_key': 'random_value'})
+#         self.assertEqual(data['_meta'], {'random_key': 'random_value'})
diff --git a/example/tests/test_serializers.py b/example/tests/test_serializers.py
@@ -8,7 +8,7 @@
 from example.models import Blog, Entry, Author
 
 import pytest
-from example.tests.utils import dump_json, redump_json
+from example.tests.utils import load_json
 
 pytestmark = pytest.mark.django_db
 
@@ -108,7 +108,6 @@ def test_model_serializer_with_implicit_fields(self, comment, client):
 
         assert response.status_code == 200
 
-        actual = redump_json(response.content)
-        expected_json = dump_json(expected)
+        parsed_content = load_json(response.content)
 
-        assert actual == expected_json
+        assert expected == parsed_content
diff --git a/example/tests/test_views.py b/example/tests/test_views.py
@@ -221,4 +221,4 @@
 #         request = factory.post('/', data, content_type='application/vnd.api+json')
 #         user = self.create_user('user', 'pass')
 #         force_authenticate(request, user)
-#         return view(request)
+#         return view(request)
diff --git a/example/tests/utils.py b/example/tests/utils.py
@@ -19,24 +19,3 @@ def dump_json(data):
     }
 
     return force_bytes(json.dumps(data, **json_kwargs))
-
-
-def redump_json(data):
-    '''
-    The response.content is already a JSON formatted string BUT
-    we don't know anything about its formatting, in particular,
-    the indent and separators arguments. DRF has a complex method to
-    determine what values to use for each argument and unfortunately,
-    the methods aren't the same in all DRF versions.
-
-    So what to do? LOAD the JSON formmated string (response.content)
-    as a Python object and DUMP it again and hence the name of this function.
-
-    This will guarantee that we're comparing two similarly formatted JSON
-    strings. Only the formatting similarity is guaranteed. As for the content,
-    that's what the tests are for!
-    '''
-
-    data = json.loads(force_text(data))
-
-    return dump_json(data)
diff --git a/example/urls_test.py b/example/urls_test.py
@@ -15,7 +15,6 @@
 
 urlpatterns = [
     url(r'^', include(router.urls)),
-
     url(r'^entries/(?P<pk>[^/.]+)/relationships/(?P<related_field>\w+)',
         EntryRelationshipView.as_view(),
         name='entry-relationships'),
diff --git a/rest_framework_json_api/parsers.py b/rest_framework_json_api/parsers.py
diff --git a/rest_framework_json_api/relations.py b/rest_framework_json_api/relations.py
diff --git a/rest_framework_json_api/renderers.py b/rest_framework_json_api/renderers.py

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+<<<<<<< HEAD`
`1`	`2`	`# import json`
`2`	`3`	`#`
`3`	`4`	`# from django.test import TestCase`
`@@ -35,4 +36,4 @@`
`35`	`36`	`# stream = BytesIO(self.string.encode('utf-8'))`
`36`	`37`	`# data = parser.parse(stream, None, self.parser_context)`
`37`	`38`	`#`
`38`		`-# self.assertEqual(data['_meta'], {'random_key': 'random_value'})`
	`39`	`+# self.assertEqual(data['_meta'], {'random_key': 'random_value'})`