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

Remove enable-api-fields validation for array index replacements #6646

Merged
merged 1 commit into from
May 11, 2023

Conversation

lbernick
Copy link
Member

@lbernick lbernick commented May 11, 2023

Prior to this commit, the PipelineRun and TaskRun reconcilers checked whether "enable-api-fields" was set to "alpha" or "beta" before performing array param index replacement..
There were several problems with this logic:

  • Beta CRDs don't require "enable-api-fields" to be "beta" to use beta features.
  • This validation depends on the API version of the CRD that was created, so it belongs in the admission webhook rather than the reconciler.
  • If "enable-api-fields" was set to "stable", param replacement was skipped. This means a user could create a valid array indexing expression in a beta CRD, and the reconciler would not correctly replace this param with its value.

This commit removes this logic.
/kind bug

Submitter Checklist

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

  • n/a 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
  • n/a 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.
  • n/a Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

NONE

@tekton-robot tekton-robot added release-note-none Denotes a PR that doesnt merit a release note. kind/bug Categorizes issue or PR as related to a bug. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels May 11, 2023
Prior to this commit, the PipelineRun and TaskRun reconcilers checked whether "enable-api-fields" was set to "alpha" or "beta" before performing array param index replacement..
There were several problems with this logic:
- Beta CRDs don't require "enable-api-fields" to be "beta" to use beta features.
- This validation depends on the API version of the CRD that was created, so it belongs in the admission webhook rather than the reconciler.
- If "enable-api-fields" was set to "stable", param replacement was skipped. This means a user could create a valid array indexing expression in a beta CRD, and the reconciler would not correctly replace this param with its value.
@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/apply.go 98.1% 98.1% -0.0
pkg/reconciler/taskrun/resources/apply.go 99.2% 99.2% -0.0

@lbernick lbernick changed the title Remove enable-api-fields validation for array index bounds checking Remove enable-api-fields validation for array index replacements May 11, 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/reconciler/pipelinerun/resources/apply.go 98.1% 98.1% -0.0
pkg/reconciler/taskrun/resources/apply.go 99.2% 99.2% -0.0

@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/apply.go 98.1% 98.1% -0.0
pkg/reconciler/taskrun/resources/apply.go 99.2% 99.2% -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/reconciler/pipelinerun/resources/apply.go 98.1% 98.1% -0.0
pkg/reconciler/taskrun/resources/apply.go 99.2% 99.2% -0.0

@Yongxuanzhang
Copy link
Member

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label May 11, 2023
@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dibyom

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 11, 2023
@tekton-robot tekton-robot merged commit a4c80dc into tektoncd:main May 11, 2023
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-none Denotes a PR that doesnt merit a release note. 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.

5 participants