# playtikaoss/testcontainers-spring-boot architecture

> Architecture diagram of the GitHub repository playtikaoss/testcontainers-spring-boot, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-04). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/playtikaoss/testcontainers-spring-boot
- Repository: https://github.com/playtikaoss/testcontainers-spring-boot

## Overview

##### Main Components

a. Core Framework Layer:
- TestContainers Common Module (Base functionality)
- Spring Boot Auto-configuration Integration
- Docker Integration Layer

b. Service Modules Layer (Group by category):
- Databases (MySQL, PostgreSQL, MongoDB, etc.)
- Message Brokers (Kafka, RabbitMQ, NATS)
- Caches (Redis, Aerospike)
- Search Engines (Elasticsearch, OpenSearch)
- Cloud Services (Google PubSub, LocalStack)
- Security (Keycloak, Vault)
- Monitoring (Prometheus, Grafana)

c. Configuration Management:
- Properties Management
- Bootstrap Configuration
- Container Lifecycle Management

##### Relationships

a. Core Dependencies:
- How TestContainers Common is the foundation
- Spring Boot integration points
- Docker runtime dependency

b. Module Dependencies:
- Each service module depends on common module
- Optional ToxiProxy integration for network simulation
- Container configuration flow

**┌─────────────────────────────────────────────┐**
- Spring Boot App                 │
- ┬─────────────────────────┘

**┌───────────────────▼─────────────────────────┐**
- TestContainers Spring Boot Core       │
- ┤
- Container Lifecycle Management           │
- Properties Management                    │
- Bootstrap Configuration                  │
- ┬─────────────────────────┘

- ┌───────────┴──────────┐

**┌───────▼──────┐    ┌─────────▼────────┐**
- Docker     │    │ Service Modules   │
- Runtime     │    │ (Grouped by type) │
- ┘    └──────────────────┘

##### Implementation Details

a. Configuration Flow:
- How properties are loaded from application.properties/bootstrap.properties
- Auto-configuration activation process
- Container startup sequence

b. Integration Points:
- Spring Boot auto-configuration hooks
- Docker container management
- Service-specific configuration

##### Additional Elements

- Version compatibility matrix
- Optional ToxiProxy integration points
- Configuration property flow

##### Technical Details

Technical aspects:
- Spring Boot auto-configuration mechanism
- Docker container management
- Property management system
- Test lifecycle integration

## Diagram (Mermaid)

```mermaid
graph TB
    %% Core Framework Layer
    subgraph Core
        TC["TestContainers Common"]
        SBI["Spring Boot Integration"]
        DI["Docker Integration"]
        
        TC --> SBI
        TC --> DI
    end
    
    %% Configuration Management
    subgraph Config
        PM["Properties Management"]
        BC["Bootstrap Configuration"]
        CL["Container Lifecycle"]
        
        PM --> BC
        BC --> CL
    end
    
    %% Service Modules Layer
    subgraph Databases
        MySQL["MySQL"]
        PostgreSQL["PostgreSQL"]
        MongoDB["MongoDB"]
        Cassandra["Cassandra"]
    end
    
    subgraph MessageBrokers
        Kafka["Kafka"]
        RabbitMQ["RabbitMQ"]
        NATS["NATS"]
    end
    
    subgraph Caches
        Redis["Redis"]
        Aerospike["Aerospike"]
    end
    
    subgraph Search
        ES["Elasticsearch"]
        OS["OpenSearch"]
    end
    
    subgraph CloudServices
        GPS["Google PubSub"]
        LS["LocalStack"]
    end
    
    subgraph Security
        Keycloak["Keycloak"]
        Vault["Vault"]
    end
    
    subgraph Monitoring
        Prometheus["Prometheus"]
        Grafana["Grafana"]
    end
    
    %% Dependencies
    TC --> Databases
    TC --> MessageBrokers
    TC --> Caches
    TC --> Search
    TC --> CloudServices
    TC --> Security
    TC --> Monitoring
    
    %% Click Events
    click TC "https://github.com/PlaytikaOSS/testcontainers-spring-boot/tree/develop/testcontainers-common/"
    click SBI "https://github.com/PlaytikaOSS/testcontainers-spring-boot/tree/develop/testcontainers-common/src/main/java/com/playtika/testcontainer/common/spring/"
    click DI "https://github.com/PlaytikaOSS/testcontainers-spring-boot/blob/develop/testcontainers-common/src/main/java/com/playtika/testcontainer/common/spring/DockerPresenceBootstrapConfiguration.java"
    click PM "https://github.com/PlaytikaOSS/testcontainers-spring-boot/tree/develop/testcontainers-common/src/main/java/com/playtika/testcontainer/common/properties/"
    click BC "https://github.com/PlaytikaOSS/testcontainers-spring-boot/tree/develop/testcontainers-common/src/main/java/com/playtika/testcontainer/common/spring/"
    click CL "https://github.com/PlaytikaOSS/testcontainers-spring-boot/tree/develop/testcontainers-common/src/main/java/com/playtika/testcontainer/common/checks/"
    click MySQL "https://github.com/PlaytikaOSS/testcontainers-spring-boot/tree/develop/embedded-mysql/"
    click PostgreSQL "https://github.com/PlaytikaOSS/testcontainers-spring-boot/tree/develop/embedded-postgresql/"
    click MongoDB "https://github.com/PlaytikaOSS/testcontainers-spring-boot/tree/develop/embedded-mongodb/"
    click Cassandra "https://github.com/PlaytikaOSS/testcontainers-spring-boot/tree/develop/embedded-cassandra/"
    click Kafka "https://github.com/PlaytikaOSS/testcontainers-spring-boot/tree/develop/embedded-kafka/"
    click RabbitMQ "https://github.com/PlaytikaOSS/testcontainers-spring-boot/tree/develop/embedded-rabbitmq/"
    click NATS "https://github.com/PlaytikaOSS/testcontainers-spring-boot/tree/develop/embedded-nats/"
    click Redis "https://github.com/PlaytikaOSS/testcontainers-spring-boot/tree/develop/embedded-redis/"
    click Aerospike "https://github.com/PlaytikaOSS/testcontainers-spring-boot/tree/develop/embedded-aerospike/"
    click ES "https://github.com/PlaytikaOSS/testcontainers-spring-boot/tree/develop/embedded-elasticsearch/"
    click OS "https://github.com/PlaytikaOSS/testcontainers-spring-boot/tree/develop/embedded-opensearch/"
    click GPS "https://github.com/PlaytikaOSS/testcontainers-spring-boot/tree/develop/embedded-google-pubsub/"
    click LS "https://github.com/PlaytikaOSS/testcontainers-spring-boot/tree/develop/embedded-localstack/"
    click Keycloak "https://github.com/PlaytikaOSS/testcontainers-spring-boot/tree/develop/embedded-keycloak/"
    click Vault "https://github.com/PlaytikaOSS/testcontainers-spring-boot/tree/develop/embedded-vault/"
    click Prometheus "https://github.com/PlaytikaOSS/testcontainers-spring-boot/tree/develop/embedded-prometheus/"
    click Grafana "https://github.com/PlaytikaOSS/testcontainers-spring-boot/tree/develop/embedded-grafana/"
    
    %% Styling
    classDef core fill:#a8d1f0
    classDef config fill:#ffd700
    classDef service fill:#90EE90
    
    class TC,SBI,DI core
    class PM,BC,CL config
    class MySQL,PostgreSQL,MongoDB,Cassandra,Kafka,RabbitMQ,NATS,Redis,Aerospike,ES,OS,GPS,LS,Keycloak,Vault,Prometheus,Grafana service
```
