docker

Documentation

Overview

Package docker allows to interact with Docker and docker-compose resources.

Index

• func Build(t *testing.T, path string, options *BuildOptions)
• func BuildE(t *testing.T, path string, options *BuildOptions) error
• func Run(t *testing.T, image string, options *RunOptions) string
• func RunDockerCompose(t *testing.T, options *Options, args ...string) string
• func RunDockerComposeE(t *testing.T, options *Options, args ...string) (string, error)
• func RunE(t *testing.T, image string, options *RunOptions) (string, error)
• func Stop(t *testing.T, containers []string, options *StopOptions) string
• func StopE(t *testing.T, containers []string, options *StopOptions) (string, error)
• type BuildOptions
• type Options
• type RunOptions
• type StopOptions

Functions

func Build

func Build(t *testing.T, path string, options *BuildOptions)

Build runs the 'docker build' command at the given path with the given options and fails the test if there are any errors.

func BuildE

func BuildE(t *testing.T, path string, options *BuildOptions) error

BuildE runs the 'docker build' command at the given path with the given options and returns any errors.

func Run

func Run(t *testing.T, image string, options *RunOptions) string

Run runs the 'docker run' command on the given image with the given options and return stdout/stderr. This method fails the test if there are any errors.

func RunDockerCompose

func RunDockerCompose(t *testing.T, options *Options, args ...string) string

RunDockerCompose runs docker-compose with the given arguments and options and return stdout/stderr.

func RunDockerComposeE

func RunDockerComposeE(t *testing.T, options *Options, args ...string) (string, error)

RunDockerComposeE runs docker-compose with the given arguments and options and return stdout/stderr.

func RunE

func RunE(t *testing.T, image string, options *RunOptions) (string, error)

RunE runs the 'docker run' command on the given image with the given options and return stdout/stderr, or any error.

func Stop

func Stop(t *testing.T, containers []string, options *StopOptions) string

Stop runs the 'docker stop' command for the given containers and return the stdout/stderr. This method fails the test if there are any errors

func StopE

func StopE(t *testing.T, containers []string, options *StopOptions) (string, error)

StopE runs the 'docker stop' command for the given containers and returns any errors.

Types

type BuildOptions

type BuildOptions struct {
	// Tags for the Docker image
	Tags []string

	// Build args to pass the 'docker build' command
	BuildArgs []string

	// Custom CLI options that will be passed as-is to the 'docker build' command. This is an "escape hatch" that allows
	// Terratest to not have to support every single command-line option offered by the 'docker build' command, and
	// solely focus on the most important ones.
	OtherOptions []string
}

BuildOptions defines options that can be passed to the 'docker build' command.

type Options

type Options struct {
	WorkingDir string
	EnvVars    map[string]string
}

Options are Docker options.

type RunOptions

type RunOptions struct {
	// Override the default COMMAND of the Docker image
	Command []string

	// If set to true, pass the --detach flag to 'docker run' to run the container in the background
	Detach bool

	// Override the default ENTRYPOINT of the Docker image
	Entrypoint string

	// Set environment variables
	EnvironmentVariables []string

	// If set to true, pass the --init flag to 'docker run' to run an init inside the container that forwards signals
	// and reaps processes
	Init bool

	// Assign a name to the container
	Name string

	// If set to true, pass the --privileged flag to 'docker run' to give extended privileges to the container
	Privileged bool

	// If set to true, pass the --rm flag to 'docker run' to automatically remove the container when it exits
	Remove bool

	// If set to true, pass the -tty flag to 'docker run' to allocate a pseudo-TTY
	Tty bool

	// Username or UID
	User string

	// Bind mount these volume(s) when running the container
	Volumes []string

	// Custom CLI options that will be passed as-is to the 'docker run' command. This is an "escape hatch" that allows
	// Terratest to not have to support every single command-line option offered by the 'docker run' command, and
	// solely focus on the most important ones.
	OtherOptions []string
}

RunOptions defines options that can be passed to the 'docker run' command.

type StopOptions

type StopOptions struct {
	// Seconds to wait for stop before killing the container (default 10)
	Time int
}

StopOptions defines the options that can be passed to the 'docker stop' command