Return error if there are multiple same name params #2817

NavidZ · 2020-06-12T19:25:12Z

Changes

Right now pipeline accepts multiple parameters with
the same name. This sometime causes the pipeline to
not finish.

This change adds a simple check and returns error
when there are multiple parameters with the same
name in the spec.params.

Fixes #2016

Submitter Checklist

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

Includes tests (if functionality changed/added)
Includes docs (if user facing)
Commit messages follow commit message best practices

See the contribution guide for more details.

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

If you are adding a new binary/image to the cmd dir, please update
the release Task to build and release this image.

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

After this change it is not allowed to have multiple parameters with the same name
within pipeline spec.

tekton-robot · 2020-06-12T19:25:28Z

Hi @NavidZ. Thanks for your PR.

I'm waiting for a tektoncd member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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 · 2020-06-12T19:25:37Z

This PR cannot be merged: expecting exactly one kind/ label

Available kind/ labels are:

kind/bug: Categorizes issue or PR as related to a bug.
kind/flake: Categorizes issue or PR as related to a flakey test
kind/cleanup: Categorizes issue or PR as related to cleaning up code, process, or technical debt.
kind/design: Categorizes issue or PR as related to design.
kind/documentation: Categorizes issue or PR as related to documentation.
kind/feature: Categorizes issue or PR as related to a new feature.
kind/misc: Categorizes issue or PR as a miscellaneuous one.

tekton-robot · 2020-06-12T19:25:47Z

This PR cannot be merged: expecting exactly one kind/ label

Available kind/ labels are:

kind/bug: Categorizes issue or PR as related to a bug.
kind/flake: Categorizes issue or PR as related to a flakey test
kind/cleanup: Categorizes issue or PR as related to cleaning up code, process, or technical debt.
kind/design: Categorizes issue or PR as related to design.
kind/documentation: Categorizes issue or PR as related to documentation.
kind/feature: Categorizes issue or PR as related to a new feature.
kind/misc: Categorizes issue or PR as a miscellaneuous one.

tekton-robot · 2020-06-12T19:25:55Z

This PR cannot be merged: expecting exactly one kind/ label

Available kind/ labels are:

kind/bug: Categorizes issue or PR as related to a bug.
kind/flake: Categorizes issue or PR as related to a flakey test
kind/cleanup: Categorizes issue or PR as related to cleaning up code, process, or technical debt.
kind/design: Categorizes issue or PR as related to design.
kind/documentation: Categorizes issue or PR as related to documentation.
kind/feature: Categorizes issue or PR as related to a new feature.
kind/misc: Categorizes issue or PR as a miscellaneuous one.

NavidZ · 2020-06-12T19:36:21Z

/kind bug

NavidZ · 2020-06-15T14:13:49Z

/assign bobcatfish

afrittoli · 2020-06-15T14:16:56Z

/ok-to-test

tekton-robot · 2020-06-15T14:19:44Z

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/v1beta1/pipeline_validation.go	96.2%	95.8%	-0.4

tekton-robot · 2020-06-15T14:36:43Z

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

tekton-robot · 2020-06-15T14:50: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/apis/pipeline/v1beta1/pipeline_validation.go	96.2%	96.2%	0.0

afrittoli

Strictly speaking this is an API change, but since we never advertised the current behaviour as a valid one (we didn't event realise it was possible), I think it would be good to just go ahead with this.
Release notes are there, so
/lgtm

pritidesai · 2020-06-16T15:29:07Z

pkg/apis/pipeline/v1beta1/pipeline_validation_test.go

+ }, {
+ Name: "baz", Type: ParamTypeString, Default: &ArrayOrString{Type: ParamTypeString, StringVal: "astring"},
+ }},
+ tasks: []PipelineTask{},


can we add a single valid task such that this test confirms that the pipeline validation does not fail because of no tasks but fails because of duplicate params?

The empty task list is valid though at least in the current state. So there should be no difference between an empty list and one valid task. Considering that, if you still prefer to have a single valid task here let me know and I'll add it.

yes please, so that it isolates the tests being done 🙏

thanks for adding more tests, it now has some coverage for the error being added.

Before:

Now:

pritidesai · 2020-06-16T15:47:24Z

pkg/apis/pipeline/v1beta1/pipeline_validation.go

@@ -341,6 +341,9 @@ func validatePipelineParameterVariables(tasks []PipelineTask, params []ParamSpec
 }
 }

