docker

Sep 18, 2026

Changes in this version

+ func CopyFromContainer(ctx context.Context, c Container, srcPath string) (io.ReadCloser, error)

+ func ParseRAMSize(s string) (int64, error)

type Container

+ func NewContainerWithLifecycle(name, image string, cmd []string, environment Environment, ports *PortBindings, ...) (Container, error)

+ Exec func(ctx context.Context, cmd []string) (*ExecResult, error)

+ type ContainerFileCopier interface

+ CopyFromContainer func(ctx context.Context, srcPath string) (io.ReadCloser, error)

type ContainerOption

+ func WithCPUs(count float64) ContainerOption

+ func WithCapAdd(caps ...string) ContainerOption

+ func WithCapDrop(caps ...string) ContainerOption

+ func WithCpusetCpus(cpus string) ContainerOption

+ func WithDevices(devices ...string) ContainerOption

+ func WithHostNetwork() ContainerOption

+ func WithMemoryLimit(bytes int64) ContainerOption

+ func WithMemoryReservation(bytes int64) ContainerOption

+ func WithMemorySwap(bytes int64) ContainerOption

+ func WithNetworkMode(mode NetworkMode) ContainerOption

+ func WithPidsLimit(limit int64) ContainerOption

+ func WithSecurityOpt(opts ...string) ContainerOption

+ type ExecResult struct

+ ExitCode int

+ Stderr []byte

+ Stdout []byte

+ func (r *ExecResult) Combined() []byte

+ func (r *ExecResult) Error() error

+ type File struct

+ Content io.Reader

+ Destination string

+ Gid int

+ Mode os.FileMode

+ Size int64

+ Uid int

+ func FileFromBytes(destination string, data []byte, mode os.FileMode, uid, gid int) File

+ type LifecycleOption func(*container)

+ func WithAfterReadyCommand(ready Matcher, cmd ...string) LifecycleOption

+ func WithFiles(files ...File) LifecycleOption

+ func WithHostConfig(opts ...ContainerOption) LifecycleOption

+ func WithStartupCommand(cmd ...string) LifecycleOption

+ type NetworkMode string

+ const NetworkModeBridge

+ const NetworkModeHost

+ const NetworkModeNone

+ type TestContainer struct

+ func BindToT(t *testing.T, c Container) *TestContainer

+ func NewContainerWithLifecycleT(t *testing.T, name, image string, cmd []string, env Environment, ...) (*TestContainer, error)

+ func NewContainerWithT(t *testing.T, name, image string, cmd []string, env Environment, ...) (*TestContainer, error)

+ func (tc *TestContainer) AwaitOutput(ctx context.Context, m Matcher) error

+ func (tc *TestContainer) Close(ctx context.Context) error

+ func (tc *TestContainer) CopyFromContainer(ctx context.Context, srcPath string) (io.ReadCloser, error)

+ func (tc *TestContainer) Exec(ctx context.Context, cmd []string) (*ExecResult, error)

+ func (tc *TestContainer) GetOutput(ctx context.Context, ms ...Matcher) ([]string, error)

+ func (tc *TestContainer) ID() ContainerID

+ func (tc *TestContainer) Name() string

+ func (tc *TestContainer) NetworkAttach(networkID string) error

+ func (tc *TestContainer) Ping(ctx context.Context) error

+ func (tc *TestContainer) Run(ctx context.Context) error

+ func (tc *TestContainer) RunT(ctx context.Context)

+ func (tc *TestContainer) URL(proto Protocol, port uint16) (*HostPort, error)

+ type TestGroup struct

+ func BindGroupToT(t *testing.T, g Group) *TestGroup

+ func NewGroupT(t *testing.T, name string, apps ...*Application) (*TestGroup, error)

+ func (tg *TestGroup) Close(ctx context.Context) error

+ func (tg *TestGroup) Run(ctx context.Context) error

+ func (tg *TestGroup) RunT(ctx context.Context)

Sep 4, 2026

Changes in this version

type ContainerOption

+ func WithUlimit(name string, soft, hard int64) ContainerOption

Jul 12, 2026

Changes in this version

type Container

+ ID func() ContainerID

+ type ContainerOption func(*dockerContainer.HostConfig)

+ func WithBinds(binds ...string) ContainerOption

+ func WithPrivileged() ContainerOption

+ func WithTmpfs(m map[string]string) ContainerOption

