Update test utilities to allow creating multiple workspaces

Creating multiple workspaces during a test is required for testing
functionality that only triggers when multiple workspaces exist (e.g.
PVC cleanup)

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

Author: amisevsk

controllers/workspace/devworkspace_controller_test.go

@@ -170,7 +170,7 @@ var _ = Describe("DevWorkspace Controller", func() {
 	Context("Workspace Objects creation", func() {
 
 		BeforeEach(func() {
-			createDevWorkspace("test-devworkspace.yaml")
+			createDevWorkspace(devWorkspaceName, "test-devworkspace.yaml")
 		})
 
 		AfterEach(func() {
@@ -206,7 +206,7 @@ var _ = Describe("DevWorkspace Controller", func() {
 		})
 
 		It("Creates DevWorkspaceRouting", func() {
-			devworkspace := getExistingDevWorkspace()
+			devworkspace := getExistingDevWorkspace(devWorkspaceName)
 			workspaceID := devworkspace.Status.DevWorkspaceId
 
 			By("Checking that DevWorkspaceRouting is created")
@@ -223,7 +223,7 @@ var _ = Describe("DevWorkspace Controller", func() {
 		})
 
 		It("Syncs Routing mainURL to DevWorkspace", func() {
-			devworkspace := getExistingDevWorkspace()
+			devworkspace := getExistingDevWorkspace(devWorkspaceName)
 			workspaceID := devworkspace.Status.DevWorkspaceId
 
 			By("Manually making Routing ready to continue")
@@ -239,7 +239,7 @@ var _ = Describe("DevWorkspace Controller", func() {
 		})
 
 		It("Creates workspace metadata configmap", func() {
-			devworkspace := getExistingDevWorkspace()
+			devworkspace := getExistingDevWorkspace(devWorkspaceName)
 			workspaceID := devworkspace.Status.DevWorkspaceId
 
 			By("Manually making Routing ready to continue")
@@ -266,7 +266,7 @@ var _ = Describe("DevWorkspace Controller", func() {
 		})
 
 		It("Syncs the DevWorkspace ServiceAccount", func() {
-			devworkspace := getExistingDevWorkspace()
+			devworkspace := getExistingDevWorkspace(devWorkspaceName)
 			workspaceID := devworkspace.Status.DevWorkspaceId
 
 			By("Manually making Routing ready to continue")
@@ -285,7 +285,7 @@ var _ = Describe("DevWorkspace Controller", func() {
 		})
 
 		It("Syncs DevWorkspace Deployment", func() {
-			devworkspace := getExistingDevWorkspace()
+			devworkspace := getExistingDevWorkspace(devWorkspaceName)
 			workspaceID := devworkspace.Status.DevWorkspaceId
 
 			By("Manually making Routing ready to continue")
@@ -304,7 +304,7 @@ var _ = Describe("DevWorkspace Controller", func() {
 		})
 
 		It("Marks DevWorkspace as Running", func() {
-			devworkspace := getExistingDevWorkspace()
+			devworkspace := getExistingDevWorkspace(devWorkspaceName)
 			workspaceID := devworkspace.Status.DevWorkspaceId
 
 			workspacecontroller.SetupHttpClientsForTesting(&http.Client{
@@ -354,7 +354,7 @@ var _ = Describe("DevWorkspace Controller", func() {
 					},
 				},
 			})
-			createDevWorkspace("test-devworkspace.yaml")
+			createDevWorkspace(devWorkspaceName, "test-devworkspace.yaml")
 		})
 
 		AfterEach(func() {
@@ -363,7 +363,7 @@ var _ = Describe("DevWorkspace Controller", func() {
 		})
 
 		It("Mounts image pull secrets to the DevWorkspace Deployment", func() {
-			devworkspace := getExistingDevWorkspace()
+			devworkspace := getExistingDevWorkspace(devWorkspaceName)
 			workspaceID := devworkspace.Status.DevWorkspaceId
 
 			By("Creating secrets for docker configs")
@@ -395,7 +395,7 @@ var _ = Describe("DevWorkspace Controller", func() {
 		})
 
 		It("Manages git credentials for DevWorkspace", func() {
-			devworkspace := getExistingDevWorkspace()
+			devworkspace := getExistingDevWorkspace(devWorkspaceName)
 			workspaceID := devworkspace.Status.DevWorkspaceId
 
 			By("Creating a secret for git credentials")
@@ -457,7 +457,7 @@ var _ = Describe("DevWorkspace Controller", func() {
 		})
 
 		It("Automounts secrets and configmaps volumes", func() {
-			devworkspace := getExistingDevWorkspace()
+			devworkspace := getExistingDevWorkspace(devWorkspaceName)
 			workspaceID := devworkspace.Status.DevWorkspaceId
 
 			By("Creating a automount secrets and configmaps")
@@ -519,7 +519,7 @@ var _ = Describe("DevWorkspace Controller", func() {
 		})
 
 		It("Automounts secrets and configmaps env vars", func() {
-			devworkspace := getExistingDevWorkspace()
+			devworkspace := getExistingDevWorkspace(devWorkspaceName)
 			workspaceID := devworkspace.Status.DevWorkspaceId
 
 			By("Creating a automount secrets and configmaps")
@@ -574,7 +574,7 @@ var _ = Describe("DevWorkspace Controller", func() {
 					},
 				},
 			})
-			createStartedDevWorkspace("test-devworkspace.yaml")
+			createStartedDevWorkspace(devWorkspaceName, "test-devworkspace.yaml")
 		})
 
 		AfterEach(func() {
@@ -587,7 +587,7 @@ var _ = Describe("DevWorkspace Controller", func() {
 
 			By("Setting DevWorkspace's .spec.started to false")
 			Eventually(func() error {
-				devworkspace = getExistingDevWorkspace()
+				devworkspace = getExistingDevWorkspace(devWorkspaceName)
 				devworkspace.Spec.Started = false
 				return k8sClient.Update(ctx, devworkspace)
 			}, timeout, interval).Should(Succeed(), "Update DevWorkspace to have .spec.started = false")
@@ -645,7 +645,7 @@ var _ = Describe("DevWorkspace Controller", func() {
 
 			By("Setting DevWorkspace's .spec.started to false")
 			Eventually(func() error {
-				devworkspace = getExistingDevWorkspace()
+				devworkspace = getExistingDevWorkspace(devWorkspaceName)
 				devworkspace.Spec.Started = false
 				return k8sClient.Update(ctx, devworkspace)
 			}, timeout, interval).Should(Succeed(), "Update DevWorkspace to have .spec.started = false")
@@ -693,7 +693,7 @@ var _ = Describe("DevWorkspace Controller", func() {
 
 			By("Set debug start annotation on DevWorkspace")
 			Eventually(func() error {
-				devworkspace = getExistingDevWorkspace()
+				devworkspace = getExistingDevWorkspace(devWorkspaceName)
 				if devworkspace.Annotations == nil {
 					devworkspace.Annotations = map[string]string{}
 				}
@@ -710,7 +710,7 @@ var _ = Describe("DevWorkspace Controller", func() {
 
 			By("Setting failing phase on workspace directly")
 			Eventually(func() error {
-				devworkspace = getExistingDevWorkspace()
+				devworkspace = getExistingDevWorkspace(devWorkspaceName)
 				devworkspace.Status.Phase = "Failing"
 				devworkspace.Status.Conditions = append(devworkspace.Status.Conditions, dw.DevWorkspaceCondition{
 					Type:               dw.DevWorkspaceFailedStart,
@@ -735,7 +735,7 @@ var _ = Describe("DevWorkspace Controller", func() {
 
 			By("Setting failing phase on workspace directly")
 			Eventually(func() error {
-				devworkspace = getExistingDevWorkspace()
+				devworkspace = getExistingDevWorkspace(devWorkspaceName)
 				devworkspace.Status.Phase = "Failing"
 				return k8sClient.Status().Update(ctx, devworkspace)
 			}, timeout, interval).Should(Succeed(), "Should be able to set failing status on DevWorkspace")

controllers/workspace/util_test.go

@@ -14,6 +14,7 @@
 package controllers_test
 
 import (
+	"fmt"
 	"path"
 	"time"
 
@@ -40,10 +41,10 @@ const (
 
 var clock kubeclock.Clock = &kubeclock.RealClock{}
 
-func createDevWorkspace(fromFile string) {
+func createDevWorkspace(name, fromFile string) {
 	By("Loading DevWorkspace from test file")
 	devworkspace := &dw.DevWorkspace{}
-	err := loadObjectFromFile(devWorkspaceName, devworkspace, fromFile)
+	err := loadObjectFromFile(name, devworkspace, fromFile)
 	Expect(err).NotTo(HaveOccurred())
 
 	By("Creating DevWorkspace on cluster")
@@ -57,9 +58,9 @@ func createDevWorkspace(fromFile string) {
 	}, 10*time.Second, 250*time.Millisecond).Should(BeTrue())
 }
 
-func createStartedDevWorkspace(fromFile string) {
-	createDevWorkspace(fromFile)
-	devworkspace := getExistingDevWorkspace()
+func createStartedDevWorkspace(name, fromFile string) {
+	createDevWorkspace(name, fromFile)
+	devworkspace := getExistingDevWorkspace(name)
 	workspaceID := devworkspace.Status.DevWorkspaceId
 
 	By("Manually making Routing ready to continue")
@@ -78,13 +79,16 @@ func createStartedDevWorkspace(fromFile string) {
 	}, timeout, interval).Should(Equal(dw.DevWorkspaceStatusRunning), "Workspace did not enter Running phase before timeout")
 }
 
-func getExistingDevWorkspace() *dw.DevWorkspace {
-	By("Getting existing DevWorkspace")
+func getExistingDevWorkspace(name string) *dw.DevWorkspace {
+	By(fmt.Sprintf("Getting existing DevWorkspace %s", name))
 	devworkspace := &dw.DevWorkspace{}
-	dwNN := namespacedName(devWorkspaceName, testNamespace)
-	Expect(k8sClient.Get(ctx, dwNN, devworkspace)).Should(Succeed())
-	workspaceID := devworkspace.Status.DevWorkspaceId
-	Expect(workspaceID).ShouldNot(BeEmpty(), "DevWorkspaceID not set")
+	dwNN := namespacedName(name, testNamespace)
+	Eventually(func() (string, error) {
+		if err := k8sClient.Get(ctx, dwNN, devworkspace); err != nil {
+			return "", err
+		}
+		return devworkspace.Status.DevWorkspaceId, nil
+	}, timeout, interval).Should(Not(BeEmpty()))
 	return devworkspace
 }
 
@@ -94,8 +98,13 @@ func deleteDevWorkspace(name string) {
 	dw := &dw.DevWorkspace{}
 	dw.Name = name
 	dw.Namespace = testNamespace
-	Expect(k8sClient.Delete(ctx, dw)).Should(Succeed())
-	err := k8sClient.Get(ctx, dwNN, dw)
+	// Do nothing if already deleted
+	err := k8sClient.Delete(ctx, dw)
+	if k8sErrors.IsNotFound(err) {
+		return
+	}
+	Expect(err).Should(BeNil())
+	err = k8sClient.Get(ctx, dwNN, dw)
 	if err != nil {
 		Expect(k8sErrors.IsNotFound(err)).Should(BeTrue(), "Unexpected error when deleting DevWorkspace: %s", err)
 		return
@@ -121,7 +130,7 @@ func deleteDevWorkspace(name string) {
 	Eventually(func() bool {
 		err := k8sClient.Get(ctx, dwNN, dw)
 		return err != nil && k8sErrors.IsNotFound(err)
-	}).Should(BeTrue(), "DevWorkspace not deleted after timeout")
+	}, 10*time.Second, 250*time.Millisecond).Should(BeTrue(), "DevWorkspace not deleted after timeout")
 }
 
 func createObject(obj crclient.Object) {