✨ Return error when CRD has multiple versions marked for storage #820

lauchokyip · 2023-05-22T02:29:52Z

Continue the work from #399, which will be beneficial for this kubebuilder issue kubernetes-sigs/kubebuilder#2589 too

k8s-ci-robot · 2023-05-22T02:30:00Z

Welcome @lauchokyip!

It looks like this is your first PR to kubernetes-sigs/controller-tools 🎉. 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/controller-tools 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 · 2023-05-22T02:30:01Z

Hi @lauchokyip. Thanks for your PR.

I'm waiting for a kubernetes-sigs 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.

k8s-ci-robot · 2023-05-22T02:30:03Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: lauchokyip
Once this PR has been reviewed and has the lgtm label, please assign vincepri for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

lauchokyip · 2023-05-22T02:30:43Z

/cc @camilamacedo86

lauchokyip · 2023-05-22T02:37:44Z

/cc @estroz

vincepri · 2023-05-24T21:29:28Z

pkg/crd/spec.go

-		packages[0].AddError(fmt.Errorf("CRD for %s has no storage version", groupKind))
+		errs = append(errs, fmt.Errorf("CRD for %s has no storage version", groupKind))


why was this changed?

can we pass the package in here and use AddError as before?

@vincepri I was following this PR
https://github.com/kubernetes-sigs/controller-tools/pull/399/files#diff-05d11052b3234e4c8ce76c9362508cbd5c3f275a76ee2513240234ed879cb2b5L151-R163

Should I stick with that approach or the one you suggested? I think both should work
See the comment below

@vincepri I wouldn't recommend to pass the package into the function because it would complicate the unit test writing ( need to setup a package loader and make it harder to compare the error string. In addition to that, the package loader would throw more error if the user has not have the package installed) . I would keep the function loosely coupled by not including package. Both should achieve the some results

Please let me know what you think

vincepri · 2023-05-24T21:31:08Z

pkg/crd/spec.go

+			if hasStorage {
+				errs = append(errs, fmt.Errorf("CRD for %s has more than one storage version", groupKind))


Could we collect all the storage versions in a set and error out with information on where the storage flag is set?

@vincepri
Wondering how should the map looks like? map[bool]bool? The value we are checking are just boolean value with the same type
https://github.com/kubernetes-sigs/controller-tools/pull/820/files#diff-a205d1d131ac7079cecfe9264fd82b9c7b56f982a42b4085fc4a963734cb9c2cR101-R106

sets.New[String] should do it?

I think there is a misunderstanding here.

when you loop through different version, it would be something like v1, v2, v3, and if we put them all in the set, it would be something like set{"v1,"v2", "v3"}. Enough though the version is not duplicated, there are still possible that v1 has storageversion set and v2 has storageversion set. Storage Version is a boolean value, not a string, making it a map would be map{"v1": true,"v2": true, "v3": false}, I don't think there is a need to use a set or map.

We would only need to check if the boolean is triggered twice, that should be more than enough

Please take a look at the unit test https://github.com/kubernetes-sigs/controller-tools/pull/820/files#diff-a205d1d131ac7079cecfe9264fd82b9c7b56f982a42b4085fc4a963734cb9c2cR100 , the Version is a string and the Storage is a boolean

vincepri · 2023-05-24T21:32:41Z

/ok-to-test

k8s-triage-robot · 2024-01-19T12:57:06Z

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

Mark this PR as fresh with /remove-lifecycle stale
Close this PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-triage-robot · 2024-02-18T13:07:15Z

The Kubernetes project currently lacks enough active contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

Mark this PR as fresh with /remove-lifecycle rotten
Close this PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

k8s-triage-robot · 2024-03-19T13:50:02Z

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

Reopen this PR with /reopen
Mark this PR as fresh with /remove-lifecycle rotten
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

k8s-ci-robot · 2024-03-19T13:50:07Z

@k8s-triage-robot: Closed this PR.

In response to this:

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied

After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied

After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

Reopen this PR with /reopen

Mark this PR as fresh with /remove-lifecycle rotten

Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

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.

Return error when CRD has multiple versions marked for storage

525fa0e

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label May 22, 2023

k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label May 22, 2023

k8s-ci-robot requested review from joelanford and vincepri May 22, 2023 02:30

k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label May 22, 2023

k8s-ci-robot requested a review from camilamacedo86 May 22, 2023 02:30

k8s-ci-robot requested a review from estroz May 22, 2023 02:37

vincepri reviewed May 24, 2023

View reviewed changes

k8s-ci-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 May 24, 2023

lauchokyip requested a review from vincepri May 31, 2023 02:44

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jan 19, 2024

k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Feb 18, 2024

k8s-ci-robot closed this Mar 19, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✨ Return error when CRD has multiple versions marked for storage #820

✨ Return error when CRD has multiple versions marked for storage #820

lauchokyip commented May 22, 2023

k8s-ci-robot commented May 22, 2023

k8s-ci-robot commented May 22, 2023

k8s-ci-robot commented May 22, 2023

lauchokyip commented May 22, 2023

lauchokyip commented May 22, 2023

vincepri May 24, 2023

vincepri May 24, 2023

lauchokyip May 25, 2023 •

edited

lauchokyip Jun 1, 2023 •

edited

vincepri May 24, 2023

lauchokyip May 25, 2023

vincepri May 31, 2023

lauchokyip Jun 1, 2023 •

edited

vincepri commented May 24, 2023

k8s-triage-robot commented Jan 19, 2024

k8s-triage-robot commented Feb 18, 2024

k8s-triage-robot commented Mar 19, 2024

k8s-ci-robot commented Mar 19, 2024

		packages[0].AddError(fmt.Errorf("CRD for %s has no storage version", groupKind))
		errs = append(errs, fmt.Errorf("CRD for %s has no storage version", groupKind))

		if hasStorage {
		errs = append(errs, fmt.Errorf("CRD for %s has more than one storage version", groupKind))

✨ Return error when CRD has multiple versions marked for storage #820

✨ Return error when CRD has multiple versions marked for storage #820

Conversation

lauchokyip commented May 22, 2023

k8s-ci-robot commented May 22, 2023

k8s-ci-robot commented May 22, 2023

k8s-ci-robot commented May 22, 2023

lauchokyip commented May 22, 2023

lauchokyip commented May 22, 2023

vincepri May 24, 2023

Choose a reason for hiding this comment

vincepri May 24, 2023

Choose a reason for hiding this comment

lauchokyip May 25, 2023 • edited

Choose a reason for hiding this comment

lauchokyip Jun 1, 2023 • edited

Choose a reason for hiding this comment

vincepri May 24, 2023

Choose a reason for hiding this comment

lauchokyip May 25, 2023

Choose a reason for hiding this comment

vincepri May 31, 2023

Choose a reason for hiding this comment

lauchokyip Jun 1, 2023 • edited

Choose a reason for hiding this comment

vincepri commented May 24, 2023

k8s-triage-robot commented Jan 19, 2024

k8s-triage-robot commented Feb 18, 2024

k8s-triage-robot commented Mar 19, 2024

k8s-ci-robot commented Mar 19, 2024

lauchokyip May 25, 2023 •

edited

lauchokyip Jun 1, 2023 •

edited

lauchokyip Jun 1, 2023 •

edited