testcontainer_compose

Types

ComposeConfig

opaque </>

pub opaque type ComposeConfig

ComposeServices

opaque </>

pub opaque type ComposeServices

Service

</>

pub type Service {
  Service(name: String, image: String, ports: List(#(Int, Int)))
}

Constructors

Service(name: String, image: String, ports: List(#(Int, Int)))

Values

formula

</>

pub fn formula(
  cfg: ComposeConfig,
) -> Result(
  formula.StandaloneFormula(ComposeServices, error.Error),
  error.Error,
)

from_file

</>

pub fn from_file(file_path: String) -> ComposeConfig

parse_services_json

</>

pub fn parse_services_json(
  path: String,
  json_str: String,
) -> Result(List(Service), error.Error)

Parse a docker compose config --format json output string into typed Service records. Exposed for testability — useful when you have a pre-rendered compose JSON and want to validate parsing without Docker.

path is only used to enrich error messages.

service_by_name

</>

pub fn service_by_name(
  stack: ComposeServices,
  name: String,
) -> option.Option(Service)

service_image

</>

pub fn service_image(svc: Service) -> String

service_name

</>

pub fn service_name(svc: Service) -> String

service_ports

</>

pub fn service_ports(svc: Service) -> List(#(Int, Int))

services

</>

pub fn services(stack: ComposeServices) -> List(Service)

with_compose

</>

pub fn with_compose(
  cfg: ComposeConfig,
  body: fn(ComposeServices) -> Result(a, error.Error),
) -> Result(a, error.Error)

Spin up a compose stack, run the body, and always tear it down.

with_env_override

</>

pub fn with_env_override(
  cfg: ComposeConfig,
  key: String,
  value: String,
) -> ComposeConfig

with_project_name

</>

pub fn with_project_name(
  cfg: ComposeConfig,
  project_name: String,
) -> ComposeConfig