Files
client-go/restmapper/shortcut_test.go
Patrick Ohly 0ff074ca35 restmapper + discovery: add context-aware APIs
The main purpose is to replace context.TODO with a context provided by the
caller. A secondary purpose is to enable contextual logging.

Modifying the existing interfaces and APIs would have a big impact on the
ecosystem. This is a no-go. Instead, the following approach was taken:

- All interfaces get duplicated in a *WithContext variant where the methods
  also have a *WithContext suffix and the ctx parameter. All methods are
  treated this way except for obvious local get methods (like RESTClient)
  because it cannot be ruled out entirely that some implementation may
  need a context.

- Implementations of these interfaces implement both method variants
  which is possible because the method names are different.
  The old methods are implemented as thin wrappers around the updated
  code which is now the body of the new methods or shared helpers.
  In some cases there is additional overhead (type checks, potentially
  additional allocations) when using the old methods.

- To*WithContext helpers bridge from the old to the new interfaces. They
  try a type cast first. Because the in-tree implementations implement
  both, they can be used directly. For other implementations wrappers
  are used.

- None of old APIs and interfaces are marked as deprecated. Instead
  doc comments inform consumers about the new and better alternatives.
  This approach avoids causing turmoil in the ecosystem when linters
  pick up on a formal deprecation and developers act on those linter
  warnings without properly thinking about the implications.

  "// Contextual logging: " is used as placeholder for "//logcheck:context".
  Once all relevant consumers have been updated to the new API,
  a search/replace can enable the logcheck linter to warn about
  usage of the old API.

  Implementations also get marked this way even if probably nothing
  ever calls them directly because it shows which code, at least
  theoretically, could get removed.

- Existing unit tests do not get updated to the new APIs. This gives
  us unit test coverage of the old and new API because the old
  APIs call the new ones.

- In-tree consumers will be updated in follow-up PRs. This is likely
  to be a longer process. Because of the deprecation comment,
  `hack/golangci-lint.sh -n` can be used to find code which needs
  to be updated.

Kubernetes-commit: ab9f9f2a0e2f06d29464beb1f131190c91b6655e
2024-12-06 17:38:06 +01:00

593 lines
16 KiB
Go

