Move restore container condition to controller level

The condition whether an workspace should be restored from workspace was
in the restore module itself. This make a reading a code more difficult.
Now the condition is checked in the controller itself and restore
container is only added when enabled.

This commit also fixes few minor changes based on the code review
comments:
- Licence header
- Attribute validation
- Add a test for disabled workspace recovery
- Typos

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

Author: Allda

controllers/workspace/devworkspace_controller.go

@@ -354,25 +354,23 @@ func (r *DevWorkspaceReconciler) Reconcile(ctx context.Context, req ctrl.Request
 	if err := projects.ValidateAllProjects(&workspace.Spec.Template); err != nil {
 		return r.failWorkspace(workspace, fmt.Sprintf("Invalid devfile: %s", err), metrics.ReasonBadRequest, reqLogger, &reconcileStatus), nil
 	}
-	// Add init container to restore workspace from backup if requested
-	restoreOptions := restore.Options{
-		Env: env.GetErnvinmentVariablesForProjectRestore(workspace),
-	}
-	if config.Workspace.ImagePullPolicy != "" {
-		restoreOptions.PullPolicy = corev1.PullPolicy(config.Workspace.ImagePullPolicy)
+	if restore.IsWorkspaceRestoreRequested(&workspace.Spec.Template) {
+		// Add init container to restore workspace from backup if requested
+		restoreOptions := restore.Options{
+			Env: env.GetEnvironmentVariablesForProjectRestore(workspace),
+		}
+		if config.Workspace.ImagePullPolicy != "" {
+			restoreOptions.PullPolicy = corev1.PullPolicy(config.Workspace.ImagePullPolicy)
+		} else {
+			restoreOptions.PullPolicy = corev1.PullIfNotPresent
+		}
+		if workspaceRestore, err := restore.GetWorkspaceRestoreInitContainer(ctx, workspace, clusterAPI.Client, restoreOptions, reqLogger); 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...)
+		}
 	} else {
-		restoreOptions.PullPolicy = corev1.PullIfNotPresent
-	}
-	var workspaceRestoreCreated bool
-	if workspaceRestore, err := restore.GetWorkspaceRestoreInitContainer(ctx, workspace, clusterAPI.Client, restoreOptions, reqLogger); 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...)
-		workspaceRestoreCreated = true
-	}
-
-	// Add init container to clone projects only if restore container wasn't created
-	if !workspaceRestoreCreated {
+		// Add init container to clone projects only if restore container wasn't created
 		projectCloneOptions := projects.Options{
 			Image:     workspace.Config.Workspace.ProjectCloneConfig.Image,
 			Env:       env.GetEnvironmentVariablesForProjectClone(workspace),

controllers/workspace/devworkspace_controller_test.go

@@ -1094,7 +1094,6 @@ var _ = Describe("DevWorkspace Controller", func() {
 					cloneInitContainer = container
 				}
 			}
-			// Expect(initContainers).To(BeEmpty(), "Init containers should be present in deployment")
 			Expect(cloneInitContainer.Name).To(BeEmpty(), "Project clone init container should be omitted when restoring from backup")
 			Expect(restoreInitContainer).ToNot(BeNil(), "Workspace restore init container should not be nil")
 			Expect(restoreInitContainer.Name).To(Equal(restore.WorkspaceRestoreContainerName), "Workspace restore init container should be present in deployment")
@@ -1157,7 +1156,6 @@ var _ = Describe("DevWorkspace Controller", func() {
 					cloneInitContainer = container
 				}
 			}
-			// Expect(initContainers).To(BeEmpty(), "Init containers should be present in deployment")
 			Expect(cloneInitContainer.Name).To(BeEmpty(), "Project clone init container should be omitted when restoring from backup")
 			Expect(restoreInitContainer).ToNot(BeNil(), "Workspace restore init container should not be nil")
 			Expect(restoreInitContainer.Name).To(Equal(restore.WorkspaceRestoreContainerName), "Workspace restore init container should be present in deployment")
@@ -1173,6 +1171,57 @@ var _ = Describe("DevWorkspace Controller", func() {
 			}), "Restore init container should have workspace storage volume mounted at correct path")
 
 		})
+		It("Doesn't restore workspace from backup if restore is disabled", func() {
+			config.SetGlobalConfigForTesting(&controllerv1alpha1.OperatorConfiguration{
+				Workspace: &controllerv1alpha1.WorkspaceConfig{
+					BackupCronJob: &controllerv1alpha1.BackupCronJobConfig{
+						Enable: ptr.To[bool](true),
+						Registry: &controllerv1alpha1.RegistryConfig{
+							Path: "localhost:5000",
+						},
+					},
+				},
+			})
+			defer config.SetGlobalConfigForTesting(nil)
+			By("Reading DevWorkspace with restore configuration from testdata file")
+			createDevWorkspace(devWorkspaceName, "restore-workspace-disabled.yaml")
+			devworkspace := getExistingDevWorkspace(devWorkspaceName)
+			workspaceID := devworkspace.Status.DevWorkspaceId
+
+			By("Waiting for DevWorkspaceRouting to be created")
+			dwr := &controllerv1alpha1.DevWorkspaceRouting{}
+			dwrName := common.DevWorkspaceRoutingName(workspaceID)
+			Eventually(func() error {
+				return k8sClient.Get(ctx, namespacedName(dwrName, testNamespace), dwr)
+			}, timeout, interval).Should(Succeed(), "DevWorkspaceRouting should be created")
+
+			By("Manually making Routing ready to continue")
+			markRoutingReady(testURL, common.DevWorkspaceRoutingName(workspaceID))
+
+			By("Setting the deployment to have 1 ready replica")
+			markDeploymentReady(common.DeploymentName(devworkspace.Status.DevWorkspaceId))
+
+			deployment := &appsv1.Deployment{}
+			err := k8sClient.Get(ctx, namespacedName(devworkspace.Status.DevWorkspaceId, devworkspace.Namespace), deployment)
+			Expect(err).ToNot(HaveOccurred(), "Failed to get DevWorkspace deployment")
+
+			initContainers := deployment.Spec.Template.Spec.InitContainers
+			Expect(len(initContainers)).To(BeNumerically(">", 0), "No initContainers found in deployment")
+
+			var restoreInitContainer corev1.Container
+			var cloneInitContainer corev1.Container
+			for _, container := range initContainers {
+				if container.Name == restore.WorkspaceRestoreContainerName {
+					restoreInitContainer = container
+				}
+				if container.Name == projects.ProjectClonerContainerName {
+					cloneInitContainer = container
+				}
+			}
+			Expect(restoreInitContainer.Name).To(BeEmpty(), "Workspace restore init container should be omitted when restore is disabled")
+			Expect(cloneInitContainer).ToNot(BeNil(), "Project clone init container should not be nil")
+
+		})
 
 	})
 

