Add unit tests for pdbreaper types and fix validation bugs (#122)

* Add unit tests for pdbreaper types Signed-off-by: Todd Ekenstam <[email protected]> * Fix tests Signed-off-by: Todd Ekenstam <[email protected]> * Fix test Signed-off-by: Todd Ekenstam <[email protected]> * Fix bug and add tests Signed-off-by: Todd Ekenstam <[email protected]> * Fix K8sConfigPath test Signed-off-by: Todd Ekenstam <[email protected]> * Add validation of error messages Signed-off-by: Todd Ekenstam <[email protected]> * More coverage Signed-off-by: Todd Ekenstam <[email protected]> --------- Signed-off-by: Todd Ekenstam <[email protected]>
keikoproj · Dec 9, 2023 · 12148f5 · 12148f5
1 parent c37b390
commit 12148f5
Show file tree

Hide file tree

Showing 2 changed files with 103 additions and 2 deletions.
diff --git a/pkg/reaper/pdbreaper/types.go b/pkg/reaper/pdbreaper/types.go
@@ -102,7 +102,7 @@ func (ctx *ReaperContext) validate(args *Args) error {
 	}
 	ctx.CrashLoopRestartCount = args.CrashLoopRestartCount
 
-	if args.CrashLoopRestartCount < 1 {
+	if args.ReapNotReadyThreshold < 1 {
 		return errors.Errorf("--not-ready-threshold-seconds value cannot be less than 1")
 	}
 	ctx.ReapNotReadyThreshold = args.ReapNotReadyThreshold
@@ -127,7 +127,7 @@ func (ctx *ReaperContext) validate(args *Args) error {
 
 	if args.K8sConfigPath != "" {
 		if ok := common.PathExists(args.K8sConfigPath); !ok {
-			return errors.Errorf("--kubeconfig path '%v' was not found", ctx.KubernetesConfigPath)
+			return errors.Errorf("--kubeconfig path '%v' was not found", args.K8sConfigPath)
 		}
 		ctx.KubernetesConfigPath = args.K8sConfigPath
 	}

diff --git a/pkg/reaper/pdbreaper/types_test.go b/pkg/reaper/pdbreaper/types_test.go
@@ -0,0 +1,101 @@
+/*
+
+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
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package pdbreaper
+
+import (
+	"os"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestReaperContext_validate(t *testing.T) {
+	reaperArgsValid := Args{
+		LocalMode:             false,
+		DryRun:                true,
+		CrashLoopRestartCount: 1,
+		ReapNotReadyThreshold: 1,
+		PromPushgateway:       "http://localhost:9091",
+		ExcludedNamespaces:    []string{"kube-system"},
+	}
+
+	reaperArgsInvalidCrashLoopRestartCount := Args(reaperArgsValid)
+	reaperArgsInvalidCrashLoopRestartCount.CrashLoopRestartCount = -99
+
+	reaperArgsInvalidReapNotReadyThreshold := Args(reaperArgsValid)
+	reaperArgsInvalidReapNotReadyThreshold.ReapNotReadyThreshold = -99
+
+	reaperArgsInvalidInClusterAuth := Args(reaperArgsValid)
+	reaperArgsInvalidInClusterAuth.LocalMode = false
+
+	reaperArgsInvalidLocalMode := Args(reaperArgsValid)
+	reaperArgsInvalidLocalMode.LocalMode = true
+
+	reaperArgsInvalidK8sConfigPath := Args(reaperArgsValid)
+	reaperArgsInvalidK8sConfigPath.LocalMode = true
+	reaperArgsInvalidK8sConfigPath.K8sConfigPath = "/tmp/invalid/path"
+
+	reaperArgsInvalidK8sConfigPath2 := Args(reaperArgsValid)
+	reaperArgsInvalidK8sConfigPath2.LocalMode = true
+	reaperArgsInvalidK8sConfigPath2.K8sConfigPath = os.Getenv("HOME")
+
+	tests := []struct {
+		name       string
+		fields     ReaperContext
+		args       *Args
+		wantErr    bool
+		wantErrMsg string
+	}{
+		// {"Valid-Args", *_fakeReaperContext(), &reaperArgsValid, false},
+		{"Invalid-CrashLoopRestartCount", *_fakeReaperContext(), &reaperArgsInvalidCrashLoopRestartCount, true, "--crashloop-restart-count value cannot be less than 1"},
+		{"Invalid-ReapNotReadyThreshold", *_fakeReaperContext(), &reaperArgsInvalidReapNotReadyThreshold, true, "--not-ready-threshold-seconds value cannot be less than 1"},
+		{"Invalid-InClusterAuth", *_fakeReaperContext(), &reaperArgsInvalidInClusterAuth, true, "in-cluster auth failed: unable to load in-cluster configuration, KUBERNETES_SERVICE_HOST and KUBERNETES_SERVICE_PORT must be defined"},
+		{"Invalid-LocalMode", *_fakeReaperContext(), &reaperArgsInvalidLocalMode, true, "cannot use --local-mode without --kubeconfig"},
+		{"Invalid-K8sConfigPath", *_fakeReaperContext(), &reaperArgsInvalidK8sConfigPath, true, "--kubeconfig path '/tmp/invalid/path' was not found"},
+		{"Invalid-K8sConfigPath2", *_fakeReaperContext(), &reaperArgsInvalidK8sConfigPath2, true, "cluster external auth failed: error loading config file"},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			ctx := &ReaperContext{
+				KubernetesClient:                    tt.fields.KubernetesClient,
+				KubernetesConfigPath:                tt.fields.KubernetesConfigPath,
+				DryRun:                              tt.fields.DryRun,
+				LocalMode:                           tt.fields.LocalMode,
+				ReapMisconfigured:                   tt.fields.ReapMisconfigured,
+				ReapMultiple:                        tt.fields.ReapMultiple,
+				ReapCrashLoop:                       tt.fields.ReapCrashLoop,
+				AllCrashLoop:                        tt.fields.AllCrashLoop,
+				CrashLoopRestartCount:               tt.fields.CrashLoopRestartCount,
+				ReapNotReady:                        tt.fields.ReapNotReady,
+				ReapNotReadyThreshold:               tt.fields.ReapNotReadyThreshold,
+				AllNotReady:                         tt.fields.AllNotReady,
+				ReapablePodDisruptionBudgets:        tt.fields.ReapablePodDisruptionBudgets,
+				ClusterBlockingPodDisruptionBudgets: tt.fields.ClusterBlockingPodDisruptionBudgets,
+				NamespacesWithMultiplePodDisruptionBudgets: tt.fields.NamespacesWithMultiplePodDisruptionBudgets,
+				ExcludedNamespaces:                         tt.fields.ExcludedNamespaces,
+				ReapablePodDisruptionBudgetsCount:          tt.fields.ReapablePodDisruptionBudgetsCount,
+				ReapedPodDisruptionBudgetCount:             tt.fields.ReapedPodDisruptionBudgetCount,
+				PromPushgateway:                            tt.fields.PromPushgateway,
+				MetricsAPI:                                 tt.fields.MetricsAPI,
+			}
+			if err := ctx.validate(tt.args); (err != nil) != tt.wantErr {
+				t.Errorf("ReaperContext.validate() error = %v, wantErr %v", err, tt.wantErr)
+			} else {
+				assert.ErrorContainsf(t, err, tt.wantErrMsg, "expected error containing %q, got %s", tt.wantErrMsg, err.Error())
+			}
+		})
+	}
+}