tomodachi-testcontainers

Tomodachi Testcontainers

Tomodachi Testcontainers is a Python library built on top of testcontainers-python. It provides Testcontainers, pytest fixtures, and test clients for convenient use of Testcontainers with pytest and testing applications built with the Python Tomodachi framework.

This library was created to explore and learn Testcontainers. Although initially intended to be used with the Tomodachi framework, it works for testing applications built with any other Python framework like Flask, FastAPI, Django, etc.

What is Testcontainers?

Testcontainers is an open-source framework for providing throwaway, lightweight instances of databases, message brokers, web browsers, or just about anything that can run in a Docker container. It facilitates the use of Docker containers for functional, integration, and end-to-end testing. — https://testcontainers.com/

To learn more about what Testcontainers are and what problems they solve, take a look at the Getting Started guide in the official Testcontainers documentation - https://testcontainers.com/getting-started/

Documentation

Find documentation at https://filipsnastins.github.io/tomodachi-testcontainers/

The official Testcontainers documentation is at https://testcontainers.com/

Installation

Install with pip:

pip install tomodachi-testcontainers

Install with Poetry:

poetry add --group dev tomodachi-testcontainers

Find a list of extras in the installation reference.

A Simple Example

The hello, world Tomodachi service:

# src/hello.py
import tomodachi
from aiohttp import web


class Service(tomodachi.Service):
    @tomodachi.http("GET", r"/hello/?")
    async def hello(self, request: web.Request) -> web.Response:
        name = request.query.get("name", "world")
        return web.json_response({"message": f"Hello, {name}!"})

• testcontainer_image fixture builds a Docker image with a Dockerfile from the current working directory.
• tomodachi_container fixture starts a new Docker container running the hello service on a randomly available port.
• test_hello_testcontainers sends a GET /hello?name=Testcontainers request to the running container and asserts the response.

# tests/test_hello.py
from typing import Generator

import httpx
import pytest

from tomodachi_testcontainers import DockerContainer, TomodachiContainer


@pytest.fixture(scope="session")
def tomodachi_container(testcontainer_image: str) -> Generator[DockerContainer, None, None]:
    with TomodachiContainer(testcontainer_image).with_command(
        "tomodachi run readme/hello.py --production"
    ) as container:
        yield container


@pytest.mark.asyncio(loop_scope="session")
async def test_hello_testcontainers(tomodachi_container: TomodachiContainer) -> None:
    async with httpx.AsyncClient(base_url=tomodachi_container.get_external_url()) as client:
        response = await client.get("/hello", params={"name": "Testcontainers"})

    assert response.status_code == 200
    assert response.json() == {"message": "Hello, Testcontainers!"}

Links

• Documentation: https://filipsnastins.github.io/tomodachi-testcontainers/
• Releases and Changelog: https://github.com/filipsnastins/tomodachi-testcontainers/releases
• PyPI: https://pypi.org/project/tomodachi-testcontainers/
• Source Code: https://github.com/filipsnastins/tomodachi-testcontainers
• Reference - Code API: https://filipsnastins.github.io/tomodachi-testcontainers/reference/