Merge pull request #1313 from aluzzardi/task-prerun

engine: Task PreRun Hook
This commit is contained in:
Sam Alba 2021-12-23 16:24:45 -08:00 committed by GitHub
commit 7e523c7c39
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 58 additions and 24 deletions

View File

@ -2,9 +2,7 @@ package plan
import ( import (
"context" "context"
"errors"
"fmt" "fmt"
"os"
"strings" "strings"
"time" "time"
@ -43,11 +41,11 @@ func Load(ctx context.Context, args ...string) (*Plan, error) {
source: v, source: v,
} }
if err := p.registerLocalDirs(); err != nil { if err := p.configPlatform(); err != nil {
return nil, err return nil, err
} }
if err := p.configPlatform(); err != nil { if err := p.prepare(ctx); err != nil {
return nil, err return nil, err
} }
@ -87,26 +85,39 @@ func (p *Plan) configPlatform() error {
return nil return nil
} }
// registerLocalDirectories scans the context for local imports. // prepare executes the pre-run hooks of tasks
// BuildKit requires to known the list of directories ahead of time. func (p *Plan) prepare(ctx context.Context) error {
func (p *Plan) registerLocalDirs() error { flow := cueflow.New(
imports, err := p.source.Lookup("inputs.directories").Fields() &cueflow.Config{},
p.source.Cue(),
func(flowVal cue.Value) (cueflow.Runner, error) {
v := compiler.Wrap(flowVal)
t, err := task.Lookup(v)
if err != nil { if err != nil {
return err // Not a task
if err == task.ErrNotTask {
return nil, nil
}
return nil, err
}
r, ok := t.(task.PreRunner)
if !ok {
return nil, nil
} }
for _, v := range imports { return cueflow.RunnerFunc(func(t *cueflow.Task) error {
dir, err := v.Value.Lookup("path").AbsPath() ctx := t.Context()
if err != nil { lg := log.Ctx(ctx).With().Str("task", t.Path().String()).Logger()
return err ctx = lg.WithContext(ctx)
}
if _, err := os.Stat(dir); errors.Is(err, os.ErrNotExist) {
return fmt.Errorf("path %q does not exist", dir)
}
p.context.LocalDirs.Add(dir)
}
if err := r.PreRun(ctx, p.context, compiler.Wrap(t.Value())); err != nil {
return fmt.Errorf("%s: %w", t.Path().String(), err)
}
return nil return nil
}), nil
},
)
return flow.Run(ctx)
} }
// Up executes the plan // Up executes the plan
@ -175,7 +186,7 @@ func newRunner(pctx *plancontext.Context, s solver.Solver, computed *compiler.Va
} else { } else {
lg.Error().Dur("duration", time.Since(start)).Err(err).Str("state", string(environment.StateFailed)).Msg(string(environment.StateFailed)) lg.Error().Dur("duration", time.Since(start)).Err(err).Str("state", string(environment.StateFailed)).Msg(string(environment.StateFailed))
} }
return err return fmt.Errorf("%s: %w", t.Path().String(), err)
} }
lg.Info().Dur("duration", time.Since(start)).Str("state", string(environment.StateCompleted)).Msg(string(environment.StateCompleted)) lg.Info().Dur("duration", time.Since(start)).Str("state", string(environment.StateCompleted)).Msg(string(environment.StateCompleted))

View File

@ -2,6 +2,9 @@ package task
import ( import (
"context" "context"
"errors"
"fmt"
"os"
"github.com/moby/buildkit/client/llb" "github.com/moby/buildkit/client/llb"
"github.com/rs/zerolog/log" "github.com/rs/zerolog/log"
@ -17,6 +20,20 @@ func init() {
type inputDirectoryTask struct { type inputDirectoryTask struct {
} }
func (c *inputDirectoryTask) PreRun(ctx context.Context, pctx *plancontext.Context, v *compiler.Value) error {
path, err := v.Lookup("path").AbsPath()
if err != nil {
return err
}
if _, err := os.Stat(path); errors.Is(err, os.ErrNotExist) {
return fmt.Errorf("path %q does not exist", path)
}
pctx.LocalDirs.Add(path)
return nil
}
func (c *inputDirectoryTask) Run(ctx context.Context, pctx *plancontext.Context, s solver.Solver, v *compiler.Value) (*compiler.Value, error) { func (c *inputDirectoryTask) Run(ctx context.Context, pctx *plancontext.Context, s solver.Solver, v *compiler.Value) (*compiler.Value, error) {
path, err := v.Lookup("path").AbsPath() path, err := v.Lookup("path").AbsPath()
if err != nil { if err != nil {

View File

@ -29,6 +29,12 @@ type Task interface {
Run(ctx context.Context, pctx *plancontext.Context, s solver.Solver, v *compiler.Value) (*compiler.Value, error) Run(ctx context.Context, pctx *plancontext.Context, s solver.Solver, v *compiler.Value) (*compiler.Value, error)
} }
type PreRunner interface {
Task
PreRun(ctx context.Context, pctx *plancontext.Context, v *compiler.Value) error
}
// Register a task type and initializer // Register a task type and initializer
func Register(typ string, f NewFunc) { func Register(typ string, f NewFunc) {
tasks.Store(typ, f) tasks.Store(typ, f)

View File

@ -62,7 +62,7 @@ setup() {
cd "$TESTDIR" cd "$TESTDIR"
run "$DAGGER" --europa up ./plan/inputs/directories/conflicting_values.cue run "$DAGGER" --europa up ./plan/inputs/directories/conflicting_values.cue
assert_failure assert_failure
assert_output --partial 'failed to up environment: actions.verify.contents: conflicting values "local directory" and "local dfsadf"' assert_output --partial 'conflicting values "local directory" and "local dfsadf"'
} }
@test "plan/inputs/secrets exec" { @test "plan/inputs/secrets exec" {