docker

type AfterHandler func()

type BeforeHandler func() error

type Compose struct {
	// contains filtered or unexported fields
}

type ComposeConfig struct {
	// Env the global config for this composes' execution
	Env *EnvironmentConfig
	// Services maps service names to their config, for those managed by this composes' execution
	Services map[string]*ServiceConfig
}

type Container struct {
	Config        *types.Container
	ServiceConfig *ServiceConfig
	// contains filtered or unexported fields
}

type ContainerStatus struct {
	Error error
	Code  ContainerStatusCode
}

type ContainerStatusCode uint8

type Endpoints interface {
	GetHost() string
	GetPublicPorts(privatePorts ...int) []int
}

type Environment struct {
	// Services maps service names to their data (output of their handlers). See ServiceHandler
	Services map[string]interface{}
	// contains filtered or unexported fields
}

type EnvironmentConfig struct {
	// UpTimeout timeout for docker-compose up
	UpTimeout time.Duration
	// DownTimeout timeout for docker-compose down
	DownTimeout time.Duration
	// ComposeFilePaths the path to the compose-YAML file(s)
	ComposeFilePaths []string
	// Optional custom container label name
	Label string
	// If true it will ignore any existing containers that are running due to a previous run
	NoCleanup bool
	// If true it will not shut down the containers after the test
	NoShutdown bool
}

type ServiceConfig struct {
	// Name Service name (must correspond to the name found in the compose file)
	Name string
	// EnvironmentVars optional set of key-value pairs to pass to the service (note, these must be globally unique)
	EnvironmentVars map[string]string
	// Optional custom network name
	Network string
}

type ServiceEntry struct {
	//Name see ServiceConfig.Name
	Name string
	// DisableShutdownLogs set to true to disable printing logs for this container on shutdown (optional)
	DisableShutdownLogs bool
	// Handler Function to extract relevant data from the service's container for the test's needs (optional, but
	// usually needed by tests/consumers)
	Handler ServiceHandler
	// Before Function to run before container startup (optional)
	Before BeforeHandler
	// Before Function to run after container shutdown (optional)
	After AfterHandler
	// EnvironmentVars env variables for the service
	EnvironmentVars map[string]string
	// Network optional network name, otherwise defaults to the Network const
	Network string
}

type ServiceHandler func(*Container) (interface{}, error)