test: use t.Setenv to set env vars (#482)

This commit replaces `os.Setenv` with `t.Setenv` in tests. The
environment variable is automatically restored to its original value
when the test and all its subtests complete.

Reference: https://pkg.go.dev/testing#T.Setenv

Signed-off-by: Eng Zer Jun <[email protected]>
Co-authored-by: William Tam <[email protected]>

Author: Juneezee

controllers/argocd/openshift/clusterconfig_test.go

@@ -2,7 +2,7 @@ package openshift
 
 import (
 	"fmt"
-	"os"
+	"testing"
 
 	"k8s.io/apimachinery/pkg/util/intstr"
 
@@ -56,12 +56,8 @@ func makeTestArgoCD() *argoapp.ArgoCD {
 	return a
 }
 
-func setClusterConfigNamespaces() {
-	os.Setenv("ARGOCD_CLUSTER_CONFIG_NAMESPACES", "argocd,foo,bar")
-}
-
-func unSetClusterConfigNamespaces() {
-	os.Unsetenv("ARGOCD_CLUSTER_CONFIG_NAMESPACES")
+func setClusterConfigNamespaces(t *testing.T) {
+	t.Setenv("ARGOCD_CLUSTER_CONFIG_NAMESPACES", "argocd,foo,bar")
 }
 
 func makeTestClusterRole() *rbacv1.ClusterRole {

controllers/argocd/openshift/openshift_test.go

@@ -12,8 +12,7 @@ import (
 
 func TestReconcileArgoCD_reconcileApplicableClusterRole(t *testing.T) {
 
-	setClusterConfigNamespaces()
-	defer unSetClusterConfigNamespaces()
+	setClusterConfigNamespaces(t)
 
 	a := makeTestArgoCDForClusterConfig()
 	testClusterRole := &rbacv1.ClusterRole{
@@ -30,8 +29,7 @@ func TestReconcileArgoCD_reconcileApplicableClusterRole(t *testing.T) {
 
 func TestReconcileArgoCD_reconcileNotApplicableClusterRole(t *testing.T) {
 
-	setClusterConfigNamespaces()
-	defer unSetClusterConfigNamespaces()
+	setClusterConfigNamespaces(t)
 
 	a := makeTestArgoCDForClusterConfig()
 	testClusterRole := makeTestClusterRole()
@@ -42,8 +40,7 @@ func TestReconcileArgoCD_reconcileNotApplicableClusterRole(t *testing.T) {
 
 func TestReconcileArgoCD_reconcileMultipleClusterRoles(t *testing.T) {
 
-	setClusterConfigNamespaces()
-	defer unSetClusterConfigNamespaces()
+	setClusterConfigNamespaces(t)
 
 	a := makeTestArgoCDForClusterConfig()
 	testApplicableClusterRole := &rbacv1.ClusterRole{
@@ -66,8 +63,7 @@ func TestReconcileArgoCD_reconcileMultipleClusterRoles(t *testing.T) {
 
 func TestReconcileArgoCD_testDeployment(t *testing.T) {
 
-	setClusterConfigNamespaces()
-	defer unSetClusterConfigNamespaces()
+	setClusterConfigNamespaces(t)
 
 	a := makeTestArgoCDForClusterConfig()
 	testDeployment := makeTestDeployment()
@@ -77,8 +73,7 @@ func TestReconcileArgoCD_testDeployment(t *testing.T) {
 
 func TestReconcileArgoCD_notInClusterConfigNamespaces(t *testing.T) {
 
-	setClusterConfigNamespaces()
-	defer unSetClusterConfigNamespaces()
+	setClusterConfigNamespaces(t)
 
 	a := makeTestArgoCD()
 	testClusterRole := &rbacv1.ClusterRole{
@@ -193,8 +188,7 @@ func TestReconcileArgoCD_reconcileRedisHaServerStatefulSet(t *testing.T) {
 }
 
 func TestReconcileArgoCD_reconcileSecrets(t *testing.T) {
-	setClusterConfigNamespaces()
-	defer unSetClusterConfigNamespaces()
+	setClusterConfigNamespaces(t)
 
 	a := makeTestArgoCDForClusterConfig()
 	testSecret := &corev1.Secret{

controllers/argocd_controller_test.go

@@ -19,7 +19,6 @@ package controllers
 import (
 	"context"
 	"net/url"
-	"os"
 	"testing"
 
 	"github.com/argoproj-labs/argocd-operator/controllers/argocd"
@@ -77,33 +76,30 @@ func TestReconcile_create_consolelink(t *testing.T) {
 func TestReconcile_delete_consolelink(t *testing.T) {
 	logf.SetLogger(argocd.ZapLogger(true))
 
-	restoreEnvFunc := func() {
-		os.Unsetenv(disableArgoCDConsoleLink)
-	}
 	defer util.SetConsoleAPIFound(util.IsConsoleAPIFound())
 	util.SetConsoleAPIFound(true)
 
 	tests := []struct {
 		name                   string
-		setEnvVarFunc          func(string)
+		setEnvVarFunc          func(*testing.T, string)
 		envVar                 string
 		consoleLinkShouldExist bool
 		wantErr                bool
 		Err                    error
 	}{
 		{
 			name: "DISABLE_DEFAULT_ARGOCD_CONSOLELINK is set to true and consoleLink gets deleted",
-			setEnvVarFunc: func(envVar string) {
-				os.Setenv(disableArgoCDConsoleLink, envVar)
+			setEnvVarFunc: func(t *testing.T, envVar string) {
+				t.Setenv(disableArgoCDConsoleLink, envVar)
 			},
 			consoleLinkShouldExist: false,
 			envVar:                 "true",
 			wantErr:                false,
 		},
 		{
 			name: "DISABLE_DEFAULT_ARGOCD_CONSOLELINK is set to false and consoleLink doesn't get deleted",
-			setEnvVarFunc: func(envVar string) {
-				os.Setenv(disableArgoCDConsoleLink, envVar)
+			setEnvVarFunc: func(t *testing.T, envVar string) {
+				t.Setenv(disableArgoCDConsoleLink, envVar)
 			},
 			envVar:                 "false",
 			consoleLinkShouldExist: true,
@@ -120,14 +116,12 @@ func TestReconcile_delete_consolelink(t *testing.T) {
 
 	for _, test := range tests {
 		t.Run(test.name, func(t *testing.T) {
-			defer restoreEnvFunc()
-
 			reconcileArgoCD, fakeClient := newFakeReconcileArgoCD(argoCDRoute, consoleLink)
 			consoleLink := newConsoleLink("https://test.com", "Cluster Argo CD")
 			fakeClient.Create(context.TODO(), consoleLink)
 
 			if test.setEnvVarFunc != nil {
-				test.setEnvVarFunc(test.envVar)
+				test.setEnvVarFunc(t, test.envVar)
 			}
 
 			result, err := reconcileArgoCD.Reconcile(context.TODO(), newRequest(argocdNS, argocdInstanceName))

controllers/gitopsservice_controller_test.go

@@ -19,7 +19,6 @@ package controllers
 import (
 	"context"
 	"fmt"
-	"os"
 	"testing"
 
 	argoapp "github.com/argoproj-labs/argocd-operator/api/v1beta1"
@@ -54,8 +53,7 @@ func TestImageFromEnvVariable(t *testing.T) {
 	ns := types.NamespacedName{Name: "test", Namespace: "test"}
 	t.Run("Image present as env variable", func(t *testing.T) {
 		image := "quay.io/org/test"
-		os.Setenv(backendImageEnvName, image)
-		defer os.Unsetenv(backendImageEnvName)
+		t.Setenv(backendImageEnvName, image)
 
 		deployment := newBackendDeployment(ns)
 
@@ -75,8 +73,7 @@ func TestImageFromEnvVariable(t *testing.T) {
 
 	t.Run("Kam Image present as env variable", func(t *testing.T) {
 		image := "quay.io/org/test"
-		os.Setenv(cliImageEnvName, image)
-		defer os.Unsetenv(cliImageEnvName)
+		t.Setenv(cliImageEnvName, image)
 
 		deployment := newDeploymentForCLI()