docker

type APIClient interface {
	ContainerCreate(
		ctx context.Context,
		config *container.Config,
		hostConfig *container.HostConfig,
		networkingConfig *network.NetworkingConfig,
		platform *ocispec.Platform,
		containerName string,
	) (container.CreateResponse, error)
	ContainerStart(
		ctx context.Context,
		containerID string,
		options container.StartOptions,
	) error
	ContainerStop(
		ctx context.Context,
		containerID string,
		options container.StopOptions,
	) error
	ContainerRemove(
		ctx context.Context,
		containerID string,
		options container.RemoveOptions,
	) error
	ContainerList(
		ctx context.Context,
		options container.ListOptions,
	) ([]container.Summary, error)
	ContainerInspect(
		ctx context.Context,
		containerID string,
	) (container.InspectResponse, error)
	ContainerExecCreate(
		ctx context.Context,
		container string,
		options container.ExecOptions,
	) (common.IDResponse, error)
	ContainerExecAttach(
		ctx context.Context,
		execID string,
		options container.ExecStartOptions,
	) (types.HijackedResponse, error)
	ContainerExecInspect(
		ctx context.Context,
		execID string,
	) (container.ExecInspect, error)
	ImagePull(
		ctx context.Context,
		ref string,
		options image.PullOptions,
	) (io.ReadCloser, error)
	ImageInspect(
		ctx context.Context,
		imageID string,
		options ...dockerclient.ImageInspectOption,
	) (image.InspectResponse, error)
	ImageRemove(
		ctx context.Context,
		imageID string,
		options image.RemoveOptions,
	) ([]image.DeleteResponse, error)
	Ping(
		ctx context.Context,
	) (types.Ping, error)
}

type ActionResult struct {
	Message string `json:"message"`
	Changed bool   `json:"changed"`
}

type Client struct {
	provider.FactsAware
	// contains filtered or unexported fields
}

type Container struct {
	ID      string    `json:"id"`
	Name    string    `json:"name"`
	Image   string    `json:"image"`
	State   string    `json:"state"`
	Created time.Time `json:"created"`
	Changed bool      `json:"changed"`
}

type ContainerDetail struct {
	Container
	NetworkSettings *NetworkSettings `json:"network_settings,omitempty"`
	Ports           []PortMapping    `json:"ports,omitempty"`
	Mounts          []VolumeMapping  `json:"mounts,omitempty"`
	Health          string           `json:"health,omitempty"`
}

type CreateParams struct {
	// Image is the container image (required).
	Image string `json:"image"`
	// Name is an optional container name.
	Name string `json:"name,omitempty"`
	// Hostname sets the container hostname.
	Hostname string `json:"hostname,omitempty"`
	// DNS sets custom DNS servers for the container.
	DNS []string `json:"dns,omitempty"`
	// Command overrides the image's default command.
	Command []string `json:"command,omitempty"`
	// Env sets environment variables.
	Env map[string]string `json:"env,omitempty"`
	// Ports maps host ports to container ports.
	Ports []PortMapping `json:"ports,omitempty"`
	// Volumes maps host paths to container paths.
	Volumes []VolumeMapping `json:"volumes,omitempty"`
	// AutoStart starts the container after creation.
	AutoStart bool `json:"auto_start,omitempty"`
}

type ExecParams struct {
	// Command is the command and arguments.
	Command []string `json:"command"`
	// Env sets environment variables.
	Env map[string]string `json:"env,omitempty"`
	// WorkingDir sets the working directory.
	WorkingDir string `json:"working_dir,omitempty"`
}

type ExecResult struct {
	Stdout   string `json:"stdout"`
	Stderr   string `json:"stderr"`
	ExitCode int    `json:"exit_code"`
	Changed  bool   `json:"changed"`
}

type ListParams struct {
	// State filters by container state: "running", "stopped", "all".
	State string `json:"state,omitempty"`
	// Limit caps the number of results.
	Limit int `json:"limit,omitempty"`
}

type NetworkSettings struct {
	IPAddress string `json:"ip_address,omitempty"`
	Gateway   string `json:"gateway,omitempty"`
}

type PortMapping struct {
	Host      int `json:"host"`
	Container int `json:"container"`
}

type Provider interface {
	Ping(
		ctx context.Context,
	) error

	Create(
		ctx context.Context,
		params CreateParams,
	) (*Container, error)

	Start(
		ctx context.Context,
		id string,
	) (*ActionResult, error)

	Stop(
		ctx context.Context,
		id string,
		timeout *time.Duration,
	) (*ActionResult, error)

	Remove(
		ctx context.Context,
		id string,
		force bool,
	) (*ActionResult, error)

	List(
		ctx context.Context,
		params ListParams,
	) ([]Container, error)

	Inspect(
		ctx context.Context,
		id string,
	) (*ContainerDetail, error)

	Exec(
		ctx context.Context,
		id string,
		params ExecParams,
	) (*ExecResult, error)

	Pull(
		ctx context.Context,
		image string,
	) (*PullResult, error)

	ImageRemove(
		ctx context.Context,
		image string,
		force bool,
	) (*ActionResult, error)
}

type PullResult struct {
	ImageID string `json:"image_id"`
	Tag     string `json:"tag"`
	Size    int64  `json:"size"`
	Changed bool   `json:"changed"`
}

type VolumeMapping struct {
	Host      string `json:"host"`
	Container string `json:"container"`
}