Change default behavior of tests to use nested serializers (#816)

sliverc · n2ygk · web-flow · commit 959aec7cadcb · 2020-08-25T13:32:13.000-04:00
Co-authored-by: Alan Crosswell &lt;alan@columbia.edu&gt;
diff --git a/example/serializers.py b/example/serializers.py
@@ -40,9 +40,9 @@ class Meta:
 
 class BlogSerializer(serializers.ModelSerializer):
     copyright = serializers.SerializerMethodField()
-    tags = TaggedItemSerializer(many=True, read_only=True)
+    tags = relations.ResourceRelatedField(many=True, read_only=True)
 
-    include_serializers = {
+    included_serializers = {
         'tags': 'example.serializers.TaggedItemSerializer',
     }
 
@@ -147,7 +147,7 @@ def __init__(self, *args, **kwargs):
         model=Entry,
         read_only=True
     )
-    tags = TaggedItemSerializer(many=True, read_only=True)
+    tags = relations.ResourceRelatedField(many=True, read_only=True)
 
     def get_suggested(self, obj):
         return Entry.objects.exclude(pk=obj.pk)
diff --git a/example/settings/dev.py b/example/settings/dev.py
@@ -67,6 +67,7 @@
 
 JSON_API_FORMAT_FIELD_NAMES = 'camelize'
 JSON_API_FORMAT_TYPES = 'camelize'
+JSON_API_SERIALIZE_NESTED_SERIALIZERS_AS_ATTRIBUTE = True
 REST_FRAMEWORK = {
     'PAGE_SIZE': 5,
     'EXCEPTION_HANDLER': 'rest_framework_json_api.exceptions.exception_handler',
diff --git a/example/tests/integration/test_meta.py b/example/tests/integration/test_meta.py
@@ -18,11 +18,7 @@ def test_top_level_meta_for_list_view(blog, client):
             "links": {
                 "self": 'http://testserver/blogs/1'
             },
-            "relationships": {
-                "tags": {
-                    "data": []
-                }
-            },
+            'relationships': {'tags': {'data': [], 'meta': {'count': 0}}},
             "meta": {
                 "copyright": datetime.now().year
             },
@@ -53,11 +49,7 @@ def test_top_level_meta_for_detail_view(blog, client):
             "attributes": {
                 "name": blog.name
             },
-            "relationships": {
-                "tags": {
-                    "data": []
-                }
-            },
+            'relationships': {'tags': {'data': [], 'meta': {'count': 0}}},
             "links": {
                 "self": "http://testserver/blogs/1"
             },
diff --git a/example/tests/integration/test_non_paginated_responses.py b/example/tests/integration/test_non_paginated_responses.py
@@ -72,9 +72,7 @@ def test_multiple_entries_no_pagination(multiple_entries, client):
                             "self": "http://testserver/entries/1/relationships/featured_hyperlinked"
                         }
                     },
-                    "tags": {
-                        "data": []
-                    }
+                    'tags': {'data': [], 'meta': {'count': 0}},
                 }
             },
             {
@@ -135,9 +133,7 @@ def test_multiple_entries_no_pagination(multiple_entries, client):
                             "self": "http://testserver/entries/2/relationships/featured_hyperlinked"
                         }
                     },
-                    "tags": {
-                        "data": []
-                    }
+                    'tags': {'data': [], 'meta': {'count': 0}},
                 }
             },
         ]
