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

Jump to bottom

Add validation when applying task modifiers 🧐 #1479

Merged
merged 1 commit into from
Oct 31, 2019
Merged

Add validation when applying task modifiers 🧐 #1479

merged 1 commit into from
Oct 31, 2019

Conversation

bobcatfish
Copy link
Collaborator

Changes

Task modifiers for PipelineResources add pre and post steps and
sometimes Volumes to a pod spec. Adding a step or a volume that already
exists will create a pod that cannot run so this commit adds validation:

  • If a modifier tries to add a step that already exists (i.e. the name
    is the same) that's an error
  • If a modifier tries to add a volume that already exists but the volume
    it references is the same, we assume that two resources need the same
    volume, so it's not an error, but we only add it wonce
  • If a modifier tries to add a volume that already exists but the volume
    it references is different, that means two resources need different
    volumes but we cant add both since the names are the same, so that's
    an error

I encountered a problem with this while working on #1417 (which we
decided not to merge) where I tried to use two VolumeResources and there
was a bug where they both had the same name, so the pod was not
schedulable. I had to work backwards from the error that the pod was
invalid and thought it would be much more handy to get the error
earlier, so I added this.

Submitter Checklist

These are the criteria that every PR should meet, please check them off as you
review them:

See the contribution guide for more details.

Double check this list of stuff that's easy to miss:

Reviewer Notes

If API changes are included, additive changes must be approved by at least two OWNERS and backwards incompatible changes must be approved by more than 50% of the OWNERS, and they must first be added in a backwards compatible way.

Release Notes

If the implementation of a PipelineResource tries to add steps or volumes that already exist, execution will fail before the pod is created.

@googlebot googlebot added the cla: yes Trying to make the CLA bot happy with ppl from different companies work on one commit label Oct 25, 2019
@tekton-robot tekton-robot requested review from a user and vdemeester October 25, 2019 18:28
@tekton-robot tekton-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Oct 25, 2019
@tekton-robot
Copy link
Collaborator

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

File Old Coverage New Coverage Delta
pkg/apis/pipeline/v1alpha1/resource_types.go 11.8% 5.6% -6.2
pkg/reconciler/taskrun/resources/input_resources.go 96.0% 94.1% -1.9
pkg/reconciler/taskrun/resources/output_resource.go 92.1% 89.7% -2.4

@tekton-robot tekton-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Oct 25, 2019
@tekton-robot
Copy link
Collaborator

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

File Old Coverage New Coverage Delta
pkg/apis/pipeline/v1alpha1/resource_types.go 11.8% 75.0% 63.2
pkg/reconciler/taskrun/resources/input_resources.go 96.0% 94.1% -1.9
pkg/reconciler/taskrun/resources/output_resource.go 92.1% 89.7% -2.4

@ghost
Copy link

ghost commented Oct 25, 2019

/lgtm

@tekton-robot tekton-robot assigned ghost Oct 25, 2019
@tekton-robot tekton-robot added lgtm Indicates that a PR is ready to be merged. and removed lgtm Indicates that a PR is ready to be merged. labels Oct 25, 2019
@tekton-robot
Copy link
Collaborator

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

File Old Coverage New Coverage Delta
pkg/apis/pipeline/v1alpha1/resource_types.go 11.8% 75.0% 63.2
pkg/reconciler/taskrun/resources/input_resources.go 96.0% 94.1% -1.9
pkg/reconciler/taskrun/resources/output_resource.go 92.1% 89.7% -2.4

@bobcatfish
Copy link
Collaborator Author 

I1025 18:48:53.806] -------------------------------------------
I1025 18:48:53.807] ---- Checking go code style with gofmt ----
I1025 18:48:53.807] -------------------------------------------
I1025 18:48:55.023] diff -u pkg/apis/pipeline/v1alpha1/resource_types_test.go.orig pkg/apis/pipeline/v1alpha1/resource_types_test.go
I1025 18:48:55.023] --- pkg/apis/pipeline/v1alpha1/resource_types_test.go.orig	2019-10-25 18:48:54.735941415 +0000
I1025 18:48:55.024] +++ pkg/apis/pipeline/v1alpha1/resource_types_test.go	2019-10-25 18:48:54.735941415 +0000
I1025 18:48:55.024] @@ -141,4 +141,4 @@
I1025 18:48:55.025]  			}
I1025 18:48:55.025]  		})
I1025 18:48:55.025]  	}
I1025 18:48:55.026] -}
I1025 18:48:55.026] \ No newline at end of file
I1025 18:48:55.026] +}

image

@bobcatfish
Add validation when applying task modifiers 🧐
4540d19 
Task modifiers for PipelineResources add pre and post steps and
sometimes Volumes to a pod spec. Adding a step or a volume that already
exists will create a pod that cannot run so this commit adds validation:
- If a modifier tries to add a step that already exists (i.e. the name
  is the same) that's an error
- If a modifier tries to add a volume that already exists but the volume
  it references is the same, we assume that two resources need the same
  volume, so it's not an error, but we only add it wonce
- If a modifier tries to add a volume that already exists but the volume
  it references is different, that means two resources need different
  volumes but we cant add both since the names are the same, so that's
  an error

I encountered a problem with this while working on tektoncd#1417 (which we
decided not to merge) where I tried to use two VolumeResources and there
was a bug where they both had the same name, so the pod was not
schedulable. I had to work backwards from the error that the pod was
invalid and thought it would be much more handy to get the error
earlier, so I added this.
@tekton-robot
Copy link
Collaborator

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

File Old Coverage New Coverage Delta
pkg/apis/pipeline/v1alpha1/resource_types.go 11.8% 75.0% 63.2
pkg/reconciler/taskrun/resources/input_resources.go 96.0% 94.1% -1.9
pkg/reconciler/taskrun/resources/output_resource.go 92.1% 89.7% -2.4

@bobcatfish bobcatfish changed the title Add validtion when applying task modifiers 🧐 Add validation when applying task modifiers 🧐 Oct 25, 2019
@ghost
Copy link

ghost commented Oct 25, 2019

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Oct 25, 2019
@tekton-robot
Copy link
Collaborator

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

File Old Coverage New Coverage Delta
pkg/apis/pipeline/v1alpha1/resource_types.go 11.8% 75.0% 63.2
pkg/reconciler/taskrun/resources/input_resources.go 96.0% 94.1% -1.9
pkg/reconciler/taskrun/resources/output_resource.go 92.1% 89.7% -2.4

@bobcatfish
Copy link
Collaborator Author

👀
/test pull-tekton-pipeline-integration-tests

vdemeester
vdemeester approved these changes Oct 27, 2019
View reviewed changes
Copy link
Member

@vdemeester vdemeester left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm
/meow

@tekton-robot
Copy link
Collaborator

@vdemeester: cat image

In response to this:

/lgtm
/meow

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vdemeester

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:

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

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 27, 2019
@vdemeester
Copy link
Member

/test pull-tekton-pipeline-integration-tests

@vdemeester
Copy link
Member

/test pull-tekton-pipeline-integration-tests

@tekton-robot tekton-robot merged commit 19dcc45 into tektoncd:master Oct 31, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vdemeester vdemeester vdemeester approved these changes

Assignees

@vdemeester vdemeester

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cla: yes Trying to make the CLA bot happy with ppl from different companies work on one commit lgtm Indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@bobcatfish @tekton-robot @vdemeester @googlebot