client tests part 1

Author: pwittrock

pkg/cache/cache.go

@@ -37,8 +37,8 @@ import (
 
 var log = logf.KBLog.WithName("object-cache")
 
-// objectCache is a ReadInterface
-var _ client.ReadInterface = &objectCache{}
+// objectCache is a Reader
+var _ client.Reader = &objectCache{}
 
 // objectCache is a Kubernetes Object cache populated from Informers
 type objectCache struct {
@@ -47,7 +47,7 @@ type objectCache struct {
 	informers    *informers
 }
 
-var _ client.ReadInterface = &objectCache{}
+var _ client.Reader = &objectCache{}
 
 // addInformer adds an informer to the objectCache
 func (o *objectCache) addInformer(gvk schema.GroupVersionKind, c cache.SharedIndexInformer) {
@@ -106,7 +106,7 @@ func (o *objectCache) cacheFor(obj runtime.Object) (*singleObjectCache, error) {
 	return cache, nil
 }
 
-// Get implements populatingClient.ReadInterface
+// Get implements populatingClient.Reader
 func (o *objectCache) Get(ctx context.Context, key client.ObjectKey, out runtime.Object) error {
 	// Make sure there is a Cache for this type
 	if !o.has(out) {
@@ -124,7 +124,7 @@ func (o *objectCache) Get(ctx context.Context, key client.ObjectKey, out runtime
 	return cache.Get(ctx, key, out)
 }
 
-// List implements populatingClient.ReadInterface
+// List implements populatingClient.Reader
 func (o *objectCache) List(ctx context.Context, opts *client.ListOptions, out runtime.Object) error {
 	itemsPtr, err := apimeta.GetItemsPtr(out)
 	if err != nil {
@@ -148,10 +148,10 @@ func (o *objectCache) List(ctx context.Context, opts *client.ListOptions, out ru
 	return cache.List(ctx, opts, out)
 }
 
-// singleObjectCache is a ReadInterface
-var _ client.ReadInterface = &singleObjectCache{}
+// singleObjectCache is a Reader
+var _ client.Reader = &singleObjectCache{}
 
-// singleObjectCache is a ReadInterface that retrieves objects
+// singleObjectCache is a Reader that retrieves objects
 // from a single local cache populated by a watch.
 type singleObjectCache struct {
 	// Indexer is the underlying indexer wrapped by this cache.

pkg/cache/cache_test.go

@@ -87,7 +87,7 @@ var _ = Describe("Indexers", func() {
 	})
 
 	Describe("populatingClient interface wrapper around an indexer", func() {
-		var singleCache client.ReadInterface
+		var singleCache client.Reader
 
 		BeforeEach(func() {
 			var err error

pkg/cache/informer.go

@@ -19,9 +19,9 @@ import (
 	"k8s.io/client-go/tools/cache"
 )
 
-// Cache implements ReadInterface by reading objects from a cache populated by Informers
+// Cache implements Reader by reading objects from a cache populated by Informers
 type Cache interface {
-	client.ReadInterface
+	client.Reader
 	Informers
 	IndexField(obj runtime.Object, field string, extractValue client.IndexerFunc) error
 }

pkg/client/client.go

@@ -1,18 +1,34 @@
+/*
+Copyright 2018 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 client
 
 import (
 	"context"
+	"fmt"
 	"reflect"
 	"sync"
 
+	"github.com/kubernetes-sigs/controller-runtime/pkg/client/apiutil"
 	"k8s.io/apimachinery/pkg/api/meta"
+	"k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
-	serializer "k8s.io/apimachinery/pkg/runtime/serializer"
+	"k8s.io/apimachinery/pkg/runtime/serializer"
 	"k8s.io/client-go/kubernetes/scheme"
 	"k8s.io/client-go/rest"
-
-	"github.com/kubernetes-sigs/controller-runtime/pkg/client/apiutil"
-	"k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
 // Options are creation options for a Client
@@ -26,6 +42,10 @@ type Options struct {
 
 // New returns a new Client using the provided config and Options.
 func New(config *rest.Config, options Options) (Client, error) {
+	if config == nil {
+		return nil, fmt.Errorf("must provide non-nil rest.Config to client.New")
+	}
+
 	// Init a scheme if none provided
 	if options.Scheme == nil {
 		options.Scheme = scheme.Scheme
@@ -48,6 +68,7 @@ func New(config *rest.Config, options Options) (Client, error) {
 		paramCodec:      runtime.NewParameterCodec(options.Scheme),
 		clientsByType:   make(map[reflect.Type]rest.Interface),
 		resourcesByType: make(map[reflect.Type]string),
+		mappingByType:   make(map[reflect.Type]*meta.RESTMapping),
 	}
 
 	return c, nil
@@ -65,74 +86,94 @@ type populatingClient struct {
 	codecs          serializer.CodecFactory
 	paramCodec      runtime.ParameterCodec
 	clientsByType   map[reflect.Type]rest.Interface
+	mappingByType   map[reflect.Type]*meta.RESTMapping
 	resourcesByType map[reflect.Type]string
 	mu              sync.RWMutex
 }
 
 // makeClient maps obj to a Kubernetes Resource and constructs a populatingClient for that Resource.
-func (c *populatingClient) makeClient(obj runtime.Object) (rest.Interface, string, error) {
+func (c *populatingClient) makeClient(obj runtime.Object) (rest.Interface, *meta.RESTMapping, string, error) {
 	gvk, err := apiutil.GVKForObject(obj, c.scheme)
 	if err != nil {
-		return nil, "", err
+		return nil, nil, "", err
 	}
 	client, err := apiutil.RESTClientForGVK(gvk, c.config, c.codecs)
 	if err != nil {
-		return nil, "", err
+		return nil, nil, "", err
 	}
 	mapping, err := c.mapper.RESTMapping(gvk.GroupKind(), gvk.Version)
 	if err != nil {
-		return nil, "", err
+		return nil, nil, "", err
 	}
-	return client, mapping.Resource, nil
+	return client, mapping, mapping.Resource, nil
 }
 
 // clientFor returns a raw rest.Client for the given object type.
-func (c *populatingClient) clientFor(obj runtime.Object) (rest.Interface, string, error) {
+func (c *populatingClient) clientFor(obj runtime.Object) (rest.Interface, *meta.RESTMapping, string, error) {
 	typ := reflect.TypeOf(obj)
 
 	// It's better to do creation work twice than to not let multiple
 	// people make requests at once
 	c.mu.RLock()
 	client, known := c.clientsByType[typ]
 	resource, _ := c.resourcesByType[typ]
+	mapping, _ := c.mappingByType[typ]
 	c.mu.RUnlock()
 
 	// Initialize a new Client
 	if !known {
 		var err error
-		client, resource, err = c.makeClient(obj)
+		client, mapping, resource, err = c.makeClient(obj)
 		if err != nil {
-			return nil, "", err
+			return nil, mapping, "", err
 		}
 		c.mu.Lock()
 		defer c.mu.Unlock()
 		c.clientsByType[typ] = client
 		c.resourcesByType[typ] = resource
+		c.mappingByType[typ] = mapping
 	}
 
-	return client, resource, nil
+	return client, mapping, resource, nil
 }
 
-func (c *populatingClient) metaAndClientFor(obj runtime.Object) (v1.Object, rest.Interface, string, error) {
-	client, resource, err := c.clientFor(obj)
+func (c *populatingClient) metaAndClientFor(obj runtime.Object) (v1.Object, rest.Interface, *meta.RESTMapping, string, error) {
+	client, mapping, resource, err := c.clientFor(obj)
 	if err != nil {
-		return nil, nil, "", err
+		return nil, nil, nil, "", err
 	}
+
 	meta, err := meta.Accessor(obj)
 	if err != nil {
-		return nil, nil, "", err
+		return nil, nil, nil, "", err
 	}
-	return meta, client, resource, err
+	return meta, client, mapping, resource, err
+}
+
+func isNamespaced(mapping *meta.RESTMapping) bool {
+	if mapping.Scope.Name() == meta.RESTScopeNameRoot {
+		return false
+	}
+	return true
 }
 
 // Create implements Client
 func (c *populatingClient) Create(ctx context.Context, obj runtime.Object) error {
-	meta, client, resource, err := c.metaAndClientFor(obj)
+	meta, client, mapping, resource, err := c.metaAndClientFor(obj)
 	if err != nil {
 		return err
 	}
+
+	if isNamespaced(mapping) {
+		return client.Post().
+			Namespace(meta.GetNamespace()).
+			Resource(resource).
+			Body(obj).
+			Do().
+			Into(obj)
+	}
+
 	return client.Post().
-		Namespace(meta.GetNamespace()).
 		Resource(resource).
 		Body(obj).
 		Do().
@@ -141,12 +182,21 @@ func (c *populatingClient) Create(ctx context.Context, obj runtime.Object) error
 
 // Update implements Client
 func (c *populatingClient) Update(ctx context.Context, obj runtime.Object) error {
-	meta, client, resource, err := c.metaAndClientFor(obj)
+	meta, client, mapping, resource, err := c.metaAndClientFor(obj)
 	if err != nil {
 		return err
 	}
+	if isNamespaced(mapping) {
+		return client.Put().
+			Namespace(meta.GetNamespace()).
+			Resource(resource).
+			Name(meta.GetName()).
+			Body(obj).
+			Do().
+			Into(obj)
+	}
+
 	return client.Put().
-		Namespace(meta.GetNamespace()).
 		Resource(resource).
 		Name(meta.GetName()).
 		Body(obj).
@@ -156,12 +206,19 @@ func (c *populatingClient) Update(ctx context.Context, obj runtime.Object) error
 
 // Delete implements Client
 func (c *populatingClient) Delete(ctx context.Context, obj runtime.Object) error {
-	meta, client, resource, err := c.metaAndClientFor(obj)
+	meta, client, mapping, resource, err := c.metaAndClientFor(obj)
 	if err != nil {
 		return err
 	}
+	if isNamespaced(mapping) {
+		return client.Delete().
+			Namespace(meta.GetNamespace()).
+			Resource(resource).
+			Name(meta.GetName()).
+			Do().
+			Error()
+	}
 	return client.Delete().
-		Namespace(meta.GetNamespace()).
 		Resource(resource).
 		Name(meta.GetName()).
 		Do().
@@ -170,12 +227,19 @@ func (c *populatingClient) Delete(ctx context.Context, obj runtime.Object) error
 
 // Get implements Client
 func (c *populatingClient) Get(ctx context.Context, key ObjectKey, obj runtime.Object) error {
-	client, resource, err := c.clientFor(obj)
+	_, client, mapping, resource, err := c.metaAndClientFor(obj)
 	if err != nil {
 		return err
 	}
+	if isNamespaced(mapping) {
+		return client.Get().
+			Namespace(key.Namespace).
+			Resource(resource).
+			Name(key.Name).
+			Do().
+			Into(obj)
+	}
 	return client.Get().
-		Namespace(key.Namespace).
 		Resource(resource).
 		Name(key.Name).
 		Do().
@@ -184,16 +248,20 @@ func (c *populatingClient) Get(ctx context.Context, key ObjectKey, obj runtime.O
 
 // List implements Client
 func (c *populatingClient) List(ctx context.Context, opts *ListOptions, obj runtime.Object) error {
-	client, resource, err := c.clientFor(obj)
+	_, client, mapping, resource, err := c.metaAndClientFor(obj)
 	if err != nil {
 		return err
 	}
-	ns := ""
-	if opts != nil {
-		ns = opts.Namespace
+	if isNamespaced(mapping) && opts != nil && len(opts.Namespace) > 0 {
+		return client.Get().
+			Namespace(opts.Namespace).
+			Resource(resource).
+			Body(obj).
+			VersionedParams(opts.AsListOptions(), c.paramCodec).
+			Do().
+			Into(obj)
 	}
 	return client.Get().
-		Namespace(ns).
 		Resource(resource).
 		Body(obj).
 		VersionedParams(opts.AsListOptions(), c.paramCodec).

pkg/client/client_suite_test.go

@@ -1,13 +1,60 @@
+/*
+Copyright 2018 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 client_test
 
 import (
 	"testing"
+	"time"
 
+	"github.com/kubernetes-sigs/controller-runtime/pkg/test"
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
+	"k8s.io/client-go/kubernetes"
+	"k8s.io/client-go/rest"
+
+	logf "github.com/kubernetes-sigs/controller-runtime/pkg/runtime/log"
 )
 
-func TestEventhandler(t *testing.T) {
+func TestSource(t *testing.T) {
 	RegisterFailHandler(Fail)
-	RunSpecs(t, "client tests")
+	RunSpecsWithDefaultAndCustomReporters(t, "Controller Integration Suite", []Reporter{test.NewlineReporter{}})
 }
+
+var testenv *test.Environment
+var cfg *rest.Config
+var clientset *kubernetes.Clientset
+
+var _ = BeforeSuite(func(done Done) {
+	logf.SetLogger(logf.ZapLogger(false))
+
+	testenv = &test.Environment{}
+
+	var err error
+	cfg, err = testenv.Start()
+	Expect(err).NotTo(HaveOccurred())
+
+	time.Sleep(1 * time.Second)
+
+	clientset, err = kubernetes.NewForConfig(cfg)
+	Expect(err).NotTo(HaveOccurred())
+
+	close(done)
+}, 60)
+
+var _ = AfterSuite(func() {
+	testenv.Stop()
+})