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

Unscheduled Runs shouldn't be included in full status #5287

Merged

Conversation

abayer
Copy link
Contributor

@abayer abayer commented Aug 9, 2022

Changes

Fixes #5282

When removing conditions, I accidentally made GetRunsStatus not skip including custom task ResolvedPipelineTasks without Runs in the PipelineRun.Status.Runs map. This resulted in cancellation failing, because the cancellation logic tries to patch each Run or TaskRun in the PipelineRun status (either in the Runs and TaskRuns maps for full embedded status, or ChildReferences for minimal or both embedded status). Unscheduled PipelineTasks for Tasks were already properly excluded from the status map, and ChildReferences was fine either way, but due to the oversight I mentioned above, unscheduled PipelineTasks for custom tasks were included in the full embedded status map, and cancellation would error due to that.

This will need to be cherry-picked to v0.37.x and v0.38.x, since the issue was a regression.

/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

Fix cancellation of PipelineRuns with unscheduled custom tasks.

@tekton-robot tekton-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/bug Categorizes issue or PR as related to a bug. labels Aug 9, 2022
@tekton-robot tekton-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Aug 9, 2022
@abayer
Copy link
Contributor Author

abayer commented Aug 9, 2022

/assign @afrittoli

@abayer abayer added the needs-cherry-pick Indicates a PR needs to be cherry-pick to a release branch label Aug 9, 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/reconciler/pipelinerun/resources/pipelinerunstate.go 97.4% 97.8% 0.4

@abayer abayer force-pushed the unscheduled-run-shouldnt-be-in-status branch from 86bfe80 to 3a20f8b Compare August 9, 2022 11:53
@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/reconciler/pipelinerun/resources/pipelinerunstate.go 97.4% 97.8% 0.4

Copy link
Member

@afrittoli afrittoli left a comment

Choose a reason for hiding this comment

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

🎉

/approve

@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: afrittoli

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 Aug 9, 2022
@afrittoli
Copy link
Member

/test pull-tekton-pipeline-alpha-integration-tests

@abayer
Copy link
Contributor Author

abayer commented Aug 9, 2022

/retest

@abayer
Copy link
Contributor Author

abayer commented Aug 9, 2022

cc @tektoncd/core-maintainers - we're going to be cherry-picking this back to 0.37 and 0.38, so an lgtm would be much appreciated. =)

@abayer abayer force-pushed the unscheduled-run-shouldnt-be-in-status branch from 3a20f8b to 8cdf1e7 Compare August 9, 2022 13: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/reconciler/pipelinerun/resources/pipelinerunstate.go 97.4% 97.8% 0.4

Fixes tektoncd#5282

When removing conditions, I accidentally made `GetRunsStatus` not skip including custom task `ResolvedPipelineTask`s without `Run`s in the `PipelineRun.Status.Runs` map. This resulted in cancellation failing, because the cancellation logic tries to patch each `Run` or `TaskRun` in the `PipelineRun` status (either in the `Runs` and `TaskRuns` maps for full embedded status, or `ChildReferences` for minimal or both embedded status). Unscheduled `PipelineTask`s for `Task`s were already properly excluded from the status map, and `ChildReferences` was fine either way, but due to the oversight I mentioned above, unscheduled `PipelineTask`s for custom tasks _were_ included in the full embedded status map, and cancellation would error due to that.

Signed-off-by: Andrew Bayer <[email protected]>
@abayer abayer force-pushed the unscheduled-run-shouldnt-be-in-status branch from 8cdf1e7 to 3b93c23 Compare August 9, 2022 14:44
@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/reconciler/pipelinerun/resources/pipelinerunstate.go 97.4% 97.8% 0.4

@afrittoli afrittoli added this to the Pipelines v0.39 milestone Aug 9, 2022
@@ -2381,6 +2381,15 @@ spec:
}},
TaskRef: &v1beta1.TaskRef{Name: "unit-test-task"},
}
unscheduledPipelineTask := v1beta1.PipelineTask{
Name: "unit-test-2",
WhenExpressions: []v1beta1.WhenExpression{{
Copy link
Member

Choose a reason for hiding this comment

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

What is the significance of whenExpression in the test?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

None - I just copy-pasted the task above.

Copy link
Member

Choose a reason for hiding this comment

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

will be great to avoid such copy/paste specially given that it does not bring any value to the test, thanks 🙏

@pritidesai
Copy link
Member

thanks @abayer 👍

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Aug 9, 2022
@tekton-robot tekton-robot merged commit ef73cfe into tektoncd:main Aug 9, 2022
abayer added a commit to abayer/tektoncd-pipeline that referenced this pull request Aug 9, 2022
Fixes tektoncd#5282

When removing conditions, I accidentally made `GetRunsStatus` not skip including custom task `ResolvedPipelineTask`s without `Run`s in the `PipelineRun.Status.Runs` map. This resulted in cancellation failing, because the cancellation logic tries to patch each `Run` or `TaskRun` in the `PipelineRun` status (either in the `Runs` and `TaskRuns` maps for full embedded status, or `ChildReferences` for minimal or both embedded status). Unscheduled `PipelineTask`s for `Task`s were already properly excluded from the status map, and `ChildReferences` was fine either way, but due to the oversight I mentioned above, unscheduled `PipelineTask`s for custom tasks _were_ included in the full embedded status map, and cancellation would error due to that.

cherry-picked from tektoncd#5287, with some additional modifications to child reference population for custom tasks without a `Run` which have been fixed in v0.38.x.

Signed-off-by: Andrew Bayer <[email protected]>
tekton-robot pushed a commit that referenced this pull request Aug 9, 2022
Fixes #5282

When removing conditions, I accidentally made `GetRunsStatus` not skip including custom task `ResolvedPipelineTask`s without `Run`s in the `PipelineRun.Status.Runs` map. This resulted in cancellation failing, because the cancellation logic tries to patch each `Run` or `TaskRun` in the `PipelineRun` status (either in the `Runs` and `TaskRuns` maps for full embedded status, or `ChildReferences` for minimal or both embedded status). Unscheduled `PipelineTask`s for `Task`s were already properly excluded from the status map, and `ChildReferences` was fine either way, but due to the oversight I mentioned above, unscheduled `PipelineTask`s for custom tasks _were_ included in the full embedded status map, and cancellation would error due to that.

cherry-picked from #5287, with some additional modifications to child reference population for custom tasks without a `Run` which have been fixed in v0.38.x.

Signed-off-by: Andrew Bayer <[email protected]>
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. needs-cherry-pick Indicates a PR needs to be cherry-pick to a release branch 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.

[REGRESSION] Unable to cancel pipeline run - error PipelineRunCouldntCancel reported on a pending custom task
4 participants