/*
Copyright 2016 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 restmapper
import (
"testing"
openapi_v2 "github.com/google/gnostic-models/openapiv2"
"github.com/google/go-cmp/cmp"
"k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/api/meta"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/apimachinery/pkg/version"
"k8s.io/client-go/discovery"
"k8s.io/client-go/openapi"
restclient "k8s.io/client-go/rest"
"k8s.io/client-go/rest/fake"
"k8s.io/klog/v2/ktesting"
)
func TestReplaceAliases(t *testing.T) {
_, ctx := ktesting.NewTestContext(t)
tests := []struct {
name string
arg string
expected schema.GroupVersionResource
srvRes []*metav1.APIResourceList
}{
{
name: "storageclasses-no-replacement",
arg: "storageclasses",
expected: schema.GroupVersionResource{Resource: "storageclasses"},
srvRes: []*metav1.APIResourceList{},
},
{
name: "hpa-priority",
arg: "hpa",
expected: schema.GroupVersionResource{Resource: "superhorizontalpodautoscalers", Group: "autoscaling"},
srvRes: []*metav1.APIResourceList{
{
GroupVersion: "autoscaling/v1",
APIResources: []metav1.APIResource{
{
Name: "superhorizontalpodautoscalers",
ShortNames: []string{"hpa"},
},
},
},
{
GroupVersion: "autoscaling/v1",
APIResources: []metav1.APIResource{
{
Name: "horizontalpodautoscalers",
ShortNames: []string{"hpa"},
},
},
},
},
},
{
name: "resource-override",
arg: "dpl",
expected: schema.GroupVersionResource{Resource: "deployments", Group: "foo"},
srvRes: []*metav1.APIResourceList{
{
GroupVersion: "foo/v1",
APIResources: []metav1.APIResource{
{
Name: "deployments",
ShortNames: []string{"dpl"},
},
},
},
{
GroupVersion: "extension/v1beta1",
APIResources: []metav1.APIResource{
{
Name: "deployments",
ShortNames: []string{"deploy"},
},
},
},
},
},
{
name: "resource-match-preferred",
arg: "pods",
expected: schema.GroupVersionResource{Resource: "pods", Group: ""},
srvRes: []*metav1.APIResourceList{
{
GroupVersion: "v1",
APIResources: []metav1.APIResource{{Name: "pods", SingularName: "pod"}},
},
{
GroupVersion: "acme.com/v1",
APIResources: []metav1.APIResource{{Name: "poddlers", ShortNames: []string{"pods", "pod"}}},
},
},
},
{
name: "resource-match-singular-preferred",
arg: "pod",
expected: schema.GroupVersionResource{Resource: "pod", Group: ""},
srvRes: []*metav1.APIResourceList{
{
GroupVersion: "v1",
APIResources: []metav1.APIResource{{Name: "pods", SingularName: "pod"}},
},
{
GroupVersion: "acme.com/v1",
APIResources: []metav1.APIResource{{Name: "poddlers", ShortNames: []string{"pods", "pod"}}},
},
},
},
}
for _, test := range tests {
ds := &fakeDiscoveryClient{}
ds.serverResourcesHandler = func() ([]*metav1.APIResourceList, error) {
return test.srvRes, nil
}
mapper := NewShortcutExpander(&fakeRESTMapper{}, ds, nil).(shortcutExpander)
actual := mapper.expandResourceShortcut(ctx, schema.GroupVersionResource{Resource: test.arg})
if actual != test.expected {
t.Errorf("%s: unexpected argument: expected %s, got %s", test.name, test.expected, actual)
}
}
}
func TestKindFor(t *testing.T) {
tests := []struct {
in schema.GroupVersionResource
expected schema.GroupVersionResource
srvRes []*metav1.APIResourceList
}{
{
in: schema.GroupVersionResource{Group: "storage.k8s.io", Version: "", Resource: "sc"},
expected: schema.GroupVersionResource{Group: "storage.k8s.io", Version: "", Resource: "storageclasses"},
srvRes: []*metav1.APIResourceList{
{
GroupVersion: "storage.k8s.io/v1",
APIResources: []metav1.APIResource{
{
Name: "storageclasses",
ShortNames: []string{"sc"},
},
},
},
},
},
{
in: schema.GroupVersionResource{Group: "", Version: "", Resource: "sc"},
expected: schema.GroupVersionResource{Group: "storage.k8s.io", Version: "", Resource: "storageclasses"},
srvRes: []*metav1.APIResourceList{
{
GroupVersion: "storage.k8s.io/v1",
APIResources: []metav1.APIResource{
{
Name: "storageclasses",
ShortNames: []string{"sc"},
},
},
},
},
},
}
for i, test := range tests {
ds := &fakeDiscoveryClient{}
ds.serverResourcesHandler = func() ([]*metav1.APIResourceList, error) {
return test.srvRes, nil
}
delegate := &fakeRESTMapper{}
mapper := NewShortcutExpander(delegate, ds, func(a string) {
t.Fatalf("unexpected warning message %s", a)
})
mapper.KindFor(test.in)
if delegate.kindForInput != test.expected {
t.Errorf("%d: unexpected data returned %#v, expected %#v", i, delegate.kindForInput, test.expected)
}
}
}
func TestKindForWithNewCRDs(t *testing.T) {
tests := map[string]struct {
in schema.GroupVersionResource
expected schema.GroupVersionKind
srvRes []*metav1.APIResourceList
}{
"": {
in: schema.GroupVersionResource{Group: "a", Version: "", Resource: "sc"},
expected: schema.GroupVersionKind{Group: "a", Version: "v1", Kind: "StorageClass"},
srvRes: []*metav1.APIResourceList{
{
GroupVersion: "a/v1",
APIResources: []metav1.APIResource{
{
Name: "storageclasses",
ShortNames: []string{"sc"},
Kind: "StorageClass",
},
},
},
},
},
}
for name, test := range tests {
t.Run(name, func(t *testing.T) {
invalidateCalled := false
fakeDiscovery := &fakeDiscoveryClient{}
fakeDiscovery.serverResourcesHandler = func() ([]*metav1.APIResourceList, error) {
if invalidateCalled {
return test.srvRes, nil
}
return []*metav1.APIResourceList{}, nil
}
fakeCachedDiscovery := &fakeCachedDiscoveryClient{DiscoveryInterface: fakeDiscovery}
fakeCachedDiscovery.invalidateHandler = func() {
invalidateCalled = true
}
fakeCachedDiscovery.freshHandler = func() bool {
return invalidateCalled
}
// in real world the discovery client is fronted with a cache which
// will answer the initial request, only failure to match will trigger
// the cache invalidation and live discovery call
delegate := NewDeferredDiscoveryRESTMapper(fakeCachedDiscovery)
mapper := NewShortcutExpander(delegate, fakeCachedDiscovery, func(a string) {
t.Fatalf("unexpected warning message %s", a)
})
gvk, err := mapper.KindFor(test.in)
if err != nil {
t.Errorf("unexpected error: %v", err)
}
if diff := cmp.Equal(gvk, test.expected); !diff {
t.Errorf("unexpected data returned %#v, expected %#v", gvk, test.expected)
}
})
}
}
func TestWarnAmbigious(t *testing.T) {
_, ctx := ktesting.NewTestContext(t)
tests := []struct {
name string
arg string
expected schema.GroupVersionResource
expectedWarningLogs []string
srvRes []*metav1.APIResourceList
}{
{
name: "warn ambiguity",
arg: "hpa",
expected: schema.GroupVersionResource{Resource: "superhorizontalpodautoscalers", Group: "autoscaling"},
expectedWarningLogs: []string{`short name "hpa" could also match lower priority resource horizontalpodautoscalers.autoscaling`},
srvRes: []*metav1.APIResourceList{
{
GroupVersion: "autoscaling/v1",
APIResources: []metav1.APIResource{
{
Name: "superhorizontalpodautoscalers",
ShortNames: []string{"hpa"},
},
},
},
{
GroupVersion: "autoscaling/v1",
APIResources: []metav1.APIResource{
{
Name: "horizontalpodautoscalers",
ShortNames: []string{"hpa"},
},
},
},
},
},
{
name: "warn-builtin-shortname-ambugity",
arg: "po",
expected: schema.GroupVersionResource{Resource: "pods", Group: ""},
expectedWarningLogs: []string{`short name "po" could also match lower priority resource poddlers.acme.com`},
srvRes: []*metav1.APIResourceList{
{
GroupVersion: "v1",
APIResources: []metav1.APIResource{{Name: "pods", SingularName: "pod", ShortNames: []string{"po"}}},
},
{
GroupVersion: "acme.com/v1",
APIResources: []metav1.APIResource{{Name: "poddlers", ShortNames: []string{"po"}}},
},
},
},
{
name: "warn-builtin-shortname-ambugity-multi-version",
arg: "po",
expected: schema.GroupVersionResource{Resource: "pods", Group: ""},
expectedWarningLogs: []string{`short name "po" could also match lower priority resource poddlers.acme.com`},
srvRes: []*metav1.APIResourceList{
{
GroupVersion: "v1",
APIResources: []metav1.APIResource{{Name: "pods", SingularName: "pod", ShortNames: []string{"po"}}},
},
{
GroupVersion: "acme.com/v1",
APIResources: []metav1.APIResource{{Name: "poddlers", ShortNames: []string{"po"}}},
},
{
GroupVersion: "acme.com/v1beta1",
APIResources: []metav1.APIResource{{Name: "poddlers", ShortNames: []string{"po"}}},
},
},
},
{
name: "resource-match-singular-preferred",
arg: "pod",
expected: schema.GroupVersionResource{Resource: "pod", Group: ""},
srvRes: []*metav1.APIResourceList{
{
GroupVersion: "v1",
APIResources: []metav1.APIResource{{Name: "pods", SingularName: "pod"}},
},
{
GroupVersion: "acme.com/v1",
APIResources: []metav1.APIResource{{Name: "poddlers", ShortNames: []string{"pods", "pod"}}},
},
},
},
{
name: "resource-multiple-versions-shortform",
arg: "hpa",
expected: schema.GroupVersionResource{Resource: "horizontalpodautoscalers", Group: "autoscaling"},
expectedWarningLogs: []string{},
srvRes: []*metav1.APIResourceList{
{
GroupVersion: "autoscaling/v1alphav1",
APIResources: []metav1.APIResource{
{
Name: "horizontalpodautoscalers",
ShortNames: []string{"hpa"},
},
},
},
{
GroupVersion: "autoscaling/v1",
APIResources: []metav1.APIResource{
{
Name: "horizontalpodautoscalers",
ShortNames: []string{"hpa"},
},
},
},
},
},
{
name: "multi-resource-multiple-versions-shortform",
arg: "hpa",
expected: schema.GroupVersionResource{Resource: "horizontalpodautoscalers", Group: "autoscaling"},
expectedWarningLogs: []string{
`short name "hpa" could also match lower priority resource foo.foo`,
`short name "hpa" could also match lower priority resource bar.bar`,
},
srvRes: []*metav1.APIResourceList{
{
GroupVersion: "autoscaling/v1alphav1",
APIResources: []metav1.APIResource{
{
Name: "horizontalpodautoscalers",
ShortNames: []string{"hpa"},
},
},
},
{
GroupVersion: "autoscaling/v1",
APIResources: []metav1.APIResource{
{
Name: "horizontalpodautoscalers",
ShortNames: []string{"hpa"},
},
},
},
{
GroupVersion: "foo/v1",
APIResources: []metav1.APIResource{
{
Name: "foo",
ShortNames: []string{"hpa"},
},
},
},
{
GroupVersion: "foo/v1beta1",
APIResources: []metav1.APIResource{
{
Name: "foo",
ShortNames: []string{"hpa"},
},
},
},
{
GroupVersion: "bar/v1",
APIResources: []metav1.APIResource{
{
Name: "bar",
ShortNames: []string{"hpa"},
},
},
},
},
},
}
for _, test := range tests {
ds := &fakeDiscoveryClient{}
ds.serverResourcesHandler = func() ([]*metav1.APIResourceList, error) {
return test.srvRes, nil
}
var actualWarnings []string
mapper := NewShortcutExpander(&fakeRESTMapper{}, ds, func(a string) {
actualWarnings = append(actualWarnings, a)
}).(shortcutExpander)
actual := mapper.expandResourceShortcut(ctx, schema.GroupVersionResource{Resource: test.arg})
if actual != test.expected {
t.Errorf("%s: unexpected argument: expected %s, got %s", test.name, test.expected, actual)
}
if len(actualWarnings) == 0 && len(test.expectedWarningLogs) == 0 {
continue
}
if !cmp.Equal(test.expectedWarningLogs, actualWarnings) {
t.Fatalf("expected warning message %s but got %s", test.expectedWarningLogs, actualWarnings)
}
}
}
type fakeRESTMapper struct {
kindForInput schema.GroupVersionResource
}
func (f *fakeRESTMapper) KindFor(resource schema.GroupVersionResource) (schema.GroupVersionKind, error) {
f.kindForInput = resource
return schema.GroupVersionKind{}, nil
}
func (f *fakeRESTMapper) KindsFor(resource schema.GroupVersionResource) ([]schema.GroupVersionKind, error) {
return nil, nil
}
func (f *fakeRESTMapper) ResourceFor(input schema.GroupVersionResource) (schema.GroupVersionResource, error) {
return schema.GroupVersionResource{}, nil
}
func (f *fakeRESTMapper) ResourcesFor(input schema.GroupVersionResource) ([]schema.GroupVersionResource, error) {
return nil, nil
}
func (f *fakeRESTMapper) RESTMapping(gk schema.GroupKind, versions ...string) (*meta.RESTMapping, error) {
return nil, nil
}
func (f *fakeRESTMapper) RESTMappings(gk schema.GroupKind, versions ...string) ([]*meta.RESTMapping, error) {
return nil, nil
}
func (f *fakeRESTMapper) ResourceSingularizer(resource string) (singular string, err error) {
return "", nil
}
type fakeDiscoveryClient struct {
serverResourcesHandler func() ([]*metav1.APIResourceList, error)
}
var _ discovery.DiscoveryInterface = &fakeDiscoveryClient{}
func (c *fakeDiscoveryClient) RESTClient() restclient.Interface {
return &fake.RESTClient{}
}
func (c *fakeDiscoveryClient) ServerGroups() (*metav1.APIGroupList, error) {
return &metav1.APIGroupList{
Groups: []metav1.APIGroup{
{
Name: "a",
Versions: []metav1.GroupVersionForDiscovery{
{
GroupVersion: "a/v1",
Version: "v1",
},
},
PreferredVersion: metav1.GroupVersionForDiscovery{
GroupVersion: "a/v1",
Version: "v1",
},
},
},
}, nil
}
func (c *fakeDiscoveryClient) ServerResourcesForGroupVersion(groupVersion string) (*metav1.APIResourceList, error) {
if groupVersion == "a/v1" {
return &metav1.APIResourceList{APIResources: []metav1.APIResource{{Name: "widgets", Kind: "Widget"}}}, nil
}
return nil, errors.NewNotFound(schema.GroupResource{}, "")
}
func (c *fakeDiscoveryClient) ServerGroupsAndResources() ([]*metav1.APIGroup, []*metav1.APIResourceList, error) {
sgs, err := c.ServerGroups()
if err != nil {
return nil, nil, err
}
resultGroups := []*metav1.APIGroup{}
for i := range sgs.Groups {
resultGroups = append(resultGroups, &sgs.Groups[i])
}
if c.serverResourcesHandler != nil {
rs, err := c.serverResourcesHandler()
return resultGroups, rs, err
}
return resultGroups, []*metav1.APIResourceList{}, nil
}
func (c *fakeDiscoveryClient) ServerPreferredResources() ([]*metav1.APIResourceList, error) {
return nil, nil
}
func (c *fakeDiscoveryClient) ServerPreferredNamespacedResources() ([]*metav1.APIResourceList, error) {
return nil, nil
}
func (c *fakeDiscoveryClient) ServerVersion() (*version.Info, error) {
return &version.Info{}, nil
}
func (c *fakeDiscoveryClient) OpenAPISchema() (*openapi_v2.Document, error) {
return &openapi_v2.Document{}, nil
}
func (c *fakeDiscoveryClient) OpenAPIV3() openapi.Client {
panic("implement me")
}
func (c *fakeDiscoveryClient) WithLegacy() discovery.DiscoveryInterface {
panic("implement me")
}
type fakeCachedDiscoveryClient struct {
discovery.DiscoveryInterface
freshHandler func() bool
invalidateHandler func()
}
var _ discovery.CachedDiscoveryInterface = &fakeCachedDiscoveryClient{}
func (c *fakeCachedDiscoveryClient) Fresh() bool {
if c.freshHandler != nil {
return c.freshHandler()
}
return true
}
func (c *fakeCachedDiscoveryClient) Invalidate() {
if c.invalidateHandler != nil {
c.invalidateHandler()
}
}