diff --git a/example/tests/integration/test_pagination.py b/example/tests/integration/test_pagination.py
@@ -73,6 +73,7 @@ def test_pagination_with_single_entry(single_entry, client):
                         }
                     },
                     "tags": {
+                        'meta': {'count': 1},
                         "data": [
                             {
                                 "id": "1",
diff --git a/example/tests/test_filters.py b/example/tests/test_filters.py
@@ -461,9 +461,7 @@ def test_search_keywords(self):
                                 'self': 'http://testserver/entries/7/relationships/suggested_hyperlinked',  # noqa: E501
                                 'related': 'http://testserver/entries/7/suggested/'}
                         },
-                        'tags': {
-                            'data': []
-                        },
+                        'tags': {'data': [], 'meta': {'count': 0}},
                         'featuredHyperlinked': {
                             'links': {
                                 'self': 'http://testserver/entries/7/relationships/featured_hyperlinked',  # noqa: E501
diff --git a/example/tests/test_serializers.py b/example/tests/test_serializers.py
@@ -45,7 +45,7 @@ def setUp(self):
             )
 
     def test_forward_relationship_not_loaded_when_not_included(self):
-        to_representation_method = 'example.serializers.BlogSerializer.to_representation'
+        to_representation_method = 'example.serializers.TaggedItemSerializer.to_representation'
         with mock.patch(to_representation_method) as mocked_serializer:
             class EntrySerializer(ModelSerializer):
                 blog = BlogSerializer()
@@ -79,7 +79,12 @@ class Meta:
         expected = dict(
             [
                 ('id', 1),
-                ('blog', dict([('type', 'blogs'), ('id', 1)])),
+                ('blog', dict([
+                    ('name', 'Some Blog'),
+                    ('tags', []),
+                    ('copyright', 2020),
+                    ('url', 'http://testserver/blogs/1')
+                ])),
                 ('headline', 'headline'),
                 ('body_text', 'body_text'),
                 ('pub_date', DateField().to_representation(self.entry.pub_date)),
diff --git a/example/tests/test_views.py b/example/tests/test_views.py
@@ -538,7 +538,7 @@ def test_get_object_gives_correct_blog(self):
                 'id': '{}'.format(self.blog.id),
                 'links': {'self': 'http://testserver/blogs/{}'.format(self.blog.id)},
                 'meta': {'copyright': datetime.now().year},
-                'relationships': {'tags': {'data': []}},
+                'relationships': {'tags': {'data': [], 'meta': {'count': 0}}},
                 'type': 'blogs'
             },
             'meta': {'apiDocs': '/docs/api/blogs'}
@@ -632,7 +632,7 @@ def test_get_object_gives_correct_entry(self):
                                     '/suggested_hyperlinked'.format(self.second_entry.id)
                         }
                     },
-                    'tags': {'data': []}},
+                    'tags': {'data': [], 'meta': {'count': 0}}},
                 'type': 'posts'
             }
         }
