Writing Basic Tests with Pytest

Welcome to the first lesson of the course Automating API Tests with Python. In this course, we will focus on the critical aspect of API testing, specifically from the perspective of an API client, ensuring that the API behaves as expected from the consumer's end.

As software systems become more interconnected through APIs, the reliability and stability of these interfaces have a direct impact on the client experience. By testing APIs, clients can verify that they receive accurate, consistent data and that the API performs as intended in various circumstances.

We will introduce you to pytest, a powerful Python framework that simplifies the process of writing and running tests. By leveraging pytest, you will be equipped to efficiently ensure the APIs you rely on are dependable, fostering greater confidence and trust in software integrations.

Pytest is a popular and powerful testing framework for Python that is designed to make testing simple and scalable. It is used for writing simple as well as complex functional test cases and can be leveraged for API testing. Pytest stands out due to its simple syntax, robust assertion introspection, and ability to integrate various test fixtures and plugins.

Here’s how Pytest works:

• Test Discovery: Pytest automatically identifies test files and test functions within those files. By default, it looks for files named test_*.py or *_test.py and functions that start with the keyword test_.

• Running Tests: Once tests are discovered, Pytest executes them and provides a detailed report of the outcomes. It captures the standard output and exceptions raised during test execution, displaying any errors and their traceback if a test fails.

• Assertions: Pytest enhances Python's assert statements, giving rich comparison introspection and providing meaningful error messages. This makes it easier to find out why a test failed.

• Fixtures: Pytest supports test setup and cleanup activities. You can define reusable testing code that helps manage state and configuration needed by your tests through fixtures.

By using Pytest, web developers can efficiently verify that their APIs and applications are working as expected, ensuring quality and reliability in software projects.

The Arrange-Act-Assert (AAA) pattern is a widely-used pattern in software testing that helps structure your test cases in a clear, logical, and consistent manner. This pattern makes tests more readable and maintainable by dividing them into three distinct phases:

1. Arrange: This phase involves setting up all necessary preconditions and inputs required for your test. In the context of API testing, this could involve defining any required data setup.

2. Act: In this phase, you perform the action that triggers the behavior you want to test. For API tests, this usually involves making a request to the API endpoint you've set up.

3. Assert: The final phase is where you verify that the outcome of the "Act" phase matches your expectations. This is done using assertions to check the response from the API, ensuring it behaves as expected.

Using the AAA pattern helps keep your tests organized and ensures that each test follows a consistent structure. This makes it easier to understand and maintain your test cases over time. Let's apply the AAA pattern in the next section by creating a basic test with pytest.

In the example below, we're preparing to test an API endpoint that retrieves all todo items. It’s important to note the naming convention used for our test function. In Pytest, test functions should begin with the word "test_" to make them easily discoverable by the framework.

import requests

BASE_URL = "http://localhost:8000"

def test_get_all_todos():
    # Arrange
    url = f"{BASE_URL}/todos"

In this code block, we define a base URL for our API and construct the full URL for the "todos" endpoint. By naming our function test_get_all_todos, we adhere to Pytest's convention, allowing it to automatically recognize this function as a test case. This forms your "Arrange" step by setting up the conditions required for the test to proceed.

The next stage in the AAA pattern is "Act." This is where you perform the action that triggers the behavior you want to test. In API testing, the action usually involves making a request to the API endpoint you've prepared.

Continuing with our example, here is how you would use the requests library to fetch data:

import requests

BASE_URL = "http://localhost:8000"

def test_get_all_todos():
    # Arrange
    url = f"{BASE_URL}/todos"

    # Act
    response = requests.get(url)

This line executes a GET request to the URL we arranged. The response from this request will be used in the final phase of the pattern, where we will verify that it meets our expectations.

In the "Assert" stage, you verify that the result of the "Act" stage is what you expected. You’ll use assertions to check the behavior of the API, ensuring it performs reliably every time. Let's look at how we can assert the correctness of our response:

import requests

BASE_URL = "http://localhost:8000"

def test_get_all_todos():
    # Arrange
    url = f"{BASE_URL}/todos"

    # Act
    response = requests.get(url)

    # Assert
    assert response.status_code == 200
    todos = response.json()
    assert isinstance(todos, list)
    assert len(todos) > 0

Here, we first check that the status code of the response is 200, indicating a successful request. Then, we convert the response to JSON and assert that it is a list containing one or more items. These assertions confirm that the API works as expected by verifying both the success of the request and the correctness of the data format returned.

Once you have written your test, it’s time to run it with pytest, a crucial step for validating your code. Pytest identifies test functions by looking for names that either start with "test_" or end with "_test". This naming convention allows pytest to automatically discover and execute your test cases seamlessly.

To run the tests, you simply need to use the following command in your terminal:

pytest test_file.py

In the CodeSignal environment, pytest is pre-installed and ready to use. Once you submit your code, pytest will automatically discover and execute all the tests in your file. The output will indicate whether the tests passed or failed, and in case of a failure, pytest will provide helpful information for diagnosing the issue.

A successful test run will produce an output similar to this:

============================= test session starts ==============================
platform linux -- Python 3.10.6, pytest-8.3.3, pluggy-1.5.0
rootdir: /usercode/FILESYSTEM
plugins: anyio-4.6.2.post1, typeguard-4.4.1
collected 1 item

test_file.py .                                                            [100%]

============================== 1 passed in 0.31s ===============================

This output shows that the test session has started, with details about the platform and pytest version being used. It also indicates that one test was collected and executed successfully, as denoted by the . in the results, and confirms the test passed in a fraction of a second. Seeing this output assures you that your API test is functioning as expected.

In this lesson, we discussed the importance of testing APIs and introduced pytest, a tool that simplifies the process of automating these tests. We explored the Arrange-Act-Assert pattern, which helps structure our tests logically. By following this pattern, we successfully created and executed a basic test using pytest.

Remember, the arrange phase sets up your test, the act phase conducts the actions, and the assert phase verifies the outcomes. You now have the foundational knowledge required to advance into more complex testing scenarios. As you move into the practice exercises, I encourage you to experiment and apply what you’ve learned. Get ready to deepen your understanding through hands-on experience.