Test Conditional Controllers

Author: kevindelgado

pkg/controller/controller_integration_test.go

@@ -18,15 +18,27 @@ package controller_test
 
 import (
 	"context"
+	goerrors "errors"
+	"path/filepath"
+	"time"
 
 	appsv1 "k8s.io/api/apps/v1"
 	corev1 "k8s.io/api/core/v1"
+	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
+	"k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1beta1"
+	"k8s.io/apimachinery/pkg/api/errors"
+	"k8s.io/apimachinery/pkg/api/meta"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/apimachinery/pkg/runtime/schema"
 	"k8s.io/apimachinery/pkg/types"
+	"k8s.io/apimachinery/pkg/util/wait"
 	"sigs.k8s.io/controller-runtime/pkg/cache"
+	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/controller"
 	"sigs.k8s.io/controller-runtime/pkg/controller/controllertest"
+	foo "sigs.k8s.io/controller-runtime/pkg/controller/testdata/foo/v1"
+	"sigs.k8s.io/controller-runtime/pkg/envtest"
 	"sigs.k8s.io/controller-runtime/pkg/handler"
 	"sigs.k8s.io/controller-runtime/pkg/reconcile"
 	"sigs.k8s.io/controller-runtime/pkg/source"
@@ -173,6 +185,198 @@ var _ = Describe("controller", func() {
 			close(done)
 		}, 5)
 	})
