Added tests

Author: Anton-Shutik

example/tests/test_relations.py

@@ -1,15 +1,23 @@
 from __future__ import absolute_import
 
+from django.test.client import RequestFactory
 from django.utils import timezone
 from rest_framework import serializers
+from rest_framework.fields import SkipField
+from rest_framework.reverse import reverse
 
 from rest_framework_json_api.exceptions import Conflict
-from rest_framework_json_api.relations import ResourceRelatedField
+from rest_framework_json_api.relations import (
+    HyperLinkedRelatedField,
+    ResourceRelatedField,
+    SerializerMethodHyperLinkedRelatedField
+)
 from rest_framework_json_api.utils import format_resource_type
 
 from . import TestBase
 from example.models import Author, Blog, Comment, Entry
 from example.serializers import CommentSerializer
+from example.views import EntryViewSet
 
 
 class TestResourceRelatedField(TestBase):
@@ -129,6 +137,117 @@ def test_invalid_resource_id_object(self):
         }
 
 
+class TestHyperLinkedFieldBase(TestBase):
+
+    def setUp(self):
+        super(TestHyperLinkedFieldBase, self).setUp()
+        self.blog = Blog.objects.create(name='Some Blog', tagline="It's a blog")
+        self.entry = Entry.objects.create(
+            blog=self.blog,
+            headline='headline',
+            body_text='body_text',
+            pub_date=timezone.now(),
+            mod_date=timezone.now(),
+            n_comments=0,
+            n_pingbacks=0,
+            rating=3
+        )
+        self.comment = Comment.objects.create(
+            entry=self.entry,
+            body='testing one two three',
+        )
+
+        self.request = RequestFactory().get(reverse('entry-detail', kwargs={'pk': self.entry.pk}))
+        self.view = EntryViewSet(request=self.request, kwargs={'entry_pk': self.entry.id})
+
+
+class TestHyperLinkedRelatedField(TestHyperLinkedFieldBase):
+
+    def test_single_hyperlinked_related_field(self):
+        field = HyperLinkedRelatedField(
+            related_link_view_name='entry-blog',
+            related_link_url_kwarg='entry_pk',
+            self_link_view_name='entry-relationships',
+            read_only=True,
+        )
+        field._context = {'request': self.request, 'view': self.view}
+        field.field_name = 'blog'
+
+        self.assertRaises(NotImplementedError, field.to_representation, self.entry)
+        self.assertRaises(SkipField, field.get_attribute, self.entry)
+
+        links_expected = {
+            'self': 'http://testserver/entries/{}/relationships/blog'.format(self.entry.pk),
+            'related': 'http://testserver/entries/{}/blog'.format(self.entry.pk)
+        }
+        got = field.get_links(self.entry)
+        self.assertEqual(got, links_expected)
+
+    def test_many_hyperlinked_related_field(self):
+        field = HyperLinkedRelatedField(
+            related_link_view_name='entry-comments',
+            related_link_url_kwarg='entry_pk',
+            self_link_view_name='entry-relationships',
+            read_only=True,
+            many=True
+        )
+        field._context = {'request': self.request, 'view': self.view}
+        field.field_name = 'comments'
+
+        self.assertRaises(NotImplementedError, field.to_representation, self.entry.comments.all())
+        self.assertRaises(SkipField, field.get_attribute, self.entry)
+
+        links_expected = {
+            'self': 'http://testserver/entries/{}/relationships/comments'.format(self.entry.pk),
+            'related': 'http://testserver/entries/{}/comments'.format(self.entry.pk)
+        }
+        got = field.child_relation.get_links(self.entry)
+        self.assertEqual(got, links_expected)
+
+
+class TestSerializerMethodHyperLinkedRelatedField(TestHyperLinkedFieldBase):
+
+    def test_single_serializer_method_hyperlinked_related_field(self):
+        serializer = EntryModelSerializerWithHyperLinks(
+            instance=self.entry,
+            context={
+                'request': self.request,
+                'view': self.view
+            }
+        )
+        field = serializer.fields['blog']
+
+        self.assertRaises(NotImplementedError, field.to_representation, self.entry)
+        self.assertRaises(SkipField, field.get_attribute, self.entry)
+
+        expected = {
+            'self': 'http://testserver/entries/{}/relationships/blog'.format(self.entry.pk),
+            'related': 'http://testserver/entries/{}/blog'.format(self.entry.pk)
+        }
+        got = field.get_links(self.entry)
+        self.assertEqual(got, expected)
+
+    def test_many_serializer_method_hyperlinked_related_field(self):
+        serializer = EntryModelSerializerWithHyperLinks(
+            instance=self.entry,
+            context={
+                'request': self.request,
+                'view': self.view
+            }
+        )
+        field = serializer.fields['comments']
+
+        self.assertRaises(NotImplementedError, field.to_representation, self.entry)
+        self.assertRaises(SkipField, field.get_attribute, self.entry)
+
+        expected = {
+            'self': 'http://testserver/entries/{}/relationships/comments'.format(self.entry.pk),
+            'related': 'http://testserver/entries/{}/comments'.format(self.entry.pk)
+        }
+        got = field.get_links(self.entry)
+        self.assertEqual(got, expected)
+
+
 class BlogResourceRelatedField(ResourceRelatedField):
     def get_queryset(self):
         return Blog.objects
@@ -149,3 +268,32 @@ class EntryModelSerializer(serializers.ModelSerializer):
     class Meta:
         model = Entry
         fields = ('authors', 'comments')
+
+
+class EntryModelSerializerWithHyperLinks(serializers.ModelSerializer):
+    blog = SerializerMethodHyperLinkedRelatedField(
+        related_link_view_name='entry-blog',
+        related_link_url_kwarg='entry_pk',
+        self_link_view_name='entry-relationships',
+        many=True,
+        read_only=True,
+        source='get_blog'
+    )
+    comments = SerializerMethodHyperLinkedRelatedField(
+        related_link_view_name='entry-comments',
+        related_link_url_kwarg='entry_pk',
+        self_link_view_name='entry-relationships',
+        many=True,
+        read_only=True,
+        source='get_comments'
+    )
+
+    class Meta:
+        model = Entry
+        fields = ('blog', 'comments',)
+
+    def get_blog(self, obj):
+        return obj.blog
+
+    def get_authors(self, obj):
+        return obj.comments.all()

example/urls_test.py

@@ -37,10 +37,25 @@
         GenericIdentity.as_view(), name='user-default'),
 
 
+    url(r'^entries/(?P<entry_pk>[^/.]+)/blog',
+        BlogViewSet.as_view({'get': 'retrieve'}),
+        name='entry-blog'
+        ),
+    url(r'^entries/(?P<entry_pk>[^/.]+)/comments',
+        CommentViewSet.as_view({'get': 'list'}),
+        name='entry-comments'
+        ),
     url(r'^entries/(?P<entry_pk>[^/.]+)/suggested/',
         EntryViewSet.as_view({'get': 'list'}),
         name='entry-suggested'
         ),
+    url(r'entries/(?P<entry_pk>[^/.]+)/authors',
+        AuthorViewSet.as_view({'get': 'list'}),
+        name='entry-authors'),
+    url(r'entries/(?P<entry_pk>[^/.]+)/featured',
+        EntryViewSet.as_view({'get': 'retrieve'}),
+        name='entry-featured'),
+
     url(r'^entries/(?P<pk>[^/.]+)/relationships/(?P<related_field>\w+)',
         EntryRelationshipView.as_view(),
         name='entry-relationships'),