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

Add custom error struct for Group/Version not found #116237

Merged
merged 1 commit into from Mar 3, 2023
Merged

Add custom error struct for Group/Version not found #116237

merged 1 commit into from Mar 3, 2023

Conversation

seans3
Copy link
Contributor

@seans3 seans3 commented Mar 3, 2023

  • Adds custom error struct GroupVersionNotFoundError for OpenAPI V3 Root, instead of current unstructured error string. Allows users of Root to more accurately and reliably check this error condition.
  • Adds unit tests to validate the error is returned in the proper situations.
  • Unit test coverage: 96.2%

/kind cleanup

NONE

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Mar 3, 2023
@k8s-ci-robot k8s-ci-robot added sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. labels Mar 3, 2023
@seans3
Copy link
Contributor Author

seans3 commented Mar 3, 2023

/sig api-machinery
/priority important-longterm

@k8s-ci-robot k8s-ci-robot added priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. and removed needs-priority Indicates a PR lacks a `priority/foo` label and requires one. labels Mar 3, 2023
@seans3
Copy link
Contributor Author

seans3 commented Mar 3, 2023

/assign @apelisse
/assign @Jefftree

apelisse
apelisse reviewed Mar 3, 2023
View reviewed changes
Copy link
Member

@apelisse apelisse left a comment

Choose a reason for hiding this comment

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

one nit, thanks
/approve
/lgtm

staging/src/k8s.io/client-go/openapi3/root.go
// Encapsulates GroupVersion not found as one of the paths
// at OpenAPI V3 endpoint.
type GroupVersionNotFoundError struct {
gv schema.GroupVersion
Copy link
Member

Choose a reason for hiding this comment

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

should this be public?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

If others outside the package want to check the type, they would have to cast to GroupVersionNotFoundError; so I think it has to be public. Unless we create and export a IsGroupVersionNotFoundError function in this package.

Copy link
Member

Choose a reason for hiding this comment

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

I wasn't referring to the type, but to the gv variable

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 3, 2023
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 7bfc6359d74e14e9b064dec7eaaed3a547025379

@seans3
Copy link
Contributor Author

seans3 commented Mar 3, 2023

/cc @yliaog

@k8s-ci-robot k8s-ci-robot requested a review from yliaog March 3, 2023 01:43
@yliaog
Copy link
Contributor

yliaog commented Mar 3, 2023

thanks for the pr

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: apelisse, seans3, yliaog

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 3, 2023
@seans3
Copy link
Contributor Author

seans3 commented Mar 3, 2023

/retest

@k8s-ci-robot k8s-ci-robot merged commit a6c7753 into kubernetes:master Mar 3, 2023
@k8s-ci-robot k8s-ci-robot added this to the v1.27 milestone Mar 3, 2023
@fedebongio
Copy link
Contributor

/triage accepted

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Mar 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@apelisse apelisse apelisse left review comments

@aojea aojea Awaiting requested review from aojea

@caesarxuchao caesarxuchao Awaiting requested review from caesarxuchao

@yliaog yliaog Awaiting requested review from yliaog

Assignees

@apelisse apelisse

@Jefftree Jefftree

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. lgtm "Looks good to me", indicates that a PR is ready to be merged. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. release-note-none Denotes a PR that doesn't merit a release note. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Milestone
v1.27
Development

Successfully merging this pull request may close these issues.

None yet
6 participants
@seans3 @k8s-ci-robot @yliaog @fedebongio @apelisse @Jefftree