+
+	It("should reconcile when the CRD is installed, uninstalled, reinstalled", func(done Done) {
+		By("Initializing the scheme and crd")
+		s := runtime.NewScheme()
+		err := v1beta1.AddToScheme(s)
+		Expect(err).NotTo(HaveOccurred())
+		err = apiextensionsv1.AddToScheme(s)
+		Expect(err).NotTo(HaveOccurred())
+		err = foo.AddToScheme(s)
+		Expect(err).NotTo(HaveOccurred())
+		options := manager.Options{Scheme: s}
+
+		By("Creating the Manager")
+		cm, err := manager.New(cfg, options)
+		Expect(err).NotTo(HaveOccurred())
+
+		By("Creating the Controller")
+		instance, err := controller.New("foo-controller", cm, controller.Options{
+			Reconciler: reconcile.Func(
+				func(_ context.Context, request reconcile.Request) (reconcile.Result, error) {
+					reconciled <- request
+					return reconcile.Result{}, nil
+				}),
+		})
+		Expect(err).NotTo(HaveOccurred())
+
+		By("Watching foo CRD as conditional kinds")
+		f := &foo.Foo{}
+		gvk := schema.GroupVersionKind{
+			Group:   "bar.example.com",
+			Version: "v1",
+			Kind:    "Foo",
+		}
+		Expect(err).NotTo(HaveOccurred())
+		existsInDiscovery := func() bool {
+			resources, err := clientset.Discovery().ServerResourcesForGroupVersion(gvk.GroupVersion().String())
+			if err != nil {
+				return false
+			}
+			for _, res := range resources.APIResources {
+				if res.Kind == gvk.Kind {
+					return true
+				}
+			}
+			return false
+		}
+		err = instance.Watch(&source.ConditionalKind{Kind: source.Kind{Type: f}, DiscoveryCheck: existsInDiscovery}, &handler.EnqueueRequestForObject{})
+		Expect(err).NotTo(HaveOccurred())
+
+		By("Starting the Manager")
+		ctx, cancel := context.WithCancel(context.Background())
+		defer cancel()
+		go func() {
+			defer GinkgoRecover()
+			Expect(cm.Start(ctx)).NotTo(HaveOccurred())
+		}()
+
+		testFoo := &foo.Foo{
+			TypeMeta:   metav1.TypeMeta{Kind: gvk.Kind, APIVersion: gvk.GroupVersion().String()},
+			ObjectMeta: metav1.ObjectMeta{Name: "test-foo", Namespace: "default"},
+		}
+
+		expectedReconcileRequest := reconcile.Request{NamespacedName: types.NamespacedName{
+			Name:      "test-foo",
+			Namespace: "default",
+		}}
+		_ = expectedReconcileRequest
+
+		By("Failing to create a foo object if the crd isn't installed")
+		kindMatchErr := &meta.NoKindMatchError{}
+		err = cm.GetClient().Create(ctx, testFoo)
+		Expect(goerrors.As(err, &kindMatchErr)).To(BeTrue())
+
+		By("Installing the CRD")
+		crdPath := filepath.Join(".", "testdata", "foo", "foocrd.yaml")
+		crdOpts := envtest.CRDInstallOptions{
+			Paths:        []string{crdPath},
+			MaxTime:      50 * time.Millisecond,
+			PollInterval: 15 * time.Millisecond,
+		}
+		crds, err := envtest.InstallCRDs(cfg, crdOpts)
+		Expect(err).NotTo(HaveOccurred())
+		Expect(len(crds)).To(Equal(1))
+
+		By("Expecting to find the CRD")
+		crdv1 := &apiextensionsv1.CustomResourceDefinition{}
+		err = cm.GetClient().Get(context.TODO(), types.NamespacedName{Name: "foos.bar.example.com"}, crdv1)
+		Expect(err).NotTo(HaveOccurred())
+		Expect(crdv1.Spec.Names.Kind).To(Equal("Foo"))
+
+		err = envtest.WaitForCRDs(cfg, []client.Object{
+			&v1beta1.CustomResourceDefinition{
+				Spec: v1beta1.CustomResourceDefinitionSpec{
+					Group: "bar.example.com",
+					Names: v1beta1.CustomResourceDefinitionNames{
+						Kind:   "Foo",
+						Plural: "foos",
+					},
+					Versions: []v1beta1.CustomResourceDefinitionVersion{
+						{
+							Name:    "v1",
+							Storage: true,
+							Served:  true,
+						},
+					}},
+			},
+		},
+			crdOpts,
+		)
+		Expect(err).NotTo(HaveOccurred())
+
+		By("Invoking Reconcile for foo Create")
+		err = cm.GetClient().Create(ctx, testFoo)
+		Expect(err).NotTo(HaveOccurred())
+		Expect(<-reconciled).To(Equal(expectedReconcileRequest))
+
+		By("Uninstalling the CRD")
+		err = envtest.UninstallCRDs(cfg, crdOpts)
+		Expect(err).NotTo(HaveOccurred())
+		// wait for discovery to not recognize the resource after uninstall
+		wait.PollImmediate(15*time.Millisecond, 50*time.Millisecond, func() (bool, error) {
+			if _, err := clientset.Discovery().ServerResourcesForGroupVersion(gvk.Group + "/" + gvk.Version); err != nil {
+				if err.Error() == "the server could not find the requested resource" {
+					return true, nil
+				}
+			}
+			return false, nil
+		})
+
+		By("Failing create foo object if the crd isn't installed")
+		errNotFound := errors.NewGenericServerResponse(404, "POST", schema.GroupResource{Group: "bar.example.com", Resource: "foos"}, "", "404 page not found", 0, true)
+		err = cm.GetClient().Create(ctx, testFoo)
+		Expect(err).To(Equal(errNotFound))
+
+		By("Reinstalling the CRD")
+		crds, err = envtest.InstallCRDs(cfg, crdOpts)
+		Expect(err).NotTo(HaveOccurred())
+		Expect(len(crds)).To(Equal(1))
+
+		By("Expecting to find the CRD")
+		crdv1 = &apiextensionsv1.CustomResourceDefinition{}
+		err = cm.GetClient().Get(context.TODO(), types.NamespacedName{Name: "foos.bar.example.com"}, crdv1)
+		Expect(err).NotTo(HaveOccurred())
+		Expect(crdv1.Spec.Names.Kind).To(Equal("Foo"))
+
+		err = envtest.WaitForCRDs(cfg, []client.Object{
+			&v1beta1.CustomResourceDefinition{
+				Spec: v1beta1.CustomResourceDefinitionSpec{
+					Group: "bar.example.com",
+					Names: v1beta1.CustomResourceDefinitionNames{
+						Kind:   "Foo",
+						Plural: "foos",
+					},
+					Versions: []v1beta1.CustomResourceDefinitionVersion{
+						{
+							Name:    "v1",
+							Storage: true,
+							Served:  true,
+						},
+					}},
+			},
+		},
+			crdOpts,
+		)
+		Expect(err).NotTo(HaveOccurred())
+
+		By("Invoking Reconcile for foo Create")
+		testFoo.ResourceVersion = ""
+		err = cm.GetClient().Create(ctx, testFoo)
+		Expect(err).NotTo(HaveOccurred())
+		Expect(<-reconciled).To(Equal(expectedReconcileRequest))
+
+		By("Uninstalling the CRD")
+		err = envtest.UninstallCRDs(cfg, crdOpts)
+		Expect(err).NotTo(HaveOccurred())
+		// wait for discovery to not recognize the resource after uninstall
+		wait.PollImmediate(15*time.Millisecond, 50*time.Millisecond, func() (bool, error) {
+			if _, err := clientset.Discovery().ServerResourcesForGroupVersion(gvk.Group + "/" + gvk.Version); err != nil {
+				if err.Error() == "the server could not find the requested resource" {
+					return true, nil
+				}
+			}
+			return false, nil
+		})
+
+		By("Failing create foo object if the crd isn't installed")
+		err = cm.GetClient().Create(ctx, testFoo)
+		Expect(err).To(Equal(errNotFound))
+
+		close(done)
+	}, 10)
+
 })
 
 func truePtr() *bool {

pkg/controller/testdata/foo/foocrd.yaml

@@ -0,0 +1,17 @@
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  name: foos.bar.example.com
+spec:
+  group: bar.example.com
+  names:
+    kind: Foo
+    plural: foos
+  scope: Namespaced
+  versions:
+  - name: "v1"
+    storage: true
+    served: true
+    schema:
+      openAPIV3Schema:
+        type: object

pkg/controller/testdata/foo/v1/foo_types.go

@@ -0,0 +1,60 @@
+/*
+
+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 v1
+
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+// EDIT THIS FILE!  THIS IS SCAFFOLDING FOR YOU TO OWN!
+// NOTE: json tags are required.  Any new fields you add must have json tags for the fields to be serialized.
+
+// FooSpec defines the desired state of Foo
+type FooSpec struct {
+	// INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
+	// Important: Run "make" to regenerate code after modifying this file
+	RunAt string `json:"runAt"`
+}
+
+// FooStatus defines the observed state of Foo
+type FooStatus struct {
+	// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
+	// Important: Run "make" to regenerate code after modifying this file
+}
+
+// +kubebuilder:object:root=true
+
+// Foo is the Schema for the externaljobs API
+type Foo struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec   FooSpec   `json:"spec,omitempty"`
+	Status FooStatus `json:"status,omitempty"`
+}
+
+// +kubebuilder:object:root=true
+
+// FooList contains a list of Foo
+type FooList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []Foo `json:"items"`
+}
+
+func init() {
+	SchemeBuilder.Register(&Foo{}, &FooList{})
+}

pkg/controller/testdata/foo/v1/groupversion_info.go

@@ -0,0 +1,38 @@
+/*
+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.
+*/
+
+// +kubebuilder:object:generate=true
+// +groupName=chaosapps.metamagical.io
+package v1
+
+import (
+	"k8s.io/apimachinery/pkg/runtime/schema"
+	logf "sigs.k8s.io/controller-runtime/pkg/log"
+	"sigs.k8s.io/controller-runtime/pkg/scheme"
+)
+
+var (
+	log = logf.Log.WithName("foo-resource")
+
+	// SchemeGroupVersion is group version used to register these objects
+	SchemeGroupVersion = schema.GroupVersion{Group: "bar.example.com", Version: "v1"}
+
+	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
+	SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion}
+
+	// AddToScheme is required by pkg/client/...
+	AddToScheme = SchemeBuilder.AddToScheme
+)