Testing Complex API in Django REST Framework

Introduction

In this lesson, we will explore testing complex API functionalities in the Django REST Framework, specifically filtering, sorting, and pagination. Testing these features ensures that our API behaves as expected when handling various user queries. By the end of this lesson, you will have the knowledge to write comprehensive test cases for these operations and combine them to test more complex scenarios effectively. Note : In this lesson, we will consider only the basic setup for such tests. If you want to learn more about testing in the Django REST API and how to build stable tests that cover all the required behavior, check out the Advanced Testing for Django REST FRAMEWORKS app course path (coming soon).

Recap of Setup: Data

Before we start with the new tests, let's briefly recap the setup of our Django project. In previous course, we covered filtering, sorting and pagination for your views. Here's a quick summary of the core components we'll use in this lesson: We use a fixture stored in myapp/fixtures/todos.json to ensure consistent test data: JSON [{"model": "app.Todo", "pk": 1, "fields": {"task": "Task 1", "completed": false, "priority": 1, "assignee": "John", "group": "Group A"}}, {"model": "app.Todo", "pk": 2, "fields": {"task": "Task 2", "completed": true, "priority": 3, "assignee": "Jane", "group": "Group B"}}, {"model": "app.Todo", "pk": 3, "fields": {"task": "Task 3", "completed": false, "priority": 2, "assignee": "John", "group": "Group A"}}]

Recap of Setup: Views

We will use a custom filter: Python import django_filters from .models import Todo class TodoFilter(django_filters.FilterSet): task = django_filters.CharFilter(field_name='task', lookup_expr='icontains') priority = django_filters.NumberFilter(field_name='priority') priority__gt = django_filters.NumberFilter(field_name='priority', lookup_expr='gt') priority__lt = django_filters.NumberFilter(field_name='priority', lookup_expr='lt') class Meta: model = Todo fields = ['task', 'completed', 'priority', 'assignee', 'group'] And a custom pagination: Python from rest_framework.pagination import PageNumberPagination class TodoPagination(PageNumberPagination): page_size = 2 page_size_query_param = 'page_size' max_page_size = 10 These classes are used in our ListCreateAPI view to ensure it can handle sorting, filtering, and pagination: Python class TodoListCreate(generics.ListCreateAPIView): queryset = Todo.objects.all() serializer_class = TodoSerializer filter_backends = [DjangoFilterBackend, OrderingFilter] filterset_class = TodoFilter ordering_fields = ['task', 'completed', 'priority', 'assignee', 'group'] pagination_class = TodoPagination

Join the 1M+ learners on CodeSignal

Be a part of our community of 1M+ users who develop and demonstrate their skills on CodeSignal

Testing Filtering Functionality

Filtering allows users to retrieve specific subsets of data based on certain criteria. In our Todo API, we'll start by testing the completed field.

Let's write a test case to filter Todo items by their completion status:

Python

from django.urls import reverse
from rest_framework import status
from rest_framework.test import APITestCase

class FilterTodosTestCase(APITestCase):
    fixtures = ['todos.json']

    def setUp(self):
        self.list_url = reverse('todo-list')

    def test_filter_completed_todos(self):
        response = self.client.get(self.list_url, {'completed': True})
        self.assertEqual(response.status_code, status.HTTP_200_OK)
        self.assertEqual(len(response.data['results']), 1)
        self.assertTrue(all(todo['completed'] for todo in response.data['results']))

    def test_filter_uncompleted_todos(self):
        response = self.client.get(self.list_url, {'completed': False})
        self.assertEqual(response.status_code, status.HTTP_200_OK)
        self.assertEqual(len(response.data['results']), 2)
        self.assertTrue(all(not todo['completed'] for todo in response.data['results']))

from django.urls import reverse
from rest_framework import status
from rest_framework.test import APITestCase

