chore: adding test coverage for the notification_controller (#13339)

* Adding unit tests for the Init function: for the notification controller Signed-off-by: zhaque44 <haque.zubair@gmail.com> * Adding unit tests for getAppProj function: for the notification controller Signed-off-by: zhaque44 <haque.zubair@gmail.com> * fixing linting errors for indexer.Add in build Signed-off-by: zhaque44 <haque.zubair@gmail.com> * rm appProj test(s) to assess linting issue Signed-off-by: zhaque44 <haque.zubair@gmail.com> * adding first test case for getAppProj Signed-off-by: zhaque44 <haque.zubair@gmail.com> * add happy path for getAppProj func() Signed-off-by: zhaque44 <haque.zubair@gmail.com> * updating test function to reduce duplication Signed-off-by: zhaque44 <haque.zubair@gmail.com> * sanity test fot getAppProj: rm test struct pattern to test generic scenarios Signed-off-by: zhaque44 <haque.zubair@gmail.com> * verifies that getAppProj gracefully handles input with missing "project" field and returns nil Signed-off-by: zhaque44 <haque.zubair@gmail.com> * chore: isAppSyncStatusRefreshed test for improved coverage Signed-off-by: zhaque44 <haque.zubair@gmail.com> --------- Signed-off-by: zhaque44 <haque.zubair@gmail.com>
argoproj · Apr 27, 2023 · 03513eb · 03513eb
1 parent 1fe6257
commit 03513eb
Showing 1 changed file with 166 additions and 0 deletions.
diff --git a/notification_controller/controller/controller_test.go b/notification_controller/controller/controller_test.go
@@ -0,0 +1,166 @@
+package controller
+
+import (
+	"context"
+	"testing"
+	"time"
+
+	"github.com/argoproj/argo-cd/v2/pkg/apis/application/v1alpha1"
+	"github.com/sirupsen/logrus/hooks/test"
+	"github.com/stretchr/testify/assert"
+	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
+	"k8s.io/apimachinery/pkg/runtime"
+	"k8s.io/client-go/dynamic/fake"
+	k8sfake "k8s.io/client-go/kubernetes/fake"
+	"k8s.io/client-go/tools/cache"
+)
+
+func TestIsAppSyncStatusRefreshed(t *testing.T) {
+	logger, _ := test.NewNullLogger()
+	logEntry := logger.WithField("", "")
+
+	tests := []struct {
+		name          string
+		app           *unstructured.Unstructured
+		expectedValue bool
+	}{
+		{
+			name: "No OperationState",
+			app: &unstructured.Unstructured{
+				Object: map[string]interface{}{
+					"status": map[string]interface{}{},
+				},
+			},
+			expectedValue: true,
+		},
+		{
+			name: "No FinishedAt, Completed Phase",
+			app: &unstructured.Unstructured{
+				Object: map[string]interface{}{
+					"status": map[string]interface{}{
+						"operationState": map[string]interface{}{
+							"phase": "Succeeded",
+						},
+					},
+				},
+			},
+			expectedValue: false,
+		},
+		{
+			name: "FinishedAt After ReconciledAt & ObservedAt",
+			app: &unstructured.Unstructured{
+				Object: map[string]interface{}{
+					"status": map[string]interface{}{
+						"operationState": map[string]interface{}{
+							"finishedAt": "2021-01-01T01:05:00Z",
+							"phase":      "Succeeded",
+						},
+						"reconciledAt": "2021-01-01T01:02:00Z",
+						"observedAt":   "2021-01-01T01:04:00Z",
+					},
+				},
+			},
+			expectedValue: false,
+		},
+		{
+			name: "FinishedAt Before ReconciledAt & ObservedAt",
+			app: &unstructured.Unstructured{
+				Object: map[string]interface{}{
+					"status": map[string]interface{}{
+						"operationState": map[string]interface{}{
+							"finishedAt": "2021-01-01T01:02:00Z",
+							"phase":      "Succeeded",
+						},
+						"reconciledAt": "2021-01-01T01:04:00Z",
+						"observedAt":   "2021-01-01T01:06:00Z",
+					},
+				},
+			},
+			expectedValue: true,
+		},
+	}
+
+	for _, test := range tests {
+		t.Run(test.name, func(t *testing.T) {
+			actualValue := isAppSyncStatusRefreshed(test.app, logEntry)
+			assert.Equal(t, test.expectedValue, actualValue)
+		})
+	}
+}
+
+func TestGetAppProj_invalidProjectNestedString(t *testing.T) {
+	app := &unstructured.Unstructured{
+		Object: map[string]interface{}{
+			"spec": map[string]interface{}{},
+		},
+	}
+	informer := cache.NewSharedIndexInformer(nil, nil, 0, nil)
+	proj := getAppProj(app, informer)
+
+	assert.Nil(t, proj)
+}
+
+func TestInit(t *testing.T) {
+	scheme := runtime.NewScheme()
+	err := v1alpha1.SchemeBuilder.AddToScheme(scheme)
+	if err != nil {
+		t.Fatalf("Error registering the resource: %v", err)
+	}
+	dynamicClient := fake.NewSimpleDynamicClient(scheme)
+	k8sClient := k8sfake.NewSimpleClientset()
+	appLabelSelector := "app=test"
+
+	nc := NewController(
+		k8sClient,
+		dynamicClient,
+		nil,
+		"default",
+		appLabelSelector,
+		nil,
+		"my-secret",
+		"my-configmap",
+	)
+
+	assert.NotNil(t, nc)
+
+	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
+	defer cancel()
+
+	err = nc.Init(ctx)
+
+	assert.NoError(t, err)
+}
+
+func TestInitTimeout(t *testing.T) {
+	scheme := runtime.NewScheme()
+	err := v1alpha1.SchemeBuilder.AddToScheme(scheme)
+	if err != nil {
+		t.Fatalf("Error registering the resource: %v", err)
+	}
+	dynamicClient := fake.NewSimpleDynamicClient(scheme)
+	k8sClient := k8sfake.NewSimpleClientset()
+	appLabelSelector := "app=test"
+
+	nc := NewController(
+		k8sClient,
+		dynamicClient,
+		nil,
+		"default",
+		appLabelSelector,
+		nil,
+		"my-secret",
+		"my-configmap",
+	)
+
+	assert.NotNil(t, nc)
+
+	// Use a short timeout to simulate a timeout during cache synchronization
+	ctx, cancel := context.WithTimeout(context.Background(), 1*time.Millisecond)
+	defer cancel()
+
+	err = nc.Init(ctx)
+
+	// Expect an error & add assertion for the error message
+	assert.Error(t, err)
+	assert.Equal(t, "Timed out waiting for caches to sync", err.Error())
+}