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

Refactor validation of propagated parameters and workspaces #6660

Merged
merged 1 commit into from
May 16, 2023
Merged

Refactor validation of propagated parameters and workspaces #6660

merged 1 commit into from
May 16, 2023

Conversation

lbernick
Copy link
Member

When using propagated parameters and workspaces, params/workspaces referenced in a Task or Pipeline are not necessarily declared in that Task/Pipeline. We currently skip some validation that checks whether referenced params/workspaces are declared based on sentinel values injected into the validation context.

This commit consolidates validation logic that is gated behind this check. This refactoring will make it easier to remove these sentinel values and perform this validation only where it is supposed to happen. The only functional changes expected as a result of this commit are that we now return a multierror if multiple object parameter declarations are missing keys, instead of only returning an error for the first one.

/kind cleanup
Partially addresses #6647

Submitter Checklist

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

  • n/a Has Docs if any changes are user facing, including updates to minimum requirements e.g. Kubernetes version bumps
  • n/a 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
  • n/a 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.
  • n/a Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

NONE

@tekton-robot tekton-robot added kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. release-note-none Denotes a PR that doesnt merit a release note. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels May 15, 2023
@tekton-robot
Copy link
Collaborator

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/apis/pipeline/v1/pipeline_validation.go 99.4% 99.4% 0.0
pkg/apis/pipeline/v1/pipelinerun_validation.go 93.8% 93.9% 0.1
pkg/apis/pipeline/v1/task_validation.go 96.8% 96.9% 0.1
pkg/apis/pipeline/v1/taskrun_validation.go 97.7% 97.8% 0.0
pkg/apis/pipeline/v1beta1/pipeline_validation.go 99.4% 99.4% 0.0
pkg/apis/pipeline/v1beta1/pipelinerun_validation.go 96.8% 96.9% 0.0
pkg/apis/pipeline/v1beta1/task_validation.go 97.2% 97.3% 0.1
pkg/apis/pipeline/v1beta1/taskrun_validation.go 97.8% 97.8% 0.0

@tekton-robot
Copy link
Collaborator

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/apis/pipeline/v1/pipeline_validation.go 99.4% 99.4% 0.0
pkg/apis/pipeline/v1/pipelinerun_validation.go 93.8% 93.9% 0.1
pkg/apis/pipeline/v1/task_validation.go 96.8% 96.9% 0.1
pkg/apis/pipeline/v1/taskrun_validation.go 97.7% 97.8% 0.0
pkg/apis/pipeline/v1beta1/pipeline_validation.go 99.4% 99.4% 0.0
pkg/apis/pipeline/v1beta1/pipelinerun_validation.go 96.8% 96.9% 0.0
pkg/apis/pipeline/v1beta1/task_validation.go 97.2% 97.3% 0.1
pkg/apis/pipeline/v1beta1/taskrun_validation.go 97.8% 97.8% 0.0

@chitrangpatel
Copy link
Contributor

/retest

chitrangpatel
chitrangpatel approved these changes May 15, 2023
View reviewed changes
Copy link
Contributor

@chitrangpatel chitrangpatel left a comment

Choose a reason for hiding this comment

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

Thanks! It looks really nice! Left minor comments.

@tekton-robot
Copy link
Collaborator

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/apis/pipeline/v1/pipeline_validation.go 99.4% 99.4% 0.0
pkg/apis/pipeline/v1/pipelinerun_validation.go 93.8% 93.9% 0.1
pkg/apis/pipeline/v1/task_validation.go 96.8% 96.9% 0.1
pkg/apis/pipeline/v1/taskrun_validation.go 97.7% 97.8% 0.0
pkg/apis/pipeline/v1beta1/pipeline_validation.go 99.4% 99.4% 0.0
pkg/apis/pipeline/v1beta1/pipelinerun_validation.go 96.8% 96.9% 0.0
pkg/apis/pipeline/v1beta1/task_validation.go 97.2% 97.3% 0.1
pkg/apis/pipeline/v1beta1/taskrun_validation.go 97.8% 97.8% 0.0

@tekton-robot
Copy link
Collaborator

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/apis/pipeline/v1/pipeline_validation.go 99.4% 99.4% 0.0
pkg/apis/pipeline/v1/pipelinerun_validation.go 93.8% 93.9% 0.1
pkg/apis/pipeline/v1/task_validation.go 96.8% 96.9% 0.1
pkg/apis/pipeline/v1/taskrun_validation.go 97.7% 97.8% 0.0
pkg/apis/pipeline/v1beta1/pipeline_validation.go 99.4% 99.4% 0.0
pkg/apis/pipeline/v1beta1/pipelinerun_validation.go 96.8% 96.9% 0.0
pkg/apis/pipeline/v1beta1/task_validation.go 97.2% 97.3% 0.1
pkg/apis/pipeline/v1beta1/taskrun_validation.go 97.8% 97.8% 0.0