+ if _, ok := parameterNames[p.Name]; ok {


is it possible to add the same condition for arrayParameterNames?

Also, we are still allowing params of different types having same p.Name, i.e. baz of type string and one more param baz of type array. Since we are updating release notes, can we add the check and not permit duplicate param names with different types?

This logic catches that issue too as far as I can see since this line does execute for all params regardless of their type. I added more tests to show the effect of it and the fact that it works in that case as well. Let me know if I understood what you said correctly or if you wanted me to do something else.

yeah I see, parameterNames holds all parameters whereas arrayParameterNames is a subset of parameterNames and only holds array params. Sorry for confusion 🙏

Right now pipeline accept multiple parameters with the same name. This sometime causes the pipeline to not finish. This change adds a simple check and returns error when there are multiple parameters with the same name in the spec.params.

tekton-robot · 2020-06-16T16:24:03Z

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

pritidesai · 2020-06-16T17:16:38Z

/lgtm

tekton-robot · 2020-06-16T17:28:47Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sbwsg

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~~ [sbwsg]

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

tekton-robot requested review from bobcatfish and dibyom June 12, 2020 19:25

tekton-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jun 12, 2020

tekton-robot added the kind/bug Categorizes issue or PR as related to a bug. label Jun 12, 2020

tekton-robot assigned bobcatfish Jun 15, 2020

tekton-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jun 15, 2020

tekton-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jun 15, 2020

NavidZ force-pushed the multiple-same-params-error branch from c45eb42 to fd7ae22 Compare June 15, 2020 14:46

afrittoli reviewed Jun 15, 2020

View reviewed changes

tekton-robot assigned afrittoli Jun 15, 2020

tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Jun 15, 2020

pritidesai reviewed Jun 16, 2020

View reviewed changes

NavidZ force-pushed the multiple-same-params-error branch from fd7ae22 to c2c9a5b Compare June 16, 2020 16:12

tekton-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed lgtm Indicates that a PR is ready to be merged. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jun 16, 2020

NavidZ force-pushed the multiple-same-params-error branch from c2c9a5b to eca7ef4 Compare June 16, 2020 16:20

tekton-robot assigned pritidesai Jun 16, 2020

tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Jun 16, 2020

ghost approved these changes Jun 16, 2020

View reviewed changes

tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 16, 2020

tekton-robot merged commit 648cff3 into tektoncd:master Jun 16, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Return error if there are multiple same name params #2817

Return error if there are multiple same name params #2817

NavidZ commented Jun 12, 2020 •

edited

Loading

tekton-robot commented Jun 12, 2020

tekton-robot commented Jun 12, 2020

tekton-robot commented Jun 12, 2020

tekton-robot commented Jun 12, 2020

NavidZ commented Jun 12, 2020

NavidZ commented Jun 15, 2020

afrittoli commented Jun 15, 2020

tekton-robot commented Jun 15, 2020

tekton-robot commented Jun 15, 2020

tekton-robot commented Jun 15, 2020

afrittoli left a comment

pritidesai Jun 16, 2020

NavidZ Jun 16, 2020

pritidesai Jun 16, 2020

NavidZ Jun 16, 2020

pritidesai Jun 16, 2020

pritidesai Jun 16, 2020 •

edited

Loading

NavidZ Jun 16, 2020

pritidesai Jun 16, 2020

tekton-robot commented Jun 16, 2020

pritidesai commented Jun 16, 2020

tekton-robot commented Jun 16, 2020

Return error if there are multiple same name params #2817

Return error if there are multiple same name params #2817

Conversation

NavidZ commented Jun 12, 2020 • edited Loading

Changes

Submitter Checklist

Reviewer Notes

Release Notes

tekton-robot commented Jun 12, 2020

tekton-robot commented Jun 12, 2020

tekton-robot commented Jun 12, 2020

tekton-robot commented Jun 12, 2020

NavidZ commented Jun 12, 2020

NavidZ commented Jun 15, 2020

afrittoli commented Jun 15, 2020

tekton-robot commented Jun 15, 2020

tekton-robot commented Jun 15, 2020

tekton-robot commented Jun 15, 2020

afrittoli left a comment

Choose a reason for hiding this comment

pritidesai Jun 16, 2020

Choose a reason for hiding this comment

NavidZ Jun 16, 2020

Choose a reason for hiding this comment

pritidesai Jun 16, 2020

Choose a reason for hiding this comment

NavidZ Jun 16, 2020

Choose a reason for hiding this comment

pritidesai Jun 16, 2020

Choose a reason for hiding this comment

pritidesai Jun 16, 2020 • edited Loading

Choose a reason for hiding this comment

NavidZ Jun 16, 2020

Choose a reason for hiding this comment

pritidesai Jun 16, 2020

Choose a reason for hiding this comment

tekton-robot commented Jun 16, 2020

pritidesai commented Jun 16, 2020

tekton-robot commented Jun 16, 2020

NavidZ commented Jun 12, 2020 •

edited

Loading

pritidesai Jun 16, 2020 •

edited

Loading