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

Validate pipelineTask params usage only when explicit declaration is required #6710

Merged
merged 1 commit into from
May 24, 2023
Merged

Validate pipelineTask params usage only when explicit declaration is required #6710

merged 1 commit into from
May 24, 2023

Conversation

chitrangpatel
Copy link
Member

@chitrangpatel chitrangpatel commented May 23, 2023 •
edited
Loading

Changes

Prior to this, we validated pipeline task params when validating the complete pipeline spec.
This was ok since everything was hidden behind a config flag which was passed down.
However, with the removal of that flag in Issue #6647,
that functionally needs to be tested and fixed because the test coverage was missing for the failure cases.

This PR adds a fix and a failure test
to validate proper usage of pipeline tasks with propagated parameters as described in TEP.

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

Adds validation that parameters used in inline task specs within pipelines are declared by the pipeline.

@tekton-robot tekton-robot added release-note-none Denotes a PR that doesnt merit a release note. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. labels May 23, 2023
@tekton-robot tekton-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label May 23, 2023
@chitrangpatel chitrangpatel mentioned this pull request May 23, 2023
Merged
4 tasks
@chitrangpatel
Copy link
Member Author

/assign @lbernick

@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/v1beta1/pipeline_validation.go 99.4% 99.4% 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/v1beta1/pipeline_validation.go 99.4% 99.4% 0.0

@chitrangpatel chitrangpatel force-pushed the improve-failure-test-coverage-propagated-params branch from fda063a to eb75f96 Compare May 24, 2023 16:00
@tekton-robot tekton-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels May 24, 2023
@chitrangpatel chitrangpatel changed the title Improve failure test coverage propagated params Validate pipeline task params when validating propagated param/workspace usage May 24, 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.7% 99.7% 0.0
pkg/apis/pipeline/v1beta1/pipeline_validation.go 99.4% 99.4% 0.0

@chitrangpatel chitrangpatel changed the title Validate pipeline task params when validating propagated param/workspace usage Validate pipelineTask params usage after parameter propagation May 24, 2023
@chitrangpatel chitrangpatel changed the title Validate pipelineTask params usage after parameter propagation Validate pipelineTask params usage when explicit declaration is required May 24, 2023
@chitrangpatel chitrangpatel changed the title Validate pipelineTask params usage when explicit declaration is required Validate pipelineTask params usage only when explicit declaration is required May 24, 2023
@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/v1beta1/pipeline_validation.go 99.4% 99.4% 0.0

lbernick
lbernick reviewed May 24, 2023
View reviewed changes
Copy link
Member

@lbernick lbernick left a comment

Choose a reason for hiding this comment

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

I wouldn't consider this a cleanup PR-- I think it's a bug fix and should have a release note

pkg/apis/pipeline/v1/pipeline_validation.go Outdated Show resolved Hide resolved
@chitrangpatel
Copy link
Member Author

/kind bug

@tekton-robot tekton-robot added kind/bug Categorizes issue or PR as related to a bug. release-note Denotes a PR that will be considered when it comes time to generate release notes. and removed release-note-none Denotes a PR that doesnt merit a release note. labels May 24, 2023
@chitrangpatel chitrangpatel force-pushed the improve-failure-test-coverage-propagated-params branch from eb75f96 to 1dfbadc Compare May 24, 2023 16:54
@chitrangpatel
Copy link
Member Author

/remove-kind cleanup

@tekton-robot tekton-robot removed the kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. label May 24, 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.7% 99.7% 0.0
pkg/apis/pipeline/v1beta1/pipeline_validation.go 99.4% 99.4% 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/v1beta1/pipeline_validation.go 99.4% 99.4% 0.0

@tekton-robot
Copy link
Collaborator

[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:

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 24, 2023
@lbernick
Copy link
Member

This release note might be hard for users to understand: it's not clear what validation is being done, or what "explicit declaration required" might mean. Can you reword to be a bit more concrete? e.g. "Adds validation that parameters used in inline task specs within pipelines are declared by the pipeline"?

@Yongxuanzhang
Copy link
Member

also there is a commit "Revert "[TEP-0091] use VerificationResult in verify"", can we squash the commits to remove it?

@chitrangpatel
Improve propagated params for pipeline failure test cases
0910cbf 
Prior to this, we only had success test cases for propagated params.
This led to some hidden validation skips. This PR adds failure test
to validate proper usage of pipeline tasks with propagated parameters.
@chitrangpatel chitrangpatel force-pushed the improve-failure-test-coverage-propagated-params branch from 1dfbadc to 0910cbf Compare May 24, 2023 19:09
@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 May 24, 2023
@chitrangpatel
Copy link
Member Author

also there is a commit "Revert "[TEP-0091] use VerificationResult in verify"", can we squash the commits to remove it?

Fixed! Thanks

@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/v1beta1/pipeline_validation.go 99.4% 99.4% 0.0

Yongxuanzhang
Yongxuanzhang reviewed May 24, 2023
View reviewed changes
Copy link
Member

@Yongxuanzhang Yongxuanzhang left a comment

Choose a reason for hiding this comment

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

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label May 24, 2023
@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/v1beta1/pipeline_validation.go 99.4% 99.4% 0.0

@chitrangpatel
Copy link
Member Author

/retest

@tekton-robot tekton-robot merged commit 897c777 into tektoncd:main May 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Yongxuanzhang Yongxuanzhang Yongxuanzhang left review comments

@lbernick lbernick lbernick approved these changes

@imjasonh imjasonh Awaiting requested review from imjasonh

@jerop jerop Awaiting requested review from jerop

Assignees

@lbernick lbernick

@Yongxuanzhang Yongxuanzhang

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/bug Categorizes issue or PR as related to a bug. lgtm Indicates that a PR is ready to be merged. release-note Denotes a PR that will be considered when it comes time to generate release notes. 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
@chitrangpatel @tekton-robot @lbernick @Yongxuanzhang