Rework controller test utilities to reduce repetition

Extract common test functionality to functions that can be reused to
make test code less painfully long.

Signed-off-by: Angel Misevski <[email protected]>

Author: amisevsk

controllers/workspace/devworkspace_controller_test.go

@@ -104,24 +104,12 @@ var _ = Describe("DevWorkspace Controller", func() {
 	Context("Workspace Objects creation", func() {
 
 		BeforeEach(func() {
-			By("Reading DevWorkspace from testdata file")
-			devworkspace := &dw.DevWorkspace{}
-			err := loadObjectFromFile(devWorkspaceName, devworkspace, "test-devworkspace.yaml")
-			Expect(err).NotTo(HaveOccurred())
-
-			By("Creating a new DevWorkspace")
-			Expect(k8sClient.Create(ctx, devworkspace)).Should(Succeed())
-			createdDW := &dw.DevWorkspace{}
-			Eventually(func() bool {
-				if err := k8sClient.Get(ctx, types.NamespacedName{Name: devWorkspaceName, Namespace: testNamespace}, createdDW); err != nil {
-					return false
-				}
-				return createdDW.Status.DevWorkspaceId != ""
-			}, timeout, interval).Should(BeTrue())
+			createDevWorkspace("test-devworkspace.yaml")
 		})
 
 		AfterEach(func() {
 			deleteDevWorkspace(devWorkspaceName)
+			workspacecontroller.SetupHttpClientsForTesting(getBasicTestHttpClient())
 		})
 
 		It("Creates roles and rolebindings", func() {
@@ -152,11 +140,8 @@ var _ = Describe("DevWorkspace Controller", func() {
 		})
 
 		It("Creates DevWorkspaceRouting", func() {
-			By("Getting existing DevWorkspace from cluster")
-			devworkspace := &dw.DevWorkspace{}
-			Expect(k8sClient.Get(ctx, types.NamespacedName{Name: devWorkspaceName, Namespace: testNamespace}, devworkspace)).Should(Succeed())
+			devworkspace := getExistingDevWorkspace()
 			workspaceID := devworkspace.Status.DevWorkspaceId
-			Expect(workspaceID).ShouldNot(BeEmpty(), "DevWorkspaceID not set")
 
 			By("Checking that DevWorkspaceRouting is created")
 			dwr := &controllerv1alpha1.DevWorkspaceRouting{}
@@ -172,11 +157,8 @@ var _ = Describe("DevWorkspace Controller", func() {
 		})
 
 		It("Syncs Routing mainURL to DevWorkspace", func() {
-			By("Getting existing DevWorkspace from cluster")
-			devworkspace := &dw.DevWorkspace{}
-			Expect(k8sClient.Get(ctx, types.NamespacedName{Name: devWorkspaceName, Namespace: testNamespace}, devworkspace)).Should(Succeed())
+			devworkspace := getExistingDevWorkspace()
 			workspaceID := devworkspace.Status.DevWorkspaceId
-			Expect(workspaceID).ShouldNot(BeEmpty(), "DevWorkspaceID not set")
 
 			By("Manually making Routing ready to continue")
 			markRoutingReady("test-url", common.DevWorkspaceRoutingName(workspaceID))
@@ -191,11 +173,8 @@ var _ = Describe("DevWorkspace Controller", func() {
 		})
 
 		It("Creates workspace metadata configmap", func() {
-			By("Getting existing DevWorkspace from cluster")
-			devworkspace := &dw.DevWorkspace{}
-			Expect(k8sClient.Get(ctx, types.NamespacedName{Name: devWorkspaceName, Namespace: testNamespace}, devworkspace)).Should(Succeed())
+			devworkspace := getExistingDevWorkspace()
 			workspaceID := devworkspace.Status.DevWorkspaceId
-			Expect(workspaceID).ShouldNot(BeEmpty(), "DevWorkspaceID not set")
 
 			By("Manually making Routing ready to continue")
 			markRoutingReady("test-url", common.DevWorkspaceRoutingName(workspaceID))
@@ -224,11 +203,8 @@ var _ = Describe("DevWorkspace Controller", func() {
 		})
 
 		It("Syncs the DevWorkspace ServiceAccount", func() {
-			By("Getting existing DevWorkspace from cluster")
-			devworkspace := &dw.DevWorkspace{}
-			Expect(k8sClient.Get(ctx, types.NamespacedName{Name: devWorkspaceName, Namespace: testNamespace}, devworkspace)).Should(Succeed())
+			devworkspace := getExistingDevWorkspace()
 			workspaceID := devworkspace.Status.DevWorkspaceId
-			Expect(workspaceID).ShouldNot(BeEmpty(), "DevWorkspaceID not set")
 
 			By("Manually making Routing ready to continue")
 			markRoutingReady("test-url", common.DevWorkspaceRoutingName(workspaceID))
@@ -249,11 +225,8 @@ var _ = Describe("DevWorkspace Controller", func() {
 		})
 
 		It("Syncs DevWorkspace Deployment", func() {
-			By("Getting existing DevWorkspace from cluster")
-			devworkspace := &dw.DevWorkspace{}
-			Expect(k8sClient.Get(ctx, types.NamespacedName{Name: devWorkspaceName, Namespace: testNamespace}, devworkspace)).Should(Succeed())
+			devworkspace := getExistingDevWorkspace()
 			workspaceID := devworkspace.Status.DevWorkspaceId
-			Expect(workspaceID).ShouldNot(BeEmpty(), "DevWorkspaceID not set")
 
 			By("Manually making Routing ready to continue")
 			markRoutingReady("test-url", common.DevWorkspaceRoutingName(workspaceID))
@@ -274,12 +247,8 @@ var _ = Describe("DevWorkspace Controller", func() {
 		})
 
 		It("Marks DevWorkspace as Running", func() {
-			By("Getting existing DevWorkspace from cluster")
-			devworkspace := &dw.DevWorkspace{}
-			dwNN := types.NamespacedName{Name: devWorkspaceName, Namespace: testNamespace}
-			Expect(k8sClient.Get(ctx, dwNN, devworkspace)).Should(Succeed())
+			devworkspace := getExistingDevWorkspace()
 			workspaceID := devworkspace.Status.DevWorkspaceId
-			Expect(workspaceID).ShouldNot(BeEmpty(), "DevWorkspaceID not set")
 
 			workspacecontroller.SetupHttpClientsForTesting(&http.Client{
 				Transport: &testutil.TestRoundTripper{
@@ -298,7 +267,10 @@ var _ = Describe("DevWorkspace Controller", func() {
 
 			currDW := &dw.DevWorkspace{}
 			Eventually(func() (dw.DevWorkspacePhase, error) {
-				err := k8sClient.Get(ctx, dwNN, currDW)
+				err := k8sClient.Get(ctx, types.NamespacedName{
+					Name:      devworkspace.Name,
+					Namespace: devworkspace.Namespace,
+				}, currDW)
 				if err != nil {
 					return "", err
 				}

controllers/workspace/util_test.go

@@ -18,13 +18,42 @@ import (
 
 	dw "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2"
 	controllerv1alpha1 "github.com/devfile/devworkspace-operator/apis/controller/v1alpha1"
+	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
+
 	appsv1 "k8s.io/api/apps/v1"
 	k8sErrors "k8s.io/apimachinery/pkg/api/errors"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/types"
 )
 
+func createDevWorkspace(fromFile string) {
+	By("Loading DevWorkspace from test file")
+	devworkspace := &dw.DevWorkspace{}
+	err := loadObjectFromFile(devWorkspaceName, devworkspace, fromFile)
+	Expect(err).NotTo(HaveOccurred())
+
+	By("Creating DevWorkspace on cluster")
+	Expect(k8sClient.Create(ctx, devworkspace)).Should(Succeed())
+	createdDW := &dw.DevWorkspace{}
+	Eventually(func() bool {
+		if err := k8sClient.Get(ctx, types.NamespacedName{Name: devWorkspaceName, Namespace: testNamespace}, createdDW); err != nil {
+			return false
+		}
+		return createdDW.Status.DevWorkspaceId != ""
+	}, 10*time.Second, 250*time.Millisecond).Should(BeTrue())
+}
+
+func getExistingDevWorkspace() *dw.DevWorkspace {
+	By("Getting existing DevWorkspace")
+	devworkspace := &dw.DevWorkspace{}
+	dwNN := types.NamespacedName{Name: devWorkspaceName, Namespace: testNamespace}
+	Expect(k8sClient.Get(ctx, dwNN, devworkspace)).Should(Succeed())
+	workspaceID := devworkspace.Status.DevWorkspaceId
+	Expect(workspaceID).ShouldNot(BeEmpty(), "DevWorkspaceID not set")
+	return devworkspace
+}
+
 // deleteDevWorkspace forces a DevWorkspace to be deleted by removing all finalizers
 func deleteDevWorkspace(name string) {
 	dwNN := types.NamespacedName{Name: name, Namespace: testNamespace}