docs/api/mockclient/mock.go

package mockclient

import (
	"io"

	"github.com/docker/engine-api/client"
	"github.com/docker/engine-api/types"
	"github.com/docker/engine-api/types/container"
	"github.com/docker/engine-api/types/filters"
	"github.com/docker/engine-api/types/network"
	"github.com/docker/engine-api/types/registry"
	"github.com/stretchr/testify/mock"
	"golang.org/x/net/context"
)

// MockClient is a mock API Client based on engine-api
type MockClient struct {
	mock.Mock
}

// NewMockClient creates a new mock client
func NewMockClient() *MockClient {
	return &MockClient{}
}

// ClientVersion returns the version string associated with this instance of the Client
func (client *MockClient) ClientVersion() string {
	args := client.Mock.Called()
	return args.String(0)
}

// ContainerAttach attaches a connection to a container in the server
func (client *MockClient) ContainerAttach(options types.ContainerAttachOptions) (types.HijackedResponse, error) {
	args := client.Mock.Called(options)
	return args.Get(0).(types.HijackedResponse), args.Error(1)
}

// ContainerCommit applies changes into a container and creates a new tagged image
func (client *MockClient) ContainerCommit(options types.ContainerCommitOptions) (types.ContainerCommitResponse, error) {
	args := client.Mock.Called(options)
	return args.Get(0).(types.ContainerCommitResponse), args.Error(1)
}

// ContainerCreate creates a new container based in the given configuration
func (client *MockClient) ContainerCreate(config *container.Config, hostConfig *container.HostConfig, networkingConfig *network.NetworkingConfig, containerName string) (types.ContainerCreateResponse, error) {
	args := client.Mock.Called(config, hostConfig, networkingConfig, containerName)
	return args.Get(0).(types.ContainerCreateResponse), args.Error(1)
}

// ContainerDiff shows differences in a container filesystem since it was started
func (client *MockClient) ContainerDiff(containerID string) ([]types.ContainerChange, error) {
	args := client.Mock.Called(containerID)
	return args.Get(0).([]types.ContainerChange), args.Error(1)
}

// ContainerExecAttach attaches a connection to an exec process in the server
func (client *MockClient) ContainerExecAttach(execID string, config types.ExecConfig) (types.HijackedResponse, error) {
	args := client.Mock.Called(execID, config)
	return args.Get(0).(types.HijackedResponse), args.Error(1)
}

// ContainerExecCreate creates a new exec configuration to run an exec process
func (client *MockClient) ContainerExecCreate(config types.ExecConfig) (types.ContainerExecCreateResponse, error) {
	args := client.Mock.Called(config)
	return args.Get(0).(types.ContainerExecCreateResponse), args.Error(1)
}

// ContainerExecInspect returns information about a specific exec process on the docker host
func (client *MockClient) ContainerExecInspect(execID string) (types.ContainerExecInspect, error) {
	args := client.Mock.Called(execID)
	return args.Get(0).(types.ContainerExecInspect), args.Error(1)
}

// ContainerExecResize changes the size of the tty for an exec process running inside a container
func (client *MockClient) ContainerExecResize(options types.ResizeOptions) error {
	args := client.Mock.Called(options)
	return args.Error(0)
}

// ContainerExecStart starts an exec process already create in the docker host
func (client *MockClient) ContainerExecStart(execID string, config types.ExecStartCheck) error {
	args := client.Mock.Called(execID, config)
	return args.Error(0)
}

// ContainerExport retrieves the raw contents of a container and returns them as an io.ReadCloser
func (client *MockClient) ContainerExport(ctx context.Context, containerID string) (io.ReadCloser, error) {
	args := client.Mock.Called(ctx, containerID)
	return args.Get(0).(io.ReadCloser), args.Error(1)
}

// ContainerInspect returns the container information
func (client *MockClient) ContainerInspect(containerID string) (types.ContainerJSON, error) {
	args := client.Mock.Called(containerID)
	return args.Get(0).(types.ContainerJSON), args.Error(1)
}

