docker

Documentation

Overview

Package docker provides some helpers to manage docker-compose clusters from the test suites

Index

• func Build(logger io.WriteCloser, rootPath string, imgs ...ImageBuild) error
• type Compose
  • func ComposeSuite(composeFile, logFile string) (*Compose, error)
  • func (c *Compose) Close() error
  • func (c *Compose) Logs() error
  • func (c *Compose) Remove() error
  • func (c *Compose) Stop() error
  • func (c *Compose) Up() error
• type ImageBuild

Functions

func Build

func Build(logger io.WriteCloser, rootPath string, imgs ...ImageBuild) error

Build a set of Dockerfile images

Types

type Compose

type Compose struct {
	Path   string
	Logger io.WriteCloser
	Env    []string
}

func ComposeSuite

func ComposeSuite(composeFile, logFile string) (*Compose, error)

func (*Compose) Close

func (c *Compose) Close() error

func (*Compose) Logs

func (c *Compose) Logs() error

func (*Compose) Remove

func (c *Compose) Remove() error

func (*Compose) Stop

func (c *Compose) Stop() error

func (*Compose) Up

func (c *Compose) Up() error

type ImageBuild

type ImageBuild struct {
	Tag        string
	Dockerfile string
}

ImageBuild information for testing docker images: its name/tag and where the dockerfile is located. If the dockerfile is null, it will try pulling the image.