Skip to main content

Collection of Testcontainers, pytest fixtures and test clients for end-to-end/integration testing for Python Tomodachi framework. A great starting point to learn more about Testcontainers and necessity of integration testing.

Project description

Tomodachi Testcontainers

Build Status FOSSA Status Quality Gate Status CodeScene Code Health CodeScene System Mastery codecov Maintainability

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()
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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tomodachi_testcontainers-1.2.0.tar.gz (22.2 kB view details)

Uploaded Source

Built Distribution

tomodachi_testcontainers-1.2.0-py3-none-any.whl (33.0 kB view details)

Uploaded Python 3

File details

Details for the file tomodachi_testcontainers-1.2.0.tar.gz.

File metadata

File hashes

Hashes for tomodachi_testcontainers-1.2.0.tar.gz
Algorithm Hash digest
SHA256 a5340a26f29e9b194bd1109812ad44722d4d3ed044d291609a5e3c2d80e1ee94
MD5 47fef3616c47f69d0183f9fb8c52da74
BLAKE2b-256 cbc1668d2ab94a8a31103d2f757641451a305f156e9875e24ef16fbb7a67ef34

See more details on using hashes here.

File details

Details for the file tomodachi_testcontainers-1.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for tomodachi_testcontainers-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6d13584408fa802cbcea334986d316eb439ecf04c2228af8fbc1d9e85c427134
MD5 a80815c6fb0856f4603204303fac1d68
BLAKE2b-256 300557a122a038265494862090b5b090fa0e18a8e10350504abb63f52ce90767

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page