Testing API Endpoints in Django REST Framework

Introduction

Welcome to the lesson on " Testing API Endpoints " using the Django REST Framework. Testing is a critical part of software development, ensuring that your API endpoints work as expected. In this lesson, we will focus on testing API endpoints in our Todo application. We'll cover the importance of testing, how to use APITestCase, and how to write comprehensive tests for our Todo application endpoints.

Introduction to APITestCase

In Django REST Framework, APITestCase is a powerful class that allows us to test our API endpoints. It's part of the rest_framework.test module and provides methods for making HTTP requests to our API in a test environment. You initiate a test case class by subclassing APITestCase, and set up the initial conditions using the setUp method. This method is run before every individual test method, ensuring a consistent setup for each test.

Loading Data Fixtures

Data fixtures are crucial for testing because they provide a consistent and controlled dataset. This dataset can be loaded into the database before each test is run, ensuring that your tests are predictable and reliable. Here's how to load a data fixture in your test case: Python class TodoAPITestCase(APITestCase): fixtures = ['myapp/fixtures/file.json']

Preparing Test Data

Within the test class, you can define self.todos to hold objects that represent the initial test data. This can be set up in the setUp method along with URLs that will be used in the tests. You can also define a separate self.count variable to hold the initial count of todos, which will help us to verify changes in the number of todos: Python def setUp(self): self.todos = Todo.objects.all() self.count = len(self.todos) self.list_url = reverse('todo_list') Here, self.todos is a queryset of all Todo items in the testing database, created from a fixture. self.count holds the initial count of these todos. self.list_url is the URL pointing to the list endpoint for your Todo items. Using len(self.todos) directly within test methods can lead to inconsistent results, especially if concurrent operations modify the dataset. By defining self.count in the setUp method, we ensure a stable reference to the initial dataset size, allowing us to accurately verify changes made during the tests.

Join the 1M+ learners on CodeSignal

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

Writing Tests for API Endpoints: Retrieving

Let's walk through writing tests for various API endpoints, including retrieving, creating, updating, and deleting Todo items. We will consider simple test cases, but we will also discuss possible options for more advanced testing and cover more examples in practice.

To retrieve all Todo items, we use a GET request to the list endpoint. Here's an example test case:

Python

from rest_framework import status
from django.urls import reverse

class RetrieveTodosAPITestCase(APITestCase):
    fixtures = ['myapp/fixtures/file.json']

    def setUp(self):
        self.todos = Todo.objects.all()
        self.count = len(self.todos)
        self.list_url = reverse('todo_list')

    def test_get_todos(self):
        response = self.client.get(self.list_url)
        self.assertEqual(response.status_code, status.HTTP_200_OK)
        self.assertEqual(len(response.data), self.count)

    def test_get_todo_detail(self):
        todo = self.todos.first()
        response = self.client.get(reverse('todo_detail', args=[todo.id]))
        self.assertEqual(response.status_code, status.HTTP_200_OK)
        self.assertEqual(response.data['task'], todo.task)

from rest_framework import status
from django.urls import reverse

class RetrieveTodosAPITestCase(APITestCase):
    fixtures = ['myapp/fixtures/file.json']

    def setUp(self):
        self.todos = Todo.objects.all()
        self.count = len(self.todos)
        self.list_url = reverse('todo_list')

    def test_get_todos(self):
        response = self.client.get(self.list_url)
        self.assertEqual(response.status_code, status.HTTP_200_OK)
        self.assertEqual(len(response.data), self.count)

    def test_get_todo_detail(self):
        todo = self.todos.first()
        response = self.client.get(reverse('todo_detail', args=[todo.id]))
        self.assertEqual(response.status_code, status.HTTP_200_OK)
        self.assertEqual(response.data['task'], todo.task)

In these tests, we are verifying:

The GET request to self.list_url returns a 200 status code (OK) and the number of items in the response matches the initial count of todos from the fixture.
self.client is an instance of APIClient provided by the Django REST Framework for simulating HTTP requests in your tests. You can use self.client to perform actions such as get, post, put, and delete requests to your API endpoints. This allows you to interact with your API as if you were a client making HTTP requests.
The GET request to a specific Todo detail returns a 200 status code and the task of the todo item matches the task in the response data.

