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.

Sign up for GitHub

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

Jump to bottom

Refactor validation functions for indexing into array params #6642

Merged
merged 1 commit into from
May 10, 2023
Merged

Refactor validation functions for indexing into array params #6642

merged 1 commit into from
May 10, 2023

Conversation

lbernick
Copy link
Member

@lbernick lbernick commented May 9, 2023 •
edited
Loading

This commit refactors validation functions for Tasks and Pipelines that index into array params by creating helper functions for getting all indexing references to array params in Task and Pipeline specs. No functional changes expected from this commit.

Refactoring to split out non-functional changes from #6617.

/kind cleanup

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/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. labels May 9, 2023
@tekton-robot tekton-robot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label May 9, 2023
@lbernick lbernick mentioned this pull request May 9, 2023
Merged
4 tasks
@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/pipeline_validation.go 99.4% 99.4% 0.0
pkg/apis/pipeline/v1/task_validation.go 96.9% 97.0% 0.0
pkg/apis/pipeline/v1beta1/pipeline_validation.go 99.4% 99.4% 0.0
pkg/apis/pipeline/v1beta1/task_validation.go 97.3% 97.3% 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/apis/pipeline/v1/pipeline_validation.go 99.4% 99.4% 0.0
pkg/apis/pipeline/v1/task_validation.go 96.9% 97.0% 0.0
pkg/apis/pipeline/v1beta1/pipeline_validation.go 99.4% 99.4% 0.0
pkg/apis/pipeline/v1beta1/task_validation.go 97.3% 97.3% 0.0

@lbernick
Refactor validation functions for indexing into array params
1bf22f1 
This commit refactors validation functions for Tasks and Pipelines
that index into array params by creating helper functions for getting all indexing
references to array params in Task and Pipeline specs.
No functional changes expected from this commit.
@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/pipeline_validation.go 99.4% 99.4% 0.0
pkg/apis/pipeline/v1/task_validation.go 96.9% 97.0% 0.0
pkg/apis/pipeline/v1beta1/pipeline_validation.go 99.4% 99.4% 0.0
pkg/apis/pipeline/v1beta1/task_validation.go 97.3% 97.3% 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/apis/pipeline/v1/pipeline_validation.go 99.4% 99.4% 0.0
pkg/apis/pipeline/v1/task_validation.go 96.9% 97.0% 0.0
pkg/apis/pipeline/v1beta1/pipeline_validation.go 99.4% 99.4% 0.0
pkg/apis/pipeline/v1beta1/task_validation.go 97.3% 97.3% 0.0

jerop
jerop reviewed May 10, 2023
View reviewed changes
pkg/apis/pipeline/v1/pipeline_validation.go
// from parameters, workspaces, and when expressions defined in the Pipeline's Tasks and Finally Tasks.
// For example, if a Task in the Pipeline has a parameter with a value "$(params.array-param-name[1])",
// this would be one of the strings returned.
func (ps *PipelineSpec) GetIndexingReferencesToArrayParams() sets.String {
Copy link
Member

Choose a reason for hiding this comment

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

is there a reason why this function is exported?

Copy link
Member Author

Choose a reason for hiding this comment

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

These exported functions are used in the reconciler in #6617. I would un-export them for this PR, but some of the task validation tests use package v1_test, and I don't think it's worth it to change the package name and un-export these functions only to export them in the follow-up PR. it's not a perfect split, but I'm just trying to chip away at 6617 as much as possible.

Copy link
Member

@jerop jerop May 10, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

ah good to know it is (or will be) used in the reconciler, sgtm

@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jerop

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 10, 2023
Yongxuanzhang
Yongxuanzhang reviewed May 10, 2023
View reviewed changes
Copy link
Member

@Yongxuanzhang Yongxuanzhang left a comment

Choose a reason for hiding this comment

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

Thanks!
/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label May 10, 2023
@lbernick lbernick closed this May 10, 2023
@lbernick lbernick reopened this May 10, 2023
@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/pipeline_validation.go 99.4% 99.4% 0.0
pkg/apis/pipeline/v1/task_validation.go 96.9% 97.0% 0.0
pkg/apis/pipeline/v1beta1/pipeline_validation.go 99.4% 99.4% 0.0
pkg/apis/pipeline/v1beta1/task_validation.go 97.3% 97.3% 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/apis/pipeline/v1/pipeline_validation.go 99.4% 99.4% 0.0
pkg/apis/pipeline/v1/task_validation.go 96.9% 97.0% 0.0
pkg/apis/pipeline/v1beta1/pipeline_validation.go 99.4% 99.4% 0.0
pkg/apis/pipeline/v1beta1/task_validation.go 97.3% 97.3% 0.0

@lbernick
Copy link
Member Author

flake: TestExamples/v1/taskruns/authenticating-git-commands
/retest

@tekton-robot tekton-robot merged commit e825816 into tektoncd:main May 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Yongxuanzhang Yongxuanzhang Yongxuanzhang left review comments

@jerop jerop jerop approved these changes

@pritidesai pritidesai Awaiting requested review from pritidesai

Assignees

@jerop jerop

@Yongxuanzhang Yongxuanzhang

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. lgtm Indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesnt merit a release note. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@lbernick @tekton-robot @jerop @Yongxuanzhang