diff --git a/example/tests/unit/test_default_drf_serializers.py b/example/tests/unit/test_default_drf_serializers.py
@@ -95,11 +95,10 @@ def test_blog_create(client):
 
     expected = {
         'data': {
-            'attributes': {'name': blog.name},
+            'attributes': {'name': blog.name, 'tags': []},
             'id': '{}'.format(blog.id),
             'links': {'self': 'http://testserver/blogs/{}'.format(blog.id)},
             'meta': {'copyright': datetime.now().year},
-            'relationships': {'tags': {'data': []}},
             'type': 'blogs'
         },
         'meta': {'apiDocs': '/docs/api/blogs'}
@@ -116,11 +115,10 @@ def test_get_object_gives_correct_blog(client, blog, entry):
     resp = client.get(url)
     expected = {
         'data': {
-            'attributes': {'name': blog.name},
+            'attributes': {'name': blog.name, 'tags': []},
             'id': '{}'.format(blog.id),
             'links': {'self': 'http://testserver/blogs/{}'.format(blog.id)},
             'meta': {'copyright': datetime.now().year},
-            'relationships': {'tags': {'data': []}},
             'type': 'blogs'
         },
         'meta': {'apiDocs': '/docs/api/blogs'}
@@ -154,11 +152,10 @@ def test_get_object_patches_correct_blog(client, blog, entry):
 
     expected = {
         'data': {
-            'attributes': {'name': new_name},
+            'attributes': {'name': new_name, 'tags': []},
             'id': '{}'.format(blog.id),
             'links': {'self': 'http://testserver/blogs/{}'.format(blog.id)},
             'meta': {'copyright': datetime.now().year},
-            'relationships': {'tags': {'data': []}},
             'type': 'blogs'
         },
         'meta': {'apiDocs': '/docs/api/blogs'}
@@ -189,17 +186,14 @@ def test_get_entry_list_with_blogs(client, entry):
             'first': 'http://testserver/drf-entries/1/suggested/?page%5Bnumber%5D=1',
             'last': 'http://testserver/drf-entries/1/suggested/?page%5Bnumber%5D=1',
             'next': None,
-            'prev': None
+            'prev': None,
         },
         'data': [
             {
                 'type': 'entries',
                 'id': '1',
-                'attributes': {},
-                'relationships': {
-                    'tags': {
-                        'data': []
-                    }
+                'attributes': {
+                    'tags': [],
                 },
                 'links': {
                     'self': 'http://testserver/drf-blogs/1'
diff --git a/pytest.ini b/pytest.ini
@@ -3,4 +3,3 @@ DJANGO_SETTINGS_MODULE=example.settings.test
 filterwarnings =
     error::DeprecationWarning
     error::PendingDeprecationWarning
-    ignore::DeprecationWarning:rest_framework_json_api.serializers

Original file line number	Diff line number	Diff line change
`@@ -72,9 +72,7 @@ def test_multiple_entries_no_pagination(multiple_entries, client):`
`72`	`72`	`"self": "http://testserver/entries/1/relationships/featured_hyperlinked"`
`73`	`73`	`}`
`74`	`74`	`},`
`75`		`- "tags": {`
`76`		`- "data": []`
`77`		`- }`
	`75`	`+ 'tags': {'data': [], 'meta': {'count': 0}},`
`78`	`76`	`}`
`79`	`77`	`},`
`80`	`78`	`{`
`@@ -135,9 +133,7 @@ def test_multiple_entries_no_pagination(multiple_entries, client):`
`135`	`133`	`"self": "http://testserver/entries/2/relationships/featured_hyperlinked"`
`136`	`134`	`}`
`137`	`135`	`},`
`138`		`- "tags": {`
`139`		`- "data": []`
`140`		`- }`
	`136`	`+ 'tags': {'data': [], 'meta': {'count': 0}},`
`141`	`137`	`}`
`142`	`138`	`},`
`143`	`139`	`]`
Original file line number	Diff line number	Diff line change
`@@ -73,6 +73,7 @@ def test_pagination_with_single_entry(single_entry, client):`
`73`	`73`	`}`
`74`	`74`	`},`
`75`	`75`	`"tags": {`
	`76`	`+ 'meta': {'count': 1},`
`76`	`77`	`"data": [`
`77`	`78`	`{`
`78`	`79`	`"id": "1",`
Original file line number	Diff line number	Diff line change
`@@ -538,7 +538,7 @@ def test_get_object_gives_correct_blog(self):`
`538`	`538`	`'id': '{}'.format(self.blog.id),`
`539`	`539`	`'links': {'self': 'http://testserver/blogs/{}'.format(self.blog.id)},`
`540`	`540`	`'meta': {'copyright': datetime.now().year},`
`541`		`- 'relationships': {'tags': {'data': []}},`
	`541`	`+ 'relationships': {'tags': {'data': [], 'meta': {'count': 0}}},`
`542`	`542`	`'type': 'blogs'`
`543`	`543`	`},`
`544`	`544`	`'meta': {'apiDocs': '/docs/api/blogs'}`
`@@ -632,7 +632,7 @@ def test_get_object_gives_correct_entry(self):`
`632`	`632`	`'/suggested_hyperlinked'.format(self.second_entry.id)`
`633`	`633`	`}`
`634`	`634`	`},`
`635`		`- 'tags': {'data': []}},`
	`635`	`+ 'tags': {'data': [], 'meta': {'count': 0}}},`
`636`	`636`	`'type': 'posts'`
`637`	`637`	`}`
`638`	`638`	`}`