engine

type DetachMode int

type EngineLibrary interface {
	CheckPrereqs() (bool, []string)
	List() ([]EngineMetadata, error)
	GetProvider(version string) Provider

	// IsSealedDistro indicates whether a library represents a fixed distribution.
	// Fixed distributions have a single version, so do not support version
	// resolution or fetching engine binaries.
	IsSealedDistro() bool

	// ShouldEnsurePlugins indicates whether missing default plugins should be
	// installed before starting the engine.
	ShouldEnsurePlugins() bool
}

type EngineMetadata struct {
	EngineType EngineType
	Version    string
}

type EngineType string

type EnvOptions struct {
	IncludeHome bool
	IncludePath bool
}

type ManagedMock struct {
	ID     string
	Name   string
	Port   int
	Health MockHealth
}

type MockEngine interface {
	Start(wg *sync.WaitGroup) (success bool)
	Stop(wg *sync.WaitGroup)
	StopImmediately(wg *sync.WaitGroup)
	Restart(wg *sync.WaitGroup)
	ListAllManaged() ([]ManagedMock, error)
	StopAllManaged() int

	// StopManaged stops the single managed mock identified by id (the same
	// value reported in ManagedMock.ID, i.e. the short container ID for
	// docker or the PID for process engines). Returns (true, nil) if the
	// mock was found and stopped; (false, nil) if no managed mock with
	// that id exists in this engine; (false, err) if the engine could
	// not be queried.
	StopManaged(id string) (bool, error)

	GetVersionString() (string, error)

	// GetID returns an identifier for the running mock: the container ID
	// for the docker engine, or the process PID for process engines.
	// Returns an empty string if the mock has not been started.
	GetID() string
}

type MockHealth string

type Provider interface {
	Satisfied() bool
	Provide(policy PullPolicy) error
	GetEngineType() EngineType
	Build(configDir string, startOptions StartOptions) MockEngine

	// Bundle creates a single archive file containing the engine binary and
	// configuration files. The archive is written to the specified destination.
	// If the engine type is 'docker', destination should be a valid image name.
	Bundle(configDir string, dest string) error
}

type PullPolicy int

type StartOptions struct {
	Port            int
	Version         string
	PullPolicy      PullPolicy
	LogLevel        string
	ReplaceRunning  bool
	Deduplicate     string
	EnablePlugins   bool
	EnableFileCache bool
	Environment     []string
	DirMounts       []string
	DebugMode       bool
	Detach          DetachMode
	// DetachLog is the resolved absolute path that a detached process
	// engine writes stdout/stderr to. Unused by the docker engine.
	DetachLog string
	// DetachIdFile is the path the mock ID is written to (plaintext, no
	// trailing newline) once a detached mock has started. Empty disables
	// the behaviour.
	DetachIdFile string
}