diff options
| author | Andreas Pelme | 2014-03-02 12:40:30 +0100 | 
|---|---|---|
| committer | Andreas Pelme | 2014-03-02 12:40:30 +0100 | 
| commit | 971578ca345c3d3bae7fd93b87c41d43483b6f05 (patch) | |
| tree | 72a6d3d0ced5750a8ba01bedc3a6f8a936e05e2f /tests/test_routers.py | |
| parent | 62786a7ad64918022f11f1b95ce84adb8d798830 (diff) | |
| download | django-rest-framework-971578ca345c3d3bae7fd93b87c41d43483b6f05.tar.bz2 | |
Support for running the test suite with py.test
 * Get rid of runtests.py
 * Moved test code  from rest_framework/tests and rest_framework/runtests to tests
 * Invoke py.test from setup.py
 * Invoke py.test from Travis
 * Invoke py.test from tox
 * Changed setUpClass to be just plain setUp in test_permissions.py
 * Updated contribution guideline to show how to invoke py.test
Diffstat (limited to 'tests/test_routers.py')
| -rw-r--r-- | tests/test_routers.py | 216 | 
1 files changed, 216 insertions, 0 deletions
| diff --git a/tests/test_routers.py b/tests/test_routers.py new file mode 100644 index 00000000..084c0e27 --- /dev/null +++ b/tests/test_routers.py @@ -0,0 +1,216 @@ +from __future__ import unicode_literals +from django.db import models +from django.test import TestCase +from django.core.exceptions import ImproperlyConfigured +from rest_framework import serializers, viewsets, permissions +from rest_framework.compat import include, patterns, url +from rest_framework.decorators import link, action +from rest_framework.response import Response +from rest_framework.routers import SimpleRouter, DefaultRouter +from rest_framework.test import APIRequestFactory + +factory = APIRequestFactory() + +urlpatterns = patterns('',) + + +class BasicViewSet(viewsets.ViewSet): +    def list(self, request, *args, **kwargs): +        return Response({'method': 'list'}) + +    @action() +    def action1(self, request, *args, **kwargs): +        return Response({'method': 'action1'}) + +    @action() +    def action2(self, request, *args, **kwargs): +        return Response({'method': 'action2'}) + +    @action(methods=['post', 'delete']) +    def action3(self, request, *args, **kwargs): +        return Response({'method': 'action2'}) + +    @link() +    def link1(self, request, *args, **kwargs): +        return Response({'method': 'link1'}) + +    @link() +    def link2(self, request, *args, **kwargs): +        return Response({'method': 'link2'}) + + +class TestSimpleRouter(TestCase): +    def setUp(self): +        self.router = SimpleRouter() + +    def test_link_and_action_decorator(self): +        routes = self.router.get_routes(BasicViewSet) +        decorator_routes = routes[2:] +        # Make sure all these endpoints exist and none have been clobbered +        for i, endpoint in enumerate(['action1', 'action2', 'action3', 'link1', 'link2']): +            route = decorator_routes[i] +            # check url listing +            self.assertEqual(route.url, +                             '^{{prefix}}/{{lookup}}/{0}{{trailing_slash}}$'.format(endpoint)) +            # check method to function mapping +            if endpoint == 'action3': +                methods_map = ['post', 'delete'] +            elif endpoint.startswith('action'): +                methods_map = ['post'] +            else: +                methods_map = ['get'] +            for method in methods_map: +                self.assertEqual(route.mapping[method], endpoint) + + +class RouterTestModel(models.Model): +    uuid = models.CharField(max_length=20) +    text = models.CharField(max_length=200) + + +class TestCustomLookupFields(TestCase): +    """ +    Ensure that custom lookup fields are correctly routed. +    """ +    urls = 'tests.test_routers' + +    def setUp(self): +        class NoteSerializer(serializers.HyperlinkedModelSerializer): +            class Meta: +                model = RouterTestModel +                lookup_field = 'uuid' +                fields = ('url', 'uuid', 'text') + +        class NoteViewSet(viewsets.ModelViewSet): +            queryset = RouterTestModel.objects.all() +            serializer_class = NoteSerializer +            lookup_field = 'uuid' + +        RouterTestModel.objects.create(uuid='123', text='foo bar') + +        self.router = SimpleRouter() +        self.router.register(r'notes', NoteViewSet) + +        from tests import test_routers +        urls = getattr(test_routers, 'urlpatterns') +        urls += patterns('', +            url(r'^', include(self.router.urls)), +        ) + +    def test_custom_lookup_field_route(self): +        detail_route = self.router.urls[-1] +        detail_url_pattern = detail_route.regex.pattern +        self.assertIn('<uuid>', detail_url_pattern) + +    def test_retrieve_lookup_field_list_view(self): +        response = self.client.get('/notes/') +        self.assertEqual(response.data, +            [{ +                "url": "http://testserver/notes/123/", +                "uuid": "123", "text": "foo bar" +            }] +        ) + +    def test_retrieve_lookup_field_detail_view(self): +        response = self.client.get('/notes/123/') +        self.assertEqual(response.data, +            { +                "url": "http://testserver/notes/123/", +                "uuid": "123", "text": "foo bar" +            } +        ) + + +class TestTrailingSlashIncluded(TestCase): +    def setUp(self): +        class NoteViewSet(viewsets.ModelViewSet): +            model = RouterTestModel + +        self.router = SimpleRouter() +        self.router.register(r'notes', NoteViewSet) +        self.urls = self.router.urls + +    def test_urls_have_trailing_slash_by_default(self): +        expected = ['^notes/$', '^notes/(?P<pk>[^/]+)/$'] +        for idx in range(len(expected)): +            self.assertEqual(expected[idx], self.urls[idx].regex.pattern) + + +class TestTrailingSlashRemoved(TestCase): +    def setUp(self): +        class NoteViewSet(viewsets.ModelViewSet): +            model = RouterTestModel + +        self.router = SimpleRouter(trailing_slash=False) +        self.router.register(r'notes', NoteViewSet) +        self.urls = self.router.urls + +    def test_urls_can_have_trailing_slash_removed(self): +        expected = ['^notes$', '^notes/(?P<pk>[^/.]+)$'] +        for idx in range(len(expected)): +            self.assertEqual(expected[idx], self.urls[idx].regex.pattern) + + +class TestNameableRoot(TestCase): +    def setUp(self): +        class NoteViewSet(viewsets.ModelViewSet): +            model = RouterTestModel +        self.router = DefaultRouter() +        self.router.root_view_name = 'nameable-root' +        self.router.register(r'notes', NoteViewSet) +        self.urls = self.router.urls + +    def test_router_has_custom_name(self): +        expected = 'nameable-root' +        self.assertEqual(expected, self.urls[0].name) + + +class TestActionKeywordArgs(TestCase): +    """ +    Ensure keyword arguments passed in the `@action` decorator +    are properly handled.  Refs #940. +    """ + +    def setUp(self): +        class TestViewSet(viewsets.ModelViewSet): +            permission_classes = [] + +            @action(permission_classes=[permissions.AllowAny]) +            def custom(self, request, *args, **kwargs): +                return Response({ +                    'permission_classes': self.permission_classes +                }) + +        self.router = SimpleRouter() +        self.router.register(r'test', TestViewSet, base_name='test') +        self.view = self.router.urls[-1].callback + +    def test_action_kwargs(self): +        request = factory.post('/test/0/custom/') +        response = self.view(request) +        self.assertEqual( +            response.data, +            {'permission_classes': [permissions.AllowAny]} +        ) + + +class TestActionAppliedToExistingRoute(TestCase): +    """ +    Ensure `@action` decorator raises an except when applied +    to an existing route +    """ + +    def test_exception_raised_when_action_applied_to_existing_route(self): +        class TestViewSet(viewsets.ModelViewSet): + +            @action() +            def retrieve(self, request, *args, **kwargs): +                return Response({ +                    'hello': 'world' +                }) + +        self.router = SimpleRouter() +        self.router.register(r'test', TestViewSet, base_name='test') + +        with self.assertRaises(ImproperlyConfigured): +            self.router.urls | 
