mirror of
https://github.com/encode/django-rest-framework.git
synced 2024-11-10 19:56:59 +03:00
8105a4ac5a
* Add tests for html-form-rendering choice fields * Resolve issues with ChoiceField, MultipleChoiceField and non-string options * Ensure None template comparisons don't match string None
571 lines
20 KiB
Python
571 lines
20 KiB
Python
# -*- coding: utf-8 -*-
|
|
from __future__ import unicode_literals
|
|
|
|
import json
|
|
import re
|
|
from collections import MutableMapping, OrderedDict
|
|
|
|
from django.conf.urls import include, url
|
|
from django.core.cache import cache
|
|
from django.db import models
|
|
from django.test import TestCase, override_settings
|
|
from django.utils import six
|
|
from django.utils.safestring import SafeText
|
|
from django.utils.translation import ugettext_lazy as _
|
|
|
|
from rest_framework import permissions, serializers, status
|
|
from rest_framework.renderers import (
|
|
BaseRenderer, BrowsableAPIRenderer, HTMLFormRenderer, JSONRenderer
|
|
)
|
|
from rest_framework.response import Response
|
|
from rest_framework.settings import api_settings
|
|
from rest_framework.test import APIRequestFactory
|
|
from rest_framework.views import APIView
|
|
|
|
DUMMYSTATUS = status.HTTP_200_OK
|
|
DUMMYCONTENT = 'dummycontent'
|
|
|
|
|
|
def RENDERER_A_SERIALIZER(x):
|
|
return ('Renderer A: %s' % x).encode('ascii')
|
|
|
|
|
|
def RENDERER_B_SERIALIZER(x):
|
|
return ('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 = [
|
|
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'^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<')
|
|
|
|
|
|
@override_settings(ROOT_URLCONF='tests.test_renderers')
|
|
class RendererEndToEndTests(TestCase):
|
|
"""
|
|
End-to-end testing of renderers using an RendererMixin on a generic view.
|
|
"""
|
|
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_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.assertEqual(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.assertEqual(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.assertEqual(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)
|
|
|
|
|
|
class UnicodeJSONRendererTests(TestCase):
|
|
"""
|
|
Tests specific for the Unicode JSON Renderer
|
|
"""
|
|
def test_proper_encoding(self):
|
|
obj = {'countries': ['United Kingdom', 'France', 'España']}
|
|
renderer = JSONRenderer()
|
|
content = renderer.render(obj, 'application/json')
|
|
self.assertEqual(content, '{"countries":["United Kingdom","France","España"]}'.encode('utf-8'))
|
|
|
|
def test_u2028_u2029(self):
|
|
# The \u2028 and \u2029 characters should be escaped,
|
|
# even when the non-escaping unicode representation is used.
|
|
# Regression test for #2169
|
|
obj = {'should_escape': '\u2028\u2029'}
|
|
renderer = JSONRenderer()
|
|
content = renderer.render(obj, 'application/json')
|
|
self.assertEqual(content, '{"should_escape":"\\u2028\\u2029"}'.encode('utf-8'))
|
|
|
|
|
|
class AsciiJSONRendererTests(TestCase):
|
|
"""
|
|
Tests specific for the Unicode JSON Renderer
|
|
"""
|
|
def test_proper_encoding(self):
|
|
class AsciiJSONRenderer(JSONRenderer):
|
|
ensure_ascii = True
|
|
obj = {'countries': ['United Kingdom', 'France', 'España']}
|
|
renderer = AsciiJSONRenderer()
|
|
content = renderer.render(obj, 'application/json')
|
|
self.assertEqual(content, '{"countries":["United Kingdom","France","Espa\\u00f1a"]}'.encode('utf-8'))
|
|
|
|
|
|
# Tests for caching issue, #346
|
|
@override_settings(ROOT_URLCONF='tests.test_renderers')
|
|
class CacheRenderTest(TestCase):
|
|
"""
|
|
Tests specific to caching responses
|
|
"""
|
|
def test_head_caching(self):
|
|
"""
|
|
Test caching of HEAD requests
|
|
"""
|
|
response = self.client.head('/cache')
|
|
cache.set('key', response)
|
|
cached_response = cache.get('key')
|
|
assert isinstance(cached_response, Response)
|
|
assert cached_response.content == response.content
|
|
assert cached_response.status_code == response.status_code
|
|
|
|
def test_get_caching(self):
|
|
"""
|
|
Test caching of GET requests
|
|
"""
|
|
response = self.client.get('/cache')
|
|
cache.set('key', response)
|
|
cached_response = cache.get('key')
|
|
assert isinstance(cached_response, Response)
|
|
assert cached_response.content == response.content
|
|
assert cached_response.status_code == response.status_code
|
|
|
|
|
|
class TestJSONIndentationStyles:
|
|
def test_indented(self):
|
|
renderer = JSONRenderer()
|
|
data = OrderedDict([('a', 1), ('b', 2)])
|
|
assert renderer.render(data) == b'{"a":1,"b":2}'
|
|
|
|
def test_compact(self):
|
|
renderer = JSONRenderer()
|
|
data = OrderedDict([('a', 1), ('b', 2)])
|
|
context = {'indent': 4}
|
|
assert (
|
|
renderer.render(data, renderer_context=context) ==
|
|
b'{\n "a": 1,\n "b": 2\n}'
|
|
)
|
|
|
|
def test_long_form(self):
|
|
renderer = JSONRenderer()
|
|
renderer.compact = False
|
|
data = OrderedDict([('a', 1), ('b', 2)])
|
|
assert renderer.render(data) == b'{"a": 1, "b": 2}'
|
|
|
|
|
|
class TestHiddenFieldHTMLFormRenderer(TestCase):
|
|
def test_hidden_field_rendering(self):
|
|
class TestSerializer(serializers.Serializer):
|
|
published = serializers.HiddenField(default=True)
|
|
|
|
serializer = TestSerializer(data={})
|
|
serializer.is_valid()
|
|
renderer = HTMLFormRenderer()
|
|
field = serializer['published']
|
|
rendered = renderer.render_field(field, {})
|
|
assert rendered == ''
|
|
|
|
|
|
class TestHTMLFormRenderer(TestCase):
|
|
def setUp(self):
|
|
class TestSerializer(serializers.Serializer):
|
|
test_field = serializers.CharField()
|
|
|
|
self.renderer = HTMLFormRenderer()
|
|
self.serializer = TestSerializer(data={})
|
|
|
|
def test_render_with_default_args(self):
|
|
self.serializer.is_valid()
|
|
renderer = HTMLFormRenderer()
|
|
|
|
result = renderer.render(self.serializer.data)
|
|
|
|
self.assertIsInstance(result, SafeText)
|
|
|
|
def test_render_with_provided_args(self):
|
|
self.serializer.is_valid()
|
|
renderer = HTMLFormRenderer()
|
|
|
|
result = renderer.render(self.serializer.data, None, {})
|
|
|
|
self.assertIsInstance(result, SafeText)
|
|
|
|
|
|
class TestChoiceFieldHTMLFormRenderer(TestCase):
|
|
"""
|
|
Test rendering ChoiceField with HTMLFormRenderer.
|
|
"""
|
|
|
|
def setUp(self):
|
|
choices = ((1, 'Option1'), (2, 'Option2'), (12, 'Option12'))
|
|
|
|
class TestSerializer(serializers.Serializer):
|
|
test_field = serializers.ChoiceField(choices=choices,
|
|
initial=2)
|
|
|
|
self.TestSerializer = TestSerializer
|
|
self.renderer = HTMLFormRenderer()
|
|
|
|
def test_render_initial_option(self):
|
|
serializer = self.TestSerializer()
|
|
result = self.renderer.render(serializer.data)
|
|
|
|
self.assertIsInstance(result, SafeText)
|
|
|
|
self.assertInHTML('<option value="2" selected>Option2</option>',
|
|
result)
|
|
self.assertInHTML('<option value="1">Option1</option>', result)
|
|
self.assertInHTML('<option value="12">Option12</option>', result)
|
|
|
|
def test_render_selected_option(self):
|
|
serializer = self.TestSerializer(data={'test_field': '12'})
|
|
|
|
serializer.is_valid()
|
|
result = self.renderer.render(serializer.data)
|
|
|
|
self.assertIsInstance(result, SafeText)
|
|
|
|
self.assertInHTML('<option value="12" selected>Option12</option>',
|
|
result)
|
|
self.assertInHTML('<option value="1">Option1</option>', result)
|
|
self.assertInHTML('<option value="2">Option2</option>', result)
|
|
|
|
|
|
class TestMultipleChoiceFieldHTMLFormRenderer(TestCase):
|
|
"""
|
|
Test rendering MultipleChoiceField with HTMLFormRenderer.
|
|
"""
|
|
|
|
def setUp(self):
|
|
self.renderer = HTMLFormRenderer()
|
|
|
|
def test_render_selected_option_with_string_option_ids(self):
|
|
choices = (('1', 'Option1'), ('2', 'Option2'), ('12', 'Option12'),
|
|
('}', 'OptionBrace'))
|
|
|
|
class TestSerializer(serializers.Serializer):
|
|
test_field = serializers.MultipleChoiceField(choices=choices)
|
|
|
|
serializer = TestSerializer(data={'test_field': ['12']})
|
|
serializer.is_valid()
|
|
|
|
result = self.renderer.render(serializer.data)
|
|
|
|
self.assertIsInstance(result, SafeText)
|
|
|
|
self.assertInHTML('<option value="12" selected>Option12</option>',
|
|
result)
|
|
self.assertInHTML('<option value="1">Option1</option>', result)
|
|
self.assertInHTML('<option value="2">Option2</option>', result)
|
|
self.assertInHTML('<option value="}">OptionBrace</option>', result)
|
|
|
|
def test_render_selected_option_with_integer_option_ids(self):
|
|
choices = ((1, 'Option1'), (2, 'Option2'), (12, 'Option12'))
|
|
|
|
class TestSerializer(serializers.Serializer):
|
|
test_field = serializers.MultipleChoiceField(choices=choices)
|
|
|
|
serializer = TestSerializer(data={'test_field': ['12']})
|
|
serializer.is_valid()
|
|
|
|
result = self.renderer.render(serializer.data)
|
|
|
|
self.assertIsInstance(result, SafeText)
|
|
|
|
self.assertInHTML('<option value="12" selected>Option12</option>',
|
|
result)
|
|
self.assertInHTML('<option value="1">Option1</option>', result)
|
|
self.assertInHTML('<option value="2">Option2</option>', result)
|