// ContainerInspectWithRaw returns the container information and its raw representation
func (client *MockClient) ContainerInspectWithRaw(containerID string, getSize bool) (types.ContainerJSON, []byte, error) {
	args := client.Mock.Called(containerID, getSize)
	return args.Get(0).(types.ContainerJSON), args.Get(1).([]byte), args.Error(2)
}

// ContainerKill terminates the container process but does not remove the container from the docker host
func (client *MockClient) ContainerKill(containerID, signal string) error {
	args := client.Mock.Called(containerID, signal)
	return args.Error(0)
}

// ContainerList returns the list of containers in the docker host
func (client *MockClient) ContainerList(options types.ContainerListOptions) ([]types.Container, error) {
	args := client.Mock.Called(options)
	return args.Get(0).([]types.Container), args.Error(1)
}

// ContainerLogs returns the logs generated by a container in an io.ReadCloser
func (client *MockClient) ContainerLogs(ctx context.Context, options types.ContainerLogsOptions) (io.ReadCloser, error) {
	args := client.Mock.Called(ctx, options)
	return args.Get(0).(io.ReadCloser), args.Error(1)
}

// ContainerPause pauses the main process of a given container without terminating it
func (client *MockClient) ContainerPause(containerID string) error {
	args := client.Mock.Called(containerID)
	return args.Error(0)
}

// ContainerRemove kills and removes a container from the docker host
func (client *MockClient) ContainerRemove(options types.ContainerRemoveOptions) error {
	args := client.Mock.Called(options)
	return args.Error(0)
}

// ContainerRename changes the name of a given container
func (client *MockClient) ContainerRename(containerID, newContainerName string) error {
	args := client.Mock.Called(containerID, newContainerName)
	return args.Error(0)
}

// ContainerResize changes the size of the tty for a container
func (client *MockClient) ContainerResize(options types.ResizeOptions) error {
	args := client.Mock.Called(options)
	return args.Error(0)
}

// ContainerRestart stops and starts a container again
func (client *MockClient) ContainerRestart(containerID string, timeout int) error {
	args := client.Mock.Called(containerID, timeout)
	return args.Error(0)
}

// ContainerStatPath returns Stat information about a path inside the container filesystem
func (client *MockClient) ContainerStatPath(containerID, path string) (types.ContainerPathStat, error) {
	args := client.Mock.Called(containerID, path)
	return args.Get(0).(types.ContainerPathStat), args.Error(1)
}

// ContainerStats returns near realtime stats for a given container
func (client *MockClient) ContainerStats(ctx context.Context, containerID string, stream bool) (io.ReadCloser, error) {
	args := client.Mock.Called(ctx, containerID, stream)
	return args.Get(0).(io.ReadCloser), args.Error(1)
}

// ContainerStart sends a request to the docker daemon to start a container
func (client *MockClient) ContainerStart(containerID string) error {
	args := client.Mock.Called(containerID)
	return args.Error(0)
}

// ContainerStop stops a container without terminating the process
func (client *MockClient) ContainerStop(containerID string, timeout int) error {
	args := client.Mock.Called(containerID, timeout)
	return args.Error(0)
}

// ContainerTop shows process information from within a container
func (client *MockClient) ContainerTop(containerID string, arguments []string) (types.ContainerProcessList, error) {
	args := client.Mock.Called(containerID, arguments)
	return args.Get(0).(types.ContainerProcessList), args.Error(1)
}

// ContainerUnpause resumes the process execution within a container
func (client *MockClient) ContainerUnpause(containerID string) error {
	args := client.Mock.Called(containerID)
	return args.Error(0)
}

// ContainerUpdate updates resources of a container
func (client *MockClient) ContainerUpdate(containerID string, updateConfig container.UpdateConfig) error {
	args := client.Mock.Called(containerID, updateConfig)
	return args.Error(0)
}

// ContainerWait pauses execution until a container exits
func (client *MockClient) ContainerWait(ctx context.Context, containerID string) (int, error) {
	args := client.Mock.Called(ctx, containerID)
	return args.Int(0), args.Error(1)
}

