Documentation
¶
Index ¶
- Variables
- type ExecutionContext
- type ExecutionContextOption
- type Opts
- type Runner
- type TaskCompiler
- type TaskRunner
- func (r *TaskRunner) Cancel()
- func (r *TaskRunner) Finish()
- func (r *TaskRunner) Run(t *task.Task) error
- func (r *TaskRunner) SetContexts(contexts map[string]*ExecutionContext) *TaskRunner
- func (r *TaskRunner) SetVariables(vars variables.Container) *TaskRunner
- func (r *TaskRunner) WithVariable(key, value string) *TaskRunner
Examples ¶
Constants ¶
This section is empty.
Variables ¶
var ErrMutuallyExclusiveVarSet = errors.New("mutually exclusive vars have been set")
Functions ¶
This section is empty.
Types ¶
type ExecutionContext ¶
type ExecutionContext struct {
Executable *utils.Binary
Dir string
Env variables.Container
Envfile *utils.Envfile
Variables variables.Container
Quote string
// contains filtered or unexported fields
}
ExecutionContext allow you to set up execution environment, variables, binary which will run your task, up/down commands etc.
func DefaultContext ¶
func DefaultContext() *ExecutionContext
DefaultContext creates default ExecutionContext instance
func NewExecutionContext ¶
func NewExecutionContext(executable *utils.Binary, dir string, env variables.Container, envfile *utils.Envfile, up, down, before, after []string, options ...ExecutionContextOption) *ExecutionContext
NewExecutionContext creates new ExecutionContext instance
func (*ExecutionContext) After ¶
func (c *ExecutionContext) After() error
After executes tasks defined to run after every usage of the context
func (*ExecutionContext) Before ¶
func (c *ExecutionContext) Before() error
Before executes tasks defined to run before every usage of the context
func (*ExecutionContext) Down ¶
func (c *ExecutionContext) Down()
Down executes tasks defined to run once after last usage of the context
func (*ExecutionContext) GenerateEnvfile ¶
func (c *ExecutionContext) GenerateEnvfile() error
GenerateEnvfile processes env and other supplied variables writes them to a `.taskctl` folder in a current directory the file names are generated using the `generated_{Task_Name}_{UNIX_timestamp}.env`.
Note: it will create the directory
Example ¶
package main
import (
"fmt"
"os"
"path/filepath"
"github.com/Ensono/taskctl/pkg/runner"
"github.com/Ensono/taskctl/pkg/utils"
"github.com/Ensono/taskctl/pkg/variables"
)
func helpSetupCleanUp() (path string, defereCleanUp func()) {
tmpDir, _ := os.MkdirTemp(os.TempDir(), "context-envfile")
path = filepath.Join(tmpDir, "generated_task_123.env")
return path, func() {
os.RemoveAll(tmpDir)
}
}
func main() {
outputFilePath, cleanUp := helpSetupCleanUp()
defer cleanUp()
osEnvVars := variables.FromMap(map[string]string{"TF_VAR_CAPPED_BY_MSFT": "some value"})
// "var2": "original222", "!::": "whatever val will never be added", "incld1": "welcome var", "exclude3": "sadgfddf"})
userEnvVars := variables.FromMap(map[string]string{})
execContext := runner.NewExecutionContext(nil, "", osEnvVars.Merge(userEnvVars), utils.NewEnvFile(func(e *utils.Envfile) {
e.Generate = true
e.Path = outputFilePath
e.Exclude = append(e.Exclude, []string{"excld1", "exclude3", "userSuppliedButExcluded"}...)
e.Modify = append(e.Modify, []utils.ModifyEnv{
{Pattern: "^(?P<keyword>TF_VAR_)(?P<varname>.*)", Operation: "lower"},
}...)
}), []string{}, []string{}, []string{}, []string{})
_ = execContext.GenerateEnvfile()
contents, _ := os.ReadFile(outputFilePath)
// for the purposes of the test example we need to make sure the map is
// always displayed in same order of keys, which is not a guarantee with a map
fmt.Println(string(contents))
}
Output: TF_VAR_capped_by_msft=some value
func (*ExecutionContext) StartupError ¶
func (c *ExecutionContext) StartupError() error
StartUpError reports whether an error exists on startUp
func (*ExecutionContext) Up ¶
func (c *ExecutionContext) Up() error
Up executes tasks defined to run once before first usage of the context
type ExecutionContextOption ¶
type ExecutionContextOption func(c *ExecutionContext)
ExecutionContextOption is a functional option to configure ExecutionContext
func WithQuote ¶
func WithQuote(quote string) ExecutionContextOption
WithQuote is functional option to set Quote for ExecutionContext
type Opts ¶
type Opts func(*TaskRunner)
Opts is a task runner configuration function.
func WithContexts ¶
func WithContexts(contexts map[string]*ExecutionContext) Opts
WithContexts adds provided contexts to task runner
func WithVariables ¶
WithVariables adds provided variables to task runner
type TaskCompiler ¶
type TaskCompiler struct {
// contains filtered or unexported fields
}
TaskCompiler compiles tasks into jobs for executor
func NewTaskCompiler ¶
func NewTaskCompiler() *TaskCompiler
NewTaskCompiler create new TaskCompiler instance
func (*TaskCompiler) CompileCommand ¶
func (tc *TaskCompiler) CompileCommand( taskName string, command string, executionCtx *ExecutionContext, dir string, timeout *time.Duration, stdin io.Reader, stdout, stderr io.Writer, env, vars variables.Container, ) (*executor.Job, error)
CompileCommand compiles command into Job
func (*TaskCompiler) CompileTask ¶
func (tc *TaskCompiler) CompileTask(t *task.Task, executionContext *ExecutionContext, stdin io.Reader, stdout, stderr io.Writer, env, vars variables.Container) (*executor.Job, error)
CompileTask compiles task into Job (linked list of commands) executed by Executor
type TaskRunner ¶
type TaskRunner struct {
Executor executor.Executor
DryRun bool
Stdin io.Reader
Stdout, Stderr io.Writer
OutputFormat string
// contains filtered or unexported fields
}
TaskRunner run tasks
func NewTaskRunner ¶
func NewTaskRunner(opts ...Opts) (*TaskRunner, error)
NewTaskRunner creates new TaskRunner instance
func (*TaskRunner) Run ¶
func (r *TaskRunner) Run(t *task.Task) error
Run run provided task. TaskRunner first compiles task into linked list of Jobs, then passes those jobs to Executor
Example ¶
t := taskpkg.FromCommands("go fmt ./...", "go build ./..")
r, err := NewTaskRunner()
if err != nil {
return
}
err = r.Run(t)
if err != nil {
fmt.Println(err, t.ExitCode, t.ErrorMessage())
}
fmt.Println(t.Output())
Output:
func (*TaskRunner) SetContexts ¶
func (r *TaskRunner) SetContexts(contexts map[string]*ExecutionContext) *TaskRunner
SetContexts sets task runner's contexts
func (*TaskRunner) SetVariables ¶
func (r *TaskRunner) SetVariables(vars variables.Container) *TaskRunner
SetVariables sets task runner's variables
func (*TaskRunner) WithVariable ¶
func (r *TaskRunner) WithVariable(key, value string) *TaskRunner
WithVariable adds variable to task runner's variables list. It creates new instance of variables container.
Source Files