dockerutils

Documentation

Overview

Package dockerutils is a generated GoMock package.

Index

• type Container
  • func (c *Container) AddEnv(key, value string)
  • func (c *Container) Env() []string
  • func (c *Container) RemoveEnv(key string)
• type DockerUtils
• type DockerUtilsImpl
  • func New(ctx context.Context, logger *slog.Logger) (*DockerUtilsImpl, error)
  • func NewWithClient(logger *slog.Logger, cli wrapper.DockerClient) *DockerUtilsImpl
  • func (du *DockerUtilsImpl) Close() error
  • func (du *DockerUtilsImpl) CopyBetweenContainers(srcContainer, destContainer *Container, srcPath, dstPath string) error
  • func (du *DockerUtilsImpl) CopyFrom(c *Container, srcPath, dstPath string) error
  • func (du *DockerUtilsImpl) CopyTo(c *Container, srcPath, dstPath string) error
  • func (du *DockerUtilsImpl) CreateContainer(image string) (*Container, error)
  • func (du *DockerUtilsImpl) Exec(c *Container, cmd string) (stdout, stderr string, exitcode int, err error)
• type MockDockerUtils
  • func NewMockDockerUtils(ctrl *gomock.Controller) *MockDockerUtils
  • func (m *MockDockerUtils) Close() error
  • func (m *MockDockerUtils) CopyBetweenContainers(srcContainer, destContainer *Container, srcPath, dstPath string) error
  • func (m *MockDockerUtils) CopyFrom(c *Container, srcPath, dstPath string) error
  • func (m *MockDockerUtils) CopyTo(c *Container, srcPath, dstPath string) error
  • func (m *MockDockerUtils) CreateContainer(image string) (*Container, error)
  • func (m *MockDockerUtils) EXPECT() *MockDockerUtilsMockRecorder
  • func (m *MockDockerUtils) Exec(c *Container, cmd string) (string, string, int, error)
• type MockDockerUtilsMockRecorder
  • func (mr *MockDockerUtilsMockRecorder) Close() *gomock.Call
  • func (mr *MockDockerUtilsMockRecorder) CopyBetweenContainers(srcContainer, destContainer, srcPath, dstPath any) *gomock.Call
  • func (mr *MockDockerUtilsMockRecorder) CopyFrom(c, srcPath, dstPath any) *gomock.Call
  • func (mr *MockDockerUtilsMockRecorder) CopyTo(c, srcPath, dstPath any) *gomock.Call
  • func (mr *MockDockerUtilsMockRecorder) CreateContainer(image any) *gomock.Call
  • func (mr *MockDockerUtilsMockRecorder) Exec(c, cmd any) *gomock.Call

Types

type Container

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

func (*Container) AddEnv

func (c *Container) AddEnv(key, value string)

adds and environment variable with KEY and VALUE to container

func (*Container) Env

func (c *Container) Env() []string

returns a list of KEY=VALUE environment variable bindings for the container

func (*Container) RemoveEnv

func (c *Container) RemoveEnv(key string)

removes environment variable with KEY if it exists in container

type DockerUtils

type DockerUtils interface {
	Close() error
	CreateContainer(image string) (*Container, error)
	Exec(c *Container, cmd string) (stdout, stderr string, exitcode int, err error)
	CopyTo(c *Container, srcPath, dstPath string) error
	CopyFrom(c *Container, srcPath, dstPath string) error
	CopyBetweenContainers(srcContainer, destContainer *Container, srcPath, dstPath string) error
}

type DockerUtilsImpl

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

func New

func New(ctx context.Context, logger *slog.Logger) (*DockerUtilsImpl, error)

initializes a DockerUtils client - make sure to defer a call to Close() the client on exit

func NewWithClient

func NewWithClient(logger *slog.Logger, cli wrapper.DockerClient) *DockerUtilsImpl

initialize a DockerUtils client while providing a pre-created Docker client

func (*DockerUtilsImpl) Close

func (du *DockerUtilsImpl) Close() error

