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.

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

Fail validation for PipelineRun params with results in value #5350

Merged

Conversation

abayer
Copy link
Contributor

@abayer abayer commented Aug 19, 2022

Changes

fixes #5271

To prevent confusion, we should reject PipelineRun parameter values containing task result references, like $(tasks.some-task.results.someResult), since such values will not have any substitution performed on them. Additionally, we weren't doing the basic parameter validation for PipelineRuns that we have been doing for TaskRuns, namely checking for duplicate names and use of object params without alpha being set, so let's turn that on here as well.

/kind bug

Submitter Checklist

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

  • Has Docs included if any changes are user facing
  • 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)
  • Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

PipelineRuns will now fail validation for duplicate parameter names or task result references in parameter values

fixes tektoncd#5271

To prevent confusion, we should reject `PipelineRun` parameter values containing task result references, like `$(tasks.some-task.results.someResult)`, since such values will not have any substitution performed on them. Additionally, we weren't doing the basic parameter validation for `PipelineRun`s that we have been doing for `TaskRun`s, namely checking for duplicate names and use of object params without `alpha` being set, so let's turn that on here as well.

Signed-off-by: Andrew Bayer <[email protected]>
@abayer abayer added the kind/bug Categorizes issue or PR as related to a bug. label Aug 19, 2022
@tekton-robot tekton-robot added the release-note Denotes a PR that will be considered when it comes time to generate release notes. label Aug 19, 2022
@tekton-robot tekton-robot requested review from dibyom and jerop August 19, 2022 17:27
@abayer
Copy link
Contributor Author

abayer commented Aug 19, 2022

/cc @pritidesai

@tekton-robot tekton-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Aug 19, 2022
Copy link
Member

@pritidesai pritidesai left a comment

Choose a reason for hiding this comment

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

thank you @abayer for adding restriction such that pipelineRun params cannot use a task result reference as a value 👍

This will not prevent a reference to pipelineRun result but I think it should not be a concern at this point.

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 19, 2022
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

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Aug 23, 2022
@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: pritidesai, 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

@abayer
Copy link
Contributor Author

abayer commented Aug 23, 2022

/retest

@tekton-robot tekton-robot merged commit af52990 into tektoncd:main Aug 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Development

Successfully merging this pull request may close these issues.

restrict PipelineRunSpec.Params with a task result reference
4 participants