Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding substitution for result path variable #2018

Merged
merged 1 commit into from
Feb 11, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/developers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -275,3 +275,5 @@ status:
value: |
1579722445
```

Instead of hardcoding the path to the result file, the user can also use a variable. So `/tekton/results/current-date-unix-timestamp` can be replaced with: `$(results.current-date-unix-timestamp.path)`. This is more flexible if the path to result files ever changes.
13 changes: 13 additions & 0 deletions pkg/reconciler/taskrun/resources/apply.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,11 @@ package resources

import (
"fmt"
"path/filepath"

"github.com/tektoncd/pipeline/pkg/workspace"

"github.com/tektoncd/pipeline/pkg/apis/pipeline"
"github.com/tektoncd/pipeline/pkg/apis/pipeline/v1alpha1"
"github.com/tektoncd/pipeline/pkg/substitution"
)
Expand Down Expand Up @@ -96,6 +98,17 @@ func ApplyWorkspaces(spec *v1alpha1.TaskSpec, w []v1alpha1.WorkspaceDeclaration,
return ApplyReplacements(spec, stringReplacements, map[string][]string{})
}

// ApplyTaskResults applies the substitution from values in results which are referenced in spec as subitems
// of the replacementStr.
func ApplyTaskResults(spec *v1alpha1.TaskSpec) *v1alpha1.TaskSpec {
stringReplacements := map[string]string{}

for _, result := range spec.Results {
stringReplacements[fmt.Sprintf("results.%s.path", result.Name)] = filepath.Join(pipeline.DefaultResultPath, result.Name)
}
return ApplyReplacements(spec, stringReplacements, map[string][]string{})
}

// ApplyReplacements replaces placeholders for declared parameters with the specified replacements.
func ApplyReplacements(spec *v1alpha1.TaskSpec, stringReplacements map[string]string, arrayReplacements map[string][]string) *v1alpha1.TaskSpec {
spec = spec.DeepCopy()
Expand Down
38 changes: 37 additions & 1 deletion pkg/reconciler/taskrun/resources/apply_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -720,6 +720,42 @@ func TestApplyWorkspaces(t *testing.T) {
}}
got := resources.ApplyWorkspaces(ts, w, wb)
if d := cmp.Diff(got, want); d != "" {
t.Errorf("ApplyParameters() got diff %s", d)
t.Errorf("TestApplyWorkspaces() got diff %s", d)
}
}

func TestTaskResults(t *testing.T) {
names.TestingSeed()
ts := &v1alpha1.TaskSpec{
Results: []v1alpha1.TaskResult{{
Name: "current-date-unix-timestamp",
Description: "The current date in unix timestamp format",
}, {
Name: "current-date-human-readable",
Description: "The current date in humand readable format"},
},
Steps: []v1alpha1.Step{{
Container: corev1.Container{
Name: "print-date-unix-timestamp",
Image: "bash:latest",
Args: []string{"$(results.current-date-unix-timestamp.path)"},
},
Script: "#!/usr/bin/env bash\ndate +%s | tee $(results.current-date-unix-timestamp.path)",
}, {
Container: corev1.Container{
Name: "print-date-humman-readable",
Image: "bash:latest",
},
Script: "#!/usr/bin/env bash\ndate | tee $(results.current-date-human-readable.path)",
}},
}
want := applyMutation(ts, func(spec *v1alpha1.TaskSpec) {
spec.Steps[0].Script = "#!/usr/bin/env bash\ndate +%s | tee /tekton/results/current-date-unix-timestamp"
spec.Steps[0].Args[0] = "/tekton/results/current-date-unix-timestamp"
spec.Steps[1].Script = "#!/usr/bin/env bash\ndate | tee /tekton/results/current-date-human-readable"
})
got := resources.ApplyTaskResults(ts)
if d := cmp.Diff(got, want); d != "" {
t.Errorf("ApplyTaskResults() got diff %s", d)
}
}
3 changes: 3 additions & 0 deletions pkg/reconciler/taskrun/taskrun.go
Original file line number Diff line number Diff line change
Expand Up @@ -513,6 +513,9 @@ func (c *Reconciler) createPod(tr *v1alpha1.TaskRun, rtr *resources.ResolvedTask
// Apply workspace resource substitution
ts = resources.ApplyWorkspaces(ts, ts.Workspaces, tr.Spec.Workspaces)

// Apply task result substitution
ts = resources.ApplyTaskResults(ts)

ts, err = workspace.Apply(*ts, tr.Spec.Workspaces)
if err != nil {
c.Logger.Errorf("Failed to create a pod for taskrun: %s due to workspace error %v", tr.Name, err)
Expand Down