container

Documentation

Index

• Variables
• type Client
  • func NewClient(cfg Config) (Client, error)
• type Config
  • func (c Config) ValidateBasic() error

Variables

var (
	ErrEmptyRepository  = errors.New("repository cannot be empty")
	ErrEmptyTag         = errors.New("tag cannot be empty")
	ErrEmptyName        = errors.New("name cannot be empty")
	ErrEmptyImageName   = errors.New("image name cannot be empty")
	ErrEmptyHTTPAddress = errors.New("http address cannot be empty")
	ErrEmptyWSAddress   = errors.New("ws address cannot be empty")
)

Errors returned by the localnet package.

Types

type Client

type Client interface {
	// Start starts the container.
	Start() error

	// Stop stops the container.
	Stop() error

	// Remove removes the container.
	Remove() error

	// GetEndpoint returns the endpoint for the given id of the container.
	GetEndpoint(string) string

	// GetContainerLogs retrieves the logs out of the container.
	GetContainerLogs() ([]byte, error)
}

Client is an interface for a container client.

func NewClient

func NewClient(cfg Config) (Client, error)

NewClient creates a new ContainerClient which implements Container.

type Config

type Config struct {
	Repository  string
	Tag         string
	Name        string
	HTTPAddress string
	WSAddress   string
	Env         []string
}

Config is a configuration struct for a container.

func (Config) ValidateBasic

func (c Config) ValidateBasic() error

ValidateBasic checks if the Config is valid.