Scheme helper fn

Author: pwittrock

pkg/runtime/scheme/scheme.go

@@ -0,0 +1,54 @@
+/*
+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 scheme
+
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/runtime"
+	"k8s.io/apimachinery/pkg/runtime/schema"
+)
+
+// Builder registers new go struct types with a Scheme as GroupVersionKinds.  This allows
+// the structs to be mapped to GroupVersionKinds.
+type Builder struct {
+	GroupVersion schema.GroupVersion
+	runtime.SchemeBuilder
+}
+
+// RegisterTypes adds one or objects to the SchemeBuilder so they can be added to a Scheme
+func (sb *Builder) RegisterTypes(object ...runtime.Object) {
+	sb.SchemeBuilder.Register(func(scheme *runtime.Scheme) error {
+		scheme.AddKnownTypes(sb.GroupVersion, object...)
+		metav1.AddToGroupVersion(scheme, sb.GroupVersion)
+		return nil
+	})
+}
+
+// AddToScheme adds all known objects to the Scheme
+func (sb *Builder) AddToScheme(s *runtime.Scheme) error {
+	return sb.SchemeBuilder.AddToScheme(s)
+}
+
+// NewScheme returns a new *runtime.Scheme with all known types registered
+func (sb *Builder) NewScheme() (*runtime.Scheme, error) {
+	s := runtime.NewScheme()
+	err := sb.AddToScheme(s)
+	if err != nil {
+		return nil, err
+	}
+	return s, nil
+}

pkg/runtime/scheme/scheme_suite_test.go

@@ -0,0 +1,13 @@
+package scheme_test
+
+import (
+	"testing"
+
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+)
+
+func TestScheme(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "Scheme Suite")
+}

pkg/runtime/scheme/scheme_test.go

@@ -0,0 +1,45 @@
+package scheme_test
+
+import (
+	"reflect"
+
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+	"k8s.io/api/core/v1"
+	"k8s.io/apimachinery/pkg/runtime/schema"
+	"sigs.k8s.io/controller-runtime/pkg/runtime/scheme"
+)
+
+var _ = Describe("Scheme", func() {
+	Describe("SchemeBuilder", func() {
+		It("should provide a Scheme with the types registered", func() {
+			gv := schema.GroupVersion{Group: "core", Version: "v1"}
+			a := scheme.Builder{GroupVersion: gv}
+			a.RegisterTypes(&v1.Pod{}, &v1.PodList{})
+			s, err := a.NewScheme()
+			Expect(err).NotTo(HaveOccurred())
+
+			Expect(a.AddToScheme(s)).To(Succeed())
+			Expect(s.AllKnownTypes()).To(HaveLen(13))
+			Expect(s.AllKnownTypes()[gv.WithKind("Pod")]).To(Equal(reflect.TypeOf(v1.Pod{})))
+			Expect(s.AllKnownTypes()[gv.WithKind("PodList")]).To(Equal(reflect.TypeOf(v1.PodList{})))
+
+			// Base types
+			Expect(s.AllKnownTypes()).To(HaveKey(gv.WithKind("DeleteOptions")))
+			Expect(s.AllKnownTypes()).To(HaveKey(gv.WithKind("ExportOptions")))
+			Expect(s.AllKnownTypes()).To(HaveKey(gv.WithKind("GetOptions")))
+			Expect(s.AllKnownTypes()).To(HaveKey(gv.WithKind("ListOptions")))
+			Expect(s.AllKnownTypes()).To(HaveKey(gv.WithKind("WatchEvent")))
+
+			emptyGv := schema.GroupVersion{Group: "", Version: "v1"}
+			Expect(s.AllKnownTypes()).To(HaveKey(emptyGv.WithKind("APIGroup")))
+			Expect(s.AllKnownTypes()).To(HaveKey(emptyGv.WithKind("APIGroupList")))
+			Expect(s.AllKnownTypes()).To(HaveKey(emptyGv.WithKind("APIResourceList")))
+			Expect(s.AllKnownTypes()).To(HaveKey(emptyGv.WithKind("APIVersions")))
+			Expect(s.AllKnownTypes()).To(HaveKey(emptyGv.WithKind("Status")))
+
+			internalGv := schema.GroupVersion{Group: "core", Version: "__internal"}
+			Expect(s.AllKnownTypes()).To(HaveKey(internalGv.WithKind("WatchEvent")))
+		})
+	})
+})