Update a restore feature based on code review

Signed-off-by: Ales Raszka <araszka@redhat.com>

Author: Allda

apis/controller/v1alpha1/devworkspaceoperatorconfig_types.go

@@ -380,6 +380,8 @@ type ProjectCloneConfig struct {
 }
 
 type RestoreConfig struct {
+	// ImagePullPolicy configures the imagePullPolicy for the restore container.
+	// If undefined, the general setting .config.workspace.imagePullPolicy is used instead.
 	ImagePullPolicy corev1.PullPolicy `json:"imagePullPolicy,omitempty"`
 	// Resources defines the resource (cpu, memory) limits and requests for the restore
 	// container. To explicitly not specify a limit or request, define the resource

controllers/workspace/devworkspace_controller.go

@@ -365,7 +365,7 @@ func (r *DevWorkspaceReconciler) Reconcile(ctx context.Context, req ctrl.Request
 		} else {
 			restoreOptions.PullPolicy = corev1.PullIfNotPresent
 		}
-		if workspaceRestore, err := restore.GetWorkspaceRestoreInitContainer(ctx, workspace, clusterAPI.Client, restoreOptions, reqLogger); err != nil {
+		if workspaceRestore, err := restore.GetWorkspaceRestoreInitContainer(ctx, workspace, restoreOptions); err != nil {
 			return r.failWorkspace(workspace, fmt.Sprintf("Failed to set up workspace-restore init container: %s", err), metrics.ReasonInfrastructureFailure, reqLogger, &reconcileStatus), nil
 		} else if workspaceRestore != nil {
 			devfilePodAdditions.InitContainers = append([]corev1.Container{*workspaceRestore}, devfilePodAdditions.InitContainers...)

controllers/workspace/testdata/restore-workspace-disabled.yaml

@@ -0,0 +1,27 @@
+kind: DevWorkspace
+apiVersion: workspace.devfile.io/v1alpha2
+metadata:
+  labels:
+    controller.devfile.io/creator: ""
+spec:
+  started: true
+  routingClass: 'basic'
+  template:
+    attributes:
+      controller.devfile.io/storage-type: common
+      controller.devfile.io/restore-workspace: 'false'
+    projects:
+      - name: web-nodejs-sample
+        git:
+          remotes:
+            origin: "https://github.com/che-samples/web-nodejs-sample.git"
+    components:
+      - name: web-terminal
+        container:
+          image: quay.io/wto/web-terminal-tooling:latest
+          memoryLimit: 512Mi
+          mountSources: true
+          command:
+           - "tail"
+           - "-f"
+           - "/dev/null"

pkg/constants/attributes.go

@@ -153,11 +153,11 @@ const (
 	BootstrapDevWorkspaceAttribute = "controller.devfile.io/bootstrap-devworkspace"
 
 	// WorkspaceRestoreAttribute defines whether workspace restore should be performed for a DevWorkspace.
-	// If this attribute is present, the restore process will be performed during workspace
-	// initialization before the workspace containers start.
-
-	// The backup source is automatically determined from the cluster configuration or can be overridden
-	// by specifying the WorkspaceRestoreSourceImageAttribute.
+	// If this attribute is present and set to true, the restore process will be performed during
+	// workspace initialization, before workspace containers start.
+	//
+	// The backup source is automatically determined from the cluster configuration unless overridden
+	// by WorkspaceRestoreSourceImageAttribute.
 	WorkspaceRestoreAttribute = "controller.devfile.io/restore-workspace"
 
 	// WorkspaceRestoreSourceImageAttribute defines the backup image source to restore from for a DevWorkspace.

pkg/library/restore/restore.go

@@ -24,9 +24,7 @@ import (
 	"github.com/devfile/devworkspace-operator/pkg/common"
 	devfileConstants "github.com/devfile/devworkspace-operator/pkg/library/constants"
 	dwResources "github.com/devfile/devworkspace-operator/pkg/library/resources"
-	"github.com/go-logr/logr"
 	corev1 "k8s.io/api/core/v1"
-	"sigs.k8s.io/controller-runtime/pkg/client"
 
 	"github.com/devfile/devworkspace-operator/internal/images"
 	"github.com/devfile/devworkspace-operator/pkg/constants"
@@ -47,8 +45,7 @@ func IsWorkspaceRestoreRequested(workspace *dw.DevWorkspaceTemplateSpec) bool {
 	if !workspace.Attributes.Exists(constants.WorkspaceRestoreAttribute) {
 		return false
 	}
-	enableRecovery := workspace.Attributes.GetBoolean(constants.WorkspaceRestoreAttribute, nil)
-	return enableRecovery
+	return workspace.Attributes.GetBoolean(constants.WorkspaceRestoreAttribute, nil)
 
 }
 
@@ -57,18 +54,16 @@ func IsWorkspaceRestoreRequested(workspace *dw.DevWorkspaceTemplateSpec) bool {
 func GetWorkspaceRestoreInitContainer(
 	ctx context.Context,
 	workspace *common.DevWorkspaceWithConfig,
-	k8sClient client.Client,
 	options Options,
-	log logr.Logger,
 ) (*corev1.Container, error) {
-	wokrspaceTempplate := &workspace.Spec.Template
+	workspaceTemplate := &workspace.Spec.Template
 
 	// Determine the source image for restore
 	var err error
 	var restoreSourceImage string
-	if wokrspaceTempplate.Attributes.Exists(constants.WorkspaceRestoreSourceImageAttribute) {
+	if workspaceTemplate.Attributes.Exists(constants.WorkspaceRestoreSourceImageAttribute) {
 		// User choose custom image specified in the attribute
-		restoreSourceImage = wokrspaceTempplate.Attributes.GetString(constants.WorkspaceRestoreSourceImageAttribute, &err)
+		restoreSourceImage = workspaceTemplate.Attributes.GetString(constants.WorkspaceRestoreSourceImageAttribute, &err)
 		if err != nil {
 			return nil, fmt.Errorf("failed to read %s attribute on workspace: %w", constants.WorkspaceRestoreSourceImageAttribute, err)
 		}
@@ -86,7 +81,7 @@ func GetWorkspaceRestoreInitContainer(
 		return nil, fmt.Errorf("empty value for attribute %s is invalid", constants.WorkspaceRestoreSourceImageAttribute)
 	}
 
-	if !hasContainerComponents(wokrspaceTempplate) {
+	if !hasContainerComponents(workspaceTemplate) {
 		// Avoid adding restore init container when DevWorkspace does not define any containers
 		return nil, nil
 	}
@@ -101,7 +96,7 @@ func GetWorkspaceRestoreInitContainer(
 
 	resources := dwResources.FilterResources(options.Resources)
 	if err := dwResources.ValidateResources(resources); err != nil {
-		return nil, fmt.Errorf("invalid resources for project clone container: %w", err)
+		return nil, fmt.Errorf("invalid resources for workspace restore container: %w", err)
 	}
 
 	return &corev1.Container{