tests and improvements for related fields

Author: n2ygk

example/tests/test_openapi.py

@@ -5,10 +5,11 @@
 from django.test import RequestFactory, override_settings
 from rest_framework.request import Request
 
+from rest_framework_json_api.management.commands.generateschema import Command
 from rest_framework_json_api.schemas.openapi import AutoSchema, SchemaGenerator
-from rest_framework_json_api.views import ModelViewSet
 
-from example import models, serializers, views
+from example import views
+from example.tests import TestBase
 
 
 def create_request(path):
@@ -17,12 +18,6 @@ def create_request(path):
     return request
 
 
-def create_view(view_cls, method, request):
-    generator = SchemaGenerator()
-    view = generator.create_view(view_cls.as_view(), method, request)
-    return view
-
-
 def create_view_with_kw(view_cls, method, request, initkwargs):
     generator = SchemaGenerator()
     view = generator.create_view(view_cls.as_view(initkwargs), method, request)
@@ -132,45 +127,51 @@ def test_schema_construction():
     assert 'components' in schema
 
 
-# TODO: figure these out
-def test_schema_related():
-    class AuthorBioViewSet(ModelViewSet):
-        queryset = models.AuthorBio.objects.all()
-        serializer_class = serializers.AuthorBioSerializer
-
-    patterns = [
-        url(r'^authors/(?P<pk>[^/.]+)/(?P<related_field>\w+)/$',
-            views.AuthorViewSet.as_view({'get': 'retrieve_related'}),
-            name='author-related'),
-        url(r'^bios/(?P<pk>[^/.]+)/$',
-            AuthorBioViewSet,
-            name='author-bio')
-    ]
-    generator = SchemaGenerator(patterns=patterns)
-
-    request = create_request('/authors/123/bio/')
-    schema = generator.get_schema(request=request)
-    # TODO: finish this test
-    print(schema)
-
-# def test_retrieve_relationships():
-#     path = '/authors/{id}/relationships/bio/'
-#     method = 'GET'
-#
-#     view = create_view_with_kw(
-#         views.AuthorViewSet,
-#         method,
-#         create_request(path),
-#         {'get': 'retrieve_related'}
-#     )
-#     inspector = AutoSchema()
-#     inspector.view = view
-#
-#     operation = inspector.get_operation(path, method)
-#     assert 'responses' in operation
-#     assert '200' in operation['responses']
-#     resp = operation['responses']['200']['content']
-#     data = resp['application/vnd.api+json']['schema']['properties']['data']
-#     assert data['type'] == 'object'
-#     assert data['required'] == ['type', 'id']
-#     assert data['properties']['type'] == {'$ref': '#/components/schemas/type'}
+def test_generateschema_command():
+    command = Command()
+    assert command.get_generator_class() == SchemaGenerator
+
+
+class TestSchemaRelatedField(TestBase):
+    def test_schema_related_serializers(self):
+        """
+        Confirm that paths are generated for related fields. For example:
+        url path '/authors/{pk}/{related_field>}/' generates:
+            /authors/{id}/comments/
+            /authors/{id}/entries/
+            /authors/{id}/first_entry/
+        and confirm that the schema for the related field is properly rendered
+        """
+        generator = SchemaGenerator()
+        request = create_request('/')
+        schema = generator.get_schema(request=request)
+        assert '/authors/{id}/comments/' in schema['paths']
+        assert '/authors/{id}/entries/' in schema['paths']
+        assert '/authors/{id}/first_entry/' in schema['paths']
+        first_get = schema['paths']['/authors/{id}/first_entry/']['get']['responses']['200']
+        first_schema = first_get['content']['application/vnd.api+json']['schema']
+        first_props = first_schema['properties']['data']['properties']['attributes']['properties']
+        assert 'headline' in first_props
+        assert first_props['headline'] == {'type': 'string', 'maxLength': 255}
+
+    # def test_retrieve_relationships(self):
+    #     path = '/authors/{id}/relationships/bio/'
+    #     method = 'GET'
+    #
+    #     view = create_view_with_kw(
+    #         views.AuthorViewSet,
+    #         method,
+    #         create_request(path),
+    #         {'get': 'retrieve_related'}
+    #     )
+    #     inspector = AutoSchema()
+    #     inspector.view = view
+    #
+    #     operation = inspector.get_operation(path, method)
+    #     assert 'responses' in operation
+    #     assert '200' in operation['responses']
+    #     resp = operation['responses']['200']['content']
+    #     data = resp['application/vnd.api+json']['schema']['properties']['data']
+    #     assert data['type'] == 'object'
+    #     assert data['required'] == ['type', 'id']
+    #     assert data['properties']['type'] == {'$ref': '#/components/schemas/type'}

rest_framework_json_api/schemas/openapi.py

@@ -312,12 +312,13 @@ def get_paths(self, request=None):
         #       instead of doing it here.
         expanded_endpoints = []
         for path, method, view in view_endpoints:
+            action = view.action if hasattr(view, 'action') else None
             if isinstance(view, RelationshipView):
                 expanded_endpoints += self._expand_relationships(path, method, view)
-            elif view.action == 'retrieve_related':
+            elif action == 'retrieve_related':
                 expanded_endpoints += self._expand_related(path, method, view, view_endpoints)
             else:
-                expanded_endpoints.append((path, method, view, view.action))
+                expanded_endpoints.append((path, method, view, action))
 
         for path, method, view, action in expanded_endpoints:
             if not self.has_view_permissions(path, method, view):
@@ -379,12 +380,15 @@ def _expand_related(self, path, method, view, view_endpoints):
         """
         result = []
         serializer = view.get_serializer()
+        # It's not obvious if it's allowed to have both included_ and related_ serializers,
+        # so just merge both dicts.
+        serializers = {}
+        if hasattr(serializer, 'included_serializers'):
+            serializers = {**serializers, **serializer.included_serializers}
         if hasattr(serializer, 'related_serializers'):
-            related_fields = [fs for fs in serializer.related_serializers.items()]
-        elif hasattr(serializer, 'included_serializers'):
-            related_fields = [fs for fs in serializer.included_serializers.items()]
-        else:
-            related_fields = []
+            serializers = {**serializers, **serializer.related_serializers}
+        related_fields = [fs for fs in serializers.items()]
+
         for field, related_serializer in related_fields:
             related_view = self._find_related_view(view_endpoints, related_serializer, view)
             if related_view: