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.

Sign up for GitHub

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

Move step and sidecar replacements to new package #5179

Merged
merged 1 commit into from
Jul 21, 2022
Merged

Move step and sidecar replacements to new package #5179

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 4 additions & 3 deletions ...ipeline/v1beta1/container_replacements.go → pkg/container/container_replacements.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,23 @@
limitations under the License.
*/

package v1beta1
package container

import (
"github.com/tektoncd/pipeline/pkg/apis/pipeline/v1beta1"
"github.com/tektoncd/pipeline/pkg/substitution"
corev1 "k8s.io/api/core/v1"
)

// applyStepReplacements returns a StepContainer with variable interpolation applied.
func applyStepReplacements(step *Step, stringReplacements map[string]string, arrayReplacements map[string][]string) {
func applyStepReplacements(step *v1beta1.Step, stringReplacements map[string]string, arrayReplacements map[string][]string) {
c := step.ToK8sContainer()
applyContainerReplacements(c, stringReplacements, arrayReplacements)
step.SetContainerFields(*c)
}

// applySidecarReplacements returns a SidecarContainer with variable interpolation applied.
func applySidecarReplacements(sidecar *Sidecar, stringReplacements map[string]string, arrayReplacements map[string][]string) {
func applySidecarReplacements(sidecar *v1beta1.Sidecar, stringReplacements map[string]string, arrayReplacements map[string][]string) {
c := sidecar.ToK8sContainer()
applyContainerReplacements(c, stringReplacements, arrayReplacements)
sidecar.SetContainerFields(*c)
Expand Down
5 changes: 3 additions & 2 deletions .../pipeline/v1beta1/sidecar_replacements.go → pkg/container/sidecar_replacements.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,15 @@
limitations under the License.
*/

package v1beta1
package container

import (
"github.com/tektoncd/pipeline/pkg/apis/pipeline/v1beta1"
"github.com/tektoncd/pipeline/pkg/substitution"
)

// ApplySidecarReplacements applies variable interpolation on a Sidecar.
func ApplySidecarReplacements(sidecar *Sidecar, stringReplacements map[string]string, arrayReplacements map[string][]string) {
func ApplySidecarReplacements(sidecar *v1beta1.Sidecar, stringReplacements map[string]string, arrayReplacements map[string][]string) {
sidecar.Script = substitution.ApplyReplacements(sidecar.Script, stringReplacements)
applySidecarReplacements(sidecar, stringReplacements, arrayReplacements)
}
5 changes: 3 additions & 2 deletions ...line/v1beta1/sidecar_replacements_test.go → pkg/container/sidecar_replacements_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,14 @@
limitations under the License.
*/

package v1beta1_test
package container_test

import (
"testing"

"github.com/google/go-cmp/cmp"
"github.com/tektoncd/pipeline/pkg/apis/pipeline/v1beta1"
"github.com/tektoncd/pipeline/pkg/container"
corev1 "k8s.io/api/core/v1"
)

Expand Down Expand Up @@ -120,7 +121,7 @@ func TestApplySidecarReplacements(t *testing.T) {
SubPath: "replaced!",
}},
}
v1beta1.ApplySidecarReplacements(&s, replacements, arrayReplacements)
container.ApplySidecarReplacements(&s, replacements, arrayReplacements)
if d := cmp.Diff(s, expected); d != "" {
t.Errorf("Container replacements failed: %s", d)
}
Expand Down
7 changes: 4 additions & 3 deletions ...pis/pipeline/v1beta1/step_replacements.go → pkg/container/step_replacements.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,15 @@
limitations under the License.
*/

package v1beta1
package container

import (
"github.com/tektoncd/pipeline/pkg/apis/pipeline/v1beta1"
"github.com/tektoncd/pipeline/pkg/substitution"
)

// ApplyStepReplacements applies variable interpolation on a Step.
func ApplyStepReplacements(step *Step, stringReplacements map[string]string, arrayReplacements map[string][]string) {
func ApplyStepReplacements(step *v1beta1.Step, stringReplacements map[string]string, arrayReplacements map[string][]string) {
step.Script = substitution.ApplyReplacements(step.Script, stringReplacements)
if step.StdoutConfig != nil {
step.StdoutConfig.Path = substitution.ApplyReplacements(step.StdoutConfig.Path, stringReplacements)
Expand All @@ -33,7 +34,7 @@ func ApplyStepReplacements(step *Step, stringReplacements map[string]string, arr
}

// ApplyStepTemplateReplacements applies variable interpolation on a StepTemplate (aka a container)
func ApplyStepTemplateReplacements(stepTemplate *StepTemplate, stringReplacements map[string]string, arrayReplacements map[string][]string) {
func ApplyStepTemplateReplacements(stepTemplate *v1beta1.StepTemplate, stringReplacements map[string]string, arrayReplacements map[string][]string) {
container := stepTemplate.ToK8sContainer()
applyContainerReplacements(container, stringReplacements, arrayReplacements)
stepTemplate.SetContainerFields(*container)
Expand Down
5 changes: 3 additions & 2 deletions ...ipeline/v1beta1/step_replacements_test.go → pkg/container/step_replacements_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,14 @@
limitations under the License.
*/

package v1beta1_test
package container_test

import (
"testing"

"github.com/google/go-cmp/cmp"
"github.com/tektoncd/pipeline/pkg/apis/pipeline/v1beta1"
"github.com/tektoncd/pipeline/pkg/container"
corev1 "k8s.io/api/core/v1"
)

Expand Down Expand Up @@ -133,7 +134,7 @@ func TestApplyStepReplacements(t *testing.T) {
Path: "/workspace/data/stderr.txt",
},
}
v1beta1.ApplyStepReplacements(&s, replacements, arrayReplacements)
container.ApplyStepReplacements(&s, replacements, arrayReplacements)
if d := cmp.Diff(s, expected); d != "" {
t.Errorf("Container replacements failed: %s", d)
}
Expand Down
11 changes: 6 additions & 5 deletions pkg/reconciler/taskrun/resources/apply.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ import (
"github.com/tektoncd/pipeline/pkg/apis/config"
"github.com/tektoncd/pipeline/pkg/apis/pipeline"
"github.com/tektoncd/pipeline/pkg/apis/pipeline/v1beta1"
"github.com/tektoncd/pipeline/pkg/container"
"github.com/tektoncd/pipeline/pkg/pod"
"github.com/tektoncd/pipeline/pkg/substitution"
)
Expand Down Expand Up @@ -202,7 +203,7 @@ func applyWorkspaceMountPath(variable string, spec *v1beta1.TaskSpec, declaratio
for _, usage := range step.Workspaces {
if usage.Name == declaration.Name && usage.MountPath != "" {
stringReplacements[variable] = usage.MountPath
v1beta1.ApplyStepReplacements(step, stringReplacements, emptyArrayReplacements)
container.ApplyStepReplacements(step, stringReplacements, emptyArrayReplacements)
}
}
}
Expand All @@ -212,7 +213,7 @@ func applyWorkspaceMountPath(variable string, spec *v1beta1.TaskSpec, declaratio
for _, usage := range sidecar.Workspaces {
if usage.Name == declaration.Name && usage.MountPath != "" {
stringReplacements[variable] = usage.MountPath
v1beta1.ApplySidecarReplacements(sidecar, stringReplacements, emptyArrayReplacements)
container.ApplySidecarReplacements(sidecar, stringReplacements, emptyArrayReplacements)
}
}
}
Expand Down Expand Up @@ -269,12 +270,12 @@ func ApplyReplacements(spec *v1beta1.TaskSpec, stringReplacements map[string]str
// Apply variable expansion to steps fields.
steps := spec.Steps
for i := range steps {
v1beta1.ApplyStepReplacements(&steps[i], stringReplacements, arrayReplacements)
container.ApplyStepReplacements(&steps[i], stringReplacements, arrayReplacements)
}

// Apply variable expansion to stepTemplate fields.
if spec.StepTemplate != nil {
v1beta1.ApplyStepTemplateReplacements(spec.StepTemplate, stringReplacements, arrayReplacements)
container.ApplyStepTemplateReplacements(spec.StepTemplate, stringReplacements, arrayReplacements)
}

// Apply variable expansion to the build's volumes
Expand Down Expand Up @@ -329,7 +330,7 @@ func ApplyReplacements(spec *v1beta1.TaskSpec, stringReplacements map[string]str
// Apply variable substitution to the sidecar definitions
sidecars := spec.Sidecars
for i := range sidecars {
v1beta1.ApplySidecarReplacements(&sidecars[i], stringReplacements, arrayReplacements)
container.ApplySidecarReplacements(&sidecars[i], stringReplacements, arrayReplacements)
}

return spec
Expand Down