Refactor Sidecar Containers Construction If Script Exists #6619

XinruZhang · 2023-05-03T21:17:40Z

Changes

Prior to this PR, in order to reuse the code, we convert v1beta1 Sidecar object to v1beta1.Step and then construct containers out of those steps when the script field is specified.

pipeline/pkg/pod/script.go

Lines 116 to 119 in 09d422c

    
           convertedStepContainers := convertListOfSteps(steps, &placeScriptsInit, &placeScripts, breakpoints, "script") 
        
           // Pass empty breakpoint list in "sidecar step to container" converter to not rewrite the scripts and add breakpoints to sidecar 
        
           sidecarContainers := convertListOfSteps(sideCarSteps, &placeScriptsInit, &placeScripts, []string{}, "sidecar-script")

As we are switching the storage version to v1, some fields are deprecated in v1.Step (but not Sidecar), thus it does not make sense to convert sidercar to step.

While reusing as much code as possible, this PR refactors the code to seperate the container construction process for steps and sidecars.

Partially fix #6575

/kind bug

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

~~Has Docs if any changes are user facing, including updates to minimum requirements e.g. Kubernetes version bumps~~
Has Tests included if any functionality added or changed
Follows the commit message standard
Meets the Tekton contributor standards (including functionality, content, code)
Has a kind label. You can add one by adding a comment on this PR that contains /kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tep
Release notes block below has been updated with any user facing changes (API changes, bug fixes, changes requiring upgrade notices or deprecation warnings). See some examples of good release notes.
Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

NONE

XinruZhang · 2023-05-03T21:19:28Z

cc @dibyom @lbernick

lbernick

thanks Xinru! Do we have test coverage for when both the step and sidecar have scripts, when both have debug breakpoints set, and sidecars with readiness probes/liveness probes or other fields that steps don't have?

pkg/pod/script.go

XinruZhang · 2023-05-04T15:18:31Z

Thank you for the review @lbernick, one thing I'd love to confirm is, do breakpoints apply to sidecars? Asking because I noticed perviously when building containers for sidecars, the breakpoint parameter is an empty string array 🤔

pipeline/pkg/pod/script.go

Line 119 in 09d422c

    
           sidecarContainers := convertListOfSteps(sideCarSteps, &placeScriptsInit, &placeScripts, []string{}, "sidecar-script")

lbernick · 2023-05-04T15:28:54Z

Thank you for the review @lbernick, one thing I'd love to confirm is, do breakpoints apply to sidecars? Asking because I noticed perviously when building containers for sidecars, the breakpoint parameter is an empty string array 🤔

pipeline/pkg/pod/script.go

Line 119 in 09d422c

sidecarContainers := convertListOfSteps(sideCarSteps, &placeScriptsInit, &placeScripts, []string{}, "sidecar-script")

good point, probably not! I don't see any mention of sidecars in https://github.com/tektoncd/community/blob/main/teps/0097-breakpoints-for-taskruns-and-pipelineruns.md or https://github.com/tektoncd/community/blob/main/teps/0042-taskrun-breakpoint-on-failure.md and it's probably not something that would be useful anyway.

tekton-robot · 2023-05-04T16:26:49Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/pod/script.go	100.0%	98.9%	-1.1

tekton-robot · 2023-05-04T16:29:03Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/pod/script.go	100.0%	98.9%	-1.1

tekton-robot · 2023-05-04T16:41:57Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/pod/script.go	100.0%	98.9%	-1.1

tekton-robot · 2023-05-04T16:43:23Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/pod/script.go	100.0%	98.9%	-1.1

pkg/pod/script_test.go

pkg/pod/script.go

tekton-robot · 2023-05-04T18:53:15Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/pod/script.go	100.0%	99.0%	-1.0

pkg/pod/script.go

tekton-robot · 2023-05-04T18:54:45Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lbernick

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [lbernick]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

tekton-robot · 2023-05-04T18:55:55Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/pod/script.go	100.0%	99.0%	-1.0

