docker

Documentation

Overview

Package docker contains resources needed to setup docker containers for M3 tests.

Index

• func AttachToExistingContainers(coordinatorContainerName string, dbNodesContainersNames []string) (resources.M3Resources, error)
• func NewPrometheus(opts PrometheusOptions) resources.ExternalResources
• func SetupNetwork(pool *dockertest.Pool) error
• func SetupSingleM3DBNode(opts ...SetupOptions) (resources.M3Resources, error)
• type Image
• type Prometheus
  • func (p *Prometheus) Close() error
  • func (p *Prometheus) Query(req PrometheusQueryRequest) (model.Vector, error)
  • func (p *Prometheus) Setup() error
• type PrometheusOptions
• type PrometheusQueryRequest
  • func (p *PrometheusQueryRequest) String() string
• type Resource
  • func NewDockerResource(pool *dockertest.Pool, resourceOpts ResourceOptions) (*Resource, error)
  • func (c *Resource) Close() error
  • func (c *Resource) Closed() bool
  • func (c *Resource) Exec(commands ...string) (string, error)
  • func (c *Resource) GetPort(bindPort int) (int, error)
  • func (c *Resource) GetURL(port int, path string) string
  • func (c *Resource) GoalStateExec(verifier resources.GoalStateVerifier, commands ...string) error
• type ResourceOptions
• type SetupOptions
  • func WithCoordinatorImage(name, tag string) SetupOptions
  • func WithDBNodeImage(name, tag string) SetupOptions
  • func WithExistingCluster(dbNodeContainerName, coordinatorContainerName string) SetupOptions

Functions

func AttachToExistingContainers

func AttachToExistingContainers(
	coordinatorContainerName string,
	dbNodesContainersNames []string,
) (resources.M3Resources, error)

AttachToExistingContainers attaches docker API to an existing coordinator and one or more dbnode containers.

func NewPrometheus

func NewPrometheus(opts PrometheusOptions) resources.ExternalResources

NewPrometheus creates a new docker-backed Prometheus that implements the resources.ExternalResources interface.

func SetupNetwork

func SetupNetwork(pool *dockertest.Pool) error

SetupNetwork sets up a network within docker.

func SetupSingleM3DBNode

func SetupSingleM3DBNode(opts ...SetupOptions) (resources.M3Resources, error)

SetupSingleM3DBNode creates docker resources representing a setup with a single DB node.

Types

type Image

type Image struct {
	Name string
	Tag  string
}

Image represents a docker image.

type Prometheus

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

Prometheus is a docker-backed instantiation of Prometheus.

func (*Prometheus) Close

func (p *Prometheus) Close() error

Close cleans up the prometheus instance.

func (*Prometheus) Query

func (p *Prometheus) Query(req PrometheusQueryRequest) (model.Vector, error)

Query executes a query request against the prometheus resource.

func (*Prometheus) Setup

func (p *Prometheus) Setup() error

Setup is a method that setups up the prometheus instance.

type PrometheusOptions

type PrometheusOptions struct {
	// Pool is the connection to the docker API
	Pool *dockertest.Pool
	// PathToCfg contains the path to the prometheus.yml configuration
	// file to be used on startup.
	PathToCfg string
	// InstrumentOptions are the instrument.Options to use when
	// creating the resource.
	InstrumentOptions instrument.Options
}

PrometheusOptions contains the options for spinning up docker container running Prometheus

type PrometheusQueryRequest

type PrometheusQueryRequest struct {
	// Query is the prometheus query to execute
	Query string
	// Time is the time to execute the query at
	Time time.Time
}

PrometheusQueryRequest contains the parameters for making a query request.

func (*PrometheusQueryRequest) String

func (p *PrometheusQueryRequest) String() string

String converts the query request into a string suitable for use in the url params or request body

type Resource

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

Resource is an object that provides a handle to a service being spun up via docker.

func NewDockerResource

func NewDockerResource(
	pool *dockertest.Pool,
	resourceOpts ResourceOptions,
) (*Resource, error)

NewDockerResource creates a new DockerResource.

func (*Resource) Close

func (c *Resource) Close() error

Close closes and cleans up the resource.

func (*Resource) Closed

func (c *Resource) Closed() bool

Closed returns true if the resource has been closed.

func (*Resource) Exec

func (c *Resource) Exec(commands ...string) (string, error)

Exec runs commands within a docker container.

func (*Resource) GetPort

func (c *Resource) GetPort(bindPort int) (int, error)

GetPort retrieves the port for accessing this resource.

func (*Resource) GetURL

func (c *Resource) GetURL(port int, path string) string

GetURL retrieves the URL for accessing this resource.

func (*Resource) GoalStateExec

func (c *Resource) GoalStateExec(
	verifier resources.GoalStateVerifier,
	commands ...string,
) error

GoalStateExec runs commands within a container until a specified goal state is met.

type ResourceOptions

type ResourceOptions struct {
	OverrideDefaults bool
	Source           string
	ContainerName    string
	Image            Image
	PortList         []int
	// Mounts creates mounts in the container that map back to a resource
	// on the host system.
	Mounts []string
	// TmpfsMounts creates mounts to the container's temporary file system
	TmpfsMounts    []string
	InstrumentOpts instrument.Options
}

ResourceOptions returns options for creating a Resource.

type SetupOptions

type SetupOptions func(*setupOptions)

SetupOptions is a setup option.

func WithCoordinatorImage

func WithCoordinatorImage(name, tag string) SetupOptions

WithCoordinatorImage sets an option to use an image name and tag for the coordinator.

func WithDBNodeImage

func WithDBNodeImage(name, tag string) SetupOptions

WithDBNodeImage sets an option to use an image name and tag for the DB node.

func WithExistingCluster

func WithExistingCluster(dbNodeContainerName, coordinatorContainerName string) SetupOptions

WithExistingCluster sets the names of already running containers dbnode and coordinator containers that should be used for tests.