mirror of
https://github.com/encode/django-rest-framework.git
synced 2024-09-20 19:09:03 +03:00
2ede857de0
* Add official support for Django 5.1 Following the supported Python versions: https://docs.djangoproject.com/en/stable/faq/install/ * Add tests to cover compat with Django's 5.1 LoginRequiredMiddleware * First pass to create DRF's LoginRequiredMiddleware * Attempt to fix the tests * Revert custom middleware implementation * Disable LoginRequiredMiddleware on DRF views * Document how to integrate DRF with LoginRequiredMiddleware * Move login required tests under a separate test case * Revert redundant change * Disable LoginRequiredMiddleware on ViewSets * Add some integrations tests to cover various view types
151 lines
4.5 KiB
Python
151 lines
4.5 KiB
Python
import copy
|
|
import unittest
|
|
|
|
from django import VERSION as DJANGO_VERSION
|
|
from django.test import TestCase
|
|
|
|
from rest_framework import status
|
|
from rest_framework.decorators import api_view
|
|
from rest_framework.response import Response
|
|
from rest_framework.settings import APISettings, api_settings
|
|
from rest_framework.test import APIRequestFactory
|
|
from rest_framework.views import APIView
|
|
|
|
factory = APIRequestFactory()
|
|
|
|
JSON_ERROR = 'JSON parse error - Expecting value:'
|
|
|
|
|
|
class BasicView(APIView):
|
|
def get(self, request, *args, **kwargs):
|
|
return Response({'method': 'GET'})
|
|
|
|
def post(self, request, *args, **kwargs):
|
|
return Response({'method': 'POST', 'data': request.data})
|
|
|
|
|
|
@api_view(['GET', 'POST', 'PUT', 'PATCH'])
|
|
def basic_view(request):
|
|
if request.method == 'GET':
|
|
return {'method': 'GET'}
|
|
elif request.method == 'POST':
|
|
return {'method': 'POST', 'data': request.data}
|
|
elif request.method == 'PUT':
|
|
return {'method': 'PUT', 'data': request.data}
|
|
elif request.method == 'PATCH':
|
|
return {'method': 'PATCH', 'data': request.data}
|
|
|
|
|
|
class ErrorView(APIView):
|
|
def get(self, request, *args, **kwargs):
|
|
raise Exception
|
|
|
|
|
|
def custom_handler(exc, context):
|
|
if isinstance(exc, SyntaxError):
|
|
return Response({'error': 'SyntaxError'}, status=400)
|
|
return Response({'error': 'UnknownError'}, status=500)
|
|
|
|
|
|
class OverridenSettingsView(APIView):
|
|
settings = APISettings({'EXCEPTION_HANDLER': custom_handler})
|
|
|
|
def get(self, request, *args, **kwargs):
|
|
raise SyntaxError('request is invalid syntax')
|
|
|
|
|
|
@api_view(['GET'])
|
|
def error_view(request):
|
|
raise Exception
|
|
|
|
|
|
def sanitise_json_error(error_dict):
|
|
"""
|
|
Exact contents of JSON error messages depend on the installed version
|
|
of json.
|
|
"""
|
|
ret = copy.copy(error_dict)
|
|
chop = len(JSON_ERROR)
|
|
ret['detail'] = ret['detail'][:chop]
|
|
return ret
|
|
|
|
|
|
class ClassBasedViewIntegrationTests(TestCase):
|
|
def setUp(self):
|
|
self.view = BasicView.as_view()
|
|
|
|
def test_400_parse_error(self):
|
|
request = factory.post('/', 'f00bar', content_type='application/json')
|
|
response = self.view(request)
|
|
expected = {
|
|
'detail': JSON_ERROR
|
|
}
|
|
assert response.status_code == status.HTTP_400_BAD_REQUEST
|
|
assert sanitise_json_error(response.data) == expected
|
|
|
|
|
|
class FunctionBasedViewIntegrationTests(TestCase):
|
|
def setUp(self):
|
|
self.view = basic_view
|
|
|
|
def test_400_parse_error(self):
|
|
request = factory.post('/', 'f00bar', content_type='application/json')
|
|
response = self.view(request)
|
|
expected = {
|
|
'detail': JSON_ERROR
|
|
}
|
|
assert response.status_code == status.HTTP_400_BAD_REQUEST
|
|
assert sanitise_json_error(response.data) == expected
|
|
|
|
|
|
class TestCustomExceptionHandler(TestCase):
|
|
def setUp(self):
|
|
self.DEFAULT_HANDLER = api_settings.EXCEPTION_HANDLER
|
|
|
|
def exception_handler(exc, request):
|
|
return Response('Error!', status=status.HTTP_400_BAD_REQUEST)
|
|
|
|
api_settings.EXCEPTION_HANDLER = exception_handler
|
|
|
|
def tearDown(self):
|
|
api_settings.EXCEPTION_HANDLER = self.DEFAULT_HANDLER
|
|
|
|
def test_class_based_view_exception_handler(self):
|
|
view = ErrorView.as_view()
|
|
|
|
request = factory.get('/', content_type='application/json')
|
|
response = view(request)
|
|
expected = 'Error!'
|
|
assert response.status_code == status.HTTP_400_BAD_REQUEST
|
|
assert response.data == expected
|
|
|
|
def test_function_based_view_exception_handler(self):
|
|
view = error_view
|
|
|
|
request = factory.get('/', content_type='application/json')
|
|
response = view(request)
|
|
expected = 'Error!'
|
|
assert response.status_code == status.HTTP_400_BAD_REQUEST
|
|
assert response.data == expected
|
|
|
|
|
|
class TestCustomSettings(TestCase):
|
|
def setUp(self):
|
|
self.view = OverridenSettingsView.as_view()
|
|
|
|
def test_get_exception_handler(self):
|
|
request = factory.get('/', content_type='application/json')
|
|
response = self.view(request)
|
|
assert response.status_code == 400
|
|
assert response.data == {'error': 'SyntaxError'}
|
|
|
|
|
|
@unittest.skipUnless(DJANGO_VERSION >= (5, 1), 'Only for Django 5.1+')
|
|
class TestLoginRequiredMiddlewareCompat(TestCase):
|
|
def test_class_based_view_opted_out(self):
|
|
class_based_view = BasicView.as_view()
|
|
assert class_based_view.login_required is False
|
|
|
|
def test_function_based_view_opted_out(self):
|
|
assert basic_view.login_required is False
|