exec

type ConfigGetter interface {
	// Get returns the the config with a specific config ID, if available.
	// When the config is not available, the return will be nil.
	Get(configID string) (*api.Config, error)
}

type ConfigsManager interface {
	ConfigGetter

	Add(configs ...api.Config) // add one or more configs
	Remove(configs []string)   // remove the configs by ID
	Reset()                    // remove all configs
}

type ConfigsProvider interface {
	Configs() ConfigsManager
}

type ContainerStatuser interface {
	// ContainerStatus returns the status of the target container, if
	// available. When the container is not available, the status will be nil.
	ContainerStatus(ctx context.Context) (*api.ContainerStatus, error)
}

type Controller interface {
	// Update the task definition seen by the controller. Will return
	// ErrTaskUpdateFailed if the provided task definition changes fields that
	// cannot be changed.
	//
	// Will be ignored if the task has exited.
	Update(ctx context.Context, t *api.Task) error

	// Prepare the task for execution. This should ensure that all resources
	// are created such that a call to start should execute immediately.
	Prepare(ctx context.Context) error

	// Start the target and return when it has started successfully.
	Start(ctx context.Context) error

	// Wait blocks until the target has exited.
	Wait(ctx context.Context) error

	// Shutdown requests to exit the target gracefully.
	Shutdown(ctx context.Context) error

	// Terminate the target.
	Terminate(ctx context.Context) error

	// Remove all resources allocated by the controller.
	Remove(ctx context.Context) error

	// Close closes any ephemeral resources associated with controller instance.
	Close() error
}

type ControllerLogs interface {
	// Logs will write publisher until the context is cancelled or an error
	// occurs.
	Logs(ctx context.Context, publisher LogPublisher, options api.LogSubscriptionOptions) error
}

type DependencyGetter interface {
	Secrets() SecretGetter
	Configs() ConfigGetter
	Volumes() VolumeGetter
}

type DependencyManager interface {
	SecretsProvider
	ConfigsProvider
	VolumesProvider
}

type Executor interface {
	// Describe returns the underlying node description.
	Describe(ctx context.Context) (*api.NodeDescription, error)

	// Configure uses the node object state to propagate node
	// state to the underlying executor.
	Configure(ctx context.Context, node *api.Node) error

	// Controller provides a controller for the given task.
	Controller(t *api.Task) (Controller, error)

	// SetNetworkBootstrapKeys passes the symmetric keys from the
	// manager to the executor.
	SetNetworkBootstrapKeys([]*api.EncryptionKey) error
}

type ExitCoder interface {
	// ExitCode returns the exit code.
	ExitCode() int
}

type LogPublisher interface {
	Publish(ctx context.Context, message api.LogMessage) error
}

type LogPublisherFunc func(ctx context.Context, message api.LogMessage) error

type LogPublisherProvider interface {
	Publisher(ctx context.Context, subscriptionID string) (LogPublisher, func(), error)
}

type PortStatuser interface {
	// PortStatus returns the status on a list of PortConfigs
	// which are managed at the host level by the controller.
	PortStatus(ctx context.Context) (*api.PortStatus, error)
}

type SecretGetter interface {
	// Get returns the the secret with a specific secret ID, if available.
	// When the secret is not available, the return will be nil.
	Get(secretID string) (*api.Secret, error)
}

type SecretsManager interface {
	SecretGetter

	Add(secrets ...api.Secret) // add one or more secrets
	Remove(secrets []string)   // remove the secrets by ID
	Reset()                    // remove all secrets
}

type SecretsProvider interface {
	Secrets() SecretsManager
}

type StubController struct {
	Controller
	UpdateFn    func(ctx context.Context, t *api.Task) error
	PrepareFn   func(ctx context.Context) error
	StartFn     func(ctx context.Context) error
	WaitFn      func(ctx context.Context) error
	ShutdownFn  func(ctx context.Context) error
	TerminateFn func(ctx context.Context) error
	RemoveFn    func(ctx context.Context) error
	CloseFn     func() error
	// contains filtered or unexported fields
}

type Temporary interface {
	Temporary() bool
}

type VolumeGetter interface {
	// Get returns the the volume with a specific volume ID, if available.
	// When the volume is not available, the return will be nil.
	Get(volumeID string) (string, error)
}

type VolumePluginManager interface {
	// NodeInfo returns the NodeCSIInfo for each active plugin. Plugins which
	// are added through Set but to which no connection has yet been
	// successfully established will not be included.
	NodeInfo(ctx context.Context) ([]*api.NodeCSIInfo, error)
}

type VolumesManager interface {
	VolumeGetter

	// Add adds one or more volumes
	Add(volumes ...api.VolumeAssignment)
	// Remove removes one or more volumes. The callback is called each time a
	// volume is successfully removed with the ID of the volume removed.
	//
	// Remove takes a full VolumeAssignment because we may be instructed by the
	// swarm manager to attempt removal of a Volume we don't know we have.
	Remove(volumes []api.VolumeAssignment, callback func(string))
	// Plugins returns the VolumePluginManager for this VolumesManager
	Plugins() VolumePluginManager
}

type VolumesProvider interface {
	Volumes() VolumesManager
}