on_boarding.md

graph LR
    Test_Application_Client["Test Application/Client"]
    Testcontainers_Core["Testcontainers Core"]
    Service_Container_Modules["Service Container Modules"]
    Docker_Daemon["Docker Daemon"]
    Configuration_Management["Configuration Management"]
    Docker_Compose_Orchestrator["Docker Compose Orchestrator"]
    Test_Application_Client -- "Instantiates/Uses" --> Service_Container_Modules
    Test_Application_Client -- "Orchestrates" --> Docker_Compose_Orchestrator
    Service_Container_Modules -- "Extends/Configures" --> Testcontainers_Core
    Testcontainers_Core -- "Manages/Communicates With" --> Docker_Daemon
    Configuration_Management -- "Provides Configuration To" --> Testcontainers_Core
    Configuration_Management -- "Provides Configuration To" --> Service_Container_Modules
    Docker_Compose_Orchestrator -- "Orchestrates" --> Testcontainers_Core
    Docker_Compose_Orchestrator -- "Interacts With" --> Docker_Daemon
    click Testcontainers_Core href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/testcontainers-python/Testcontainers_Core.md" "Details"
    click Service_Container_Modules href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/testcontainers-python/Service_Container_Modules.md" "Details"
    click Docker_Compose_Orchestrator href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/testcontainers-python/Docker_Compose_Orchestrator.md" "Details"

Loading

Details

The testcontainers-python architecture centers around a Testcontainers Core that provides generic Docker container lifecycle management, interacting directly with the Docker Daemon. This core functionality is extended by Service Container Modules, which offer pre-configured, service-specific container setups for common databases and tools. The Test Application/Client leverages these modules or the core directly to provision test environments. Configuration Management provides essential settings across the system, while the Docker Compose Orchestrator facilitates the management of multi-container environments. This modular design allows for flexible and efficient integration of containerized services into testing workflows.

Test Application/Client

The user's test code or application that utilizes the testcontainers-python library.

Related Classes/Methods:

• modules.memcached.example_basic.basic_example:9-131

Testcontainers Core [Expand]

The central component responsible for generic Docker container lifecycle management, including starting, stopping, connecting, and applying wait strategies. It also handles resource cleanup.

Related Classes/Methods:

• testcontainers.core.generic.GenericContainer
• testcontainers.core.container.Container
• testcontainers.core.docker_client.DockerClient
• testcontainers.core.wait_strategies.WaitStrategy

Service Container Modules [Expand]

Specialized modules that extend the Testcontainers Core to provide pre-configured images, service-specific wait strategies, and convenient client access methods for particular containerized services (e.g., Memcached, Postgres).

Related Classes/Methods:

• testcontainers.modules.memcached.MemcachedContainer
• testcontainers.modules.postgres.PostgresContainer

Docker Daemon

The external Docker engine responsible for running and managing containers. Testcontainers Core communicates with this daemon. (Note: This is an external component and does not have source code within the testcontainers-python project.)

Related Classes/Methods: None

Configuration Management

Manages global and container-specific configuration settings for Testcontainers, such as Docker host, TLS verification, and environment variables.

Related Classes/Methods:

• testcontainers.core.config.Config

Docker Compose Orchestrator [Expand]

A component that enables the orchestration of multi-container environments using Docker Compose files, abstracting complex setups.

Related Classes/Methods:

• testcontainers.compose.compose.Compose

FAQ