runtime

type AbstractRuntime struct {
	Logger         logger.Logger
	StagingDir     string
	FunctionConfig *functionconfig.Config
	DockerClient   dockerclient.Client
	CmdRunner      cmdrunner.CmdRunner
	VersionInfo    *version.Info
}

type Artifact struct {
	Name          string
	Image         string
	Paths         map[string]string
	ExternalImage bool
}

type Factory interface {
	Create(logger.Logger, string, string, *functionconfig.Config) (Runtime, error)
}

type ProcessorDockerfileInfo struct {
	BaseImage          string
	ImageArtifactPaths map[string]string
	OnbuildArtifacts   []Artifact
	Directives         map[string][]functionconfig.Directive
	DockerfileContents string
	DockerfilePath     string
	BuildArgs          map[string]string
}

type Runtime interface {
	// DetectFunctionHandlers returns a list of all the handlers
	// in that directory given a path holding a function (or functions)
	DetectFunctionHandlers(functionPath string) ([]string, error)

	// OnAfterStagingDirCreated prepares anything it may need in that directory
	// towards building a functioning processor,
	OnAfterStagingDirCreated(runtimeConfig *runtimeconfig.Config, stagingDir string) error

	// GetProcessorDockerfileInfo returns information required to build the processor Dockerfile
	GetProcessorDockerfileInfo(runtimeConfig *runtimeconfig.Config, onbuildImageRegistry string) (*ProcessorDockerfileInfo, error)

	// GetName returns the name of the runtime, including version if applicable
	GetName() string

	// GetHandlerDirObjectPaths returns the paths of all objects that should reside in the handler
	// directory
	GetHandlerDirObjectPaths() []string

	// GetOverrideImageRegistryFromMap returns an override image for the runtime from the given map
	GetOverrideImageRegistryFromMap(map[string]string) string

	// GetRuntimeBuildArgs returns building arguments
	GetRuntimeBuildArgs(runtimeConfig *runtimeconfig.Config) map[string]string
}