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

Return the error that ReadDir returns in localSchemasClient.Paths #78

Merged
merged 1 commit into from
Nov 16, 2023
Merged

Return the error that ReadDir returns in localSchemasClient.Paths #78

merged 1 commit into from
Nov 16, 2023

Conversation

hiroyaonoe
Copy link
Contributor

@hiroyaonoe hiroyaonoe commented Nov 3, 2023 •
edited

Fixes #75

If ReadDir returns an error except for fs.ErrNotExist, localSchemasClient.Paths returns the error with an additional message.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Nov 3, 2023
@k8s-ci-robot
Copy link
Contributor

Welcome @hiroyaonoe!

It looks like this is your first PR to kubernetes-sigs/kubectl-validate 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/kubectl-validate has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Nov 3, 2023
eddycharly
eddycharly reviewed Nov 9, 2023
View reviewed changes
pkg/openapiclient/local_schemas.go
@@ -32,7 +32,10 @@ func (k *localSchemasClient) Paths() (map[string]openapi.GroupVersion, error) {
return nil, nil
}
res := map[string]openapi.GroupVersion{}
apiGroups, _ := utils.ReadDir(k.fs, filepath.Join(k.dir, "apis"))
apiGroups, err := utils.ReadDir(k.fs, filepath.Join(k.dir, "apis"))
Copy link
Contributor

Choose a reason for hiding this comment

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

The apis folder is allowed to not exist, we should return an error only if the folder exists AND there was an error reading it.

eddycharly
eddycharly reviewed Nov 9, 2023
View reviewed changes
pkg/openapiclient/local_schemas.go
@@ -48,7 +51,10 @@ func (k *localSchemasClient) Paths() (map[string]openapi.GroupVersion, error) {
res[path] = groupversion.NewForFile(k.fs, filepath.Join(groupPath, v.Name()))
}
}
coregroup, _ := utils.ReadDir(k.fs, filepath.Join(k.dir, "api"))
coregroup, err := utils.ReadDir(k.fs, filepath.Join(k.dir, "api"))
Copy link
Contributor

Choose a reason for hiding this comment

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

The api folder is allowed to not exist, we should return an error only if the folder exists AND there was an error reading it.

@hiroyaonoe
Copy link
Contributor Author

Thanks for your review.
I excluded fs.ErrNotFound.

@eddycharly
Copy link
Contributor

Thanks @hiroyaonoe can you add unit tests ?

@hiroyaonoe
Copy link
Contributor Author

I added a unit test for the case where it is not a directory.
The ErrNotExist case is already tested in invalid {dir, fs} test cases.
I can test for permission-denied cases by setting the directory permission to r--, but it was difficult to manage in git, so I didn't add the case.

@alexzielenski
Copy link
Contributor

Thanks @hiroyaonoe and @eddycharly !

/lgtm
/approve

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

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: alexzielenski, hiroyaonoe

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 Nov 16, 2023
@k8s-ci-robot k8s-ci-robot merged commit eacad4b into kubernetes-sigs:main Nov 16, 2023
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@eddycharly eddycharly eddycharly left review comments

@alexzielenski alexzielenski Awaiting requested review from alexzielenski

@richabanker richabanker Awaiting requested review from richabanker

Assignees

@alexzielenski alexzielenski

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. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Improve error handling in localSchemasClient
4 participants
@hiroyaonoe @k8s-ci-robot @eddycharly @alexzielenski