Add tests for GC assumptions.

The ClusterRoles that OLM creates per provided API now have owner
references to their respective CRD or APIService instead of owner
labels to a providing OperatorGroup. These tests verify that the
Kubernetes garbage collector behaves as expected.

Author: benluddy

test/e2e/convert_suite_test.go

@@ -2,14 +2,15 @@ package e2e
 
 import (
 	"flag"
-	v1 "github.com/operator-framework/operator-lifecycle-manager/pkg/api/apis/operators/v1"
-	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"testing"
-
-	"github.com/operator-framework/operator-lifecycle-manager/pkg/api/client"
+	"time"
 
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+
+	v1 "github.com/operator-framework/operator-lifecycle-manager/pkg/api/apis/operators/v1"
+	"github.com/operator-framework/operator-lifecycle-manager/pkg/api/client"
 )
 
 var (
@@ -39,6 +40,8 @@ var (
 
 func TestConvert(t *testing.T) {
 	RegisterFailHandler(Fail)
+	SetDefaultEventuallyTimeout(1 * time.Minute)
+	SetDefaultEventuallyPollingInterval(1 * time.Second)
 	RunSpecs(t, "Convert Suite")
 }
 

test/e2e/dsl/dsl.go

@@ -0,0 +1,30 @@
+package dsl
+
+import (
+	"fmt"
+
+	. "github.com/onsi/ginkgo"
+)
+
+// IgnoreError acknowledges that an error value is being intentionally
+// disregarded.
+//
+// In general, errors should not be ignored, however, errors may be
+// unimportant in certain test scenarios. IgnoreError accepts a
+// variable-length argument list, like Expect(), as a convenience for
+// functions returning values and an error, e.g. `func DoSomething()
+// (string, error)`. IgnoreError will fail the current test if the
+// last argument is neither nil nor a non-nil error.
+func IgnoreError(vals ...interface{}) {
+	if len(vals) == 0 {
+		return
+	}
+	err := vals[len(vals)-1]
+	if err == nil {
+		return
+	}
+	if _, ok := err.(error); ok {
+		return
+	}
+	Fail(fmt.Sprintf("the last argument to IgnoreError must be an error, but it was %T", err))
+}

test/e2e/gc_e2e_test.go

@@ -1,17 +1,115 @@
 package e2e
 
 import (
+	"fmt"
+
 	"github.com/blang/semver"
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
 	"github.com/stretchr/testify/require"
 	corev1 "k8s.io/api/core/v1"
+	rbacv1 "k8s.io/api/rbac/v1"
+	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 	k8serrors "k8s.io/apimachinery/pkg/api/errors"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/util/rand"
+	apiregistrationv1 "k8s.io/kube-aggregator/pkg/apis/apiregistration/v1"
 
-	. "github.com/onsi/ginkgo"
 	"github.com/operator-framework/operator-lifecycle-manager/pkg/lib/ownerutil"
+	. "github.com/operator-framework/operator-lifecycle-manager/test/e2e/dsl"
 )
 
-var _ = Describe("Garbage Collection", func() {
+var _ = Describe("Garbage collector", func() {
+	It("should delete a ClusterRole owned by a CustomResourceDefinition when the owner is deleted", func() {
+		c := newKubeClient(GinkgoT())
+
+		group := fmt.Sprintf("%s.com", rand.String(16))
+		crd, err := c.ApiextensionsV1beta1Interface().ApiextensionsV1().CustomResourceDefinitions().Create(&apiextensionsv1.CustomResourceDefinition{
+			ObjectMeta: metav1.ObjectMeta{
+				Name: fmt.Sprintf("plural.%s", group),
+			},
+			Spec: apiextensionsv1.CustomResourceDefinitionSpec{
+				Group: group,
+				Scope: apiextensionsv1.ClusterScoped,
+				Versions: []apiextensionsv1.CustomResourceDefinitionVersion{
+					apiextensionsv1.CustomResourceDefinitionVersion{
+						Name:    "v1",
+						Served:  true,
+						Storage: true,
+						Schema: &apiextensionsv1.CustomResourceValidation{
+							&apiextensionsv1.JSONSchemaProps{Type: "object"},
+						},
+					},
+				},
+				Names: apiextensionsv1.CustomResourceDefinitionNames{
+					Plural:   "plural",
+					Singular: "singular",
+					Kind:     "Kind",
+					ListKind: "KindList",
+				},
+			},
+		})
+		Expect(err).NotTo(HaveOccurred())
+		defer func() {
+			IgnoreError(c.ApiextensionsV1beta1Interface().ApiextensionsV1().CustomResourceDefinitions().Delete(crd.GetName(), &metav1.DeleteOptions{}))
+		}()
+
+		cr, err := c.CreateClusterRole(&rbacv1.ClusterRole{
+			ObjectMeta: metav1.ObjectMeta{
+				GenerateName:    "clusterrole-",
+				OwnerReferences: []metav1.OwnerReference{ownerutil.NonBlockingOwner(crd)},
+			},
+		})
+		Expect(err).NotTo(HaveOccurred())
+		defer func() {
+			IgnoreError(c.DeleteClusterRole(cr.GetName(), &metav1.DeleteOptions{}))
+		}()
+
+		Expect(c.ApiextensionsV1beta1Interface().ApiextensionsV1().CustomResourceDefinitions().Delete(crd.GetName(), &metav1.DeleteOptions{})).To(Succeed())
+		Eventually(func() bool {
+			_, err := c.GetClusterRole(cr.GetName())
+			return k8serrors.IsNotFound(err)
+		}).Should(BeTrue(), "get cluster role should eventually return \"not found\"")
+	})
+
+	It("should delete a ClusterRole owned by an APIService when the owner is deleted", func() {
+		c := newKubeClient(GinkgoT())
+
+		group := rand.String(16)
+		as, err := c.CreateAPIService(&apiregistrationv1.APIService{
+			ObjectMeta: metav1.ObjectMeta{
+				Name: fmt.Sprintf("v1.%s", group),
+			},
+			Spec: apiregistrationv1.APIServiceSpec{
+				Group:                group,
+				Version:              "v1",
+				GroupPriorityMinimum: 1,
+				VersionPriority:      1,
+			},
+		})
+		Expect(err).NotTo(HaveOccurred())
+		defer func() {
+			IgnoreError(c.DeleteAPIService(as.GetName(), &metav1.DeleteOptions{}))
+		}()
+
+		cr, err := c.CreateClusterRole(&rbacv1.ClusterRole{
+			ObjectMeta: metav1.ObjectMeta{
+				GenerateName:    "clusterrole-",
+				OwnerReferences: []metav1.OwnerReference{ownerutil.NonBlockingOwner(as)},
+			},
+		})
+		Expect(err).NotTo(HaveOccurred())
+		defer func() {
+			IgnoreError(c.DeleteClusterRole(cr.GetName(), &metav1.DeleteOptions{}))
+		}()
+
+		Expect(c.DeleteAPIService(as.GetName(), &metav1.DeleteOptions{})).To(Succeed())
+		Eventually(func() bool {
+			_, err := c.GetClusterRole(cr.GetName())
+			return k8serrors.IsNotFound(err)
+		}).Should(BeTrue(), "get cluster role should eventually return \"not found\"")
+	})
+
 	It("owner reference GC behavior", func() {
 
 		// TestOwnerReferenceGCBehavior runs a simple check on OwnerReference behavior to ensure