docker

Documentation

Overview

Package docker is a collection of utilities to operate Docker objects in Go code tests in a simplified manner.

Index

• func CreateContainer(ctx context.Context, image string, options *Options) (string, error)
• func CreateStartContainer(ctx context.Context, image string, options *Options) (string, error)
• func ExecCommand(ctx context.Context, id string, command string, buffer *bytes.Buffer) error
• func PullImage(ctx context.Context, name string) error
• func RemoveContainer(ctx context.Context, id string) error
• func StartContainer(ctx context.Context, id string) error
• func StopContainer(ctx context.Context, id string) error
• func StopRemoveContainer(ctx context.Context, id string) error
• type Container
  • func NewContainer(image string) Container
  • func NewContainerWithOptions(image string, options Options) Container
• type Database
• type DatabaseContainer
  • func NewDatabaseContainer(image string, db Database) DatabaseContainer
  • func NewDatabaseContainerWithOptions(image string, db Database, options Options) DatabaseContainer
• type Options

Functions

func CreateContainer

func CreateContainer(ctx context.Context, image string, options *Options) (string, error)

CreateContainer creates a new Docker container and returns its id.

func CreateStartContainer

func CreateStartContainer(ctx context.Context, image string, options *Options) (string, error)

CreateStartContainer creates a new Docker container and starts it. Returns created container id.

func ExecCommand

func ExecCommand(ctx context.Context, id string, command string, buffer *bytes.Buffer) error

ExecCommand executes given shell command in Docker container.

func PullImage

func PullImage(ctx context.Context, name string) error

PullImage pulls a Docker image with the given name.

func RemoveContainer

func RemoveContainer(ctx context.Context, id string) error

RemoveContainer removes Docker container.

func StartContainer

func StartContainer(ctx context.Context, id string) error

StartContainer starts Docker container.

func StopContainer

func StopContainer(ctx context.Context, id string) error

StopContainer stops Docker container.

func StopRemoveContainer

func StopRemoveContainer(ctx context.Context, id string) error

StopRemoveContainer stops and removes Docker container.

Types

type Container

type Container interface {
	Create(ctx context.Context) error
	Start(ctx context.Context) error
	CreateStart(ctx context.Context) error
	Stop(ctx context.Context) error
	Remove(ctx context.Context) error
	StopRemove(ctx context.Context) error
	HasStarted(ctx context.Context) (bool, error)
	Exec(ctx context.Context, command string, buffer *bytes.Buffer) error
}

Container defines container methods.

func NewContainer

func NewContainer(image string) Container

NewContainer creates a new Container object.

func NewContainerWithOptions

func NewContainerWithOptions(image string, options Options) Container

NewContainerWithOptions creates a new Container object with optional attributes values specified.

type Database

type Database struct {
	Name         string
	ResetCommand string
}

Database holds database metadata.

type DatabaseContainer

type DatabaseContainer interface {
	Container
	ResetDatabase(ctx context.Context) error
}

DatabaseContainer extends Container interface with database interaction methods.

func NewDatabaseContainer

func NewDatabaseContainer(image string, db Database) DatabaseContainer

NewDatabaseContainer creates a new DatabaseContainer object.

func NewDatabaseContainerWithOptions

func NewDatabaseContainerWithOptions(image string, db Database, options Options) DatabaseContainer

NewDatabaseContainerWithOptions creates a new DatabaseContainer object with optional attributes values specified.

type Options

type Options struct {
	Name, Healthcheck                  string
	EnvironmentVariables, ExposedPorts []string
	StartTimeout                       int
}

Options holds container optional attributes values which can be set on new container object creation.