iceberg-cpp
Loading...
Searching...
No Matches
Public Member Functions | List of all members
iceberg::DockerCompose Class Reference

Docker Compose orchestration utilities for integration testing. More...

#include <docker_compose_util.h>

Public Member Functions

 DockerCompose (std::string project_name, std::filesystem::path docker_compose_dir)
 Initializes the Docker Compose manager context.
 
 DockerCompose (const DockerCompose &)=delete
 
DockerComposeoperator= (const DockerCompose &)=delete
 
 DockerCompose (DockerCompose &&)=default
 
DockerComposeoperator= (DockerCompose &&)=default
 
const std::string & project_name () const
 Get the docker project name.
 
void Up ()
 Executes 'docker-compose up' to start services.
 
void Down ()
 Executes 'docker-compose down' to stop and remove services.
 

Detailed Description

Docker Compose orchestration utilities for integration testing.

Constructor & Destructor Documentation

◆ DockerCompose()

iceberg::DockerCompose::DockerCompose ( std::string  project_name,
std::filesystem::path  docker_compose_dir 
)

Initializes the Docker Compose manager context.

Parameters
project_nameA unique identifier for this project to ensure test isolation.
docker_compose_dirThe directory path containing the target docker-compose.yml.

Member Function Documentation

◆ Down()

void iceberg::DockerCompose::Down ( )

Executes 'docker-compose down' to stop and remove services.

Note
May throw an exception if the services fail to stop.

◆ Up()

void iceberg::DockerCompose::Up ( )

Executes 'docker-compose up' to start services.

Note
May throw an exception if the services fail to start.

The documentation for this class was generated from the following files: