Finished first E2E test case by openshift/client-go and Kubernetes/client-go

openshift/client-go gives us more efficient functions to access cluster

Author: JianLi-RH

.openshift-tests-extension/openshift_payload_cluster-version-operator.json

@@ -1,6 +1,6 @@
 [
   {
-    "name": "[Jira:\"Cluster Version Operator\"] cluster-version-operator-tests should support passing tests the sanity test should pass",
+    "name": "[Jira:\"Cluster Version Operator\"] cluster-version-operator-tests should support passing tests",
     "labels": {},
     "resources": {
       "isolation": {}

cmd/cluster-version-operator-tests/README.md

@@ -32,6 +32,11 @@ After [installing-ginkgo](https://onsi.github.io/ginkgo/#installing-ginkgo):
 ```console
 $ ginkgo ./test/...
 ```
+or run a specific test
+```console
+$ ginkgo --focus "<test case name>" ./test/...
+```
+`test case name` is the text in g.It()
 
 The output looks nicer this way.
 

test/cvo/cvo.go

@@ -1,12 +1,84 @@
 package cvo
 
 import (
-	. "github.com/onsi/ginkgo/v2"
-	. "github.com/onsi/gomega"
+	"context"
+	"fmt"
+
+	g "github.com/onsi/ginkgo/v2"
+	o "github.com/onsi/gomega"
+	kerrors "k8s.io/apimachinery/pkg/api/errors"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/client-go/kubernetes"
+
+	v1 "github.com/openshift/client-go/config/clientset/versioned/typed/config/v1"
+	"github.com/openshift/cluster-version-operator/test/utilities"
 )
 
-var _ = Describe(`[Jira:"Cluster Version Operator"] cluster-version-operator-tests`, func() {
-	It("should support passing tests", func() {
-		Expect(true).To(BeTrue())
+var _ = g.Describe(`[Jira:"Cluster Version Operator"] cluster-version-operator-tests`, func() {
+	g.It("should support passing tests", func() {
+		o.Expect(true).To(o.BeTrue())
+	})
+})
+
+var _ = g.Describe("[Jira:Cluster Version Operator] The cluster version operator", g.Ordered, g.Label("cvo"), func() {
+	defer g.GinkgoRecover()
+	var client *v1.ConfigV1Client
+	var kubeclient *kubernetes.Clientset
+
+	g.BeforeAll(func() {
+		client = utilities.MustGetV1Client()
+		kubeclient = utilities.MustGetKubeClient()
+	})
+
+	g.It(`should not install resources annotated with release.openshift.io/delete=true`, g.Label("Conformance", "High", "42543"), func() {
+		annotation := "release.openshift.io/delete"
+
+		auths, err := client.Authentications().List(context.TODO(), metav1.ListOptions{})
+		o.Expect(kerrors.IsNotFound(err)).To(o.BeFalse(), "The NotFound error should occur when listing authentications")
+
+		g.By(fmt.Sprintf("checking if authentication with %s annotation exists", annotation))
+		for _, auth := range auths.Items {
+			if _, ok := auth.Annotations[annotation]; ok {
+				o.Expect(ok).NotTo(o.BeTrue(), fmt.Sprintf("Unexpectedly installed authentication %s which has '%s' annotation", auth.Name, annotation))
+			}
+		}
+
+		namespaces, err := kubeclient.CoreV1().Namespaces().List(context.TODO(), metav1.ListOptions{})
+		o.Expect(kerrors.IsNotFound(err)).To(o.BeFalse(), "The NotFound error should occur when listing namespaces")
+
+		g.By(fmt.Sprintf("checking if special resources with %s annotation exist in all namespaces", annotation))
+		for _, ns := range namespaces.Items {
+			namespace := ns.Name
+			fmt.Printf("namespace: %s\n", namespace)
+
+			fmt.Println("	- Test services...")
+			services, err := kubeclient.CoreV1().Services(namespace).List(context.TODO(), metav1.ListOptions{})
+			o.Expect(kerrors.IsNotFound(err)).To(o.BeFalse(), "The NotFound error should occur when listing services")
+			for _, service := range services.Items {
+				if _, ok := service.Annotations[annotation]; ok {
+					o.Expect(ok).NotTo(o.BeTrue(), fmt.Sprintf("Unexpectedly installed service %s which has '%s' annotation", service.Name, annotation))
+				}
+			}
+
+			fmt.Println("	- Test RoleBinding...")
+			rolebindings, err := kubeclient.RbacV1().RoleBindings(namespace).List(context.TODO(), metav1.ListOptions{})
+			o.Expect(kerrors.IsNotFound(err)).To(o.BeFalse(), "The NotFound error should occur when listing rolebindings")
+			for _, rb := range rolebindings.Items {
+				if _, ok := rb.Annotations[annotation]; ok {
+					o.Expect(ok).NotTo(o.BeTrue(), fmt.Sprintf("Unexpectedly installed RoleBinding %s which has '%s' annotation", rb.Name, annotation))
+				}
+			}
+
+			fmt.Println("	- Test CronJob...")
+			cronjobs, err := kubeclient.BatchV1().CronJobs(namespace).List(context.TODO(), metav1.ListOptions{})
+			o.Expect(kerrors.IsNotFound(err)).To(o.BeFalse(), "The NotFound error should occur when listing cronjobs")
+			for _, cj := range cronjobs.Items {
+				if _, ok := cj.Annotations[annotation]; ok {
+					o.Expect(ok).NotTo(o.BeTrue(), fmt.Sprintf("Unexpectedly installed CronJob %s which has %s annotation", cj.Name, annotation))
+				}
+			}
+
+			fmt.Println("success")
+		}
 	})
 })

test/utilities/connection.go

@@ -6,16 +6,25 @@ import (
 	"os"
 
 	"k8s.io/client-go/kubernetes"
+	"k8s.io/client-go/rest"
 	"k8s.io/client-go/tools/clientcmd"
+
+	configclientv1 "github.com/openshift/client-go/config/clientset/versioned/typed/config/v1"
 )
 
-// getKubeClient creates a Kubernetes clientset.
-func getKubeClient() (*kubernetes.Clientset, error) {
+// getKubeConfig get KUBECONFIG file from environment variable
+func getKubeConfig() (*rest.Config, error) {
 	configPath, present := os.LookupEnv("KUBECONFIG")
 	if !present {
 		return nil, errors.New("the environment variable KUBECONFIG must be set")
 	}
 	config, err := clientcmd.BuildConfigFromFlags("", configPath)
+	return config, err
+}
+
+// getKubeClient creates a kubernetes.Clientset instance.
+func getKubeClient() (*kubernetes.Clientset, error) {
+	config, err := getKubeConfig()
 	if err != nil {
 		return nil, fmt.Errorf("unable to load build config: %w", err)
 	}
@@ -24,14 +33,39 @@ func getKubeClient() (*kubernetes.Clientset, error) {
 	if err != nil {
 		return nil, fmt.Errorf("unable to create a Kubernetes clientset: %w", err)
 	}
+
 	return clientset, nil
 }
 
-// MustGetKubeClient creates a Kubernetes clientset, or panics on failures.
+// getV1Client creates a configclientv1.ConfigV1Client instance.
+func getV1Client() (*configclientv1.ConfigV1Client, error) {
+	config, err := getKubeConfig()
+	if err != nil {
+		return nil, fmt.Errorf("unable to load build config: %w", err)
+	}
+	// Create the Clientset
+	clientset, err := configclientv1.NewForConfig(config)
+	if err != nil {
+		return nil, fmt.Errorf("unable to create a configclientv1 clientset: %w", err)
+	}
+
+	return clientset, nil
+}
+
+// MustGetKubeClient creates a kubernetes.Clientset instance, or panics on failures.
 func MustGetKubeClient() *kubernetes.Clientset {
 	clientset, err := getKubeClient()
 	if err != nil {
 		panic("unable to create a Kubernetes clientset: " + err.Error())
 	}
 	return clientset
 }
+
+// MustGetV1Client creates a configclientv1.ConfigV1Client instance, or panics on failures.
+func MustGetV1Client() *configclientv1.ConfigV1Client {
+	clientset, err := getV1Client()
+	if err != nil {
+		panic("unable to create a configclientv1 clientset: " + err.Error())
+	}
+	return clientset
+}