Testing Kubernetes Applications with Pytest and Testkube: A Complete Guide
Published: 2024-07-08 14:21:12

Testing modern distributed applications within Kubernetes environments can be daunting due to the complexity and the need for scalable solutions. Traditional testing tools often fall short when it comes to efficiency and agility. 

However, with the advent of Kubernetes native solutions like Testkube, it's easier than ever to integrate powerful testing frameworks such as Pytest into your testing workflows. In this comprehensive guide, we'll explore how to leverage Testkube with Pytest to streamline your testing processes in Kubernetes.

## Pytest - An Overview

Python remains a top choice for programming among developers due to its simplicity and robust ecosystem. Pytest, a popular framework within this ecosystem, excels in testing Python-based applications, but not only. It is preferred for its minimalistic design, flexibility, and rich feature set, which makes it ideal to test any type of application. It includes:

- **Minimal Design**: Pytest reduces boilerplate code, facilitating quick and easy test case creation.
- **Flexibility**: Its modular nature and extensive plugin ecosystem allow for significant customization.
- **Rich Feature Set**: Features like auto-discovery, assertive properties, and module fixtures streamline test management.
- **Diverse Testing**: Pytest supports both unit and integration tests, ensuring you are covered in most testing scenarios.

While Pytest is robust for testing your applications, integrating it into Kubernetes can pose challenges such as scaling and parallel execution. This is where Testkube comes into play.

## Why Use Testkube To Run Pytests in Kubernetes?

Testkube is specifically designed to orchestrate and scale Pytest executions within Kubernetes, taking full advantage of Kubernetes' scalability, flexibility, and efficiency. Here's why it stands out:

- **Kubernetes Native**: By storing tests as Kubernetes Custom Resource Definitions (CRDs), Testkube ensures compatibility and scalability.
- **Integration with CI/CD Tools**: Testkube seamlessly integrates with existing CI/CD pipelines, enhancing end-to-end testing capabilities.
- **Simplified Workflow Creation**: Without the need for complex scripting, Testkube facilitates the creation of detailed test workflows, allowing for better control and customization of test executions.

## Creating a Pytest Test Workflow

We've created a custom Pytest image for this example, but you can also create your own. For all the files and examples shown on this blogpost, refer to this [Pytest folder](https://github.com/kubeshop/testkube-examples/tree/main/Pytest-Test-Workflow).

To demonstrate the power of Testkube with Pytest, let's create a simple test workflow. We first create a Pytest test that checks an API endpoint for the correct number of objects returned.

```python
import pytest
import requests

def test_validate_object_count():
    # Send a GET request to the API endpoint
    response = requests.get("https://api.restful-api.dev/objects")

    # Assert that the response status code is 200 (OK)
    assert response.status_code == 200

    # Parse the JSON response
    data = response.json()

    # Validate the number of objects in the response
    assert len(data) == 13, f"Expected 13 objects, but received {len(data)}"
```

Below are the steps to set up a Test Workflow in Testkube:

1. **Prepare Your Kubernetes Cluster**: Ensure your cluster has the Testkube agent installed and configured.
2. **Navigate to Test Workflows**: In the Testkube dashboard, click on "Add A New Test Workflow" and select "Create From Scratch".
3. **Workflow Configuration**: Follow the wizard to set up your workflow. Provide the test's image, the shell command (pytest test-api-endpoint.py), and the Git repository details.

![Image description](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/pnwikbbiw7evijiyothx.png)


On the next screen, you have to define the source of your test.

- Choose Git from the drop-down.
- Provide the path to the Git repository that has the test.
- Provide a path if the test file isn't in the root folder.
- Check the "Use path as working directory" checkbox.

![Image description](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/a09ovyhxijfk7k2hplon.png)


The wizard's last page shows you the final yaml spec generated based on the values you provided.

![Image description](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/6vwfz2kylmmippnwx32f.png)


Below is the yaml spec for the Pytest workflow:

```yaml
kind: TestWorkflow
apiVersion: testworkflows.testkube.io/v1
metadata:
  name: pytest
  namespace: testkube-agent
spec:
  content:
    git:
      uri: https://github.com/kubeshop/testkube-examples.git
      revision: main
      paths:
      - Pytest-Test-Workflow
  container:
    workingDir: /data/repo/Pytest-Test-Workflow
    image: atulinfracloud/pytest-executor:latest
  steps:
  - name: Run test
    shell: pytest test-api-endpoint.py
```

Click on "Create" to create and save the Test Workflow. 

## Executing a Test Workflow

Click on "Run Now" to run the workflow. Clicking on the respective execution will show you the logs, artifacts, and the underlying workflow file. 

![Image description](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/vh61e6c31du54zc2p6jm.png)

Creating a Test Workflow in Testkube is straightforward and simple. We saw that just from one yaml file, we can manage everything related to our test - code, environments, resources, and artifacts. This makes your testing process and workflows more efficient and robust. 

## Summary

Pytest is one of Python's most popular testing frameworks, and Testkube is the only native Kubernetes test orchestration framework. Leveraging both these tools together streamlines your testing process for Kubernetes applications. 

As we saw in this post, developers can benefit from Testkube's Kubernetes capabilities and Pytest's flexibility in creating efficient Test Workflows. You can also bring in any other testing tool and create a Test Workflow, not just Pytest. 

If you already have a testing tool and want to experience Test Workflows, visit our [website](https://testkube.io) to learn more about Testkube's capabilities and how it can transform your testing workflow. You can also join our [Slack channel](https://testkube.io/slack) for any assistance.