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

fix 5569 pipelinerun hang on Unknown status due to duplicated task parameters #5575

Merged

Conversation

chengjoey
Copy link
Member

@chengjoey chengjoey commented Sep 28, 2022

Changes

fix pipelinerun hang on Unknown status when duplicated params definded in PipelienTask

Fix #5569

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

Fix PipelineRun hang on Unknown status when duplicated params are defined in a PipelineTask

@tekton-robot tekton-robot added the do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. label Sep 28, 2022
@tekton-robot tekton-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Sep 28, 2022
@tekton-robot
Copy link
Collaborator

Hi @chengjoey. 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 tekton-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Sep 28, 2022
@chengjoey
Copy link
Member Author

/kind bug

@tekton-robot tekton-robot added the kind/bug Categorizes issue or PR as related to a bug. label Sep 28, 2022
@dibyom
Copy link
Member

dibyom commented Sep 28, 2022

/ok-to-test

@tekton-robot 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 Sep 28, 2022
@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/v1beta1/param_types.go 98.2% 98.2% 0.1

@chengjoey
Copy link
Member Author

/retest

@chengjoey chengjoey force-pushed the fix/pipelinerun-hang-on-unknown-status branch from 9e38370 to 38e61c8 Compare September 29, 2022 14:12
@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/v1beta1/param_types.go 98.2% 98.2% 0.1

@chengjoey chengjoey force-pushed the fix/pipelinerun-hang-on-unknown-status branch from 38e61c8 to ab60ee6 Compare September 29, 2022 14:59
@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/v1beta1/param_types.go 98.2% 98.2% 0.1

@tekton-robot tekton-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. and removed do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels Sep 29, 2022
@abayer
Copy link
Contributor

abayer commented Sep 29, 2022

Looks good so far - could you make these changes in pkg/apis/pipeline/v1 as well, please?

@chengjoey chengjoey force-pushed the fix/pipelinerun-hang-on-unknown-status branch from ab60ee6 to b736e9a Compare September 30, 2022 01:37
@tekton-robot tekton-robot added needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Sep 30, 2022
@chengjoey chengjoey force-pushed the fix/pipelinerun-hang-on-unknown-status branch from b736e9a to a9bd43d Compare September 30, 2022 01:44
@tekton-robot tekton-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Sep 30, 2022
@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/param_types.go 98.2% 98.3% 0.1
pkg/apis/pipeline/v1beta1/param_types.go 98.2% 98.2% 0.1

@chengjoey
Copy link
Member Author

Looks good so far - could you make these changes in pkg/apis/pipeline/v1 as well, please?

thanks for your mentions, i've made these change in pkg/apis/pipeline/v1

@chengjoey chengjoey force-pushed the fix/pipelinerun-hang-on-unknown-status branch from a9bd43d to bfb6cff Compare September 30, 2022 03:08
@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/param_types.go 98.2% 98.3% 0.1
pkg/apis/pipeline/v1beta1/param_types.go 98.2% 98.2% 0.1

}, {
Name: "duplicate-param", Value: ParamValue{Type: ParamTypeString, StringVal: "val2"},
}},
}},
Copy link
Member

Choose a reason for hiding this comment

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

So let's say I add one more param with the same name duplicate-param. It fails with:

expected exactly one, got both: [0][1].name, [0][2].name",

This is misleading, ErrMultipleOneOf might not be the best fit here. We can add a generic error saying:

params names must be unique, the same param \""+param.Name+"\" is defined multiple times at: <a list of indexes>

Copy link
Member Author

Choose a reason for hiding this comment

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

thanks @pritidesai , I think your suggestion is clearer to the user
i change the error to params names must be unique, the same param: duplicate-param is defined multiple times at: [0].params[1].name, [0].params[2].name
do you think this is okay

@chengjoey chengjoey force-pushed the fix/pipelinerun-hang-on-unknown-status branch from bfb6cff to eda03b5 Compare September 30, 2022 06:48
@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/param_types.go 98.2% 98.3% 0.1
pkg/apis/pipeline/v1beta1/param_types.go 98.2% 98.2% 0.1

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 @chengjoey 👍

@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: pritidesai

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 Sep 30, 2022
@abayer
Copy link
Contributor

abayer commented Oct 4, 2022

/test check-pr-has-kind-label

@tekton-robot
Copy link
Collaborator

@abayer: The specified target(s) for /test were not found.
The following commands are available to trigger required jobs:

  • /test pull-tekton-pipeline-alpha-integration-tests
  • /test pull-tekton-pipeline-build-tests
  • /test pull-tekton-pipeline-integration-tests
  • /test tekton-pipeline-unit-tests

The following commands are available to trigger optional jobs:

  • /test pull-tekton-pipeline-go-coverage

Use /test all to run all jobs.

In response to this:

/test check-pr-has-kind-label

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.

@abayer
Copy link
Contributor

abayer commented Oct 4, 2022

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Oct 4, 2022
@chengjoey
Copy link
Member Author

/retest

@tekton-robot tekton-robot merged commit a275e6b into tektoncd:main Oct 4, 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. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

pipelinerun hang on Unknown status when duplicated params definded in PipelienTask
5 participants