docker

Documentation

Overview

Package docker contains Docker-related helpers for component tests.

Index

• Constants
• Variables
• func CleanupResources() error
• func CleanupSessionResources(session *Session) error
• func CleanupSessionResourcesFromFile(fname string) error
• func GetEnv() (string, string, error)
• func GetFreePort() (string, error)
• func InDocker() bool
• func Retry(op func() error) error
• type BuildOptions
• type Component
• type RunOptions
• type Session
  • func LoadSession() (*Session, error)
  • func LoadSessionFromFile(inDocker bool, fpath string) (*Session, error)
  • func NewSession(id, networkID string) (*Session, error)
  • func (s *Session) AutoServiceAddress(serviceName string) (string, error)
  • func (s *Session) DockerToDockerServiceAddress(serviceName string) (string, error)
  • func (s *Session) HostToDockerServiceAddress(serviceName string) (string, error)
  • func (s *Session) ID() string
  • func (s *Session) InDocker() bool
  • func (s *Session) NetworkID() string
  • func (s *Session) Persist() error
  • func (s *Session) PersistToFile(fpath string) error
  • func (s *Session) RegisterHostMappedDockerService(serviceName, endpoint string) error
  • func (s *Session) RegisterInternalDockerService(serviceName, endpoint string) error
  • func (s *Session) ServiceNames() []string
  • func (s *Session) StartComponents(cs ...Component) error
• type SimpleComponent
  • func (c *SimpleComponent) Start(session *Session) error
• type SimpleContainerConfig
• type SimpleContainerOptionFunc
  • func WithTag(tag string) SimpleContainerOptionFunc

Constants

const DefaultSessionFile = ".bakesession"

DefaultSessionFile is the file name used for storing sessions.

Variables

var RetryMaxTimeout = 5 * time.Minute

RetryMaxTimeout is the timeout for the default retry func.

Functions

func CleanupResources

func CleanupResources() error

CleanupResources finds all session files and prunes Docker resources associated with them.

func CleanupSessionResources

func CleanupSessionResources(session *Session) error

CleanupSessionResources cleans up Docker resources for a Session.

func CleanupSessionResourcesFromFile

func CleanupSessionResourcesFromFile(fname string) error

CleanupSessionResourcesFromFile cleans up docker resources for a Session from a session file.

func GetEnv

func GetEnv() (string, string, error)

GetEnv retrieves bake related env vars, with defaults.

func GetFreePort

func GetFreePort() (string, error)

GetFreePort tries to find a free port on the current machine.

func InDocker

func InDocker() bool

InDocker indicates whether the current process is running inside a Docker container.

func Retry

func Retry(op func() error) error

Retry is an exponential backoff retry helper. All built-in components use this func to detect whether a container is alive and ready. User supplied components may use this helper func or provide their own.

Types

type BuildOptions

type BuildOptions struct {
	Dockerfile string
	ContextDir string
	BuildArgs  []docker.BuildArg
}

BuildOptions contains simple docker build options.

type Component

type Component interface {
	Start(*Session) error
}

Component is a logical service, it groups together several containers.

type RunOptions

type RunOptions struct {
	Cmd         []string
	InitExecCmd string
}

RunOptions contains docker container run options.

type Session

type Session struct {
	// contains filtered or unexported fields
}

Session is the docker session, used to manage the lifecycle of components.

func LoadSession

func LoadSession() (*Session, error)

LoadSession attempts to load a Session from the default file location.

func LoadSessionFromFile

func LoadSessionFromFile(inDocker bool, fpath string) (*Session, error)

LoadSessionFromFile attempts to load a session from a file.

func NewSession

func NewSession(id, networkID string) (*Session, error)

NewSession prepares a new Docker session.

func (*Session) AutoServiceAddress

func (s *Session) AutoServiceAddress(serviceName string) (string, error)

AutoServiceAddress retrieves an endpoint for a service name, appropriate for the running code.

func (*Session) DockerToDockerServiceAddress

func (s *Session) DockerToDockerServiceAddress(serviceName string) (string, error)

DockerToDockerServiceAddress retrieves an internal endpoint for a service name.

func (*Session) HostToDockerServiceAddress

func (s *Session) HostToDockerServiceAddress(serviceName string) (string, error)

HostToDockerServiceAddress retrieves a host mapped endpoint for a service name.

func (*Session) ID

func (s *Session) ID() string

ID returns the Session ID.

func (*Session) InDocker

func (s *Session) InDocker() bool

InDocker indicates whether this session was started from inside a Docker container.

func (*Session) NetworkID

func (s *Session) NetworkID() string

NetworkID returns the Docker NetworkID ID.

func (*Session) Persist

func (s *Session) Persist() error

Persist stores the session data in the default store.

func (*Session) PersistToFile

func (s *Session) PersistToFile(fpath string) error

PersistToFile serializes a session and writes it to a file.

func (*Session) RegisterHostMappedDockerService

func (s *Session) RegisterHostMappedDockerService(serviceName, endpoint string) error

RegisterHostMappedDockerService registers a host mapped endpoint against the service name.

func (*Session) RegisterInternalDockerService

func (s *Session) RegisterInternalDockerService(serviceName, endpoint string) error

RegisterInternalDockerService registers an internal endpoint against the service name.

func (*Session) ServiceNames

func (s *Session) ServiceNames() []string

ServiceNames list of registered service names.

func (*Session) StartComponents

func (s *Session) StartComponents(cs ...Component) error

StartComponents starts the provided components.

type SimpleComponent

type SimpleComponent struct {
	Name       string
	Containers []SimpleContainerConfig
}

SimpleComponent groups together several containers.

func (*SimpleComponent) Start

func (c *SimpleComponent) Start(session *Session) error

Start all containers sequentially.

type SimpleContainerConfig

type SimpleContainerConfig struct {
	Name               string
	Repository         string
	Tag                string
	Env                []string
	BuildOpts          *BuildOptions
	ServicePorts       map[string]string
	StaticServicePorts map[string]string
	ReadyFunc          func(*Session) error
	RunOpts            *RunOptions
}

SimpleContainerConfig defines a Docker container with associated service ports.

type SimpleContainerOptionFunc

type SimpleContainerOptionFunc func(*SimpleContainerConfig)

SimpleContainerOptionFunc allows for customization of SimpleContainerConfigs.

func WithTag

func WithTag(tag string) SimpleContainerOptionFunc

WithTag sets a Docker tag in a SimpleContainerConfig.