runtime

type AbstractRuntime struct {
	Logger        nuclio.Logger
	Configuration Configuration
	DockerClient  *dockerclient.Client
	CmdRunner     cmdrunner.CmdRunner
}

type Configuration interface {
	GetFunctionPath() string

	GetFunctionDir() string

	GetFunctionName() string

	GetFunctionHandler() string

	GetNuclioSourceDir() string

	GetNuclioSourceURL() string

	GetStagingDir() string

	GetNoBaseImagePull() bool
}

type Factory interface {
	Create(logger nuclio.Logger,
		configuration Configuration) (Runtime, error)
}

type Runtime interface {

	// returns the image name of the default processor base image
	GetDefaultProcessorBaseImageName() string

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

	// given a staging directory, prepares anything it may need in that directory
	// towards building a functioning processor
	OnAfterStagingDirCreated(stagingDir string) error

	// generate the contents of the processor configuration file
	GetProcessorConfigFileContents() string

	// return a map of objects the runtime needs to copy into the processor image
	// the key can be a dir, a file or a url of a file
	// the value is an absolute path into the docker image
	GetProcessorImageObjectPaths() map[string]string

	// the source extension of the runtime (e.g. .go)
	GetExtension() string

	// get the string that signifies a comment if appears at the beginning of the line
	GetCommentPattern() string
}