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

Validate PullRequest resource secrets fields #2378

Conversation

adshmh
Copy link
Contributor

@adshmh adshmh commented Apr 13, 2020

Changes

A PullRequest type pipeline resource is now validated: an unrecognised
'fieldName' in secrets will trigger an error.

As stated in #1818, this will help improve the debuggability of the
PullRequst pipeline resource, as the validatiob will cause a failure in
response to invalid input as early as possible.

Submitter Checklist

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

See the contribution guide for more details.

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

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

Specifying a value other than `authToken` in the `fieldName` field of `secrets` in a PullRequest resource will cause a validation failure, preventing the PullRequest resource from being created. 

@googlebot googlebot added the cla: yes Trying to make the CLA bot happy with ppl from different companies work on one commit label Apr 13, 2020
@tekton-robot tekton-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Apr 13, 2020
@tekton-robot
Copy link
Collaborator

Hi @adshmh. 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.

@@ -132,3 +139,15 @@ func validateURL(u, path string) *apis.FieldError {
}
return nil
}

func validatePullRequest(s *PipelineResourceSpec) *apis.FieldError {
if s.Type != PipelineResourceTypePullRequest {
Copy link

Choose a reason for hiding this comment

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

We're doing this check twice, once on line 107 and again here. Suggest removing this one.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you for the review. Fixed.

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 13, 2020
@ghost
Copy link

ghost commented Apr 13, 2020

/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 Apr 13, 2020
@tekton-robot
Copy link
Collaborator

The following is the coverage report on pkg/.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/apis/resource/v1alpha1/pipelineresource_validation.go 88.7% 88.7% 0.0

A PullRequest type pipeline resource is now validated: an unrecognised
'fieldName' in secrets will trigger an error. Part of work on tektoncd#1818

As stated in tektoncd#1818, this will help improve the debuggability of the
PullRequst pipeline resource, as the validatiob will cause a failure in
response to invalid input as early as possible.

Signed-off-by: Arash Deshmeh <adeshmeh@ca.ibm.com>
@adshmh adshmh force-pushed the 1818-improve-debuggability-of-pull-request-pipeline-resource branch from e08c92c to 9fca352 Compare April 13, 2020 11:16
@tekton-robot
Copy link
Collaborator

The following is the coverage report on pkg/.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/apis/resource/v1alpha1/pipelineresource_validation.go 88.7% 90.0% 1.3

@adshmh
Copy link
Contributor Author

adshmh commented Apr 13, 2020

/retest

@adshmh
Copy link
Contributor Author

adshmh commented Apr 13, 2020

Failing tests changed without any code changes. Look like a flake. Trying one more time.
/retest

Copy link
Member

@vdemeester vdemeester left a comment

Choose a reason for hiding this comment

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

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Apr 14, 2020
@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sbwsg, vdemeester

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 merged commit 35fbdaa into tektoncd:master Apr 14, 2020
@afrittoli afrittoli added the kind/misc Categorizes issue or PR as a miscellaneuous one. label Apr 30, 2020
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. cla: yes Trying to make the CLA bot happy with ppl from different companies work on one commit kind/misc Categorizes issue or PR as a miscellaneuous one. 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. 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