Oct 30, 2025

Changes in this version

type Container

+ GetOutput func(ctx context.Context, m ...Matcher) ([]string, error)

Apr 8, 2025

Changes in this version

+ var ErrDockerHostIPIsNotResolved = errors.New("docker host IP address cannot be resolved")

+ var ErrPortNotMapped = errors.New("port not mapped")

+ func OneToOneRandomPort(proto Protocol, srcPort uint16) (string, uint16, []string, error)

+ func RandomPort(proto Protocol, dstPort uint16) (string, uint16, []string, error)

+ type ContainerInfo interface

+ GetDockerHostIP func() (string, error)

+ GetExternalPortMapping func(Protocol, uint16) (uint16, error)

type Environment

+ func (e Environment) Eval(c ContainerInfo) (es []string)

+ func (e Environment) Var(name string, vfn func(c ContainerInfo) string) Environment

+ type PortAllocator func(proto Protocol, port uint16) (string, uint16, []string, error)

type PortBindings

+ func NewDirectPortBinding() *PortBindings

+ func NewPortBindingsWithPortAllocator(allocator PortAllocator) *PortBindings

May 12, 2024

Changes in this version

+ func DockerIP() (string, error)

+ func NewHostConfig(pb *PortBindings) (*dockerContainer.HostConfig, error)

+ func RandomPortTCP() (uint16, error)

+ type Application struct

+ func NewApplication(c Container, hooks ...Hook) *Application

+ type Binding struct

+ HostIP string

+ HostPort string

+ type Container interface

+ AwaitOutput func(ctx context.Context, m Matcher) error

+ Close func(ctx context.Context) error

+ Name func() string

+ NetworkAttach func(networkID string) error

+ Ping func(ctx context.Context) error

+ Run func(ctx context.Context) error

+ URL func(proto Protocol, port uint16) (*HostPort, error)

+ func NewContainer(name, image string, cmd []string, environment Environment, ports *PortBindings) (Container, error)

+ func NewContainerWithClient(cli *client.Client, name, image string, cmd []string, env Environment, ...) (Container, error)

+ type ContainerID = string

+ type Environment map[string]string

+ func NewEnvironment() Environment

+ func (e Environment) BoolVar(name string, value bool) Environment

+ func (e Environment) Int16Var(name string, value int16) Environment

+ func (e Environment) Int32Var(name string, value int32) Environment

+ func (e Environment) Int64Var(name string, value int64) Environment

+ func (e Environment) Int8Var(name string, value int8) Environment

+ func (e Environment) IntVar(name string, value int) Environment

+ func (e Environment) LogLevelVar(name string, l log.Level) Environment

+ func (e Environment) StringVar(name, value string) Environment

+ func (e Environment) Uint16Var(name string, value uint16) Environment

+ func (e Environment) Uint32Var(name string, value uint32) Environment

+ func (e Environment) Uint64Var(name string, value uint64) Environment

+ func (e Environment) Uint8Var(name string, value uint8) Environment

+ func (e Environment) UintVar(name string, value uint) Environment

+ type Group interface

+ Close func(ctx context.Context) error

+ Run func(ctx context.Context) error

+ func NewGroup(name string, apps ...*Application) (Group, error)

+ func NewGroupWithClient(cli *client.Client, name string, apps ...*Application) (Group, error)

+ type Hook func(context.Context, HookType, Container) error

+ type HookType string

+ const HookTypeAfterClose

+ const HookTypeAfterRun

+ const HookTypeBeforeClose

+ const HookTypeBeforeRun

+ type HostConfigSpec struct

+ PortBindings map[string][]Binding

+ type HostPort struct

+ Host string

+ Port uint16

+ func (hp *HostPort) String() string

+ type Matcher func(l string) bool

+ func NewExactMatcher(s string) Matcher

+ func NewRegexpMatcher(r *regexp.Regexp) Matcher

+ func NewSubstringMatcher(s string) Matcher

+ type NetworkID = string

+ type PortBindings struct

+ func NewPortBindings() *PortBindings

+ func NewPortBindingsWithTCPPortAllocator(allocator func() (uint16, error)) *PortBindings

+ func (pb *PortBindings) PortDNAT(proto Protocol, port uint16) *PortBindings

+ type Protocol string

+ const ProtoTCP

+ const ProtoUDP

+ func (p Protocol) String() string