add a discovery-client #15659
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
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,175 @@ | ||
| /* | ||
| Copyright 2015 The Kubernetes Authors All rights reserved. | ||
|
|
||
| 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 unversioned | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "fmt" | ||
| "net/http" | ||
| "net/url" | ||
|
|
||
| "k8s.io/kubernetes/pkg/api/unversioned" | ||
| ) | ||
|
|
||
| // DiscoveryInterface holds the methods that discover server-supported API groups, | ||
| // versions and resources. | ||
| type DiscoveryInterface interface { | ||
| ServerGroupsInterface | ||
| ServerResourcesInterface | ||
| } | ||
|
|
||
| // GroupsInterface has methods for obtaining supported groups on the API server | ||
| type ServerGroupsInterface interface { | ||
| // ServerGroups returns the supported groups, with information like supported versions and the | ||
| // preferred version. | ||
| ServerGroups() (*unversioned.APIGroupList, error) | ||
| } | ||
|
|
||
| // ServerResourcesInterface has methods for obtaining supported resources on the API server | ||
| type ServerResourcesInterface interface { | ||
| // ServerResourcesForGroupVersion returns the supported resources for a group and version. | ||
| ServerResourcesForGroupVersion(groupVersion string) (*unversioned.APIResourceList, error) | ||
| // ServerResources returns the supported resources for all groups and versions. | ||
| ServerResources() (map[string]*unversioned.APIResourceList, error) | ||
| } | ||
|
|
||
| // DiscoveryClient implements the functions that dicovery server-supported API groups, | ||
| // versions and resources. | ||
| type DiscoveryClient struct { | ||
| httpClient HTTPClient | ||
| baseURL url.URL | ||
| } | ||
|
|
||
| // Convert unversioned.APIVersions to unversioned.APIGroup. APIVersions is used by legacy v1, so | ||
| // group would be "". | ||
| func apiVersionsToAPIGroup(apiVersions *unversioned.APIVersions) (apiGroup unversioned.APIGroup) { | ||
| groupVersions := []unversioned.GroupVersion{} | ||
| for _, version := range apiVersions.Versions { | ||
| groupVersion := unversioned.GroupVersion{ | ||
| GroupVersion: version, | ||
| Version: version, | ||
| } | ||
| groupVersions = append(groupVersions, groupVersion) | ||
| } | ||
| apiGroup.Versions = groupVersions | ||
| // There should be only one groupVersion returned at /api | ||
| apiGroup.PreferredVersion = groupVersions[0] | ||
| return | ||
| } | ||
|
|
||
| func (d *DiscoveryClient) get(url string) (resp *http.Response, err error) { | ||
| req, err := http.NewRequest("GET", url, nil) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return d.httpClient.Do(req) | ||
| } | ||
|
|
||
| // APIGroups returns the supported groups, with information like supported versions and the | ||
|
There was a problem hiding this comment. Is APIGroups the function name? Many of the comments in this file contains incorrect function name. There was a problem hiding this comment. Thanks. I submitted a commit to fix these, I guess the commit is lost during the squash. I'll submit a patch. |
||
| // preferred version. | ||
| func (d *DiscoveryClient) ServerGroups() (apiGroupList *unversioned.APIGroupList, err error) { | ||
| // Get the groupVersions exposed at /api | ||
| url := d.baseURL | ||
|
There was a problem hiding this comment. @krousey I made a copy of d.baseURL to avoid race condition |
||
| url.Path = "/api" | ||
| resp, err := d.get(url.String()) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| var v unversioned.APIVersions | ||
| defer resp.Body.Close() | ||
| err = json.NewDecoder(resp.Body).Decode(&v) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("unexpected error: %v", err) | ||
| } | ||
| apiGroup := apiVersionsToAPIGroup(&v) | ||
|
|
||
| // Get the groupVersions exposed at /apis | ||
| url.Path = "/apis" | ||
| resp2, err := d.get(url.String()) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| defer resp2.Body.Close() | ||
| apiGroupList = &unversioned.APIGroupList{} | ||
| if err = json.NewDecoder(resp2.Body).Decode(&apiGroupList); err != nil { | ||
| return nil, fmt.Errorf("unexpected error: %v", err) | ||
| } | ||
|
|
||
| // append the group retrieved from /api to the list | ||
| apiGroupList.Groups = append(apiGroupList.Groups, apiGroup) | ||
| return apiGroupList, nil | ||
| } | ||
|
|
||
| // APIResourcesForGroup returns the supported resources for a group and version. | ||
| func (d *DiscoveryClient) ServerResourcesForGroupVersion(groupVersion string) (resources *unversioned.APIResourceList, err error) { | ||
| url := d.baseURL | ||
| if groupVersion == "v1" { | ||
| url.Path = "/api/" + groupVersion | ||
| } else { | ||
| url.Path = "/apis/" + groupVersion | ||
| } | ||
| resp, err := d.get(url.String()) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| defer resp.Body.Close() | ||
| resources = &unversioned.APIResourceList{} | ||
| if err = json.NewDecoder(resp.Body).Decode(resources); err != nil { | ||
| return nil, fmt.Errorf("unexpected error: %v", err) | ||
| } | ||
| return resources, nil | ||
| } | ||
|
|
||
| // APIResources returns the supported resources for all groups and versions. | ||
| func (d *DiscoveryClient) ServerResources() (map[string]*unversioned.APIResourceList, error) { | ||
| apiGroups, err := d.ServerGroups() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| groupVersions := extractGroupVersions(apiGroups) | ||
| result := map[string]*unversioned.APIResourceList{} | ||
| for _, groupVersion := range groupVersions { | ||
| resources, err := d.ServerResourcesForGroupVersion(groupVersion) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| result[groupVersion] = resources | ||
| } | ||
| return result, nil | ||
| } | ||
|
|
||
| func setDiscoveryDefaults(config *Config) error { | ||
| config.Prefix = "" | ||
| config.Version = "" | ||
| return nil | ||
| } | ||
|
|
||
| // NewDiscoveryClient creates a new DiscoveryClient for the given config. This client | ||
| // can be used to discover supported resources in the API server. | ||
| func NewDiscoveryClient(c *Config) (*DiscoveryClient, error) { | ||
| config := *c | ||
| if err := setDiscoveryDefaults(&config); err != nil { | ||
| return nil, err | ||
| } | ||
| transport, err := TransportFor(c) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| client := &http.Client{Transport: transport} | ||
| baseURL, err := defaultServerUrlFor(c) | ||
| return &DiscoveryClient{client, *baseURL}, nil | ||
| } | ||
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
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
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.
ServerGroupsInterface
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.
Thanks. BTW, do you have any preference over these names? Are they too verbose?
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.
Yes. But, that matches with the style of the rest of the package. In my ideal world, these interfaces wouldn't exist. It's a long rant of mine nicely summarized by this article, so I won't repeat it here. If I were to define an interface, I wouldn't put Interface in it's name.
But more importantly this matches the current style of this package, so I probably wouldn't change it too much.