@pritidesai
Copy link
Member

while I am trying to understand the changes in this PR, does ValidatePipelineParameterVariables need to be under the same flag ValidateParameterVariablesAndWorkspaces?

https:/tektoncd/pipeline/pull/6660/files#diff-7ce49bf4f55e7af22bd0780d7f11c97c4fad98e7b6e0939fad1e81fc9e8e18fcR64-R65

@lbernick
Copy link
Member Author

lbernick commented May 15, 2023 •
edited
Loading

while I am trying to understand the changes in this PR, does ValidatePipelineParameterVariables need to be under the same flag ValidateParameterVariablesAndWorkspaces?

https:/tektoncd/pipeline/pull/6660/files#diff-7ce49bf4f55e7af22bd0780d7f11c97c4fad98e7b6e0939fad1e81fc9e8e18fcR64-R65

I don't think so. That function checks that the defaults provided have the type of the param declared. Since we can do this in the webhook (and it's not currently guarded by the sentinel value), no need to move it into the separate validation function that will be called in the reconciler. No functional changes intended in this PR.

@lbernick
Refactor validation of propagated parameters and workspaces
a9893c6 
When using propagated parameters and workspaces, params/workspaces
referenced in a Task or Pipeline are not necessarily declared in that
Task/Pipeline. We currently skip some validation that checks whether
referenced params/workspaces are declared based on sentinel values injected
into the validation context.

This commit consolidates validation logic that is gated behind this check.
This refactoring will make it easier to remove these sentinel values
and perform this validation only where it is supposed to happen.
The only functional changes expected as a result of this commit
are that we now return a multierror if multiple object parameter declarations
are missing keys, instead of only returning an error for the first one.
@tekton-robot
Copy link
Collaborator

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/apis/pipeline/v1/pipeline_validation.go 99.7% 99.7% 0.0
pkg/apis/pipeline/v1/pipelinerun_validation.go 93.8% 93.9% 0.1
pkg/apis/pipeline/v1/task_validation.go 97.3% 97.3% 0.1
pkg/apis/pipeline/v1/taskrun_validation.go 97.7% 97.8% 0.0
pkg/apis/pipeline/v1beta1/pipeline_validation.go 99.4% 99.4% 0.0
pkg/apis/pipeline/v1beta1/pipelinerun_validation.go 96.8% 96.9% 0.0
pkg/apis/pipeline/v1beta1/task_validation.go 97.2% 97.3% 0.1
pkg/apis/pipeline/v1beta1/taskrun_validation.go 97.8% 97.8% 0.0

@tekton-robot
Copy link
Collaborator

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/apis/pipeline/v1/pipeline_validation.go 99.7% 99.7% 0.0
pkg/apis/pipeline/v1/pipelinerun_validation.go 93.8% 93.9% 0.1
pkg/apis/pipeline/v1/task_validation.go 97.3% 97.3% 0.1
pkg/apis/pipeline/v1/taskrun_validation.go 97.7% 97.8% 0.0
pkg/apis/pipeline/v1beta1/pipeline_validation.go 99.4% 99.4% 0.0
pkg/apis/pipeline/v1beta1/pipelinerun_validation.go 96.8% 96.9% 0.0
pkg/apis/pipeline/v1beta1/task_validation.go 97.2% 97.3% 0.1
pkg/apis/pipeline/v1beta1/taskrun_validation.go 97.8% 97.8% 0.0

@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: chitrangpatel, dibyom

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 May 16, 2023
@chitrangpatel
Copy link
Contributor

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label May 16, 2023
@tekton-robot tekton-robot merged commit fd09e49 into tektoncd:main May 16, 2023
@chitrangpatel chitrangpatel mentioned this pull request Oct 23, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@chitrangpatel chitrangpatel chitrangpatel approved these changes

@dibyom dibyom dibyom approved these changes

@abayer abayer Awaiting requested review from abayer

@bobcatfish bobcatfish Awaiting requested review from bobcatfish

Assignees

@chitrangpatel chitrangpatel

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. lgtm Indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesnt merit a release note. 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.
5 participants
@lbernick @tekton-robot @chitrangpatel @pritidesai @dibyom