closes the DockerUtils client, and removes all containers created by the client during program execution

func (*DockerUtilsImpl) CopyBetweenContainers

func (du *DockerUtilsImpl) CopyBetweenContainers(srcContainer, destContainer *Container, srcPath, dstPath string) error

copies a file or directory between two containers

func (*DockerUtilsImpl) CopyFrom

func (du *DockerUtilsImpl) CopyFrom(c *Container, srcPath, dstPath string) error

copies a file or directory from a container to the host

func (*DockerUtilsImpl) CopyTo

func (du *DockerUtilsImpl) CopyTo(c *Container, srcPath, dstPath string) error

copies a file or directory from the host to a container

func (*DockerUtilsImpl) CreateContainer

func (du *DockerUtilsImpl) CreateContainer(image string) (*Container, error)

creates a container with the specified image

func (*DockerUtilsImpl) Exec

func (du *DockerUtilsImpl) Exec(c *Container, cmd string) (stdout, stderr string, exitcode int, err error)

executes the specified command on the provided container. Note: command will be executed with `sh -c <command>`

type MockDockerUtils

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

MockDockerUtils is a mock of DockerUtils interface.

func NewMockDockerUtils

func NewMockDockerUtils(ctrl *gomock.Controller) *MockDockerUtils

NewMockDockerUtils creates a new mock instance.

func (*MockDockerUtils) Close

func (m *MockDockerUtils) Close() error

Close mocks base method.

func (*MockDockerUtils) CopyBetweenContainers

func (m *MockDockerUtils) CopyBetweenContainers(srcContainer, destContainer *Container, srcPath, dstPath string) error

CopyBetweenContainers mocks base method.

func (*MockDockerUtils) CopyFrom

func (m *MockDockerUtils) CopyFrom(c *Container, srcPath, dstPath string) error

CopyFrom mocks base method.

func (*MockDockerUtils) CopyTo

func (m *MockDockerUtils) CopyTo(c *Container, srcPath, dstPath string) error

CopyTo mocks base method.

func (*MockDockerUtils) CreateContainer

func (m *MockDockerUtils) CreateContainer(image string) (*Container, error)

CreateContainer mocks base method.

func (*MockDockerUtils) EXPECT

func (m *MockDockerUtils) EXPECT() *MockDockerUtilsMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockDockerUtils) Exec

func (m *MockDockerUtils) Exec(c *Container, cmd string) (string, string, int, error)

Exec mocks base method.

type MockDockerUtilsMockRecorder

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

MockDockerUtilsMockRecorder is the mock recorder for MockDockerUtils.

func (*MockDockerUtilsMockRecorder) Close

func (mr *MockDockerUtilsMockRecorder) Close() *gomock.Call

Close indicates an expected call of Close.

func (*MockDockerUtilsMockRecorder) CopyBetweenContainers

func (mr *MockDockerUtilsMockRecorder) CopyBetweenContainers(srcContainer, destContainer, srcPath, dstPath any) *gomock.Call

CopyBetweenContainers indicates an expected call of CopyBetweenContainers.

func (*MockDockerUtilsMockRecorder) CopyFrom

func (mr *MockDockerUtilsMockRecorder) CopyFrom(c, srcPath, dstPath any) *gomock.Call

CopyFrom indicates an expected call of CopyFrom.

func (*MockDockerUtilsMockRecorder) CopyTo

func (mr *MockDockerUtilsMockRecorder) CopyTo(c, srcPath, dstPath any) *gomock.Call

CopyTo indicates an expected call of CopyTo.

func (*MockDockerUtilsMockRecorder) CreateContainer

func (mr *MockDockerUtilsMockRecorder) CreateContainer(image any) *gomock.Call

CreateContainer indicates an expected call of CreateContainer.

func (*MockDockerUtilsMockRecorder) Exec

func (mr *MockDockerUtilsMockRecorder) Exec(c, cmd any) *gomock.Call

Exec indicates an expected call of Exec.