package task import ( "bytes" "context" "fmt" "io" "os" "path/filepath" "strings" "sync" "sync/atomic" "github.com/go-task/task/execext" "golang.org/x/sync/errgroup" ) const ( // TaskFilePath is the default Taskfile TaskFilePath = "Taskfile" // MaximumTaskCall is the max number of times a task can be called. // This exists to prevent infinite loops on cyclic dependencies MaximumTaskCall = 100 ) // Executor executes a Taskfile type Executor struct { Tasks Tasks Dir string Force bool Watch bool Verbose bool Stdin io.Reader Stdout io.Writer Stderr io.Writer taskvars Vars watchingFiles map[string]struct{} dynamicCache Vars muDynamicCache sync.Mutex } // Vars is a string[string] variables map type Vars map[string]string // Tasks representas a group of tasks type Tasks map[string]*Task // Task represents a task type Task struct { Cmds []*Cmd Deps []*Dep Desc string Sources []string Generates []string Status []string Dir string Vars Vars Set string Env Vars callCount int32 } // Run runs Task func (e *Executor) Run(args ...string) error { if e.Stdin == nil { e.Stdin = os.Stdin } if e.Stdout == nil { e.Stdout = os.Stdout } if e.Stderr == nil { e.Stderr = os.Stderr } if e.dynamicCache == nil { e.dynamicCache = make(Vars, 10) } // check if given tasks exist for _, a := range args { if _, ok := e.Tasks[a]; !ok { // FIXME: move to the main package e.printExistingTasksHelp() return &taskNotFoundError{taskName: a} } } if e.Watch { if err := e.watchTasks(args...); err != nil { return err } return nil } for _, a := range args { if err := e.RunTask(context.Background(), Call{Task: a}); err != nil { return err } } return nil } // RunTask runs a task by its name func (e *Executor) RunTask(ctx context.Context, call Call) error { t, ok := e.Tasks[call.Task] if !ok { return &taskNotFoundError{call.Task} } if atomic.AddInt32(&t.callCount, 1) >= MaximumTaskCall { return &MaximumTaskCallExceededError{task: call.Task} } var err error call.Vars, err = e.getVariables(call) if err != nil { return err } if err := e.runDeps(ctx, call); err != nil { return err } // FIXME: doing again, since a var may have been overriden // using the `set:` attribute of a dependecy. // Remove this when `set` (that is deprecated) be removed call.Vars, err = e.getVariables(call) if err != nil { return err } if !e.Force { upToDate, err := e.isTaskUpToDate(ctx, call) if err != nil { return err } if upToDate { e.printfln(`task: Task "%s" is up to date`, call.Task) return nil } } for i := range t.Cmds { if err := e.runCommand(ctx, call, i); err != nil { return &taskRunError{call.Task, err} } } return nil } func (e *Executor) runDeps(ctx context.Context, call Call) error { g, ctx := errgroup.WithContext(ctx) t := e.Tasks[call.Task] for _, d := range t.Deps { d := d g.Go(func() error { dep, err := e.ReplaceVariables(d.Task, call) if err != nil { return err } depVars := make(Vars, len(d.Vars)) for k, v := range d.Vars { v, err := e.ReplaceVariables(v, call) if err != nil { return err } depVars[k] = v } return e.RunTask(ctx, Call{Task: dep, Vars: depVars}) }) } return g.Wait() } func (e *Executor) isTaskUpToDate(ctx context.Context, call Call) (bool, error) { t := e.Tasks[call.Task] if len(t.Status) > 0 { return e.isUpToDateStatus(ctx, call) } return e.isUpToDateTimestamp(ctx, call) } func (e *Executor) isUpToDateStatus(ctx context.Context, call Call) (bool, error) { t := e.Tasks[call.Task] environ, err := e.getEnviron(call) if err != nil { return false, err } dir, err := e.getTaskDir(call) if err != nil { return false, err } status, err := e.ReplaceSliceVariables(t.Status, call) if err != nil { return false, err } for _, s := range status { err = execext.RunCommand(&execext.RunCommandOptions{ Context: ctx, Command: s, Dir: dir, Env: environ, }) if err != nil { return false, nil } } return true, nil } func (e *Executor) isUpToDateTimestamp(ctx context.Context, call Call) (bool, error) { t := e.Tasks[call.Task] if len(t.Sources) == 0 || len(t.Generates) == 0 { return false, nil } dir, err := e.getTaskDir(call) if err != nil { return false, err } sources, err := e.ReplaceSliceVariables(t.Sources, call) if err != nil { return false, err } generates, err := e.ReplaceSliceVariables(t.Generates, call) if err != nil { return false, err } sourcesMaxTime, err := getPatternsMaxTime(dir, sources) if err != nil || sourcesMaxTime.IsZero() { return false, nil } generatesMinTime, err := getPatternsMinTime(dir, generates) if err != nil || generatesMinTime.IsZero() { return false, nil } return generatesMinTime.After(sourcesMaxTime), nil } func (e *Executor) runCommand(ctx context.Context, call Call, i int) error { t := e.Tasks[call.Task] cmd := t.Cmds[i] if cmd.Cmd == "" { cmdVars := make(Vars, len(cmd.Vars)) for k, v := range cmd.Vars { v, err := e.ReplaceVariables(v, call) if err != nil { return err } cmdVars[k] = v } return e.RunTask(ctx, Call{Task: cmd.Task, Vars: cmdVars}) } c, err := e.ReplaceVariables(cmd.Cmd, call) if err != nil { return err } dir, err := e.getTaskDir(call) if err != nil { return err } envs, err := e.getEnviron(call) if err != nil { return err } opts := &execext.RunCommandOptions{ Context: ctx, Command: c, Dir: dir, Env: envs, Stdin: e.Stdin, Stderr: e.Stderr, } e.println(c) if t.Set != "" { var stdout bytes.Buffer opts.Stdout = &stdout if err = execext.RunCommand(opts); err != nil { return err } return os.Setenv(t.Set, strings.TrimSpace(stdout.String())) } opts.Stdout = e.Stdout return execext.RunCommand(opts) } func (e *Executor) getTaskDir(call Call) (string, error) { t := e.Tasks[call.Task] taskDir, err := e.ReplaceVariables(t.Dir, call) if err != nil { return "", err } return filepath.Join(e.Dir, taskDir), nil } func (e *Executor) getEnviron(call Call) ([]string, error) { t := e.Tasks[call.Task] if t.Env == nil { return nil, nil } envs := os.Environ() for k, v := range t.Env { env, err := e.ReplaceVariables(fmt.Sprintf("%s=%s", k, v), call) if err != nil { return nil, err } envs = append(envs, env) } return envs, nil }