pkg/constants/attributes.go

@@ -152,15 +152,15 @@ const (
 	// from the DevWorkspace
 	BootstrapDevWorkspaceAttribute = "controller.devfile.io/bootstrap-devworkspace"
 
-	// WorkspaceRestoreAttribute defines whether workspace restore should be performed when creating a 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.
 	WorkspaceRestoreAttribute = "controller.devfile.io/restore-workspace"
 
-	// WorkspaceRestoreSourceImageAttribute defines the backup image source to restore from when creating a DevWorkspace.
+	// WorkspaceRestoreSourceImageAttribute defines the backup image source to restore from for a DevWorkspace.
 	// The value should be a container image reference containing a workspace backup created by the backup functionality.
 	// The restore will be performed during workspace initialization before the workspace containers start.
 	// For example:

pkg/library/env/workspaceenv.go

@@ -49,7 +49,7 @@ func AddCommonEnvironmentVariables(podAdditions *v1alpha1.PodAdditions, clusterD
 	return nil
 }
 
-func GetErnvinmentVariablesForProjectRestore(workspace *common.DevWorkspaceWithConfig) []corev1.EnvVar {
+func GetEnvironmentVariablesForProjectRestore(workspace *common.DevWorkspaceWithConfig) []corev1.EnvVar {
 	var restoreEnv []corev1.EnvVar
 	restoreEnv = append(restoreEnv, commonEnvironmentVariables(workspace)...)
 	restoreEnv = append(restoreEnv, corev1.EnvVar{

pkg/library/restore/restore.go

@@ -1,5 +1,5 @@
 //
-// Copyright (c) 2019-2025 Red Hat, Inc.
+// Copyright (c) 2019-2026 Red Hat, Inc.
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
@@ -23,7 +23,6 @@ import (
 	dw "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2"
 	"github.com/devfile/devworkspace-operator/pkg/common"
 	devfileConstants "github.com/devfile/devworkspace-operator/pkg/library/constants"
-	"github.com/devfile/devworkspace-operator/pkg/library/storage"
 	"github.com/go-logr/logr"
 	corev1 "k8s.io/api/core/v1"
 	"sigs.k8s.io/controller-runtime/pkg/client"
@@ -43,6 +42,15 @@ type Options struct {
 	Env        []corev1.EnvVar
 }
 
+func IsWorkspaceRestoreRequested(workspace *dw.DevWorkspaceTemplateSpec) bool {
+	if !workspace.Attributes.Exists(constants.WorkspaceRestoreAttribute) {
+		return false
+	}
+	enableRecovery := workspace.Attributes.GetBoolean(constants.WorkspaceRestoreAttribute, nil)
+	return enableRecovery
+
+}
+
 // GetWorkspaceRestoreInitContainer creates an init container that restores workspace data from a backup image.
 // The restore container uses the existing workspace-recovery.sh script to extract backup content.
 func GetWorkspaceRestoreInitContainer(
@@ -53,21 +61,9 @@ func GetWorkspaceRestoreInitContainer(
 	log logr.Logger,
 ) (*corev1.Container, error) {
 	wokrspaceTempplate := &workspace.Spec.Template
-	// Check if restore is requested via workspace attribute
-	if !wokrspaceTempplate.Attributes.Exists(constants.WorkspaceRestoreAttribute) {
-		return nil, nil
-	}
-
-	// Get workspace PVC information for mounting into the restore container
-	pvcName, _, err := storage.GetWorkspacePVCInfo(ctx, workspace.DevWorkspace, workspace.Config, k8sClient, log)
-	if err != nil {
-		return nil, fmt.Errorf("failed to resolve workspace PVC info for restore: %w", err)
-	}
-	if pvcName == "" {
-		return nil, fmt.Errorf("no PVC found for workspace %s during restore", workspace.Name)
-	}
 
 	// Determine the source image for restore
+	var err error
 	var restoreSourceImage string
 	if wokrspaceTempplate.Attributes.Exists(constants.WorkspaceRestoreSourceImageAttribute) {
 		// User choose custom image specified in the attribute
@@ -115,7 +111,6 @@ func GetWorkspaceRestoreInitContainer(
 			},
 		},
 		ImagePullPolicy: options.PullPolicy,
-		// },
 	}, nil
 }
 

pkg/library/storage/storage.go

@@ -1,5 +1,5 @@
 //
-// Copyright (c) 2019-2025 Red Hat, Inc.
+// Copyright (c) 2019-2026 Red Hat, Inc.
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at