class FilterTodosTestCase(APITestCase):
    fixtures = ['todos.json']

    def setUp(self):
        self.list_url = reverse('todo-list')

    def test_filter_completed_todos(self):
        response = self.client.get(self.list_url, {'completed': True})
        self.assertEqual(response.status_code, status.HTTP_200_OK)
        self.assertEqual(len(response.data['results']), 1)
        self.assertTrue(all(todo['completed'] for todo in response.data['results']))

    def test_filter_uncompleted_todos(self):
        response = self.client.get(self.list_url, {'completed': False})
        self.assertEqual(response.status_code, status.HTTP_200_OK)
        self.assertEqual(len(response.data['results']), 2)
        self.assertTrue(all(not todo['completed'] for todo in response.data['results']))

Reminder: As we have pagination enabled for the todos by default, in all test cases you must use response.data['results'] instead of response.data. This ensures that you are accessing the actual list of todo items within the paginated response.

In the above test case:

We use the fixtures attribute to load data from todos.json.
The setUp method initializes the URL for the Todo list endpoint.
We then have two test methods:
- test_filter_completed_todos: This tests the filtering of completed Todo items.
- test_filter_uncompleted_todos: This tests the filtering of uncompleted Todo items.
For each test, we make a GET request with the appropriate filter parameter and validate the response using assertions. We validate the number of returned items and that all items have a specified value for the field used for filtering.

Running these tests will ensure that our API correctly filters Todo items based on their completion status.

Suggestions for extending this test case:

Test filtering by other fields like priority, assignee, and group.
Combine multiple filter parameters in a single request.
Test the case when no items match the filter criteria.

Testing Sorting Functionality

Sorting allows users to order data based on specific fields. We'll test sorting Todo items by their priority field.

Let's write a test case to sort Todo items by their priority:

Python

class SortTodosTestCase(APITestCase):
    fixtures = ['todos.json']

    def setUp(self):
        self.list_url = reverse('todo-list')

    def test_sort_todos_by_priority_asc(self):
        response = self.client.get(self.list_url, {'ordering': 'priority'})
        self.assertEqual(response.status_code, status.HTTP_200_OK)
        priorities = [todo['priority'] for todo in response.data['results']]
        self.assertEqual(priorities, sorted(priorities))

    def test_sort_todos_by_priority_desc(self):
        response = self.client.get(self.list_url, {'ordering': '-priority'})
        self.assertEqual(response.status_code, status.HTTP_200_OK)
        priorities = [todo['priority'] for todo in response.data['results']]
        self.assertEqual(priorities, sorted(priorities, reverse=True))

class SortTodosTestCase(APITestCase):
    fixtures = ['todos.json']

    def setUp(self):
        self.list_url = reverse('todo-list')

    def test_sort_todos_by_priority_asc(self):
        response = self.client.get(self.list_url, {'ordering': 'priority'})
        self.assertEqual(response.status_code, status.HTTP_200_OK)
        priorities = [todo['priority'] for todo in response.data['results']]
        self.assertEqual(priorities, sorted(priorities))

    def test_sort_todos_by_priority_desc(self):
        response = self.client.get(self.list_url, {'ordering': '-priority'})
        self.assertEqual(response.status_code, status.HTTP_200_OK)
        priorities = [todo['priority'] for todo in response.data['results']]
        self.assertEqual(priorities, sorted(priorities, reverse=True))

In this test case:

We test the sorting functionality of the Todo list endpoint by the priority field in both ascending and descending order.
The test_sort_todos_by_priority_asc method validates the ascending sort order.
The test_sort_todos_by_priority_desc method validates the descending sort order.
Both methods check that the response status is 200 OK and that the priority values in the response are sorted as expected.

Suggestions for extending this test case:

Test sorting by other fields like task, completed, and assignee.
Combine multiple sorting fields in a single request.

Testing Pagination Functionality

Pagination allows users to retrieve data in chunks or pages. We'll test the pagination of Todo items.

Let's write a test case to paginate Todo items:

Python