// CopyFromContainer gets the content from the container and returns it as a Reader to manipulate it in the host
func (client *MockClient) CopyFromContainer(ctx context.Context, containerID, srcPath string) (io.ReadCloser, types.ContainerPathStat, error) {
	args := client.Mock.Called(ctx, containerID, srcPath)
	return args.Get(0).(io.ReadCloser), args.Get(1).(types.ContainerPathStat), args.Error(2)
}

// CopyToContainer copies content into the container filesystem
func (client *MockClient) CopyToContainer(ctx context.Context, options types.CopyToContainerOptions) error {
	args := client.Mock.Called(ctx, options)
	return args.Error(0)
}

// Events returns a stream of events in the daemon in a ReadCloser
func (client *MockClient) Events(ctx context.Context, options types.EventsOptions) (io.ReadCloser, error) {
	args := client.Mock.Called(ctx, options)
	return args.Get(0).(io.ReadCloser), args.Error(1)
}

// ImageBuild sends request to the daemon to build images
func (client *MockClient) ImageBuild(ctx context.Context, options types.ImageBuildOptions) (types.ImageBuildResponse, error) {
	args := client.Mock.Called(ctx, options)
	return args.Get(0).(types.ImageBuildResponse), args.Error(1)
}

// ImageCreate creates a new image based in the parent options
func (client *MockClient) ImageCreate(ctx context.Context, options types.ImageCreateOptions) (io.ReadCloser, error) {
	args := client.Mock.Called(ctx, options)
	return args.Get(0).(io.ReadCloser), args.Error(1)
}

// ImageHistory returns the changes in an image in history format
func (client *MockClient) ImageHistory(imageID string) ([]types.ImageHistory, error) {
	args := client.Mock.Called(imageID)
	return args.Get(0).([]types.ImageHistory), args.Error(1)
}

// ImageImport creates a new image based in the source options
func (client *MockClient) ImageImport(ctx context.Context, options types.ImageImportOptions) (io.ReadCloser, error) {
	args := client.Mock.Called(ctx, options)
	return args.Get(0).(io.ReadCloser), args.Error(1)
}

// ImageInspectWithRaw returns the image information and it's raw representation
func (client *MockClient) ImageInspectWithRaw(imageID string, getSize bool) (types.ImageInspect, []byte, error) {
	args := client.Mock.Called(imageID, getSize)
	return args.Get(0).(types.ImageInspect), args.Get(1).([]byte), args.Error(2)
}

// ImageList returns a list of images in the docker host
func (client *MockClient) ImageList(options types.ImageListOptions) ([]types.Image, error) {
	args := client.Mock.Called(options)
	return args.Get(0).([]types.Image), args.Error(1)
}

// ImageLoad loads an image in the docker host from the client host
func (client *MockClient) ImageLoad(ctx context.Context, input io.Reader, quiet bool) (types.ImageLoadResponse, error) {
	args := client.Mock.Called(ctx, input, quiet)
	return args.Get(0).(types.ImageLoadResponse), args.Error(1)
}

// ImagePull requests the docker host to pull an image from a remote registry
func (client *MockClient) ImagePull(ctx context.Context, options types.ImagePullOptions, privilegeFunc client.RequestPrivilegeFunc) (io.ReadCloser, error) {
	args := client.Mock.Called(ctx, options, privilegeFunc)
	return args.Get(0).(io.ReadCloser), args.Error(1)
}

// ImagePush requests the docker host to push an image to a remote registry
func (client *MockClient) ImagePush(ctx context.Context, options types.ImagePushOptions, privilegeFunc client.RequestPrivilegeFunc) (io.ReadCloser, error) {
	args := client.Mock.Called(ctx, options, privilegeFunc)
	return args.Get(0).(io.ReadCloser), args.Error(1)
}

// ImageRemove removes an image from the docker host
func (client *MockClient) ImageRemove(options types.ImageRemoveOptions) ([]types.ImageDelete, error) {
	args := client.Mock.Called(options)
	return args.Get(0).([]types.ImageDelete), args.Error(1)
}

