[BUG]: CSM Operator not deleting the deployment and daemon sets after…

… deleting the CSM (#815)

* Set default value for forceRemoveDriver to true if not specified by the user

* Update commonconfig.go

* Added e2e scenarios and test files

* Fixed linting issues

* Update steps_def.go

api/v1/types.go

@@ -226,7 +226,7 @@ type Driver struct {
 
 	// ForceRemoveDriver is the boolean flag used to remove driver deployment when CR is deleted
 	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Force Remove Driver"
-	ForceRemoveDriver bool `json:"forceRemoveDriver,omitempty" yaml:"forceRemoveDriver"`
+	ForceRemoveDriver *bool `json:"forceRemoveDriver,omitempty" yaml:"forceRemoveDriver"`
 }
 
 // ContainerTemplate template

controllers/csm_controller.go

@@ -271,6 +271,12 @@ func (r *ContainerStorageModuleReconciler) Reconcile(_ context.Context, req ctrl
 		ConfigDirectory: r.Config.ConfigDirectory,
 	}
 
+	// Set default value for forceRemoveDriver to true if not specified by the user
+	if csm.Spec.Driver.ForceRemoveDriver == nil {
+		truebool := true
+		csm.Spec.Driver.ForceRemoveDriver = &truebool
+	}
+
 	// Set default components if using miminal manifest (without components)
 	err = utils.LoadDefaultComponents(ctx, csm, *operatorConfig)
 	if err != nil {
@@ -289,7 +295,7 @@ func (r *ContainerStorageModuleReconciler) Reconcile(_ context.Context, req ctrl
 		log.Infow("Delete request", "csm", req.Namespace, "Name", req.Name)
 
 		// check for force cleanup
-		if csm.Spec.Driver.ForceRemoveDriver {
+		if *csm.Spec.Driver.ForceRemoveDriver {
 			// remove all resources deployed from CR by operator
 			if err := r.removeDriver(ctx, *csm, *operatorConfig); err != nil {
 				r.EventRecorder.Event(csm, corev1.EventTypeWarning, csmv1.EventDeleted, fmt.Sprintf("Failed to remove driver: %s", err))

controllers/csm_controller_test.go

@@ -2068,7 +2068,7 @@ func (suite *CSMControllerTestSuite) makeFakeCSM(name, ns string, withFinalizer
 		csm.ObjectMeta.Finalizers = []string{CSMFinalizerName}
 	}
 	// remove driver when deleting csm
-	csm.Spec.Driver.ForceRemoveDriver = true
+	csm.Spec.Driver.ForceRemoveDriver = &truebool
 	csm.Annotations[configVersionKey] = configVersion
 
 	csm.Spec.Modules = modules
@@ -2102,7 +2102,7 @@ func (suite *CSMControllerTestSuite) makeFakeResiliencyCSM(name, ns string, with
 		csm.ObjectMeta.Finalizers = []string{CSMFinalizerName}
 	}
 	// remove driver when deleting csm
-	csm.Spec.Driver.ForceRemoveDriver = true
+	csm.Spec.Driver.ForceRemoveDriver = &truebool
 	csm.Annotations[configVersionKey] = configVersion
 
 	csm.Spec.Modules = modules
@@ -2374,7 +2374,7 @@ func (suite *CSMControllerTestSuite) makeFakeRevProxyCSM(name string, ns string,
 		csm.ObjectMeta.Finalizers = []string{CSMFinalizerName}
 	}
 	// remove driver when deleting csm
-	csm.Spec.Driver.ForceRemoveDriver = true
+	csm.Spec.Driver.ForceRemoveDriver = &trueBool
 	csm.Spec.Modules = modules
 	out, _ := json.Marshal(&csm)
 	csm.Annotations[previouslyAppliedCustomResource] = string(out)

pkg/drivers/commonconfig.go

@@ -171,7 +171,7 @@ func GetController(ctx context.Context, cr csmv1.ContainerStorageModule, operato
 
 	crUID := cr.GetUID()
 	bController := true
-	bOwnerDeletion := !cr.Spec.Driver.ForceRemoveDriver
+	bOwnerDeletion := cr.Spec.Driver.ForceRemoveDriver != nil && !*cr.Spec.Driver.ForceRemoveDriver
 	kind := cr.Kind
 	v1 := "apps/v1"
 	controllerYAML.Deployment.OwnerReferences = []metacv1.OwnerReferenceApplyConfiguration{

tests/e2e/steps/steps_def.go

@@ -27,6 +27,8 @@ import (
 	"encoding/json"
 	"path/filepath"
 
+	"path/filepath"
+
 	"github.com/dell/csm-operator/pkg/constants"
 	"github.com/dell/csm-operator/pkg/modules"
 	"github.com/dell/csm-operator/pkg/utils"
@@ -1073,10 +1075,47 @@ func (step *Step) enableForceRemoveDriver(res Resource, crNumStr string) error {
 		return err
 	}
 
-	found.Spec.Driver.ForceRemoveDriver = true
+	truebool := true
+	found.Spec.Driver.ForceRemoveDriver = &truebool
 	return step.ctrlClient.Update(context.TODO(), found)
 }
 
+func (step *Step) validateForceRemoveDriverEnabled(res Resource, crNumStr string) error {
+	crNum, _ := strconv.Atoi(crNumStr)
+	cr := res.CustomResource[crNum-1].(csmv1.ContainerStorageModule)
+	found := new(csmv1.ContainerStorageModule)
+	if err := step.ctrlClient.Get(context.TODO(), client.ObjectKey{
+		Namespace: cr.Namespace,
+		Name:      cr.Name,
+	}, found,
+	); err != nil {
+		return err
+	}
+
+	if found.Spec.Driver.ForceRemoveDriver != nil && *found.Spec.Driver.ForceRemoveDriver {
+		return nil
+	}
+	return fmt.Errorf("forceRemoveDriver is not set to true")
+}
+
+func (step *Step) validateForceRemoveDriverDisabled(res Resource, crNumStr string) error {
+	crNum, _ := strconv.Atoi(crNumStr)
+	cr := res.CustomResource[crNum-1].(csmv1.ContainerStorageModule)
+	found := new(csmv1.ContainerStorageModule)
+	if err := step.ctrlClient.Get(context.TODO(), client.ObjectKey{
+		Namespace: cr.Namespace,
+		Name:      cr.Name,
+	}, found,
+	); err != nil {
+		return err
+	}
+
+	if found.Spec.Driver.ForceRemoveDriver != nil && !*found.Spec.Driver.ForceRemoveDriver {
+		return nil
+	}
+	return fmt.Errorf("forceRemoveDriver is not set to false")
+}
+
 func (step *Step) enableForceRemoveModule(res Resource, crNumStr string) error {
 	crNum, _ := strconv.Atoi(crNumStr)
 	cr := res.CustomResource[crNum-1].(csmv1.ContainerStorageModule)

tests/e2e/steps/steps_runner.go

@@ -44,6 +44,8 @@ func StepRunnerInit(runner *Runner, ctrlClient client.Client, clientSet *kuberne
 	runner.addStep(`^Install \[([^"]*)\]$`, step.installThirdPartyModule)
 	runner.addStep(`^Uninstall \[([^"]*)\]$`, step.uninstallThirdPartyModule)
 	runner.addStep(`^Apply custom resource \[(\d+)\]$`, step.applyCustomResource)
+	runner.addStep(`^Validate \[(\d+)\] CSM has forceRemoveDriver set to true$`, step.validateForceRemoveDriverEnabled)
+	runner.addStep(`^Validate \[(\d+)\] CSM has forceRemoveDriver set to false$`, step.validateForceRemoveDriverDisabled)
 	runner.addStep(`^Upgrade from custom resource \[(\d+)\] to \[(\d+)\]$`, step.upgradeCustomResource)
 	runner.addStep(`^Validate custom resource \[(\d+)\]$`, step.validateCustomResourceStatus)
 	runner.addStep(`^Validate \[([^"]*)\] driver from CR \[(\d+)\] is installed$`, step.validateDriverInstalled)