From 8e7db3a0d34399e8235daed4b20abcd222cf1b34 Mon Sep 17 00:00:00 2001 From: Daniel Smith Date: Tue, 27 Jun 2017 10:54:33 -0400 Subject: [PATCH] Add a refreshing discovery client --- .../garbagecollector/memcachediscovery/BUILD | 49 +++++ .../memcachediscovery/client.go | 167 ++++++++++++++++++ .../memcachediscovery/client_test.go | 132 ++++++++++++++ 3 files changed, 348 insertions(+) create mode 100644 pkg/controller/garbagecollector/memcachediscovery/BUILD create mode 100644 pkg/controller/garbagecollector/memcachediscovery/client.go create mode 100644 pkg/controller/garbagecollector/memcachediscovery/client_test.go diff --git a/pkg/controller/garbagecollector/memcachediscovery/BUILD b/pkg/controller/garbagecollector/memcachediscovery/BUILD new file mode 100644 index 00000000000..c9c80eb6175 --- /dev/null +++ b/pkg/controller/garbagecollector/memcachediscovery/BUILD @@ -0,0 +1,49 @@ +package(default_visibility = ["//visibility:public"]) + +licenses(["notice"]) + +load( + "@io_bazel_rules_go//go:def.bzl", + "go_library", + "go_test", +) + +go_test( + name = "go_default_test", + srcs = ["client_test.go"], + library = ":go_default_library", + tags = ["automanaged"], + deps = [ + "//vendor/k8s.io/apimachinery/pkg/apis/meta/v1:go_default_library", + "//vendor/k8s.io/client-go/discovery/fake:go_default_library", + ], +) + +go_library( + name = "go_default_library", + srcs = ["client.go"], + tags = ["automanaged"], + deps = [ + "//vendor/github.com/emicklei/go-restful-swagger12:go_default_library", + "//vendor/github.com/go-openapi/spec:go_default_library", + "//vendor/github.com/golang/glog:go_default_library", + "//vendor/k8s.io/apimachinery/pkg/apis/meta/v1:go_default_library", + "//vendor/k8s.io/apimachinery/pkg/runtime/schema:go_default_library", + "//vendor/k8s.io/apimachinery/pkg/version:go_default_library", + "//vendor/k8s.io/client-go/discovery:go_default_library", + "//vendor/k8s.io/client-go/rest:go_default_library", + ], +) + +filegroup( + name = "package-srcs", + srcs = glob(["**"]), + tags = ["automanaged"], + visibility = ["//visibility:private"], +) + +filegroup( + name = "all-srcs", + srcs = [":package-srcs"], + tags = ["automanaged"], +) diff --git a/pkg/controller/garbagecollector/memcachediscovery/client.go b/pkg/controller/garbagecollector/memcachediscovery/client.go new file mode 100644 index 00000000000..15d53456ef2 --- /dev/null +++ b/pkg/controller/garbagecollector/memcachediscovery/client.go @@ -0,0 +1,167 @@ +/* +Copyright 2017 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 memcachediscovery includes a Client which is a CachedDiscoveryInterface. +package memcachediscovery + +import ( + "errors" + "sync" + + "github.com/emicklei/go-restful-swagger12" + "github.com/go-openapi/spec" + "github.com/golang/glog" + + metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" + "k8s.io/apimachinery/pkg/runtime/schema" + "k8s.io/apimachinery/pkg/version" + "k8s.io/client-go/discovery" + restclient "k8s.io/client-go/rest" +) + +// Client can Refresh() to stay up-to-date with discovery information. Before +// this is moved some place where it's easier to call, it needs to switch to a +// watch interface. Right now it will poll anytime Refresh() is called. +type Client struct { + delegate discovery.DiscoveryInterface + + lock sync.RWMutex + groupToServerResources map[string]*metav1.APIResourceList + groupList *metav1.APIGroupList + cacheValid bool +} + +var ( + ErrCacheEmpty = errors.New("the cache has not been filled yet") +) + +var _ discovery.CachedDiscoveryInterface = &Client{} + +// ServerResourcesForGroupVersion returns the supported resources for a group and version. +func (d *Client) ServerResourcesForGroupVersion(groupVersion string) (*metav1.APIResourceList, error) { + d.lock.RLock() + defer d.lock.RUnlock() + cachedVal, ok := d.groupToServerResources[groupVersion] + if !ok { + return nil, ErrCacheEmpty + } + return cachedVal, nil +} + +// ServerResources returns the supported resources for all groups and versions. +func (d *Client) ServerResources() ([]*metav1.APIResourceList, error) { + apiGroups, err := d.ServerGroups() + if err != nil { + return nil, err + } + groupVersions := metav1.ExtractGroupVersions(apiGroups) + result := []*metav1.APIResourceList{} + for _, groupVersion := range groupVersions { + resources, err := d.ServerResourcesForGroupVersion(groupVersion) + if err != nil { + return nil, err + } + result = append(result, resources) + } + return result, nil +} + +func (d *Client) ServerGroups() (*metav1.APIGroupList, error) { + d.lock.RLock() + defer d.lock.RUnlock() + if d.groupList == nil { + return nil, ErrCacheEmpty + } + return d.groupList, nil +} + +func (d *Client) RESTClient() restclient.Interface { + return d.delegate.RESTClient() +} + +func (d *Client) ServerPreferredResources() ([]*metav1.APIResourceList, error) { + return d.delegate.ServerPreferredResources() +} + +func (d *Client) ServerPreferredNamespacedResources() ([]*metav1.APIResourceList, error) { + return d.delegate.ServerPreferredNamespacedResources() +} + +func (d *Client) ServerVersion() (*version.Info, error) { + return d.delegate.ServerVersion() +} + +func (d *Client) SwaggerSchema(version schema.GroupVersion) (*swagger.ApiDeclaration, error) { + return d.delegate.SwaggerSchema(version) +} + +func (d *Client) OpenAPISchema() (*spec.Swagger, error) { + return d.delegate.OpenAPISchema() +} + +func (d *Client) Fresh() bool { + d.lock.RLock() + defer d.lock.RUnlock() + // Fresh is supposed to tell the caller whether or not to retry if the + // cache fails to find something. The idea here is that Refresh and/or + // Invalidate will be called periodically and therefore we'll always be + // returning the latest data. (And in the future we can watch and stay + // even more up-to-date.) So we only return false if the cache has + // never been filled. + return d.cacheValid +} + +// Invalidate refreshes the cache, blocking calls until the cache has been +// refreshed. It would be trivial to make a version that does this in the +// background while continuing to respond to requests if needed. +func (d *Client) Invalidate() { + d.lock.Lock() + defer d.lock.Unlock() + gl, err := d.delegate.ServerGroups() + if err != nil || len(gl.Groups) == 0 { + glog.V(2).Infof("Error getting current server API group list, will keep using cached value. (%v)", err) + return + } + + rl := map[string]*metav1.APIResourceList{} + for _, g := range gl.Groups { + for _, v := range g.Versions { + r, err := d.delegate.ServerResourcesForGroupVersion(v.GroupVersion) + if err != nil || len(r.APIResources) == 0 { + glog.V(2).Infof("Error getting resource list for %v: %v", v.GroupVersion, err) + if cur, ok := d.groupToServerResources[v.GroupVersion]; ok { + // retain the existing list, if we had it. + r = cur + } else { + continue + } + } + rl[v.GroupVersion] = r + } + } + + d.groupToServerResources, d.groupList = rl, gl + d.cacheValid = true +} + +// NewClient creates a new Client which caches discovery information in memory +// and will stay up-to-date if Invalidate is called with regularity. +func NewClient(delegate discovery.DiscoveryInterface) *Client { + return &Client{ + delegate: delegate, + groupToServerResources: map[string]*metav1.APIResourceList{}, + } +} diff --git a/pkg/controller/garbagecollector/memcachediscovery/client_test.go b/pkg/controller/garbagecollector/memcachediscovery/client_test.go new file mode 100644 index 00000000000..f7ac08e5556 --- /dev/null +++ b/pkg/controller/garbagecollector/memcachediscovery/client_test.go @@ -0,0 +1,132 @@ +/* +Copyright 2017 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 memcachediscovery + +import ( + "errors" + "reflect" + "sync" + "testing" + + metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" + "k8s.io/client-go/discovery/fake" +) + +type fakeDiscovery struct { + *fake.FakeDiscovery + + lock sync.Mutex + groupList *metav1.APIGroupList + resourceMap map[string]*metav1.APIResourceList +} + +func (c *fakeDiscovery) ServerResourcesForGroupVersion(groupVersion string) (*metav1.APIResourceList, error) { + c.lock.Lock() + defer c.lock.Unlock() + if rl, ok := c.resourceMap[groupVersion]; ok { + return rl, nil + } + return nil, errors.New("doesn't exist") +} + +func (c *fakeDiscovery) ServerGroups() (*metav1.APIGroupList, error) { + c.lock.Lock() + defer c.lock.Unlock() + if c.groupList == nil { + return nil, errors.New("doesn't exist") + } + return c.groupList, nil +} + +func TestClient(t *testing.T) { + fake := &fakeDiscovery{ + groupList: &metav1.APIGroupList{ + Groups: []metav1.APIGroup{{ + Name: "astronomy", + Versions: []metav1.GroupVersionForDiscovery{{ + GroupVersion: "astronomy/v8beta1", + Version: "v8beta1", + }}, + }}, + }, + resourceMap: map[string]*metav1.APIResourceList{ + "astronomy/v8beta1": { + GroupVersion: "astronomy/v8beta1", + APIResources: []metav1.APIResource{{ + Name: "dwarfplanets", + SingularName: "dwarfplanet", + Namespaced: true, + Kind: "DwarfPlanet", + ShortNames: []string{"dp"}, + }}, + }, + }, + } + + c := NewClient(fake) + g, err := c.ServerGroups() + if err == nil { + t.Errorf("Unexpected non-error.") + } + if c.Fresh() { + t.Errorf("Expected not fresh.") + } + + c.Invalidate() + if !c.Fresh() { + t.Errorf("Expected fresh.") + } + + g, err = c.ServerGroups() + if err != nil { + t.Errorf("Unexpected error: %v", err) + } + if e, a := fake.groupList, g; !reflect.DeepEqual(e, a) { + t.Errorf("Expected %#v, got %#v", e, a) + } + r, err := c.ServerResourcesForGroupVersion("astronomy/v8beta1") + if err != nil { + t.Errorf("Unexpected error: %v", err) + } + if e, a := fake.resourceMap["astronomy/v8beta1"], r; !reflect.DeepEqual(e, a) { + t.Errorf("Expected %#v, got %#v", e, a) + } + + fake.lock.Lock() + fake.resourceMap = map[string]*metav1.APIResourceList{ + "astronomy/v8beta1": { + GroupVersion: "astronomy/v8beta1", + APIResources: []metav1.APIResource{{ + Name: "stars", + SingularName: "star", + Namespaced: true, + Kind: "Star", + ShortNames: []string{"s"}, + }}, + }, + } + fake.lock.Unlock() + + c.Invalidate() + r, err = c.ServerResourcesForGroupVersion("astronomy/v8beta1") + if err != nil { + t.Errorf("Unexpected error: %v", err) + } + if e, a := fake.resourceMap["astronomy/v8beta1"], r; !reflect.DeepEqual(e, a) { + t.Errorf("Expected %#v, got %#v", e, a) + } +}