client-go: extend discovery intf with ServerGroupsAndResources

pull/564/head
Dr. Stefan Schimanski 2019-02-05 11:35:36 +01:00
parent 57d0f9d972
commit 618050e35d
10 changed files with 149 additions and 37 deletions

View File

@ -948,10 +948,15 @@ func (_ *fakeServerResources) ServerResourcesForGroupVersion(groupVersion string
return nil, nil return nil, nil
} }
// Deprecated: use ServerGroupsAndResources instead.
func (_ *fakeServerResources) ServerResources() ([]*metav1.APIResourceList, error) { func (_ *fakeServerResources) ServerResources() ([]*metav1.APIResourceList, error) {
return nil, nil return nil, nil
} }
func (_ *fakeServerResources) ServerGroupsAndResources() ([]*metav1.APIGroup, []*metav1.APIResourceList, error) {
return nil, nil, nil
}
func (f *fakeServerResources) ServerPreferredResources() ([]*metav1.APIResourceList, error) { func (f *fakeServerResources) ServerPreferredResources() ([]*metav1.APIResourceList, error) {
f.Lock.Lock() f.Lock.Lock()
defer f.Lock.Unlock() defer f.Lock.Unlock()

View File

@ -275,10 +275,15 @@ func (d *fakeCachedDiscoveryClient) Fresh() bool {
func (d *fakeCachedDiscoveryClient) Invalidate() { func (d *fakeCachedDiscoveryClient) Invalidate() {
} }
// Deprecated: use ServerGroupsAndResources instead.
func (d *fakeCachedDiscoveryClient) ServerResources() ([]*metav1.APIResourceList, error) { func (d *fakeCachedDiscoveryClient) ServerResources() ([]*metav1.APIResourceList, error) {
return []*metav1.APIResourceList{}, nil return []*metav1.APIResourceList{}, nil
} }
func (d *fakeCachedDiscoveryClient) ServerGroupsAndResources() ([]*metav1.APIGroup, []*metav1.APIResourceList, error) {
return []*metav1.APIGroup{}, []*metav1.APIResourceList{}, nil
}
// TestFactory extends cmdutil.Factory // TestFactory extends cmdutil.Factory
type TestFactory struct { type TestFactory struct {
cmdutil.Factory cmdutil.Factory

View File

@ -405,10 +405,16 @@ func (d *fakeDiscovery) ServerResourcesForGroupVersion(groupVersion string) (*me
} }
// ServerResources returns the supported resources for all groups and versions. // ServerResources returns the supported resources for all groups and versions.
// Deprecated: use ServerGroupsAndResources instead.
func (d *fakeDiscovery) ServerResources() ([]*metav1.APIResourceList, error) { func (d *fakeDiscovery) ServerResources() ([]*metav1.APIResourceList, error) {
return nil, nil return nil, nil
} }
// ServerGroupsAndResources returns the supported groups and resources for all groups and versions.
func (d *fakeDiscovery) ServerGroupsAndResources() ([]*metav1.APIGroup, []*metav1.APIResourceList, error) {
return nil, nil, nil
}
// ServerPreferredResources returns the supported resources with the version preferred by the // ServerPreferredResources returns the supported resources with the version preferred by the
// server. // server.
func (d *fakeDiscovery) ServerPreferredResources() ([]*metav1.APIResourceList, error) { func (d *fakeDiscovery) ServerPreferredResources() ([]*metav1.APIResourceList, error) {

View File

@ -118,10 +118,16 @@ func (d *memCacheClient) ServerResourcesForGroupVersion(groupVersion string) (*m
} }
// ServerResources returns the supported resources for all groups and versions. // ServerResources returns the supported resources for all groups and versions.
// Deprecated: use ServerGroupsAndResources instead.
func (d *memCacheClient) ServerResources() ([]*metav1.APIResourceList, error) { func (d *memCacheClient) ServerResources() ([]*metav1.APIResourceList, error) {
return discovery.ServerResources(d) return discovery.ServerResources(d)
} }
// ServerGroupsAndResources returns the groups and supported resources for all groups and versions.
func (d *memCacheClient) ServerGroupsAndResources() ([]*metav1.APIGroup, []*metav1.APIResourceList, error) {
return discovery.ServerGroupsAndResources(d)
}
func (d *memCacheClient) ServerGroups() (*metav1.APIGroupList, error) { func (d *memCacheClient) ServerGroups() (*metav1.APIGroupList, error) {
d.lock.Lock() d.lock.Lock()
defer d.lock.Unlock() defer d.lock.Unlock()

View File

@ -90,8 +90,15 @@ func (d *CachedDiscoveryClient) ServerResourcesForGroupVersion(groupVersion stri
} }
// ServerResources returns the supported resources for all groups and versions. // ServerResources returns the supported resources for all groups and versions.
// Deprecated: use ServerGroupsAndResources instead.
func (d *CachedDiscoveryClient) ServerResources() ([]*metav1.APIResourceList, error) { func (d *CachedDiscoveryClient) ServerResources() ([]*metav1.APIResourceList, error) {
return ServerResources(d) _, rs, err := ServerGroupsAndResources(d)
return rs, err
}
// ServerGroupsAndResources returns the supported groups and resources for all groups and versions.
func (d *CachedDiscoveryClient) ServerGroupsAndResources() ([]*metav1.APIGroup, []*metav1.APIResourceList, error) {
return ServerGroupsAndResources(d)
} }
// ServerGroups returns the supported groups, with information like supported versions and the // ServerGroups returns the supported groups, with information like supported versions and the

View File

@ -112,6 +112,10 @@ func (c *fakeDiscoveryClient) RESTClient() restclient.Interface {
func (c *fakeDiscoveryClient) ServerGroups() (*metav1.APIGroupList, error) { func (c *fakeDiscoveryClient) ServerGroups() (*metav1.APIGroupList, error) {
c.groupCalls = c.groupCalls + 1 c.groupCalls = c.groupCalls + 1
return c.serverGroups()
}
func (c *fakeDiscoveryClient) serverGroups() (*metav1.APIGroupList, error) {
return &metav1.APIGroupList{ return &metav1.APIGroupList{
Groups: []metav1.APIGroup{ Groups: []metav1.APIGroup{
{ {
@ -140,12 +144,26 @@ func (c *fakeDiscoveryClient) ServerResourcesForGroupVersion(groupVersion string
return nil, errors.NewNotFound(schema.GroupResource{}, "") return nil, errors.NewNotFound(schema.GroupResource{}, "")
} }
// Deprecated: use ServerGroupsAndResources instead.
func (c *fakeDiscoveryClient) ServerResources() ([]*metav1.APIResourceList, error) { func (c *fakeDiscoveryClient) ServerResources() ([]*metav1.APIResourceList, error) {
_, rs, err := c.ServerGroupsAndResources()
return rs, err
}
func (c *fakeDiscoveryClient) ServerGroupsAndResources() ([]*metav1.APIGroup, []*metav1.APIResourceList, error) {
c.resourceCalls = c.resourceCalls + 1 c.resourceCalls = c.resourceCalls + 1
if c.serverResourcesHandler != nil {
return c.serverResourcesHandler() gs, _ := c.serverGroups()
resultGroups := []*metav1.APIGroup{}
for i := range gs.Groups {
resultGroups = append(resultGroups, &gs.Groups[i])
} }
return []*metav1.APIResourceList{}, nil
if c.serverResourcesHandler != nil {
rs, err := c.serverResourcesHandler()
return resultGroups, rs, err
}
return resultGroups, []*metav1.APIResourceList{}, nil
} }
func (c *fakeDiscoveryClient) ServerPreferredResources() ([]*metav1.APIResourceList, error) { func (c *fakeDiscoveryClient) ServerPreferredResources() ([]*metav1.APIResourceList, error) {

View File

@ -88,12 +88,28 @@ type ServerResourcesInterface interface {
// ServerResourcesForGroupVersion returns the supported resources for a group and version. // ServerResourcesForGroupVersion returns the supported resources for a group and version.
ServerResourcesForGroupVersion(groupVersion string) (*metav1.APIResourceList, error) ServerResourcesForGroupVersion(groupVersion string) (*metav1.APIResourceList, error)
// ServerResources returns the supported resources for all groups and versions. // ServerResources returns the supported resources for all groups and versions.
//
// The returned resource list might be non-nil with partial results even in the case of
// non-nil error.
//
// Deprecated: use ServerGroupsAndResources instead.
ServerResources() ([]*metav1.APIResourceList, error) ServerResources() ([]*metav1.APIResourceList, error)
// ServerResources returns the supported groups and resources for all groups and versions.
//
// The returned group and resource lists might be non-nil with partial results even in the
// case of non-nil error.
ServerGroupsAndResources() ([]*metav1.APIGroup, []*metav1.APIResourceList, error)
// ServerPreferredResources returns the supported resources with the version preferred by the // ServerPreferredResources returns the supported resources with the version preferred by the
// server. // server.
//
// The returned group and resource lists might be non-nil with partial results even in the
// case of non-nil error.
ServerPreferredResources() ([]*metav1.APIResourceList, error) ServerPreferredResources() ([]*metav1.APIResourceList, error)
// ServerPreferredNamespacedResources returns the supported namespaced resources with the // ServerPreferredNamespacedResources returns the supported namespaced resources with the
// version preferred by the server. // version preferred by the server.
//
// The returned resource list might be non-nil with partial results even in the case of
// non-nil error.
ServerPreferredNamespacedResources() ([]*metav1.APIResourceList, error) ServerPreferredNamespacedResources() ([]*metav1.APIResourceList, error)
} }
@ -191,14 +207,18 @@ func (d *DiscoveryClient) ServerResourcesForGroupVersion(groupVersion string) (r
return resources, nil return resources, nil
} }
// serverResources returns the supported resources for all groups and versions. // ServerResources returns the supported resources for all groups and versions.
func (d *DiscoveryClient) serverResources() ([]*metav1.APIResourceList, error) { // Deprecated: use ServerGroupsAndResources instead.
return ServerResources(d) func (d *DiscoveryClient) ServerResources() ([]*metav1.APIResourceList, error) {
_, rs, err := d.ServerGroupsAndResources()
return rs, err
} }
// ServerResources returns the supported resources for all groups and versions. // ServerGroupsAndResources returns the supported resources for all groups and versions.
func (d *DiscoveryClient) ServerResources() ([]*metav1.APIResourceList, error) { func (d *DiscoveryClient) ServerGroupsAndResources() ([]*metav1.APIGroup, []*metav1.APIResourceList, error) {
return withRetries(defaultRetries, d.serverResources) return withRetries(defaultRetries, func() ([]*metav1.APIGroup, []*metav1.APIResourceList, error) {
return ServerGroupsAndResources(d)
})
} }
// ErrGroupDiscoveryFailed is returned if one or more API groups fail to load. // ErrGroupDiscoveryFailed is returned if one or more API groups fail to load.
@ -224,23 +244,28 @@ func IsGroupDiscoveryFailedError(err error) bool {
return err != nil && ok return err != nil && ok
} }
// serverPreferredResources returns the supported resources with the version preferred by the server. // ServerResources uses the provided discovery interface to look up supported resources for all groups and versions.
func (d *DiscoveryClient) serverPreferredResources() ([]*metav1.APIResourceList, error) { // Deprecated: use ServerGroupsAndResources instead.
return ServerPreferredResources(d) func ServerResources(d DiscoveryInterface) ([]*metav1.APIResourceList, error) {
_, rs, err := ServerGroupsAndResources(d)
return rs, err
} }
// ServerResources uses the provided discovery interface to look up supported resources for all groups and versions. func ServerGroupsAndResources(d DiscoveryInterface) ([]*metav1.APIGroup, []*metav1.APIResourceList, error) {
func ServerResources(d DiscoveryInterface) ([]*metav1.APIResourceList, error) { sgs, err := d.ServerGroups()
apiGroups, err := d.ServerGroups() if sgs == nil {
if err != nil { return nil, nil, err
return nil, err }
resultGroups := []*metav1.APIGroup{}
for i := range sgs.Groups {
resultGroups = append(resultGroups, &sgs.Groups[i])
} }
groupVersionResources, failedGroups := fetchGroupVersionResources(d, apiGroups) groupVersionResources, failedGroups := fetchGroupVersionResources(d, sgs)
// order results by group/version discovery order // order results by group/version discovery order
result := []*metav1.APIResourceList{} result := []*metav1.APIResourceList{}
for _, apiGroup := range apiGroups.Groups { for _, apiGroup := range sgs.Groups {
for _, version := range apiGroup.Versions { for _, version := range apiGroup.Versions {
gv := schema.GroupVersion{Group: apiGroup.Name, Version: version.Version} gv := schema.GroupVersion{Group: apiGroup.Name, Version: version.Version}
if resources, ok := groupVersionResources[gv]; ok { if resources, ok := groupVersionResources[gv]; ok {
@ -250,10 +275,10 @@ func ServerResources(d DiscoveryInterface) ([]*metav1.APIResourceList, error) {
} }
if len(failedGroups) == 0 { if len(failedGroups) == 0 {
return result, nil return resultGroups, result, nil
} }
return result, &ErrGroupDiscoveryFailed{Groups: failedGroups} return resultGroups, result, &ErrGroupDiscoveryFailed{Groups: failedGroups}
} }
// ServerPreferredResources uses the provided discovery interface to look up preferred resources // ServerPreferredResources uses the provided discovery interface to look up preferred resources
@ -357,7 +382,11 @@ func fetchGroupVersionResources(d DiscoveryInterface, apiGroups *metav1.APIGroup
// ServerPreferredResources returns the supported resources with the version preferred by the // ServerPreferredResources returns the supported resources with the version preferred by the
// server. // server.
func (d *DiscoveryClient) ServerPreferredResources() ([]*metav1.APIResourceList, error) { func (d *DiscoveryClient) ServerPreferredResources() ([]*metav1.APIResourceList, error) {
return withRetries(defaultRetries, d.serverPreferredResources) _, rs, err := withRetries(defaultRetries, func() ([]*metav1.APIGroup, []*metav1.APIResourceList, error) {
rs, err := ServerPreferredResources(d)
return nil, rs, err
})
return rs, err
} }
// ServerPreferredNamespacedResources returns the supported namespaced resources with the // ServerPreferredNamespacedResources returns the supported namespaced resources with the
@ -412,19 +441,20 @@ func (d *DiscoveryClient) OpenAPISchema() (*openapi_v2.Document, error) {
} }
// withRetries retries the given recovery function in case the groups supported by the server change after ServerGroup() returns. // withRetries retries the given recovery function in case the groups supported by the server change after ServerGroup() returns.
func withRetries(maxRetries int, f func() ([]*metav1.APIResourceList, error)) ([]*metav1.APIResourceList, error) { func withRetries(maxRetries int, f func() ([]*metav1.APIGroup, []*metav1.APIResourceList, error)) ([]*metav1.APIGroup, []*metav1.APIResourceList, error) {
var result []*metav1.APIResourceList var result []*metav1.APIResourceList
var resultGroups []*metav1.APIGroup
var err error var err error
for i := 0; i < maxRetries; i++ { for i := 0; i < maxRetries; i++ {
result, err = f() resultGroups, result, err = f()
if err == nil { if err == nil {
return result, nil return resultGroups, result, nil
} }
if _, ok := err.(*ErrGroupDiscoveryFailed); !ok { if _, ok := err.(*ErrGroupDiscoveryFailed); !ok {
return nil, err return nil, nil, err
} }
} }
return result, err return resultGroups, result, err
} }
func setDiscoveryDefaults(config *restclient.Config) error { func setDiscoveryDefaults(config *restclient.Config) error {

View File

@ -53,13 +53,29 @@ func (c *FakeDiscovery) ServerResourcesForGroupVersion(groupVersion string) (*me
} }
// ServerResources returns the supported resources for all groups and versions. // ServerResources returns the supported resources for all groups and versions.
// Deprecated: use ServerGroupsAndResources instead.
func (c *FakeDiscovery) ServerResources() ([]*metav1.APIResourceList, error) { func (c *FakeDiscovery) ServerResources() ([]*metav1.APIResourceList, error) {
_, rs, err := c.ServerGroupsAndResources()
return rs, err
}
// ServerGroupsAndResources returns the supported groups and resources for all groups and versions.
func (c *FakeDiscovery) 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])
}
action := testing.ActionImpl{ action := testing.ActionImpl{
Verb: "get", Verb: "get",
Resource: schema.GroupVersionResource{Resource: "resource"}, Resource: schema.GroupVersionResource{Resource: "resource"},
} }
c.Invokes(action, nil) c.Invokes(action, nil)
return c.Resources, nil return resultGroups, c.Resources, nil
} }
// ServerPreferredResources returns the supported resources with the version // ServerPreferredResources returns the supported resources with the version

View File

@ -391,6 +391,9 @@ func (d *fakeFailingDiscovery) ServerGroups() (*metav1.APIGroupList, error) {
return &metav1.APIGroupList{Groups: d.groups}, d.groupsErr return &metav1.APIGroupList{Groups: d.groups}, d.groupsErr
} }
func (d *fakeFailingDiscovery) ServerGroupsAndResources() ([]*metav1.APIGroup, []*metav1.APIResourceList, error) {
return ServerGroupsAndResources(d)
}
func (d *fakeFailingDiscovery) ServerResourcesForGroupVersion(groupVersion string) (*metav1.APIResourceList, error) { func (d *fakeFailingDiscovery) ServerResourcesForGroupVersion(groupVersion string) (*metav1.APIResourceList, error) {
if rs, found := d.resourcesForGroupVersion[groupVersion]; found { if rs, found := d.resourcesForGroupVersion[groupVersion]; found {
return rs, d.resourcesForGroupVersionErr[groupVersion] return rs, d.resourcesForGroupVersionErr[groupVersion]
@ -449,6 +452,10 @@ func (c *fakeCachedDiscoveryInterface) ServerGroups() (*metav1.APIGroupList, err
return &metav1.APIGroupList{}, nil return &metav1.APIGroupList{}, nil
} }
func (c *fakeCachedDiscoveryInterface) ServerGroupsAndResources() ([]*metav1.APIGroup, []*metav1.APIResourceList, error) {
return ServerGroupsAndResources(c)
}
func (c *fakeCachedDiscoveryInterface) ServerResourcesForGroupVersion(groupVersion string) (*metav1.APIResourceList, error) { func (c *fakeCachedDiscoveryInterface) ServerResourcesForGroupVersion(groupVersion string) (*metav1.APIResourceList, error) {
if c.enabledGroupA && groupVersion == "a/v1" { if c.enabledGroupA && groupVersion == "a/v1" {
return &aResources, nil return &aResources, nil
@ -457,12 +464,9 @@ func (c *fakeCachedDiscoveryInterface) ServerResourcesForGroupVersion(groupVersi
return nil, errors.NewNotFound(schema.GroupResource{}, "") return nil, errors.NewNotFound(schema.GroupResource{}, "")
} }
// Deprecated: use ServerGroupsAndResources instead.
func (c *fakeCachedDiscoveryInterface) ServerResources() ([]*metav1.APIResourceList, error) { func (c *fakeCachedDiscoveryInterface) ServerResources() ([]*metav1.APIResourceList, error) {
if c.enabledGroupA { return ServerResources(c)
av1, _ := c.ServerResourcesForGroupVersion("a/v1")
return []*metav1.APIResourceList{av1}, nil
}
return []*metav1.APIResourceList{}, nil
} }
func (c *fakeCachedDiscoveryInterface) ServerPreferredResources() ([]*metav1.APIResourceList, error) { func (c *fakeCachedDiscoveryInterface) ServerPreferredResources() ([]*metav1.APIResourceList, error) {

View File

@ -265,11 +265,26 @@ func (c *fakeDiscoveryClient) ServerResourcesForGroupVersion(groupVersion string
return nil, errors.NewNotFound(schema.GroupResource{}, "") return nil, errors.NewNotFound(schema.GroupResource{}, "")
} }
// Deprecated: use ServerGroupsAndResources instead.
func (c *fakeDiscoveryClient) ServerResources() ([]*metav1.APIResourceList, error) { func (c *fakeDiscoveryClient) ServerResources() ([]*metav1.APIResourceList, error) {
if c.serverResourcesHandler != nil { _, rs, err := c.ServerGroupsAndResources()
return c.serverResourcesHandler() return rs, err
}
func (c *fakeDiscoveryClient) ServerGroupsAndResources() ([]*metav1.APIGroup, []*metav1.APIResourceList, error) {
sgs, err := c.ServerGroups()
if err != nil {
return nil, nil, err
} }
return []*metav1.APIResourceList{}, nil 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) { func (c *fakeDiscoveryClient) ServerPreferredResources() ([]*metav1.APIResourceList, error) {