HTTP status codes are part of the response from the server to the client, indicating the result of the requested action. Here's a brief overview:

200 OK: The request was successful.
201 Created: A new resource has been successfully created.
204 No Content: The request was successful but there's no content to send in the response.
400 Bad Request: The server could not understand the request due to invalid syntax.
404 Not Found: The requested resource could not be found.

In your tests, you can check these status codes to verify whether the endpoints are behaving as expected using assertions like self.assertEqual(response.status_code, status.HTTP_200_OK).

Suggestions for extending the test:

Verify the data of each returned item.
Check the format of the response.
Test filtering and pagination options.

Writing Tests for API Endpoints: Creating

To test creating a new Todo item, we use a POST request to the list endpoint. Here's an example:

Python

class CreateTodoAPITestCase(APITestCase):
    fixtures = ['myapp/fixtures/file.json']

    def setUp(self):
        self.todos = Todo.objects.all()
        self.count = len(self.todos)
        self.list_url = reverse('todo_list')

    def test_create_todo(self):
        data = {
            'task': 'New task', 
            'completed': False, 
            'assignee': 'Jane Smith', 
            'due_date': '2023-12-31T23:59:59Z',
            'group': 'Group B'
        }
        response = self.client.post(self.list_url, data)
        self.assertEqual(response.status_code, status.HTTP_201_CREATED)
        self.assertEqual(Todo.objects.count(), self.count + 1)

    def test_create_todo_invalid_data(self):
        data = {
            'task': '', 
            'completed': False, 
            'assignee': 'Jane Smith', 
            'due_date': '2023-12-31T23:59:59Z',
            'group': 'Group B'
        }
        response = self.client.post(self.list_url, data)
        self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)

class CreateTodoAPITestCase(APITestCase):
    fixtures = ['myapp/fixtures/file.json']

    def setUp(self):
        self.todos = Todo.objects.all()
        self.count = len(self.todos)
        self.list_url = reverse('todo_list')

    def test_create_todo(self):
        data = {
            'task': 'New task', 
            'completed': False, 
            'assignee': 'Jane Smith', 
            'due_date': '2023-12-31T23:59:59Z',
            'group': 'Group B'
        }
        response = self.client.post(self.list_url, data)
        self.assertEqual(response.status_code, status.HTTP_201_CREATED)
        self.assertEqual(Todo.objects.count(), self.count + 1)

    def test_create_todo_invalid_data(self):
        data = {
            'task': '', 
            'completed': False, 
            'assignee': 'Jane Smith', 
            'due_date': '2023-12-31T23:59:59Z',
            'group': 'Group B'
        }
        response = self.client.post(self.list_url, data)
        self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)

In these tests, we are verifying:

The POST request with valid data returns a 201 status code (Created) and increases the number of todos by one.
The POST request with invalid data (empty task) returns a 400 status code (Bad Request), indicating that the data did not pass validation.

Suggestions for extending the test:

Validate the content of the newly created Todo item.
Test creating an item without required fields.
Test creating an item with invalid data.

Writing Tests for API Endpoints: Updating

To update an existing Todo item, we use a PUT request to the update endpoint of a specific item. Here's an example:

Python

class UpdateTodoAPITestCase(APITestCase):
    fixtures = ['myapp/fixtures/file.json']

    def setUp(self):
        self.todos = Todo.objects.all()

    def test_update_todo(self):
        data = {
            'task': 'Updated task', 
            'completed': True, 
            'assignee': 'John Doe', 
            'due_date': '2023-12-31T23:59:59Z',
            'group': 'Group A'
        }
        todo = self.todos.first()
        response = self.client.put(reverse('todo_update', args=[todo.id]), data)
        self.assertEqual(response.status_code, status.HTTP_200_OK)
        todo.refresh_from_db()
        self.assertTrue(todo.completed)
        self.assertEqual(todo.task, "Updated task")

    def test_update_todo_invalid_data(self):
        data = {
            'task': '', 
            'completed': True, 
            'assignee': 'John Doe', 
            'due_date': '2023-12-31T23:59:59Z',
            'group': 'Group A'
        }
        todo = self.todos.first()
        response = self.client.put(reverse('todo_update', args=[todo.id]), data)
        self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)

