-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
🐛 Fix namespaced GVK check to use version #2875
Merged
k8s-ci-robot
merged 2 commits into
kubernetes-sigs:main
from
griffindvs:gcd/version-load-restmapper
Jul 7, 2024
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,188 @@ | ||
/* | ||
Copyright 2024 The Kubernetes Authors. | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
|
||
http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
*/ | ||
|
||
package apiutil_test | ||
|
||
import ( | ||
"context" | ||
"testing" | ||
|
||
gmg "github.com/onsi/gomega" | ||
apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1" | ||
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
"k8s.io/apimachinery/pkg/runtime/schema" | ||
"k8s.io/client-go/discovery" | ||
"k8s.io/client-go/kubernetes/scheme" | ||
"k8s.io/client-go/rest" | ||
"sigs.k8s.io/controller-runtime/pkg/client" | ||
"sigs.k8s.io/controller-runtime/pkg/client/apiutil" | ||
) | ||
|
||
func TestApiMachinery(t *testing.T) { | ||
restCfg, tearDownFn := setupEnvtest(t) | ||
defer tearDownFn(t) | ||
|
||
// Details of the GVK registered at initialization. | ||
initialGvk := metav1.GroupVersionKind{ | ||
Group: "crew.example.com", | ||
Version: "v1", | ||
Kind: "Driver", | ||
} | ||
|
||
// A set of GVKs to register at runtime with varying properties. | ||
runtimeGvks := []struct { | ||
name string | ||
gvk metav1.GroupVersionKind | ||
plural string | ||
}{ | ||
{ | ||
name: "new Kind and Version added to existing Group", | ||
gvk: metav1.GroupVersionKind{ | ||
Group: "crew.example.com", | ||
Version: "v1alpha1", | ||
Kind: "Passenger", | ||
}, | ||
plural: "passengers", | ||
}, | ||
{ | ||
name: "new Kind added to existing Group and Version", | ||
gvk: metav1.GroupVersionKind{ | ||
Group: "crew.example.com", | ||
Version: "v1", | ||
Kind: "Garage", | ||
}, | ||
plural: "garages", | ||
}, | ||
{ | ||
name: "new GVK", | ||
gvk: metav1.GroupVersionKind{ | ||
Group: "inventory.example.com", | ||
Version: "v1", | ||
Kind: "Taxi", | ||
}, | ||
plural: "taxis", | ||
}, | ||
} | ||
|
||
t.Run("IsGVKNamespaced should report scope for GVK registered at initialization", func(t *testing.T) { | ||
g := gmg.NewWithT(t) | ||
|
||
httpClient, err := rest.HTTPClientFor(restCfg) | ||
g.Expect(err).NotTo(gmg.HaveOccurred()) | ||
|
||
lazyRestMapper, err := apiutil.NewDynamicRESTMapper(restCfg, httpClient) | ||
g.Expect(err).NotTo(gmg.HaveOccurred()) | ||
|
||
s := scheme.Scheme | ||
err = apiextensionsv1.AddToScheme(s) | ||
g.Expect(err).NotTo(gmg.HaveOccurred()) | ||
|
||
// Query the scope of a GVK that was registered at initialization. | ||
scope, err := apiutil.IsGVKNamespaced( | ||
schema.GroupVersionKind(initialGvk), | ||
lazyRestMapper, | ||
) | ||
g.Expect(err).NotTo(gmg.HaveOccurred()) | ||
g.Expect(scope).To(gmg.BeTrue()) | ||
}) | ||
|
||
for _, runtimeGvk := range runtimeGvks { | ||
t.Run("IsGVKNamespaced should report scope for "+runtimeGvk.name, func(t *testing.T) { | ||
g := gmg.NewWithT(t) | ||
ctx := context.Background() | ||
|
||
httpClient, err := rest.HTTPClientFor(restCfg) | ||
g.Expect(err).NotTo(gmg.HaveOccurred()) | ||
|
||
lazyRestMapper, err := apiutil.NewDynamicRESTMapper(restCfg, httpClient) | ||
g.Expect(err).NotTo(gmg.HaveOccurred()) | ||
|
||
s := scheme.Scheme | ||
err = apiextensionsv1.AddToScheme(s) | ||
g.Expect(err).NotTo(gmg.HaveOccurred()) | ||
|
||
c, err := client.New(restCfg, client.Options{Scheme: s}) | ||
g.Expect(err).NotTo(gmg.HaveOccurred()) | ||
|
||
// Run a valid query to initialize cache. | ||
scope, err := apiutil.IsGVKNamespaced( | ||
schema.GroupVersionKind(initialGvk), | ||
lazyRestMapper, | ||
) | ||
g.Expect(err).NotTo(gmg.HaveOccurred()) | ||
g.Expect(scope).To(gmg.BeTrue()) | ||
|
||
// Register a new CRD at runtime. | ||
crd := newCRD(ctx, g, c, runtimeGvk.gvk.Group, runtimeGvk.gvk.Kind, runtimeGvk.plural) | ||
version := crd.Spec.Versions[0] | ||
version.Name = runtimeGvk.gvk.Version | ||
version.Storage = true | ||
version.Served = true | ||
crd.Spec.Versions = []apiextensionsv1.CustomResourceDefinitionVersion{version} | ||
crd.Spec.Scope = apiextensionsv1.NamespaceScoped | ||
|
||
g.Expect(c.Create(ctx, crd)).To(gmg.Succeed()) | ||
t.Cleanup(func() { | ||
g.Expect(c.Delete(ctx, crd)).To(gmg.Succeed()) | ||
}) | ||
|
||
// Wait until the CRD is registered. | ||
g.Eventually(func(g gmg.Gomega) { | ||
isRegistered, err := isCrdRegistered(restCfg, runtimeGvk.gvk) | ||
g.Expect(err).NotTo(gmg.HaveOccurred()) | ||
g.Expect(isRegistered).To(gmg.BeTrue()) | ||
}).Should(gmg.Succeed(), "GVK should be available") | ||
|
||
// Query the scope of the GVK registered at runtime. | ||
scope, err = apiutil.IsGVKNamespaced( | ||
schema.GroupVersionKind(runtimeGvk.gvk), | ||
lazyRestMapper, | ||
) | ||
g.Expect(err).NotTo(gmg.HaveOccurred()) | ||
g.Expect(scope).To(gmg.BeTrue()) | ||
}) | ||
} | ||
} | ||
|
||
// Check if a slice of APIResource contains a given Kind. | ||
func kindInAPIResources(resources *metav1.APIResourceList, kind string) bool { | ||
for _, res := range resources.APIResources { | ||
if res.Kind == kind { | ||
return true | ||
} | ||
} | ||
return false | ||
} | ||
|
||
// Check if a CRD has registered with the API server using a DiscoveryClient. | ||
func isCrdRegistered(cfg *rest.Config, gvk metav1.GroupVersionKind) (bool, error) { | ||
discHTTP, err := rest.HTTPClientFor(cfg) | ||
if err != nil { | ||
return false, err | ||
} | ||
|
||
discClient, err := discovery.NewDiscoveryClientForConfigAndClient(cfg, discHTTP) | ||
if err != nil { | ||
return false, err | ||
} | ||
|
||
resources, err := discClient.ServerResourcesForGroupVersion(gvk.Group + "/" + gvk.Version) | ||
if err != nil { | ||
return false, err | ||
} | ||
|
||
return kindInAPIResources(resources, gvk.Kind), nil | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could we add a test case and the PR description reasoning as a comment above here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added a comment and four unit tests in eb03471. If we compare the results of these tests with and without the change:
Without the change (no Version included):
With the change (version included):
The test case that fails without the change mimics the linked issue where a new Kind and Version are added to a pre-existing Group.