tekton-robot · 2023-05-04T19:12:09Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/pod/script.go	100.0%	99.0%	-1.0

tekton-robot · 2023-05-04T19:13:56Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/pod/script.go	100.0%	99.0%	-1.0

tekton-robot · 2023-05-04T19:48:37Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/pod/script.go	100.0%	99.0%	-1.0

tekton-robot · 2023-05-04T19:50:55Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/pod/script.go	100.0%	99.0%	-1.0

Yongxuanzhang

I wonder if we could rearrange the functions in the order when they are called?
e.g. maybe we could move convertListOfSteps, convertListOfSidecars and hasScripts in order after the function convertScripts. This might improve the readability?

Prior to this commit, in order to reuse the code, we convert v1beta1 Sidecar object to v1beta1.Step and then construct containers out of those steps when the script field is specified. As we are switching the storage version to v1, some fields are deprecated in v1.Step (but not Sidecar), thus it does not make sense to convert sidercar to step. While reusing as much code as possible, this commit refactor the code to seperate the container construction process for steps and sidecars.

XinruZhang · 2023-05-04T23:12:40Z

I wonder if we could rearrange the functions in the order when they are called? e.g. maybe we could move convertListOfSteps, convertListOfSidecars and hasScripts in order after the function convertScripts. This might improve the readability?

Thank you @Yongxuanzhang. Good idea! Updated.

tekton-robot · 2023-05-04T23:18:50Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/pod/script.go	100.0%	99.0%	-1.0

tekton-robot · 2023-05-04T23:19:20Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/pod/script.go	100.0%	99.0%	-1.0

XinruZhang · 2023-05-05T00:05:52Z

Not sure why "Setup metallb" failed.

Copied from build-log.txt:

metallb-system               pod/controller-7696f658c8-cjgsp                          0/1     ImagePullBackOff   0             33m
metallb-system               pod/speaker-85tzb                                        0/1     ImagePullBackOff   0             33m
metallb-system               pod/speaker-9s9r5                                        0/1     ImagePullBackOff   0             33m
metallb-system               pod/speaker-ptbr4                                        0/1     ImagePullBackOff   0             33m

Since this seems unrelated to this change itself, retesting to see if it will pass.

/retest

lbernick · 2023-05-05T13:28:10Z

@XinruZhang it looks like it's an issue with TestPipelineRunTasksTimeout; I created #6624

Yongxuanzhang

/lgtm

Yongxuanzhang

/lgtm

tekton-robot added release-note-none Denotes a PR that doesnt merit a release note. kind/bug Categorizes issue or PR as related to a bug. labels May 3, 2023

tekton-robot requested review from bobcatfish and vdemeester May 3, 2023 21:17

tekton-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label May 3, 2023

lbernick self-assigned this May 3, 2023

XinruZhang force-pushed the 6575-01 branch 2 times, most recently from 5216a55 to 8256fcd Compare May 4, 2023 00:13

lbernick reviewed May 4, 2023

View reviewed changes

pkg/pod/script.go Outdated Show resolved Hide resolved

pkg/pod/script.go Outdated Show resolved Hide resolved

pkg/pod/script.go Outdated Show resolved Hide resolved

pkg/pod/script.go Outdated Show resolved Hide resolved

pkg/pod/script.go Show resolved Hide resolved

XinruZhang force-pushed the 6575-01 branch from 8256fcd to 5c17840 Compare May 4, 2023 16:21

XinruZhang force-pushed the 6575-01 branch from 5c17840 to 2c49eee Compare May 4, 2023 16:35

lbernick reviewed May 4, 2023

View reviewed changes

pkg/pod/script_test.go Outdated Show resolved Hide resolved

pkg/pod/script_test.go Outdated Show resolved Hide resolved

pkg/pod/script.go Outdated Show resolved Hide resolved

pkg/pod/script.go Outdated Show resolved Hide resolved

XinruZhang force-pushed the 6575-01 branch from 2c49eee to 7cec96b Compare May 4, 2023 18:47