class UpdateTodoAPITestCase(APITestCase):
    fixtures = ['myapp/fixtures/file.json']

    def setUp(self):
        self.todos = Todo.objects.all()

    def test_update_todo(self):
        data = {
            'task': 'Updated task', 
            'completed': True, 
            'assignee': 'John Doe', 
            'due_date': '2023-12-31T23:59:59Z',
            'group': 'Group A'
        }
        todo = self.todos.first()
        response = self.client.put(reverse('todo_update', args=[todo.id]), data)
        self.assertEqual(response.status_code, status.HTTP_200_OK)
        todo.refresh_from_db()
        self.assertTrue(todo.completed)
        self.assertEqual(todo.task, "Updated task")

    def test_update_todo_invalid_data(self):
        data = {
            'task': '', 
            'completed': True, 
            'assignee': 'John Doe', 
            'due_date': '2023-12-31T23:59:59Z',
            'group': 'Group A'
        }
        todo = self.todos.first()
        response = self.client.put(reverse('todo_update', args=[todo.id]), data)
        self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)

In these tests, we are verifying:

The PUT request with valid data returns a 200 status code (OK) and updates the todo item. We then check that the completed field is set to True and the task field is updated.
The PUT request with invalid data (empty task) returns a 400 status code (Bad Request), indicating that the update did not succeed due to invalid input.

The first method retrieves the first object in the queryset, while refresh_from_db refreshes the instance with data from the database, ensuring that you are working with the latest state of the object. In this context, refresh_from_db allows us to fetch updated information about the item stored in the todo variable.

Suggestions for extending the test:

Validate error handling for invalid updates.
Test updating non-existent items.

Writing Tests for API Endpoints: Deleting

To delete a Todo item, we use a DELETE request to the delete endpoint of a specific item. Here's an example:

Python

class DeleteTodoAPITestCase(APITestCase):
    fixtures = ['myapp/fixtures/file.json']

    def setUp(self):
        self.todos = Todo.objects.all()
        self.count = len(self.todos)

    def test_delete_todo(self):
        todo = self.todos.first()
        response = self.client.delete(reverse('todo_delete', args=[todo.id]))
        self.assertEqual(response.status_code, status.HTTP_204_NO_CONTENT)
        self.assertEqual(Todo.objects.count(), self.count - 1)

    def test_delete_nonexistent_todo(self):
        non_existent_id = 9999
        response = self.client.delete(reverse('todo_delete', args=[non_existent_id]))
        self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND)

class DeleteTodoAPITestCase(APITestCase):
    fixtures = ['myapp/fixtures/file.json']

    def setUp(self):
        self.todos = Todo.objects.all()
        self.count = len(self.todos)

    def test_delete_todo(self):
        todo = self.todos.first()
        response = self.client.delete(reverse('todo_delete', args=[todo.id]))
        self.assertEqual(response.status_code, status.HTTP_204_NO_CONTENT)
        self.assertEqual(Todo.objects.count(), self.count - 1)

    def test_delete_nonexistent_todo(self):
        non_existent_id = 9999
        response = self.client.delete(reverse('todo_delete', args=[non_existent_id]))
        self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND)

In these tests, we are verifying:

The DELETE request for an existing todo returns a 204 status code (No Content) and decreases the number of todos by one.
The DELETE request for a non-existent todo returns a 404 status code (Not Found), indicating that the item does not exist.

Suggestions for extending the test:

Validate error handling for deleting non-existent items.
Test authorization checks for deletion.
Verify the cascade effect on related models, if any.

Introduction

Introduction to APITestCase

Loading Data Fixtures

Preparing Test Data

Join the 1M+ learners on CodeSignal

Recap of the `reverse` Method

Writing Tests for API Endpoints: Retrieving

Writing Tests for API Endpoints: Creating

Writing Tests for API Endpoints: Updating

Writing Tests for API Endpoints: Deleting

Running Tests and Checking Results

Conclusion and Next Steps