fix: Reconcile serviceAccount fields in redis deployment (#1635)

* fix redis SA updation issue Signed-off-by: Varsha B <[email protected]> * fix CI test failure Signed-off-by: Varsha B <[email protected]> --------- Signed-off-by: Varsha B <[email protected]>
argoproj-labs · Jan 8, 2025 · dd06745 · dd06745
1 parent 2fe1ab0
commit dd06745
Show file tree

Hide file tree

Showing 3 changed files with 69 additions and 1 deletion.
diff --git a/controllers/argocd/deployment.go b/controllers/argocd/deployment.go
@@ -592,6 +592,15 @@ func (r *ReconcileArgoCD) reconcileRedisDeployment(cr *argoproj.ArgoCD, useTLS b
 			changed = true
 		}
 
+		if !reflect.DeepEqual(deploy.Spec.Template.Spec.ServiceAccountName, existing.Spec.Template.Spec.ServiceAccountName) {
+			existing.Spec.Template.Spec.ServiceAccountName = deploy.Spec.Template.Spec.ServiceAccountName
+			if changed {
+				explanation += ", "
+			}
+			explanation += "serviceAccountName"
+			changed = true
+		}
+
 		if changed {
 			argoutil.LogResourceUpdate(log, existing, "updating", explanation)
 			return r.Client.Update(context.TODO(), existing)

diff --git a/controllers/argocd/deployment_test.go b/controllers/argocd/deployment_test.go
@@ -1833,6 +1833,65 @@ func TestReconcileArgoCD_reconcileRedisDeployment_with_error(t *testing.T) {
 	assert.Error(t, r.reconcileRedisDeployment(cr, false), "this is a test error")
 }
 
+func TestReconcileRedisDeployment_serviceAccountNameUpdate(t *testing.T) {
+	// tests SA update for redis deployment
+
+	tests := []struct {
+		name       string
+		SA         string
+		expectedSA string
+	}{
+		{
+			name:       "serviceAccountName field should reflect the original value",
+			SA:         "argocd-argocd-redis",
+			expectedSA: "argocd-argocd-redis",
+		},
+		{
+			name:       "serviceAccountName field should be reset to the original value with an existing SA modification",
+			SA:         "builder",
+			expectedSA: "argocd-argocd-redis",
+		},
+		{
+			name:       "serviceAccountName field should be reset to the original value with a non-existing SA modification",
+			SA:         "argocd-argocd-redis-new",
+			expectedSA: "argocd-argocd-redis",
+		},
+		{
+			name:       "serviceAccountName field should be reset to the original value and not left empty",
+			SA:         "",
+			expectedSA: "argocd-argocd-redis",
+		},
+	}
+
+	cr := makeTestArgoCD()
+
+	resObjs := []client.Object{cr}
+	subresObjs := []client.Object{cr}
+	runtimeObjs := []runtime.Object{}
+	sch := makeTestReconcilerScheme(argoproj.AddToScheme)
+	cl := makeTestReconcilerClient(sch, resObjs, subresObjs, runtimeObjs)
+	r := makeTestReconciler(cl, sch)
+
+	// Verify redis deployment
+	assert.NoError(t, r.reconcileRedisDeployment(cr, false))
+
+	// Verify SA update
+	for _, test := range tests {
+		t.Run(test.name, func(t *testing.T) {
+			existing := &appsv1.Deployment{}
+			assert.NoError(t, r.Client.Get(context.TODO(), types.NamespacedName{Name: cr.Name + "-redis", Namespace: cr.Namespace}, existing))
+
+			existing.Spec.Template.Spec.ServiceAccountName = test.SA
+			assert.NoError(t, cl.Update(context.TODO(), existing))
+			assert.NoError(t, r.reconcileRedisDeployment(cr, false))
+
+			newRedis := &appsv1.Deployment{}
+			assert.NoError(t, r.Client.Get(context.TODO(), types.NamespacedName{Name: cr.Name + "-redis", Namespace: cr.Namespace}, newRedis))
+			assert.Equal(t, newRedis.Spec.Template.Spec.ServiceAccountName, test.expectedSA)
+		})
+	}
+}
+
 func operationProcessors(n int32) argoCDOpt {
 	return func(a *argoproj.ArgoCD) {
 		a.Spec.Controller.Processors.Operation = n

diff --git a/tests/k8s/1-038_validate_controller_extra_command_args/03-remove-extraCommandArgs.yaml b/tests/k8s/1-038_validate_controller_extra_command_args/03-remove-extraCommandArgs.yaml
@@ -2,4 +2,4 @@ apiVersion: kuttl.dev/v1beta1
 kind: TestStep
 commands:
 - script: |
-    oc patch -n test-1-38-controller-extra-command argocds/example-argocd --type=json --patch '[{"op": "remove", "path": "/spec/controller/extraCommandArgs"}]'
+    kubectl patch -n test-1-38-controller-extra-command argocds/example-argocd --type=json --patch '[{"op": "remove", "path": "/spec/controller/extraCommandArgs"}]'