compose

Mar 27, 2025

Changes in this version

type DockerCompose

+ func (d *DockerCompose) ServiceContainer(ctx context.Context, svcName string) (*testcontainers.DockerContainer, error)

+ func (d *DockerCompose) Services() []string

+ func (d *DockerCompose) Up(ctx context.Context, opts ...StackUpOption) (err error)

+ func (d *DockerCompose) WithOsEnv() ComposeStack

+ type DockerComposer interface

+ Down func() ExecError

+ Invoke func() ExecError

+ WaitForService func(string, wait.Strategy) DockerComposer

+ WithCommand func([]string) DockerComposer

+ WithEnv func(map[string]string) DockerComposer

+ WithExposedService func(string, int, wait.Strategy) DockerComposer

Oct 21, 2024

Changes in this version

+ type ComposeProfiles []string

type ComposeStackOption

+ func WithProfiles(profiles ...string) ComposeStackOption

May 9, 2024

Changes in this version

type ComposeStackOption

+ func WithStackReaders(readers ...io.Reader) ComposeStackOption

+ type ComposeStackReaders []io.Reader

+ type Recreate string

+ type RecreateDependencies string

type StackUpOption

+ func WithRecreate(recreate string) StackUpOption

+ func WithRecreateDependencies(recreate string) StackUpOption

Mar 8, 2023

Changes in this version

+ type RemoveVolumes bool

Dec 23, 2022

Changes in this version

+ var ErrNoStackConfigured = errors.New("no stack files configured")

+ func NewDockerCompose(filePaths ...string) (*dockerCompose, error)

+ func NewDockerComposeWith(opts ...ComposeStackOption) (*dockerCompose, error)

+ type ComposeLoggerOption struct

+ func WithLogger(logger testcontainers.Logging) ComposeLoggerOption

+ func (o ComposeLoggerOption) ApplyToLocalCompose(opts *LocalDockerComposeOptions)

+ type ComposeStack interface

+ Down func(ctx context.Context, opts ...StackDownOption) error

+ ServiceContainer func(ctx context.Context, svcName string) (*testcontainers.DockerContainer, error)

+ Services func() []string

+ Up func(ctx context.Context, opts ...StackUpOption) error

+ WaitForService func(s string, strategy wait.Strategy) ComposeStack

+ WithEnv func(m map[string]string) ComposeStack

+ WithOsEnv func() ComposeStack

+ type ComposeStackFiles []string

+ type ComposeStackOption interface

+ func WithStackFiles(filePaths ...string) ComposeStackOption

+ type ComposeVersion interface

+ Format func(parts ...string) string

+ type DockerCompose interface

+ Down func() ExecError

+ Invoke func() ExecError

+ WaitForService func(string, wait.Strategy) DockerCompose

+ WithCommand func([]string) DockerCompose

+ WithEnv func(map[string]string) DockerCompose

+ WithExposedService func(string, int, wait.Strategy) DockerCompose

+ type ExecError struct

+ Command []string

+ Error error

+ Stderr error

+ StderrOutput []byte

+ Stdout error

+ StdoutOutput []byte

+ type IgnoreOrphans bool

+ type LocalDockerCompose struct

+ Cmd []string

+ ComposeFilePaths []string

+ Env map[string]string

+ Executable string

+ Identifier string

+ Services map[string]interface{}

+ WaitStrategyMap map[waitService]wait.Strategy

+ func NewLocalDockerCompose(filePaths []string, identifier string, opts ...LocalDockerComposeOption) *LocalDockerCompose

+ func (dc *LocalDockerCompose) Down() ExecError

+ func (dc *LocalDockerCompose) Invoke() ExecError

+ func (dc *LocalDockerCompose) WaitForService(service string, strategy wait.Strategy) DockerCompose

+ func (dc *LocalDockerCompose) WithCommand(cmd []string) DockerCompose

+ func (dc *LocalDockerCompose) WithEnv(env map[string]string) DockerCompose

+ func (dc *LocalDockerCompose) WithExposedService(service string, port int, strategy wait.Strategy) DockerCompose

+ type LocalDockerComposeOption interface

+ ApplyToLocalCompose func(opts *LocalDockerComposeOptions)

+ type LocalDockerComposeOptions struct

+ Logger testcontainers.Logging

+ type LocalDockerComposeOptionsFunc func(opts *LocalDockerComposeOptions)

+ func (f LocalDockerComposeOptionsFunc) ApplyToLocalCompose(opts *LocalDockerComposeOptions)

+ type RemoveImages uint8

+ const RemoveImagesAll

+ const RemoveImagesLocal

+ type RemoveOrphans bool

+ type StackDownOption interface

+ type StackIdentifier string

+ func (f StackIdentifier) String() string

+ type StackUpOption interface

+ func RunServices(serviceNames ...string) StackUpOption

+ type Wait bool