engine

package

v0.8.0 Latest Latest Go to latest Published: Jun 15, 2020 License: MIT Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func MapEnvs(envs []string) map[string]string

MapEnvs map an array of string env

type DefaultExecuter struct {
	Logger map[string]Logger
}

DefaultExecuter Execute task with a POSIX emulator

func (e DefaultExecuter) Execute(ctx context.Context, elk *ox.Elk, name string) (int, error)

Execute task and returns a PID

type Engine struct {
	Elk      *ox.Elk
	Executer Executer
}

Engine is the data structure responsible of processing the content

func (e *Engine) Run(ctx context.Context, task string) error

Run task declared in ox.yml file

type Executer interface {
	Execute(context.Context, *ox.Elk, string) (int, error)
}

Executer runs a task and returns a PID and an error

type Logger struct {
	StderrWriter io.Writer
	StdoutWriter io.Writer
	StdinReader  io.Reader
}

Logger is used by the engine to store the output

func DefaultLogger() Logger

DefaultLogger is the standard output for a logger

func TimeStampLogger(logger Logger, format string) (Logger, error)

TimeStampLogger receives any logger and appends a timestamp in a specific format

type TimeStampWriter struct {
	TimeStamp func() string
	// contains filtered or unexported fields
}

TimeStampWriter attach a timestamp to each log

func (t TimeStampWriter) GetDateFormat(format string) (string, error)

GetDateFormat returns a time format from a string

func (t TimeStampWriter) Write(p []byte) (int, error)

Writes timestamp to a writer