lbernick approved these changes May 4, 2023

View reviewed changes

pkg/pod/script.go Outdated Show resolved Hide resolved

pkg/pod/script.go Outdated Show resolved Hide resolved

pkg/pod/script.go Outdated Show resolved Hide resolved

pkg/pod/script.go Show resolved Hide resolved

tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 4, 2023

XinruZhang force-pushed the 6575-01 branch from 7cec96b to b29d960 Compare May 4, 2023 19:06

XinruZhang force-pushed the 6575-01 branch from b29d960 to 9b82287 Compare May 4, 2023 19:43

Yongxuanzhang reviewed May 4, 2023

View reviewed changes

XinruZhang force-pushed the 6575-01 branch from 9b82287 to 9882a30 Compare May 4, 2023 23:12

Yongxuanzhang reviewed May 5, 2023

View reviewed changes

tekton-robot assigned Yongxuanzhang May 5, 2023

tekton-robot added the lgtm Indicates that a PR is ready to be merged. label May 5, 2023

Yongxuanzhang reviewed May 5, 2023

View reviewed changes

tekton-robot merged commit 77c1698 into tektoncd:main May 5, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor Sidecar Containers Construction If Script Exists #6619

Refactor Sidecar Containers Construction If Script Exists #6619

XinruZhang commented May 3, 2023 •

edited

Loading

XinruZhang commented May 3, 2023

lbernick left a comment

XinruZhang commented May 4, 2023

lbernick commented May 4, 2023

tekton-robot commented May 4, 2023

tekton-robot commented May 4, 2023

tekton-robot commented May 4, 2023

tekton-robot commented May 4, 2023

tekton-robot commented May 4, 2023

tekton-robot commented May 4, 2023

tekton-robot commented May 4, 2023

tekton-robot commented May 4, 2023

tekton-robot commented May 4, 2023

tekton-robot commented May 4, 2023

tekton-robot commented May 4, 2023

Yongxuanzhang left a comment

XinruZhang commented May 4, 2023

tekton-robot commented May 4, 2023

tekton-robot commented May 4, 2023

XinruZhang commented May 5, 2023

lbernick commented May 5, 2023

Yongxuanzhang left a comment

Yongxuanzhang left a comment

	convertedStepContainers := convertListOfSteps(steps, &placeScriptsInit, &placeScripts, breakpoints, "script")

	// Pass empty breakpoint list in "sidecar step to container" converter to not rewrite the scripts and add breakpoints to sidecar
	sidecarContainers := convertListOfSteps(sideCarSteps, &placeScriptsInit, &placeScripts, []string{}, "sidecar-script")

Refactor Sidecar Containers Construction If Script Exists #6619

Refactor Sidecar Containers Construction If Script Exists #6619

Conversation

XinruZhang commented May 3, 2023 • edited Loading

Changes

Submitter Checklist

Release Notes

XinruZhang commented May 3, 2023

lbernick left a comment

Choose a reason for hiding this comment

XinruZhang commented May 4, 2023

lbernick commented May 4, 2023

tekton-robot commented May 4, 2023

tekton-robot commented May 4, 2023

tekton-robot commented May 4, 2023

tekton-robot commented May 4, 2023

tekton-robot commented May 4, 2023

tekton-robot commented May 4, 2023

tekton-robot commented May 4, 2023

tekton-robot commented May 4, 2023

tekton-robot commented May 4, 2023

tekton-robot commented May 4, 2023

tekton-robot commented May 4, 2023

Yongxuanzhang left a comment

Choose a reason for hiding this comment

XinruZhang commented May 4, 2023

tekton-robot commented May 4, 2023

tekton-robot commented May 4, 2023

XinruZhang commented May 5, 2023

lbernick commented May 5, 2023

Yongxuanzhang left a comment

Choose a reason for hiding this comment

Yongxuanzhang left a comment

Choose a reason for hiding this comment

XinruZhang commented May 3, 2023 •

edited

Loading