diff options
| author | Dmitry Mukhin | 2014-08-20 20:04:48 +0400 | 
|---|---|---|
| committer | Dmitry Mukhin | 2014-08-20 20:04:48 +0400 | 
| commit | 3b07d0c9978335e183f369480618b48ff1e1b1ab (patch) | |
| tree | 041027c50d2965da1be7f93b1a6360e07ad976f9 /rest_framework/tests/test_renderers.py | |
| parent | c3891b6e00daa7a92cca1c88599e046f72926bb4 (diff) | |
| parent | 59b47eac14778767a17e56bd8adc0610417f2878 (diff) | |
| download | django-rest-framework-3b07d0c9978335e183f369480618b48ff1e1b1ab.tar.bz2 | |
Merge branch 'master' into set-retry-after
Conflicts:
	tests/test_throttling.py
Diffstat (limited to 'rest_framework/tests/test_renderers.py')
| -rw-r--r-- | rest_framework/tests/test_renderers.py | 655 | 
1 files changed, 0 insertions, 655 deletions
| diff --git a/rest_framework/tests/test_renderers.py b/rest_framework/tests/test_renderers.py deleted file mode 100644 index c7bf772e..00000000 --- a/rest_framework/tests/test_renderers.py +++ /dev/null @@ -1,655 +0,0 @@ -# -*- coding: utf-8 -*- -from __future__ import unicode_literals - -from decimal import Decimal -from django.core.cache import cache -from django.db import models -from django.test import TestCase -from django.utils import unittest -from django.utils.translation import ugettext_lazy as _ -from rest_framework import status, permissions -from rest_framework.compat import yaml, etree, patterns, url, include, six, StringIO -from rest_framework.response import Response -from rest_framework.views import APIView -from rest_framework.renderers import BaseRenderer, JSONRenderer, YAMLRenderer, \ -    XMLRenderer, JSONPRenderer, BrowsableAPIRenderer, UnicodeJSONRenderer -from rest_framework.parsers import YAMLParser, XMLParser -from rest_framework.settings import api_settings -from rest_framework.test import APIRequestFactory -from collections import MutableMapping -import datetime -import json -import pickle -import re - - -DUMMYSTATUS = status.HTTP_200_OK -DUMMYCONTENT = 'dummycontent' - -RENDERER_A_SERIALIZER = lambda x: ('Renderer A: %s' % x).encode('ascii') -RENDERER_B_SERIALIZER = lambda x: ('Renderer B: %s' % x).encode('ascii') - - -expected_results = [ -    ((elem for elem in [1, 2, 3]), JSONRenderer, b'[1, 2, 3]')  # Generator -] - - -class DummyTestModel(models.Model): -    name = models.CharField(max_length=42, default='') - - -class BasicRendererTests(TestCase): -    def test_expected_results(self): -        for value, renderer_cls, expected in expected_results: -            output = renderer_cls().render(value) -            self.assertEqual(output, expected) - - -class RendererA(BaseRenderer): -    media_type = 'mock/renderera' -    format = "formata" - -    def render(self, data, media_type=None, renderer_context=None): -        return RENDERER_A_SERIALIZER(data) - - -class RendererB(BaseRenderer): -    media_type = 'mock/rendererb' -    format = "formatb" - -    def render(self, data, media_type=None, renderer_context=None): -        return RENDERER_B_SERIALIZER(data) - - -class MockView(APIView): -    renderer_classes = (RendererA, RendererB) - -    def get(self, request, **kwargs): -        response = Response(DUMMYCONTENT, status=DUMMYSTATUS) -        return response - - -class MockGETView(APIView): -    def get(self, request, **kwargs): -        return Response({'foo': ['bar', 'baz']}) - - - -class MockPOSTView(APIView): -    def post(self, request, **kwargs): -        return Response({'foo': request.DATA}) - - -class EmptyGETView(APIView): -    renderer_classes = (JSONRenderer,) - -    def get(self, request, **kwargs): -        return Response(status=status.HTTP_204_NO_CONTENT) - - -class HTMLView(APIView): -    renderer_classes = (BrowsableAPIRenderer, ) - -    def get(self, request, **kwargs): -        return Response('text') - - -class HTMLView1(APIView): -    renderer_classes = (BrowsableAPIRenderer, JSONRenderer) - -    def get(self, request, **kwargs): -        return Response('text') - -urlpatterns = patterns('', -    url(r'^.*\.(?P<format>.+)$', MockView.as_view(renderer_classes=[RendererA, RendererB])), -    url(r'^$', MockView.as_view(renderer_classes=[RendererA, RendererB])), -    url(r'^cache$', MockGETView.as_view()), -    url(r'^jsonp/jsonrenderer$', MockGETView.as_view(renderer_classes=[JSONRenderer, JSONPRenderer])), -    url(r'^jsonp/nojsonrenderer$', MockGETView.as_view(renderer_classes=[JSONPRenderer])), -    url(r'^parseerror$', MockPOSTView.as_view(renderer_classes=[JSONRenderer, BrowsableAPIRenderer])), -    url(r'^html$', HTMLView.as_view()), -    url(r'^html1$', HTMLView1.as_view()), -    url(r'^empty$', EmptyGETView.as_view()), -    url(r'^api', include('rest_framework.urls', namespace='rest_framework')) -) - - -class POSTDeniedPermission(permissions.BasePermission): -    def has_permission(self, request, view): -        return request.method != 'POST' - - -class POSTDeniedView(APIView): -    renderer_classes = (BrowsableAPIRenderer,) -    permission_classes = (POSTDeniedPermission,) - -    def get(self, request): -        return Response() - -    def post(self, request): -        return Response() - -    def put(self, request): -        return Response() - -    def patch(self, request): -        return Response() - - -class DocumentingRendererTests(TestCase): -    def test_only_permitted_forms_are_displayed(self): -        view = POSTDeniedView.as_view() -        request = APIRequestFactory().get('/') -        response = view(request).render() -        self.assertNotContains(response, '>POST<') -        self.assertContains(response, '>PUT<') -        self.assertContains(response, '>PATCH<') - - -class RendererEndToEndTests(TestCase): -    """ -    End-to-end testing of renderers using an RendererMixin on a generic view. -    """ - -    urls = 'rest_framework.tests.test_renderers' - -    def test_default_renderer_serializes_content(self): -        """If the Accept header is not set the default renderer should serialize the response.""" -        resp = self.client.get('/') -        self.assertEqual(resp['Content-Type'], RendererA.media_type + '; charset=utf-8') -        self.assertEqual(resp.content, RENDERER_A_SERIALIZER(DUMMYCONTENT)) -        self.assertEqual(resp.status_code, DUMMYSTATUS) - -    def test_head_method_serializes_no_content(self): -        """No response must be included in HEAD requests.""" -        resp = self.client.head('/') -        self.assertEqual(resp.status_code, DUMMYSTATUS) -        self.assertEqual(resp['Content-Type'], RendererA.media_type + '; charset=utf-8') -        self.assertEqual(resp.content, six.b('')) - -    def test_default_renderer_serializes_content_on_accept_any(self): -        """If the Accept header is set to */* the default renderer should serialize the response.""" -        resp = self.client.get('/', HTTP_ACCEPT='*/*') -        self.assertEqual(resp['Content-Type'], RendererA.media_type + '; charset=utf-8') -        self.assertEqual(resp.content, RENDERER_A_SERIALIZER(DUMMYCONTENT)) -        self.assertEqual(resp.status_code, DUMMYSTATUS) - -    def test_specified_renderer_serializes_content_default_case(self): -        """If the Accept header is set the specified renderer should serialize the response. -        (In this case we check that works for the default renderer)""" -        resp = self.client.get('/', HTTP_ACCEPT=RendererA.media_type) -        self.assertEqual(resp['Content-Type'], RendererA.media_type + '; charset=utf-8') -        self.assertEqual(resp.content, RENDERER_A_SERIALIZER(DUMMYCONTENT)) -        self.assertEqual(resp.status_code, DUMMYSTATUS) - -    def test_specified_renderer_serializes_content_non_default_case(self): -        """If the Accept header is set the specified renderer should serialize the response. -        (In this case we check that works for a non-default renderer)""" -        resp = self.client.get('/', HTTP_ACCEPT=RendererB.media_type) -        self.assertEqual(resp['Content-Type'], RendererB.media_type + '; charset=utf-8') -        self.assertEqual(resp.content, RENDERER_B_SERIALIZER(DUMMYCONTENT)) -        self.assertEqual(resp.status_code, DUMMYSTATUS) - -    def test_specified_renderer_serializes_content_on_accept_query(self): -        """The '_accept' query string should behave in the same way as the Accept header.""" -        param = '?%s=%s' % ( -            api_settings.URL_ACCEPT_OVERRIDE, -            RendererB.media_type -        ) -        resp = self.client.get('/' + param) -        self.assertEqual(resp['Content-Type'], RendererB.media_type + '; charset=utf-8') -        self.assertEqual(resp.content, RENDERER_B_SERIALIZER(DUMMYCONTENT)) -        self.assertEqual(resp.status_code, DUMMYSTATUS) - -    def test_unsatisfiable_accept_header_on_request_returns_406_status(self): -        """If the Accept header is unsatisfiable we should return a 406 Not Acceptable response.""" -        resp = self.client.get('/', HTTP_ACCEPT='foo/bar') -        self.assertEqual(resp.status_code, status.HTTP_406_NOT_ACCEPTABLE) - -    def test_specified_renderer_serializes_content_on_format_query(self): -        """If a 'format' query is specified, the renderer with the matching -        format attribute should serialize the response.""" -        param = '?%s=%s' % ( -            api_settings.URL_FORMAT_OVERRIDE, -            RendererB.format -        ) -        resp = self.client.get('/' + param) -        self.assertEqual(resp['Content-Type'], RendererB.media_type + '; charset=utf-8') -        self.assertEqual(resp.content, RENDERER_B_SERIALIZER(DUMMYCONTENT)) -        self.assertEqual(resp.status_code, DUMMYSTATUS) - -    def test_specified_renderer_serializes_content_on_format_kwargs(self): -        """If a 'format' keyword arg is specified, the renderer with the matching -        format attribute should serialize the response.""" -        resp = self.client.get('/something.formatb') -        self.assertEqual(resp['Content-Type'], RendererB.media_type + '; charset=utf-8') -        self.assertEqual(resp.content, RENDERER_B_SERIALIZER(DUMMYCONTENT)) -        self.assertEqual(resp.status_code, DUMMYSTATUS) - -    def test_specified_renderer_is_used_on_format_query_with_matching_accept(self): -        """If both a 'format' query and a matching Accept header specified, -        the renderer with the matching format attribute should serialize the response.""" -        param = '?%s=%s' % ( -            api_settings.URL_FORMAT_OVERRIDE, -            RendererB.format -        ) -        resp = self.client.get('/' + param, -                               HTTP_ACCEPT=RendererB.media_type) -        self.assertEqual(resp['Content-Type'], RendererB.media_type + '; charset=utf-8') -        self.assertEqual(resp.content, RENDERER_B_SERIALIZER(DUMMYCONTENT)) -        self.assertEqual(resp.status_code, DUMMYSTATUS) - -    def test_parse_error_renderers_browsable_api(self): -        """Invalid data should still render the browsable API correctly.""" -        resp = self.client.post('/parseerror', data='foobar', content_type='application/json', HTTP_ACCEPT='text/html') -        self.assertEqual(resp['Content-Type'], 'text/html; charset=utf-8') -        self.assertEqual(resp.status_code, status.HTTP_400_BAD_REQUEST) - -    def test_204_no_content_responses_have_no_content_type_set(self): -        """ -        Regression test for #1196 - -        https://github.com/tomchristie/django-rest-framework/issues/1196 -        """ -        resp = self.client.get('/empty') -        self.assertEqual(resp.get('Content-Type', None), None) -        self.assertEqual(resp.status_code, status.HTTP_204_NO_CONTENT) - -    def test_contains_headers_of_api_response(self): -        """ -        Issue #1437 - -        Test we display the headers of the API response and not those from the -        HTML response -        """ -        resp = self.client.get('/html1') -        self.assertContains(resp, '>GET, HEAD, OPTIONS<') -        self.assertContains(resp, '>application/json<') -        self.assertNotContains(resp, '>text/html; charset=utf-8<') - - -_flat_repr = '{"foo": ["bar", "baz"]}' -_indented_repr = '{\n  "foo": [\n    "bar",\n    "baz"\n  ]\n}' - - -def strip_trailing_whitespace(content): -    """ -    Seems to be some inconsistencies re. trailing whitespace with -    different versions of the json lib. -    """ -    return re.sub(' +\n', '\n', content) - - -class JSONRendererTests(TestCase): -    """ -    Tests specific to the JSON Renderer -    """ - -    def test_render_lazy_strings(self): -        """ -        JSONRenderer should deal with lazy translated strings. -        """ -        ret = JSONRenderer().render(_('test')) -        self.assertEqual(ret, b'"test"') - -    def test_render_queryset_values(self): -        o = DummyTestModel.objects.create(name='dummy') -        qs = DummyTestModel.objects.values('id', 'name') -        ret = JSONRenderer().render(qs) -        data = json.loads(ret.decode('utf-8')) -        self.assertEquals(data, [{'id': o.id, 'name': o.name}]) - -    def test_render_queryset_values_list(self): -        o = DummyTestModel.objects.create(name='dummy') -        qs = DummyTestModel.objects.values_list('id', 'name') -        ret = JSONRenderer().render(qs) -        data = json.loads(ret.decode('utf-8')) -        self.assertEquals(data, [[o.id, o.name]]) - -    def test_render_dict_abc_obj(self): -        class Dict(MutableMapping): -            def __init__(self): -                self._dict = dict() -            def __getitem__(self, key): -                return self._dict.__getitem__(key) -            def __setitem__(self, key, value): -                return self._dict.__setitem__(key, value) -            def __delitem__(self, key): -                return self._dict.__delitem__(key) -            def __iter__(self): -                return self._dict.__iter__() -            def __len__(self): -                return self._dict.__len__() -            def keys(self): -                return self._dict.keys() - -        x = Dict() -        x['key'] = 'string value' -        x[2] = 3 -        ret = JSONRenderer().render(x) -        data = json.loads(ret.decode('utf-8')) -        self.assertEquals(data, {'key': 'string value', '2': 3})     - -    def test_render_obj_with_getitem(self): -        class DictLike(object): -            def __init__(self): -                self._dict = {} -            def set(self, value): -                self._dict = dict(value) -            def __getitem__(self, key): -                return self._dict[key] -             -        x = DictLike() -        x.set({'a': 1, 'b': 'string'}) -        with self.assertRaises(TypeError): -            JSONRenderer().render(x) -         -    def test_without_content_type_args(self): -        """ -        Test basic JSON rendering. -        """ -        obj = {'foo': ['bar', 'baz']} -        renderer = JSONRenderer() -        content = renderer.render(obj, 'application/json') -        # Fix failing test case which depends on version of JSON library. -        self.assertEqual(content.decode('utf-8'), _flat_repr) - -    def test_with_content_type_args(self): -        """ -        Test JSON rendering with additional content type arguments supplied. -        """ -        obj = {'foo': ['bar', 'baz']} -        renderer = JSONRenderer() -        content = renderer.render(obj, 'application/json; indent=2') -        self.assertEqual(strip_trailing_whitespace(content.decode('utf-8')), _indented_repr) - -    def test_check_ascii(self): -        obj = {'countries': ['United Kingdom', 'France', 'España']} -        renderer = JSONRenderer() -        content = renderer.render(obj, 'application/json') -        self.assertEqual(content, '{"countries": ["United Kingdom", "France", "Espa\\u00f1a"]}'.encode('utf-8')) - - -class UnicodeJSONRendererTests(TestCase): -    """ -    Tests specific for the Unicode JSON Renderer -    """ -    def test_proper_encoding(self): -        obj = {'countries': ['United Kingdom', 'France', 'España']} -        renderer = UnicodeJSONRenderer() -        content = renderer.render(obj, 'application/json') -        self.assertEqual(content, '{"countries": ["United Kingdom", "France", "España"]}'.encode('utf-8')) - - -class JSONPRendererTests(TestCase): -    """ -    Tests specific to the JSONP Renderer -    """ - -    urls = 'rest_framework.tests.test_renderers' - -    def test_without_callback_with_json_renderer(self): -        """ -        Test JSONP rendering with View JSON Renderer. -        """ -        resp = self.client.get('/jsonp/jsonrenderer', -                               HTTP_ACCEPT='application/javascript') -        self.assertEqual(resp.status_code, status.HTTP_200_OK) -        self.assertEqual(resp['Content-Type'], 'application/javascript; charset=utf-8') -        self.assertEqual(resp.content, -            ('callback(%s);' % _flat_repr).encode('ascii')) - -    def test_without_callback_without_json_renderer(self): -        """ -        Test JSONP rendering without View JSON Renderer. -        """ -        resp = self.client.get('/jsonp/nojsonrenderer', -                               HTTP_ACCEPT='application/javascript') -        self.assertEqual(resp.status_code, status.HTTP_200_OK) -        self.assertEqual(resp['Content-Type'], 'application/javascript; charset=utf-8') -        self.assertEqual(resp.content, -            ('callback(%s);' % _flat_repr).encode('ascii')) - -    def test_with_callback(self): -        """ -        Test JSONP rendering with callback function name. -        """ -        callback_func = 'myjsonpcallback' -        resp = self.client.get('/jsonp/nojsonrenderer?callback=' + callback_func, -                               HTTP_ACCEPT='application/javascript') -        self.assertEqual(resp.status_code, status.HTTP_200_OK) -        self.assertEqual(resp['Content-Type'], 'application/javascript; charset=utf-8') -        self.assertEqual(resp.content, -            ('%s(%s);' % (callback_func, _flat_repr)).encode('ascii')) - - -if yaml: -    _yaml_repr = 'foo: [bar, baz]\n' - -    class YAMLRendererTests(TestCase): -        """ -        Tests specific to the YAML Renderer -        """ - -        def test_render(self): -            """ -            Test basic YAML rendering. -            """ -            obj = {'foo': ['bar', 'baz']} -            renderer = YAMLRenderer() -            content = renderer.render(obj, 'application/yaml') -            self.assertEqual(content, _yaml_repr) - -        def test_render_and_parse(self): -            """ -            Test rendering and then parsing returns the original object. -            IE obj -> render -> parse -> obj. -            """ -            obj = {'foo': ['bar', 'baz']} - -            renderer = YAMLRenderer() -            parser = YAMLParser() - -            content = renderer.render(obj, 'application/yaml') -            data = parser.parse(StringIO(content)) -            self.assertEqual(obj, data) - -        def test_render_decimal(self): -            """ -            Test YAML decimal rendering. -            """ -            renderer = YAMLRenderer() -            content = renderer.render({'field': Decimal('111.2')}, 'application/yaml') -            self.assertYAMLContains(content, "field: '111.2'") - -        def assertYAMLContains(self, content, string): -            self.assertTrue(string in content, '%r not in %r' % (string, content)) - - -class XMLRendererTestCase(TestCase): -    """ -    Tests specific to the XML Renderer -    """ - -    _complex_data = { -        "creation_date": datetime.datetime(2011, 12, 25, 12, 45, 00), -        "name": "name", -        "sub_data_list": [ -            { -                "sub_id": 1, -                "sub_name": "first" -            }, -            { -                "sub_id": 2, -                "sub_name": "second" -            } -        ] -    } - -    def test_render_string(self): -        """ -        Test XML rendering. -        """ -        renderer = XMLRenderer() -        content = renderer.render({'field': 'astring'}, 'application/xml') -        self.assertXMLContains(content, '<field>astring</field>') - -    def test_render_integer(self): -        """ -        Test XML rendering. -        """ -        renderer = XMLRenderer() -        content = renderer.render({'field': 111}, 'application/xml') -        self.assertXMLContains(content, '<field>111</field>') - -    def test_render_datetime(self): -        """ -        Test XML rendering. -        """ -        renderer = XMLRenderer() -        content = renderer.render({ -            'field': datetime.datetime(2011, 12, 25, 12, 45, 00) -        }, 'application/xml') -        self.assertXMLContains(content, '<field>2011-12-25 12:45:00</field>') - -    def test_render_float(self): -        """ -        Test XML rendering. -        """ -        renderer = XMLRenderer() -        content = renderer.render({'field': 123.4}, 'application/xml') -        self.assertXMLContains(content, '<field>123.4</field>') - -    def test_render_decimal(self): -        """ -        Test XML rendering. -        """ -        renderer = XMLRenderer() -        content = renderer.render({'field': Decimal('111.2')}, 'application/xml') -        self.assertXMLContains(content, '<field>111.2</field>') - -    def test_render_none(self): -        """ -        Test XML rendering. -        """ -        renderer = XMLRenderer() -        content = renderer.render({'field': None}, 'application/xml') -        self.assertXMLContains(content, '<field></field>') - -    def test_render_complex_data(self): -        """ -        Test XML rendering. -        """ -        renderer = XMLRenderer() -        content = renderer.render(self._complex_data, 'application/xml') -        self.assertXMLContains(content, '<sub_name>first</sub_name>') -        self.assertXMLContains(content, '<sub_name>second</sub_name>') - -    @unittest.skipUnless(etree, 'defusedxml not installed') -    def test_render_and_parse_complex_data(self): -        """ -        Test XML rendering. -        """ -        renderer = XMLRenderer() -        content = StringIO(renderer.render(self._complex_data, 'application/xml')) - -        parser = XMLParser() -        complex_data_out = parser.parse(content) -        error_msg = "complex data differs!IN:\n %s \n\n OUT:\n %s" % (repr(self._complex_data), repr(complex_data_out)) -        self.assertEqual(self._complex_data, complex_data_out, error_msg) - -    def assertXMLContains(self, xml, string): -        self.assertTrue(xml.startswith('<?xml version="1.0" encoding="utf-8"?>\n<root>')) -        self.assertTrue(xml.endswith('</root>')) -        self.assertTrue(string in xml, '%r not in %r' % (string, xml)) - - -# Tests for caching issue, #346 -class CacheRenderTest(TestCase): -    """ -    Tests specific to caching responses -    """ - -    urls = 'rest_framework.tests.test_renderers' - -    cache_key = 'just_a_cache_key' - -    @classmethod -    def _get_pickling_errors(cls, obj, seen=None): -        """ Return any errors that would be raised if `obj' is pickled -        Courtesy of koffie @ http://stackoverflow.com/a/7218986/109897 -        """ -        if seen == None: -            seen = [] -        try: -            state = obj.__getstate__() -        except AttributeError: -            return -        if state == None: -            return -        if isinstance(state, tuple): -            if not isinstance(state[0], dict): -                state = state[1] -            else: -                state = state[0].update(state[1]) -        result = {} -        for i in state: -            try: -                pickle.dumps(state[i], protocol=2) -            except pickle.PicklingError: -                if not state[i] in seen: -                    seen.append(state[i]) -                    result[i] = cls._get_pickling_errors(state[i], seen) -        return result - -    def http_resp(self, http_method, url): -        """ -        Simple wrapper for Client http requests -        Removes the `client' and `request' attributes from as they are -        added by django.test.client.Client and not part of caching -        responses outside of tests. -        """ -        method = getattr(self.client, http_method) -        resp = method(url) -        del resp.client, resp.request -        try: -            del resp.wsgi_request -        except AttributeError: -            pass -        return resp - -    def test_obj_pickling(self): -        """ -        Test that responses are properly pickled -        """ -        resp = self.http_resp('get', '/cache') - -        # Make sure that no pickling errors occurred -        self.assertEqual(self._get_pickling_errors(resp), {}) - -        # Unfortunately LocMem backend doesn't raise PickleErrors but returns -        # None instead. -        cache.set(self.cache_key, resp) -        self.assertTrue(cache.get(self.cache_key) is not None) - -    def test_head_caching(self): -        """ -        Test caching of HEAD requests -        """ -        resp = self.http_resp('head', '/cache') -        cache.set(self.cache_key, resp) - -        cached_resp = cache.get(self.cache_key) -        self.assertIsInstance(cached_resp, Response) - -    def test_get_caching(self): -        """ -        Test caching of GET requests -        """ -        resp = self.http_resp('get', '/cache') -        cache.set(self.cache_key, resp) - -        cached_resp = cache.get(self.cache_key) -        self.assertIsInstance(cached_resp, Response) -        self.assertEqual(cached_resp.content, resp.content) | 
