Rework functionality for detecting existing PVCs on cluster

Rename the checkForExistingPVC function to make functionality clearer
and fix handling of common PVC when using DevWorkspaceWithConfig.

This fixes an issue where DWO does not provision the default common PVC.

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

Author: amisevsk

pkg/provision/storage/asyncStorage.go

@@ -89,7 +89,7 @@ func (p *AsyncStorageProvisioner) ProvisionStorage(podAdditions *v1alpha1.PodAdd
 		return err
 	}
 
-	pvcName, err := checkForExistingCommonPVC(workspace.Namespace, clusterAPI)
+	usingAlternatePVC, pvcName, err := checkForAlternatePVC(workspace.Namespace, clusterAPI)
 	if err != nil {
 		return err
 	}
@@ -107,7 +107,7 @@ func (p *AsyncStorageProvisioner) ProvisionStorage(podAdditions *v1alpha1.PodAdd
 		}
 	}
 
-	if pvcName != "" {
+	if !usingAlternatePVC {
 		// Create common PVC if needed
 		clusterPVC, err := syncCommonPVC(workspace.Namespace, workspace.Config, clusterAPI)
 		if err != nil {

pkg/provision/storage/cleanup.go

@@ -117,7 +117,7 @@ func runCommonPVCCleanupJob(workspace *common.DevWorkspaceWithConfig, clusterAPI
 func getSpecCommonPVCCleanupJob(workspace *common.DevWorkspaceWithConfig, clusterAPI sync.ClusterAPI) (*batchv1.Job, error) {
 	workspaceId := workspace.Status.DevWorkspaceId
 
-	pvcName, err := checkForExistingCommonPVC(workspace.Namespace, clusterAPI)
+	_, pvcName, err := checkForAlternatePVC(workspace.Namespace, clusterAPI)
 	if err != nil {
 		return nil, err
 	}

pkg/provision/storage/commonStorage.go

@@ -53,7 +53,7 @@ func (p *CommonStorageProvisioner) ProvisionStorage(podAdditions *v1alpha1.PodAd
 		return nil
 	}
 
-	pvcName, err := checkForExistingCommonPVC(workspace.Namespace, clusterAPI)
+	usingAlternatePVC, pvcName, err := checkForAlternatePVC(workspace.Namespace, clusterAPI)
 	if err != nil {
 		return err
 	}
@@ -71,7 +71,7 @@ func (p *CommonStorageProvisioner) ProvisionStorage(podAdditions *v1alpha1.PodAd
 		}
 	}
 
-	if pvcName == "" {
+	if !usingAlternatePVC {
 		commonPVC, err := syncCommonPVC(workspace.Namespace, workspace.Config, clusterAPI)
 		if err != nil {
 			return err

pkg/provision/storage/shared.go

@@ -219,21 +219,22 @@ func processProjectsVolume(workspace *dw.DevWorkspaceTemplateSpec) (projectsComp
 	return
 }
 
-// checkForExistingCommonPVC checks the current namespace for existing PVCs that may be used for workspace storage. If
+// checkForAlternatePVC checks the current namespace for existing PVCs that may be used for workspace storage. If
 // such a PVC is found, its name is returned and should be used in place of the configured common PVC. If no suitable
 // PVC is found, the returned PVC name is an empty string and a nil error is returned. If an error occurs during the lookup,
 // then an empty string is returned as well as the error.
-func checkForExistingCommonPVC(namespace string, api sync.ClusterAPI) (string, error) {
+// Currently, the only alternate PVC that can be used is named `claim-che-workspace`.
+func checkForAlternatePVC(namespace string, api sync.ClusterAPI) (exists bool, name string, err error) {
 	existingPVC := &corev1.PersistentVolumeClaim{}
 	namespacedName := types.NamespacedName{Name: constants.CheCommonPVCName, Namespace: namespace}
-	err := api.Client.Get(api.Ctx, namespacedName, existingPVC)
+	err = api.Client.Get(api.Ctx, namespacedName, existingPVC)
 	if err != nil {
 		if k8sErrors.IsNotFound(err) {
-			return "", nil
+			return false, "", nil
 		}
-		return "", err
+		return false, "", err
 	}
-	return existingPVC.Name, nil
+	return true, existingPVC.Name, nil
 }
 
 // getSharedPVCWorkspaceCount returns the total number of workspaces which are using a shared PVC