docker

type BuildOptions struct {
	// Additional environment variables to pass in when running docker build command.
	Env map[string]string

	// Set a logger that should be used. See the logger package for more info.
	Logger *logger.Logger

	// Target build arg to pass to the 'docker build' command
	Target string

	// Tags for the Docker image
	Tags []string

	// Build args to pass the 'docker build' command
	BuildArgs []string

	// All architectures to target in a multiarch build. Configuring this variable will cause terratest to use docker
	// buildx to construct multiarch images.
	// You can read more about multiarch docker builds in the official documentation for buildx:
	// https://docs.docker.com/buildx/working-with-buildx/
	// NOTE: This list does not automatically include the current platform. For example, if you are building images on
	// an Apple Silicon based MacBook, and you configure this variable to []string{"linux/amd64"} to build an amd64
	// image, the buildx command will not automatically include linux/arm64 - you must include that explicitly.
	Architectures []string

	// Custom CLI options that will be passed as-is to the 'docker build' command. This is an "escape hatch" that allows
	// Terratest to not have to support every single command-line option offered by the 'docker build' command, and
	// solely focus on the most important ones.
	OtherOptions []string

	// Whether or not to push images directly to the registry on build. Note that for multiarch images (Architectures is
	// not empty), this must be true to ensure availability of all architectures - only the image for the current
	// platform will be loaded into the daemon (due to a limitation of the docker daemon), so you won't be able to run a
	// `docker push` command later to push the multiarch image.
	// See https://github.com/moby/moby/pull/38738 for more info on the limitation of multiarch images in docker daemon.
	Push bool

	// Whether or not to load the image into the docker daemon at the end of a multiarch build so that it can be used
	// locally. Note that this is only used when Architectures is set, and assumes the current architecture is already
	// included in the Architectures list.
	Load bool

	// Whether ot not to enable buildkit. You can find more information about buildkit here https://docs.docker.com/build/buildkit/#getting-started.
	EnableBuildKit bool
}

type ContainerInspect struct {
	// ID of the inspected container
	ID string

	// Name of the inspected container
	Name string

	// time.Time that the container was created
	Created time.Time

	// String representing the container's status
	Status string

	// String with the container's error message, if there is any
	Error string

	// Ports exposed by the container
	Ports []Port

	// Volume bindings made to the container
	Binds []VolumeBind

	// Health check
	Health HealthCheck

	// Container's exit code
	ExitCode uint8

	// Whether the container is currently running or not
	Running bool
}

type HealthCheck struct {
	// Health check status
	Status string `json:"Status"`

	// Log of failures
	Log []HealthLog `json:"Log"`

	// Current count of failing health checks
	FailingStreak uint8 `json:"FailingStreak"`
}

type HealthLog struct {
	// Start time of health check
	Start string `json:"Start"`

	// End time of health check
	End string `json:"End"`

	// Output of health check
	Output string `json:"Output"`

	// Exit code of health check
	ExitCode uint8 `json:"ExitCode"`
}

type Image struct {
	// ID is the image ID in docker, and can be used to identify the image in place of the repo and tag.
	ID string `json:"ID"`

	// Repository is the image repository.
	Repository string `json:"Repository"`

	// Tag is the image tag wichin the repository.
	Tag string `json:"Tag"`

	// CreatedAt represents a timestamp for when the image was created.
	CreatedAt string `json:"CreatedAt"`

	// CreatedSince is a diff between when the image was created to now.
	CreatedSince string `json:"CreatedSince"`

	// SharedSize is the amount of space that an image shares with another one (i.e. their common data).
	SharedSize string `json:"SharedSize"`

	// UniqueSize is the amount of space that is only used by a given image.
	UniqueSize string `json:"UniqueSize"`

	// VirtualSize is the total size of the image, combining SharedSize and UniqueSize.
	VirtualSize string `json:"VirtualSize"`

	// Containers represents the list of containers that are using the image.
	Containers string `json:"Containers"`

	// Digest is the hash digest of the image, if requested.
	Digest string `json:"Digest"`
}

type Options struct {
	EnvVars    map[string]string
	Logger     *logger.Logger
	WorkingDir string

	ProjectName string

	// Whether ot not to enable buildkit. You can find more information about buildkit here https://docs.docker.com/build/buildkit/#getting-started.
	EnableBuildKit bool
}

type Port struct {
	Protocol      string
	HostPort      uint16
	ContainerPort uint16
}

type RunOptions struct {
	// Set a logger that should be used. See the logger package for more info.
	Logger *logger.Logger

	// Override the default ENTRYPOINT of the Docker image
	Entrypoint string

	// Assign a name to the container
	Name string

	// Set platform
	Platform string

	// Username or UID
	User string

	// Override the default COMMAND of the Docker image
	Command []string

	// Set environment variables
	EnvironmentVariables []string

	// Bind mount these volume(s) when running the container
	Volumes []string

	// Custom CLI options that will be passed as-is to the 'docker run' command. This is an "escape hatch" that allows
	// Terratest to not have to support every single command-line option offered by the 'docker run' command, and
	// solely focus on the most important ones.
	OtherOptions []string

	// If set to true, pass the --detach flag to 'docker run' to run the container in the background
	Detach bool

	// If set to true, pass the --init flag to 'docker run' to run an init inside the container that forwards signals
	// and reaps processes
	Init bool

	// If set to true, pass the --privileged flag to 'docker run' to give extended privileges to the container
	Privileged bool

	// If set to true, pass the --rm flag to 'docker run' to automatically remove the container when it exits
	Remove bool

	// If set to true, pass the -tty flag to 'docker run' to allocate a pseudo-TTY
	Tty bool
}

type StopOptions struct {
	// Set a logger that should be used. See the logger package for more info.
	Logger *logger.Logger

	// Seconds to wait for stop before killing the container (default 10)
	Time int
}

type VolumeBind struct {
	Source      string
	Destination string
}