NO-ISSUE: OTA-1605 Create MustGetKubeClient function for e2e test

.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",
+    "name": "[Jira:\"Cluster Version Operator\"] cluster-version-operator-tests should support passing tests the sanity test should pass",
     "labels": {},
     "resources": {
       "isolation": {}

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

@@ -4,16 +4,28 @@ It integrates [openshift-tests-extension](https://github.com/openshift-eng/opens
 cluster-version-operator which allows openshift components to contribute tests to openshift-tests' suites with
 extension binaries.
 
+## Build the executable binary
+In root folder, run below command to build executable binary:
+```console
+$ make build
+```
 
 ## Run the tests locally
 
-## Using the framework
+### Using the binary
+- run a test-suite
+```console
+$ _output/<OS>/<ARCH>/cluster-version-operator-tests run-suite <test suite name>
+```
+where test suites can be listed by `_output/<OS>/<ARCH>/cluster-version-operator-tests info`.
+
+- run a single test case
 ```console
-$ hack/build-go.sh
-$ _output/<OS>/<ARCH>/cluster-version-operator-tests run-suite cluster-version-operator
+$ _output/<OS>/<ARCH>/cluster-version-operator-tests run-test <test case name>
 ```
+where test names can be listed by `_output/<OS>/<ARCH>/cluster-version-operator-tests list`.
 
-## Using ginko-cli
+### Using ginko-cli
 
 After [installing-ginkgo](https://onsi.github.io/ginkgo/#installing-ginkgo):
 

test/cvo/cvo.go

@@ -1,12 +1,12 @@
 package cvo
 
 import (
-	. "github.com/onsi/ginkgo/v2"
-	. "github.com/onsi/gomega"
+	g "github.com/onsi/ginkgo/v2"
+	o "github.com/onsi/gomega"
 )
 
-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 should support passing tests`, func() {
+	g.It("the sanity test should pass", func() {
+		o.Expect(true).To(o.BeTrue())
 	})
 })

test/utilities/connection.go

@@ -0,0 +1,122 @@
+package utilities
+
+import (
+	"errors"
+	"fmt"
+	"os"
+
+	"k8s.io/client-go/rest"
+	"k8s.io/client-go/tools/clientcmd"
+
+	configclient "github.com/openshift/client-go/config/clientset/versioned"
+	configclientv1 "github.com/openshift/client-go/config/clientset/versioned/typed/config/v1"
+	configv1alpha1 "github.com/openshift/client-go/config/clientset/versioned/typed/config/v1alpha1"
+	configv1alpha2 "github.com/openshift/client-go/config/clientset/versioned/typed/config/v1alpha2"
+)
+
+// getKubeConfig get KUBECONFIG file from environment variable
+func getKubeConfig() (*rest.Config, error) {
+	configPath, present := os.LookupEnv("KUBECONFIG")
+	fmt.Print("configPath: ", configPath)
+	if !present {
+		return nil, errors.New("the environment variable KUBECONFIG must be set")
+	}
+	config, err := clientcmd.BuildConfigFromFlags("", configPath)
+	return config, err
+}
+
+// getClient creates a configclient.Clientset instance.
+func getClient() (*configclient.Clientset, error) {
+	config, err := getKubeConfig()
+	if err != nil {
+		return nil, fmt.Errorf("unable to load build config: %w", err)
+	}
+	// Create the Clientset
+	clientset, err := configclient.NewForConfig(config)
+	if err != nil {
+		return nil, fmt.Errorf("unable to create a Kubernetes clientset: %w", err)
+	}
+
+	return clientset, nil
+}
+
+// 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 Kubernetes clientset: %w", err)
+	}
+
+	return clientset, nil
+}
+
+// getV1alpha1Client creates a configv1alpha1.ConfigV1alpha1Client instance.
+func getV1alpha1Client() (*configv1alpha1.ConfigV1alpha1Client, error) {
+	// Create the Clientset
+	config, err := getKubeConfig()
+	if err != nil {
+		return nil, fmt.Errorf("unable to load build config: %w", err)
+	}
+	clientset, err := configv1alpha1.NewForConfig(config)
+	if err != nil {
+		return nil, fmt.Errorf("unable to create a Kubernetes clientset: %w", err)
+	}
+
+	return clientset, nil
+}
+
+// getV1alpha2Client creates a configv1alpha2.ConfigV1alpha2Client instance.
+func getV1alpha2Client() (*configv1alpha2.ConfigV1alpha2Client, error) {
+	// Create the Clientset
+	config, err := getKubeConfig()
+	if err != nil {
+		return nil, fmt.Errorf("unable to load build config: %w", err)
+	}
+	clientset, err := configv1alpha2.NewForConfig(config)
+	if err != nil {
+		return nil, fmt.Errorf("unable to create a Kubernetes clientset: %w", err)
+	}
+
+	return clientset, nil
+}
+
+// MustGetClient creates a configclient.Clientset instance, or panics on failures.
+func MustGetClient() *configclient.Clientset {
+	clientset, err := getClient()
+	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 Kubernetes clientset: " + err.Error())
+	}
+	return clientset
+}
+
+// MUSTGetV1alpha1Client creates a configv1alpha1.ConfigV1alpha1Client instance, or panics on failures.
+func MUSTGetV1alpha1Client() *configv1alpha1.ConfigV1alpha1Client {
+	clientset, err := getV1alpha1Client()
+	if err != nil {
+		panic("unable to create a Kubernetes clientset: " + err.Error())
+	}
+	return clientset
+}
+
+// MUSTGetV1alpha2Client creates a configv1alpha2.ConfigV1alpha2Client instance, or panics on failures.
+func MUSTGetV1alpha2Client() *configv1alpha2.ConfigV1alpha2Client {
+	clientset, err := getV1alpha2Client()
+	if err != nil {
+		panic("unable to create a Kubernetes clientset: " + err.Error())
+	}
+	return clientset
+}