/* Copyright 2014 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 discovery_test import ( "encoding/json" "fmt" "mime" "net/http" "net/http/httptest" "reflect" "testing" "github.com/gogo/protobuf/proto" "github.com/googleapis/gnostic/OpenAPIv2" metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" "k8s.io/apimachinery/pkg/runtime/schema" "k8s.io/apimachinery/pkg/util/sets" "k8s.io/apimachinery/pkg/version" . "k8s.io/client-go/discovery" restclient "k8s.io/client-go/rest" ) func TestGetServerVersion(t *testing.T) { expect := version.Info{ Major: "foo", Minor: "bar", GitCommit: "baz", } server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) { output, err := json.Marshal(expect) if err != nil { t.Errorf("unexpected encoding error: %v", err) return } w.Header().Set("Content-Type", "application/json") w.WriteHeader(http.StatusOK) w.Write(output) })) defer server.Close() client := NewDiscoveryClientForConfigOrDie(&restclient.Config{Host: server.URL}) got, err := client.ServerVersion() if err != nil { t.Fatalf("unexpected encoding error: %v", err) } if e, a := expect, *got; !reflect.DeepEqual(e, a) { t.Errorf("expected %v, got %v", e, a) } } func TestGetServerGroupsWithV1Server(t *testing.T) { server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) { var obj interface{} switch req.URL.Path { case "/api": obj = &metav1.APIVersions{ Versions: []string{ "v1", }, } case "/apis": obj = &metav1.APIGroupList{ Groups: []metav1.APIGroup{ { Name: "extensions", Versions: []metav1.GroupVersionForDiscovery{ {GroupVersion: "extensions/v1beta1"}, }, }, }, } default: w.WriteHeader(http.StatusNotFound) return } output, err := json.Marshal(obj) if err != nil { t.Fatalf("unexpected encoding error: %v", err) return } w.Header().Set("Content-Type", "application/json") w.WriteHeader(http.StatusOK) w.Write(output) })) defer server.Close() client := NewDiscoveryClientForConfigOrDie(&restclient.Config{Host: server.URL}) // ServerGroups should not return an error even if server returns error at /api and /apis apiGroupList, err := client.ServerGroups() if err != nil { t.Fatalf("unexpected error: %v", err) } groupVersions := metav1.ExtractGroupVersions(apiGroupList) if !reflect.DeepEqual(groupVersions, []string{"v1", "extensions/v1beta1"}) { t.Errorf("expected: %q, got: %q", []string{"v1", "extensions/v1beta1"}, groupVersions) } } func TestGetServerGroupsWithBrokenServer(t *testing.T) { for _, statusCode := range []int{http.StatusNotFound, http.StatusForbidden} { server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) { w.WriteHeader(statusCode) })) defer server.Close() client := NewDiscoveryClientForConfigOrDie(&restclient.Config{Host: server.URL}) // ServerGroups should not return an error even if server returns Not Found or Forbidden error at all end points apiGroupList, err := client.ServerGroups() if err != nil { t.Fatalf("unexpected error: %v", err) } groupVersions := metav1.ExtractGroupVersions(apiGroupList) if len(groupVersions) != 0 { t.Errorf("expected empty list, got: %q", groupVersions) } } } func TestGetServerResourcesWithV1Server(t *testing.T) { server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) { var obj interface{} switch req.URL.Path { case "/api": obj = &metav1.APIVersions{ Versions: []string{ "v1", }, } default: w.WriteHeader(http.StatusNotFound) return } output, err := json.Marshal(obj) if err != nil { t.Errorf("unexpected encoding error: %v", err) return } w.Header().Set("Content-Type", "application/json") w.WriteHeader(http.StatusOK) w.Write(output) })) defer server.Close() client := NewDiscoveryClientForConfigOrDie(&restclient.Config{Host: server.URL}) // ServerResources should not return an error even if server returns error at /api/v1. serverResources, err := client.ServerResources() if err != nil { t.Errorf("unexpected error: %v", err) } gvs := groupVersions(serverResources) if !sets.NewString(gvs...).Has("v1") { t.Errorf("missing v1 in resource list: %v", serverResources) } } func TestGetServerResources(t *testing.T) { stable := metav1.APIResourceList{ GroupVersion: "v1", APIResources: []metav1.APIResource{ {Name: "pods", Namespaced: true, Kind: "Pod"}, {Name: "services", Namespaced: true, Kind: "Service"}, {Name: "namespaces", Namespaced: false, Kind: "Namespace"}, }, } beta := metav1.APIResourceList{ GroupVersion: "extensions/v1beta1", APIResources: []metav1.APIResource{ {Name: "deployments", Namespaced: true, Kind: "Deployment"}, {Name: "ingresses", Namespaced: true, Kind: "Ingress"}, {Name: "jobs", Namespaced: true, Kind: "Job"}, }, } tests := []struct { resourcesList *metav1.APIResourceList path string request string expectErr bool }{ { resourcesList: &stable, path: "/api/v1", request: "v1", expectErr: false, }, { resourcesList: &beta, path: "/apis/extensions/v1beta1", request: "extensions/v1beta1", expectErr: false, }, { resourcesList: &stable, path: "/api/v1", request: "foobar", expectErr: true, }, } server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) { var list interface{} switch req.URL.Path { case "/api/v1": list = &stable case "/apis/extensions/v1beta1": list = &beta case "/api": list = &metav1.APIVersions{ Versions: []string{ "v1", }, } case "/apis": list = &metav1.APIGroupList{ Groups: []metav1.APIGroup{ { Versions: []metav1.GroupVersionForDiscovery{ {GroupVersion: "extensions/v1beta1"}, }, }, }, } default: t.Logf("unexpected request: %s", req.URL.Path) w.WriteHeader(http.StatusNotFound) return } output, err := json.Marshal(list) if err != nil { t.Errorf("unexpected encoding error: %v", err) return } w.Header().Set("Content-Type", "application/json") w.WriteHeader(http.StatusOK) w.Write(output) })) defer server.Close() client := NewDiscoveryClientForConfigOrDie(&restclient.Config{Host: server.URL}) for _, test := range tests { got, err := client.ServerResourcesForGroupVersion(test.request) if test.expectErr { if err == nil { t.Error("unexpected non-error") } continue } if err != nil { t.Errorf("unexpected error: %v", err) continue } if !reflect.DeepEqual(got, test.resourcesList) { t.Errorf("expected:\n%v\ngot:\n%v\n", test.resourcesList, got) } } serverResources, err := client.ServerResources() if err != nil { t.Errorf("unexpected error: %v", err) } serverGroupVersions := sets.NewString(groupVersions(serverResources)...) for _, api := range []string{"v1", "extensions/v1beta1"} { if !serverGroupVersions.Has(api) { t.Errorf("missing expected api %q in %v", api, serverResources) } } } var returnedOpenAPI = openapi_v2.Document{ Definitions: &openapi_v2.Definitions{ AdditionalProperties: []*openapi_v2.NamedSchema{ { Name: "fake.type.1", Value: &openapi_v2.Schema{ Properties: &openapi_v2.Properties{ AdditionalProperties: []*openapi_v2.NamedSchema{ { Name: "count", Value: &openapi_v2.Schema{ Type: &openapi_v2.TypeItem{ Value: []string{"integer"}, }, }, }, }, }, }, }, { Name: "fake.type.2", Value: &openapi_v2.Schema{ Properties: &openapi_v2.Properties{ AdditionalProperties: []*openapi_v2.NamedSchema{ { Name: "count", Value: &openapi_v2.Schema{ Type: &openapi_v2.TypeItem{ Value: []string{"array"}, }, Items: &openapi_v2.ItemsItem{ Schema: []*openapi_v2.Schema{ { Type: &openapi_v2.TypeItem{ Value: []string{"string"}, }, }, }, }, }, }, }, }, }, }, }, }, } func openapiSchemaDeprecatedFakeServer() (*httptest.Server, error) { var sErr error server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) { // old server returns 403 on new endpoint request if req.URL.Path == "/openapi/v2" { w.WriteHeader(http.StatusForbidden) return } if req.URL.Path != "/swagger-2.0.0.pb-v1" { sErr = fmt.Errorf("Unexpected url %v", req.URL) } if req.Method != "GET" { sErr = fmt.Errorf("Unexpected method %v", req.Method) } mime.AddExtensionType(".pb-v1", "application/com.github.googleapis.gnostic.OpenAPIv2@68f4ded+protobuf") output, err := proto.Marshal(&returnedOpenAPI) if err != nil { sErr = err return } w.WriteHeader(http.StatusOK) w.Write(output) })) return server, sErr } func openapiSchemaFakeServer() (*httptest.Server, error) { var sErr error server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) { if req.URL.Path != "/openapi/v2" { sErr = fmt.Errorf("Unexpected url %v", req.URL) } if req.Method != "GET" { sErr = fmt.Errorf("Unexpected method %v", req.Method) } decipherableFormat := req.Header.Get("Accept") if decipherableFormat != "application/com.github.proto-openapi.spec.v2@v1.0+protobuf" { sErr = fmt.Errorf("Unexpected accept mime type %v", decipherableFormat) } mime.AddExtensionType(".pb-v1", "application/com.github.googleapis.gnostic.OpenAPIv2@68f4ded+protobuf") output, err := proto.Marshal(&returnedOpenAPI) if err != nil { sErr = err return } w.WriteHeader(http.StatusOK) w.Write(output) })) return server, sErr } func TestGetOpenAPISchema(t *testing.T) { server, err := openapiSchemaFakeServer() if err != nil { t.Errorf("unexpected error starting fake server: %v", err) } defer server.Close() client := NewDiscoveryClientForConfigOrDie(&restclient.Config{Host: server.URL}) got, err := client.OpenAPISchema() if err != nil { t.Fatalf("unexpected error getting openapi: %v", err) } if e, a := returnedOpenAPI, *got; !reflect.DeepEqual(e, a) { t.Errorf("expected %v, got %v", e, a) } } func TestGetOpenAPISchemaFallback(t *testing.T) { server, err := openapiSchemaDeprecatedFakeServer() if err != nil { t.Errorf("unexpected error starting fake server: %v", err) } defer server.Close() client := NewDiscoveryClientForConfigOrDie(&restclient.Config{Host: server.URL}) got, err := client.OpenAPISchema() if err != nil { t.Fatalf("unexpected error getting openapi: %v", err) } if e, a := returnedOpenAPI, *got; !reflect.DeepEqual(e, a) { t.Errorf("expected %v, got %v", e, a) } } func TestServerPreferredResources(t *testing.T) { stable := metav1.APIResourceList{ GroupVersion: "v1", APIResources: []metav1.APIResource{ {Name: "pods", Namespaced: true, Kind: "Pod"}, {Name: "services", Namespaced: true, Kind: "Service"}, {Name: "namespaces", Namespaced: false, Kind: "Namespace"}, }, } tests := []struct { resourcesList []*metav1.APIResourceList response func(w http.ResponseWriter, req *http.Request) expectErr func(err error) bool }{ { resourcesList: []*metav1.APIResourceList{&stable}, expectErr: IsGroupDiscoveryFailedError, response: func(w http.ResponseWriter, req *http.Request) { var list interface{} switch req.URL.Path { case "/apis/extensions/v1beta1": w.WriteHeader(http.StatusInternalServerError) return case "/api/v1": list = &stable case "/api": list = &metav1.APIVersions{ Versions: []string{ "v1", }, } case "/apis": list = &metav1.APIGroupList{ Groups: []metav1.APIGroup{ { Versions: []metav1.GroupVersionForDiscovery{ {GroupVersion: "extensions/v1beta1"}, }, }, }, } default: t.Logf("unexpected request: %s", req.URL.Path) w.WriteHeader(http.StatusNotFound) return } output, err := json.Marshal(list) if err != nil { t.Errorf("unexpected encoding error: %v", err) return } w.Header().Set("Content-Type", "application/json") w.WriteHeader(http.StatusOK) w.Write(output) }, }, { resourcesList: nil, expectErr: IsGroupDiscoveryFailedError, response: func(w http.ResponseWriter, req *http.Request) { var list interface{} switch req.URL.Path { case "/apis/extensions/v1beta1": w.WriteHeader(http.StatusInternalServerError) return case "/api/v1": w.WriteHeader(http.StatusInternalServerError) case "/api": list = &metav1.APIVersions{ Versions: []string{ "v1", }, } case "/apis": list = &metav1.APIGroupList{ Groups: []metav1.APIGroup{ { Versions: []metav1.GroupVersionForDiscovery{ {GroupVersion: "extensions/v1beta1"}, }, }, }, } default: t.Logf("unexpected request: %s", req.URL.Path) w.WriteHeader(http.StatusNotFound) return } output, err := json.Marshal(list) if err != nil { t.Errorf("unexpected encoding error: %v", err) return } w.Header().Set("Content-Type", "application/json") w.WriteHeader(http.StatusOK) w.Write(output) }, }, } for _, test := range tests { server := httptest.NewServer(http.HandlerFunc(test.response)) defer server.Close() client := NewDiscoveryClientForConfigOrDie(&restclient.Config{Host: server.URL}) resources, err := client.ServerPreferredResources() if test.expectErr != nil { if err == nil { t.Error("unexpected non-error") } continue } if err != nil { t.Errorf("unexpected error: %v", err) continue } got, err := GroupVersionResources(resources) if err != nil { t.Errorf("unexpected error: %v", err) continue } expected, _ := GroupVersionResources(test.resourcesList) if !reflect.DeepEqual(got, expected) { t.Errorf("expected:\n%v\ngot:\n%v\n", test.resourcesList, got) } server.Close() } } func TestServerPreferredResourcesRetries(t *testing.T) { stable := metav1.APIResourceList{ GroupVersion: "v1", APIResources: []metav1.APIResource{ {Name: "pods", Namespaced: true, Kind: "Pod"}, }, } beta := metav1.APIResourceList{ GroupVersion: "extensions/v1", APIResources: []metav1.APIResource{ {Name: "deployments", Namespaced: true, Kind: "Deployment"}, }, } response := func(numErrors int) http.HandlerFunc { var i = 0 return func(w http.ResponseWriter, req *http.Request) { var list interface{} switch req.URL.Path { case "/apis/extensions/v1beta1": if i < numErrors { i++ w.WriteHeader(http.StatusInternalServerError) return } list = &beta case "/api/v1": list = &stable case "/api": list = &metav1.APIVersions{ Versions: []string{ "v1", }, } case "/apis": list = &metav1.APIGroupList{ Groups: []metav1.APIGroup{ { Name: "extensions", Versions: []metav1.GroupVersionForDiscovery{ {GroupVersion: "extensions/v1beta1"}, }, PreferredVersion: metav1.GroupVersionForDiscovery{ GroupVersion: "extensions/v1beta1", Version: "v1beta1", }, }, }, } default: t.Logf("unexpected request: %s", req.URL.Path) w.WriteHeader(http.StatusNotFound) return } output, err := json.Marshal(list) if err != nil { t.Errorf("unexpected encoding error: %v", err) return } w.Header().Set("Content-Type", "application/json") w.WriteHeader(http.StatusOK) w.Write(output) } } tests := []struct { responseErrors int expectResources int expectedError func(err error) bool }{ { responseErrors: 1, expectResources: 2, expectedError: func(err error) bool { return err == nil }, }, { responseErrors: 2, expectResources: 1, expectedError: IsGroupDiscoveryFailedError, }, } for i, tc := range tests { server := httptest.NewServer(http.HandlerFunc(response(tc.responseErrors))) defer server.Close() client := NewDiscoveryClientForConfigOrDie(&restclient.Config{Host: server.URL}) resources, err := client.ServerPreferredResources() if !tc.expectedError(err) { t.Errorf("case %d: unexpected error: %v", i, err) } got, err := GroupVersionResources(resources) if err != nil { t.Errorf("case %d: unexpected error: %v", i, err) } if len(got) != tc.expectResources { t.Errorf("case %d: expect %d resources, got %#v", i, tc.expectResources, got) } server.Close() } } func TestServerPreferredNamespacedResources(t *testing.T) { stable := metav1.APIResourceList{ GroupVersion: "v1", APIResources: []metav1.APIResource{ {Name: "pods", Namespaced: true, Kind: "Pod"}, {Name: "services", Namespaced: true, Kind: "Service"}, {Name: "namespaces", Namespaced: false, Kind: "Namespace"}, }, } batchv1 := metav1.APIResourceList{ GroupVersion: "batch/v1", APIResources: []metav1.APIResource{ {Name: "jobs", Namespaced: true, Kind: "Job"}, }, } batchv2alpha1 := metav1.APIResourceList{ GroupVersion: "batch/v2alpha1", APIResources: []metav1.APIResource{ {Name: "jobs", Namespaced: true, Kind: "Job"}, {Name: "cronjobs", Namespaced: true, Kind: "CronJob"}, }, } batchv3alpha1 := metav1.APIResourceList{ GroupVersion: "batch/v3alpha1", APIResources: []metav1.APIResource{ {Name: "jobs", Namespaced: true, Kind: "Job"}, {Name: "cronjobs", Namespaced: true, Kind: "CronJob"}, }, } tests := []struct { response func(w http.ResponseWriter, req *http.Request) expected map[schema.GroupVersionResource]struct{} }{ { response: func(w http.ResponseWriter, req *http.Request) { var list interface{} switch req.URL.Path { case "/api/v1": list = &stable case "/api": list = &metav1.APIVersions{ Versions: []string{ "v1", }, } default: t.Logf("unexpected request: %s", req.URL.Path) w.WriteHeader(http.StatusNotFound) return } output, err := json.Marshal(list) if err != nil { t.Errorf("unexpected encoding error: %v", err) return } w.Header().Set("Content-Type", "application/json") w.WriteHeader(http.StatusOK) w.Write(output) }, expected: map[schema.GroupVersionResource]struct{}{ {Group: "", Version: "v1", Resource: "pods"}: {}, {Group: "", Version: "v1", Resource: "services"}: {}, }, }, { response: func(w http.ResponseWriter, req *http.Request) { var list interface{} switch req.URL.Path { case "/apis": list = &metav1.APIGroupList{ Groups: []metav1.APIGroup{ { Name: "batch", Versions: []metav1.GroupVersionForDiscovery{ {GroupVersion: "batch/v1", Version: "v1"}, {GroupVersion: "batch/v2alpha1", Version: "v2alpha1"}, {GroupVersion: "batch/v3alpha1", Version: "v3alpha1"}, }, PreferredVersion: metav1.GroupVersionForDiscovery{GroupVersion: "batch/v1", Version: "v1"}, }, }, } case "/apis/batch/v1": list = &batchv1 case "/apis/batch/v2alpha1": list = &batchv2alpha1 case "/apis/batch/v3alpha1": list = &batchv3alpha1 default: t.Logf("unexpected request: %s", req.URL.Path) w.WriteHeader(http.StatusNotFound) return } output, err := json.Marshal(list) if err != nil { t.Errorf("unexpected encoding error: %v", err) return } w.Header().Set("Content-Type", "application/json") w.WriteHeader(http.StatusOK) w.Write(output) }, expected: map[schema.GroupVersionResource]struct{}{ {Group: "batch", Version: "v1", Resource: "jobs"}: {}, {Group: "batch", Version: "v2alpha1", Resource: "cronjobs"}: {}, }, }, { response: func(w http.ResponseWriter, req *http.Request) { var list interface{} switch req.URL.Path { case "/apis": list = &metav1.APIGroupList{ Groups: []metav1.APIGroup{ { Name: "batch", Versions: []metav1.GroupVersionForDiscovery{ {GroupVersion: "batch/v1", Version: "v1"}, {GroupVersion: "batch/v2alpha1", Version: "v2alpha1"}, {GroupVersion: "batch/v3alpha1", Version: "v3alpha1"}, }, PreferredVersion: metav1.GroupVersionForDiscovery{GroupVersion: "batch/v2alpha", Version: "v2alpha1"}, }, }, } case "/apis/batch/v1": list = &batchv1 case "/apis/batch/v2alpha1": list = &batchv2alpha1 case "/apis/batch/v3alpha1": list = &batchv3alpha1 default: t.Logf("unexpected request: %s", req.URL.Path) w.WriteHeader(http.StatusNotFound) return } output, err := json.Marshal(list) if err != nil { t.Errorf("unexpected encoding error: %v", err) return } w.Header().Set("Content-Type", "application/json") w.WriteHeader(http.StatusOK) w.Write(output) }, expected: map[schema.GroupVersionResource]struct{}{ {Group: "batch", Version: "v2alpha1", Resource: "jobs"}: {}, {Group: "batch", Version: "v2alpha1", Resource: "cronjobs"}: {}, }, }, } for i, test := range tests { server := httptest.NewServer(http.HandlerFunc(test.response)) defer server.Close() client := NewDiscoveryClientForConfigOrDie(&restclient.Config{Host: server.URL}) resources, err := client.ServerPreferredNamespacedResources() if err != nil { t.Errorf("[%d] unexpected error: %v", i, err) continue } got, err := GroupVersionResources(resources) if err != nil { t.Errorf("[%d] unexpected error: %v", i, err) continue } if !reflect.DeepEqual(got, test.expected) { t.Errorf("[%d] expected:\n%v\ngot:\n%v\n", i, test.expected, got) } server.Close() } } func groupVersions(resources []*metav1.APIResourceList) []string { result := []string{} for _, resourceList := range resources { result = append(result, resourceList.GroupVersion) } return result }