class PaginateTodosTestCase(APITestCase):
    fixtures = ['todos.json']

    def setUp(self):
        self.list_url = reverse('todo-list')

    def test_paginate_todos_first_page(self):
        response = self.client.get(self.list_url, {'page_size': 2, 'page': 1})
        self.assertEqual(response.status_code, status.HTTP_200_OK)
        self.assertEqual(len(response.data['results']), 2)

    def test_paginate_todos_second_page(self):
        response = self.client.get(self.list_url, {'page_size': 2, 'page': 2})
        self.assertEqual(response.status_code, status.HTTP_200_OK)
        self.assertEqual(len(response.data['results']), 1)

class PaginateTodosTestCase(APITestCase):
    fixtures = ['todos.json']

    def setUp(self):
        self.list_url = reverse('todo-list')

    def test_paginate_todos_first_page(self):
        response = self.client.get(self.list_url, {'page_size': 2, 'page': 1})
        self.assertEqual(response.status_code, status.HTTP_200_OK)
        self.assertEqual(len(response.data['results']), 2)

    def test_paginate_todos_second_page(self):
        response = self.client.get(self.list_url, {'page_size': 2, 'page': 2})
        self.assertEqual(response.status_code, status.HTTP_200_OK)
        self.assertEqual(len(response.data['results']), 1)

In this test case:

We test the pagination functionality of the Todo list endpoint by specifying the page_size and page parameters.
The test_paginate_todos_first_page method checks the first page of results, ensuring it contains 2 items.
The test_paginate_todos_second_page method checks the second page of results, ensuring it contains 1 item.
Both methods verify that the response status is 200 OK and the number of items in the results matches the expected count.

Suggestions for extending this test case:

Test with different page_size values.
Test accessing a non-existing page.

Combining Operations in Test Cases

Combining filtering, sorting, and pagination allows for more complex queries. We'll test a combination of these operations.

Let's write a test case combining filtering, sorting, and pagination:

Python

from django.utils.http import urlencode

class CombinedOperationsTestCase(APITestCase):
    fixtures = ['todos.json']

    def setUp(self):
        self.list_url = reverse('todo-list')

    def test_combined_filter_sort_paginate(self):
        params = urlencode({'completed': False, 'ordering': 'priority', 'page_size': 2, 'page': 1})
        response = self.client.get(f"{self.list_url}?{params}")
        self.assertEqual(response.status_code, status.HTTP_200_OK)
        self.assertEqual(len(response.data['results']), 2)
        self.assertTrue(all(not todo['completed'] for todo in response.data['results']))
        priorities = [todo['priority'] for todo in response.data['results']]
        self.assertEqual(priorities, sorted(priorities))

from django.utils.http import urlencode

class CombinedOperationsTestCase(APITestCase):
    fixtures = ['todos.json']

    def setUp(self):
        self.list_url = reverse('todo-list')

    def test_combined_filter_sort_paginate(self):
        params = urlencode({'completed': False, 'ordering': 'priority', 'page_size': 2, 'page': 1})
        response = self.client.get(f"{self.list_url}?{params}")
        self.assertEqual(response.status_code, status.HTTP_200_OK)
        self.assertEqual(len(response.data['results']), 2)
        self.assertTrue(all(not todo['completed'] for todo in response.data['results']))
        priorities = [todo['priority'] for todo in response.data['results']]
        self.assertEqual(priorities, sorted(priorities))

In this test case:

We combine filtering by completed, sorting by priority, and pagination parameters.
The assertTrue(all(not todo['completed'] for todo in response.data['results'])) line iterates over all items in the response data to check that they all have completed set to False.
The priorities list is created to hold all priority values from the response, ensuring they are in ascending order. This list is then compared to the sorted version of itself to confirm that the priorities are sorted correctly.

Suggestions for extending this test case:

Combine different fields for filtering and sorting.
Test combined operations with varying page_size values.
Test combinations with more complex filter criteria.
Filter items in a way that results in 0 items returned.

Introduction

Recap of Setup: Data

Recap of Setup: Views

Join the 1M+ learners on CodeSignal

Testing Filtering Functionality

Testing Sorting Functionality

Testing Pagination Functionality

Combining Operations in Test Cases

Explanation of urlencode

Overview and Summary