// ImageSearch makes the docker host to search by a term in a remote registry
func (client *MockClient) ImageSearch(options types.ImageSearchOptions, privilegeFunc client.RequestPrivilegeFunc) ([]registry.SearchResult, error) {
	args := client.Mock.Called(options, privilegeFunc)
	return args.Get(0).([]registry.SearchResult), args.Error(1)
}

// ImageSave retrieves one or more images from the docker host as an io.ReadCloser
func (client *MockClient) ImageSave(ctx context.Context, imageIDs []string) (io.ReadCloser, error) {
	args := client.Mock.Called(ctx, imageIDs)
	return args.Get(0).(io.ReadCloser), args.Error(1)
}

// ImageTag tags an image in the docker host
func (client *MockClient) ImageTag(options types.ImageTagOptions) error {
	args := client.Mock.Called(options)
	return args.Error(0)
}

// Info returns information about the docker server
func (client *MockClient) Info() (types.Info, error) {
	args := client.Mock.Called()
	return args.Get(0).(types.Info), args.Error(1)
}

// NetworkConnect connects a container to an existent network in the docker host
func (client *MockClient) NetworkConnect(networkID, containerID string, config *network.EndpointSettings) error {
	args := client.Mock.Called(networkID, containerID, config)
	return args.Error(0)
}

// NetworkCreate creates a new network in the docker host
func (client *MockClient) NetworkCreate(options types.NetworkCreate) (types.NetworkCreateResponse, error) {
	args := client.Mock.Called(options)
	return args.Get(0).(types.NetworkCreateResponse), args.Error(1)
}

// NetworkDisconnect disconnects a container from an existent network in the docker host
func (client *MockClient) NetworkDisconnect(networkID, containerID string, force bool) error {
	args := client.Mock.Called(networkID, containerID, force)
	return args.Error(0)
}

// NetworkInspect returns the information for a specific network configured in the docker host
func (client *MockClient) NetworkInspect(networkID string) (types.NetworkResource, error) {
	args := client.Mock.Called(networkID)
	return args.Get(0).(types.NetworkResource), args.Error(1)
}

// NetworkList returns the list of networks configured in the docker host
func (client *MockClient) NetworkList(options types.NetworkListOptions) ([]types.NetworkResource, error) {
	args := client.Mock.Called(options)
	return args.Get(0).([]types.NetworkResource), args.Error(1)
}

// NetworkRemove removes an existent network from the docker host
func (client *MockClient) NetworkRemove(networkID string) error {
	args := client.Mock.Called(networkID)
	return args.Error(0)
}

// RegistryLogin authenticates the docker server with a given docker registry
func (client *MockClient) RegistryLogin(auth types.AuthConfig) (types.AuthResponse, error) {
	args := client.Mock.Called(auth)
	return args.Get(0).(types.AuthResponse), args.Error(1)
}

// ServerVersion returns information of the docker client and server host
func (client *MockClient) ServerVersion() (types.Version, error) {
	args := client.Mock.Called()
	return args.Get(0).(types.Version), args.Error(1)
}

// VolumeCreate creates a volume in the docker host
func (client *MockClient) VolumeCreate(options types.VolumeCreateRequest) (types.Volume, error) {
	args := client.Mock.Called(options)
	return args.Get(0).(types.Volume), args.Error(1)
}

// VolumeInspect returns the information about a specific volume in the docker host
func (client *MockClient) VolumeInspect(volumeID string) (types.Volume, error) {
	args := client.Mock.Called(volumeID)
	return args.Get(0).(types.Volume), args.Error(1)
}

// VolumeList returns the volumes configured in the docker host
func (client *MockClient) VolumeList(filter filters.Args) (types.VolumesListResponse, error) {
	args := client.Mock.Called(filter)
	return args.Get(0).(types.VolumesListResponse), args.Error(1)
}

// VolumeRemove removes a volume from the docker host
func (client *MockClient) VolumeRemove(volumeID string) error {
	args := client.Mock.Called(volumeID)
	return args.Error(0)
}