Interface DockerClientInterface

libdocker/client.go:61–91

DockerClientInterface is an abstract interface for testability. It abstracts the interface of docker client.

// DockerClientInterface is an abstract interface for testability.  It abstracts the interface of docker client.
type DockerClientInterface interface {
	ListContainers(options dockercontainer.ListOptions) ([]dockertypes.Container, error)
	InspectContainer(id string) (*dockertypes.ContainerJSON, error)
	InspectContainerWithSize(id string) (*dockertypes.ContainerJSON, error)
	CreateContainer(
		createConfig ContainerCreateConfig,
	) (*dockercontainer.CreateResponse, error)
	StartContainer(id string) error
	StopContainer(id string, timeout time.Duration) error
	UpdateContainerResources(id string, updateConfig dockercontainer.UpdateConfig) error
	RemoveContainer(id string, opts dockercontainer.RemoveOptions) error
	InspectImageByRef(imageRef string) (*dockertypes.ImageInspect, error)
	InspectImageByID(imageID string) (*dockertypes.ImageInspect, error)
	ListImages(opts dockertypes.ImageListOptions) ([]dockerimagetypes.Summary, error)
	PullImage(image string, auth dockerregistry.AuthConfig, opts dockertypes.ImagePullOptions) error
	RemoveImage(
		imageName string,
		opts dockertypes.ImageRemoveOptions,
	) ([]dockerimagetypes.DeleteResponse, error)
	ImageHistory(id string) ([]dockerimagetypes.HistoryResponseItem, error)
	Logs(string, dockercontainer.LogsOptions, StreamOptions) error
	Version() (*dockertypes.Version, error)
	Info() (*dockersystem.Info, error)
	CreateExec(string, dockertypes.ExecConfig) (*dockertypes.IDResponse, error)
	StartExec(string, dockertypes.ExecStartCheck, StreamOptions) error
	InspectExec(id string) (*dockertypes.ContainerExecInspect, error)
	AttachToContainer(string, dockercontainer.AttachOptions, StreamOptions) error
	ResizeContainerTTY(id string, height, width uint) error
	ResizeExecTTY(id string, height, width uint) error
	GetContainerStats(id string) (*dockertypes.StatsJSON, error)
}

// Get a *dockerapi.Client, either using the endpoint passed in, or using
// DOCKER_HOST, DOCKER_TLS_VERIFY, and DOCKER_CERT path per their spec