1
0
mirror of https://github.com/go-task/task.git synced 2025-11-23 22:24:45 +02:00

Reintroduce template evaluation in variables

With a recent commit, template evaluation for variables in tasks got
broken. This reindroudces temmplate evaluation in taks, and resolves
a series of issues that where previouisly present on master, such as:

- Taskvars did not get evaluated as templates.
- Taskvars would, in contrast to the documentation, _override_ task
  variables for the taks called directly via `Executor.Run(args
  ...string)`. This caused different behaviour in the "default" task
  v.s. other tasks.

This commit ensures:
 - Priority order for variables is now according to the documentation,
   also for the "default" task.
 - Variables gets resolved in a particular order to ensure logical
   access to varaibles on template compile time, and that template
   compilation finds place _before_ resolution of dynamic variables.

This change also allows the following to work:

    task:
      vars:
        A: "52"
        B: "{{.A}}"

However, the following will always replace C with the uncompiled
`{{.A}}`:

    task:
      vars:
        A: "52"
        C: "{{.B}}"
        B: "{{.A}}"

Several tests have also been added to prevent this feature from breaking
again. This should hopefully finally resolve issue #40.
This commit is contained in:
Sindre Røkenes Myren
2017-07-20 09:05:37 +02:00
committed by Sindre Røkenes Myren
parent 55672410cd
commit 31faf05c3a
7 changed files with 249 additions and 106 deletions

View File

@@ -33,6 +33,11 @@ type Var struct {
func (vs Vars) toStringMap() (m map[string]string) {
m = make(map[string]string, len(vs))
for k, v := range vs {
if v.Sh != "" {
// Dynamic variable is not yet resolved; trigger
// <no value> to be used in templates.
continue
}
m[k] = v.Static
}
return
@@ -95,33 +100,82 @@ func init() {
}
}
func (e *Executor) getVariables(t *Task, call Call) (Vars, error) {
result := make(Vars, len(t.Vars)+len(e.taskvars)+len(call.Vars))
// getVariables returns fully resolved variables following the priorty order:
// 1. Call variables (should already have been resolved)
// 2. Environment (should not need to be resolved)
// 3. Task variables, resolved with access to:
// - call, taskvars and environement variables
// 4. Taskvars variables, resolved with access to:
// - environment variables
func (e *Executor) getVariables(call Call) (Vars, error) {
t, ok := e.Tasks[call.Task]
if !ok {
return nil, &taskNotFoundError{call.Task}
}
merge := func(vars Vars) error {
for k, v := range vars {
v, err := e.handleDynamicVariableContent(v)
merge := func(dest Vars, srcs ...Vars) {
for _, src := range srcs {
for k, v := range src {
dest[k] = v
}
}
}
varsKeys := func(srcs ...Vars) []string {
m := make(map[string]struct{})
for _, src := range srcs {
for k := range src {
m[k] = struct{}{}
}
}
lst := make([]string, 0, len(m))
for k := range m {
lst = append(lst, k)
}
return lst
}
replaceVars := func(dest Vars, keys []string) error {
r := varReplacer{vars: dest}
for _, k := range keys {
v := dest[k]
dest[k] = Var{
Static: r.replace(v.Static),
Sh: r.replace(v.Sh),
}
}
return r.err
}
resolveShell := func(dest Vars, keys []string) error {
for _, k := range keys {
v := dest[k]
static, err := e.handleDynamicVariableContent(v)
if err != nil {
return err
}
result[k] = Var{Static: v}
dest[k] = Var{Static: static}
}
return nil
}
if err := merge(e.taskvars); err != nil {
return nil, err
}
if err := merge(t.Vars); err != nil {
return nil, err
}
if err := merge(getEnvironmentVariables()); err != nil {
return nil, err
}
if err := merge(call.Vars); err != nil {
return nil, err
update := func(dest Vars, srcs ...Vars) error {
merge(dest, srcs...)
// updatedKeys ensures template evaluation is run only once.
updatedKeys := varsKeys(srcs...)
if err := replaceVars(dest, updatedKeys); err != nil {
return err
}
return resolveShell(dest, updatedKeys)
}
// Resolve taskvars variables to "result" with environment override variables.
override := getEnvironmentVariables()
result := make(Vars, len(e.taskvars)+len(t.Vars)+len(override))
if err := update(result, e.taskvars, override); err != nil {
return nil, err
}
// Resolve task variables to "result" with environment and call override variables.
merge(override, call.Vars)
if err := update(result, t.Vars, override); err != nil {
return nil, err
}
return result, nil
}
@@ -176,13 +230,14 @@ func (e *Executor) handleDynamicVariableContent(v Var) (string, error) {
// variables in almost all properties using the Go template package
func (t *Task) ReplaceVariables(vars Vars) (*Task, error) {
r := varReplacer{vars: vars}
new := Task{
Desc: r.replace(t.Desc),
Sources: r.replaceSlice(t.Sources),
Generates: r.replaceSlice(t.Generates),
Status: r.replaceSlice(t.Status),
Dir: r.replace(t.Dir),
Vars: r.replaceVars(t.Vars),
Vars: nil,
Set: r.replace(t.Set),
Env: r.replaceVars(t.Env),
Silent: t.Silent,