Merge pull request #304 from typeid/refactor_mapping

maint: refactor mapping.go

Author: openshift-merge-bot[bot]

Makefile

@@ -36,7 +36,7 @@ build-cadctl: ## Build the cadctl binary
 lint-cadctl: ## Lint cadctl subproject
 	@echo
 	@echo "Linting cadctl..."
-	cd cadctl && GOLANGCI_LINT_CACHE=$$(mktemp -d) $(GOPATH)/bin/golangci-lint run -c ../.golangci.yml
+	GOLANGCI_LINT_CACHE=$$(mktemp -d) $(GOPATH)/bin/golangci-lint run -c .golangci.yml
 
 .PHONY: test-cadctl
 test-cadctl:  ## Run automated tests for cadctl

pkg/aws/aws.go

@@ -635,4 +635,4 @@ func (c *SdkClient) getRouteTable(routeTableID string) (*ec2.RouteTable, error)
 		return &ec2.RouteTable{}, fmt.Errorf("no route tables found for route table id %v", routeTableID)
 	}
 	return describeRouteTablesOutput.RouteTables[0], nil
-}
+}

pkg/investigations/mapping/mapping.go

@@ -15,25 +15,27 @@ import (
 func GetInvestigation(alertTitle string) *investigation.Investigation {
 	// We currently map to the alert by using the title, we should use the name in the alert note in the future.
 	// This currently isn't feasible yet, as CPD's alertmanager doesn't allow for the field to exist.
-
-	// We can't switch case here as it's strings.Contains.
-	if strings.Contains(alertTitle, "has gone missing") {
+	switch {
+	case strings.Contains(alertTitle, "has gone missing"):
 		return investigation.NewInvestigation(chgm.Investigate, "ClusterHasGoneMissing")
-	} else if strings.Contains(alertTitle, "ClusterProvisioningDelay -") {
+	case strings.Contains(alertTitle, "ClusterProvisioningDelay -"):
 		return investigation.NewInvestigation(cpd.Investigate, "ClusterProvisioningDelay")
 	}
 
-	// Return early if experimental features are not enabled
-	if strings.ToUpper(os.Getenv("CAD_EXPERIMENTAL_ENABLED")) != "TRUE" {
-		return nil
-	}
-
-	logging.Warn("Flag CAD_EXPERIMENTAL_ENABLED is set, experimental CAD investigations are enabled!")
+	if experimentalFeaturesEnabled() {
+		logging.Warn("Flag CAD_EXPERIMENTAL_ENABLED is set, experimental CAD investigations are enabled!")
 
-	// Experimental investigations go here
-	if strings.Contains(alertTitle, "ClusterMonitoringErrorBudgetBurnSRE") {
-		return investigation.NewInvestigation(clustermonitoringerrorbudgetburn.Investigate, "ClusterMonitoringErrorBudgetBurnSRE")
+		// We don't care this is a single case switch (gocritic), this should just be extensible
+		switch { //nolint:gocritic
+		case strings.Contains(alertTitle, "ClusterMonitoringErrorBudgetBurnSRE"):
+			return investigation.NewInvestigation(clustermonitoringerrorbudgetburn.Investigate, "ClusterMonitoringErrorBudgetBurnSRE")
+		}
 	}
 
+	logging.Infof("No investigation exists for %s", alertTitle)
 	return nil
 }
+
+func experimentalFeaturesEnabled() bool {
+	return strings.ToUpper(os.Getenv("CAD_EXPERIMENTAL_ENABLED")) == "TRUE"
+}

pkg/investigations/mapping/mapping_test.go

@@ -0,0 +1,72 @@
+package investigation_mapping
+
+import (
+	"os"
+	"testing"
+)
+
+// Helper function to set up environment variable for tests.
+func setExperimentalEnv(enabled bool) {
+	if enabled {
+		_ = os.Setenv("CAD_EXPERIMENTAL_ENABLED", "TRUE")
+	} else {
+		_ = os.Unsetenv("CAD_EXPERIMENTAL_ENABLED")
+	}
+}
+
+func TestGetInvestigation(t *testing.T) {
+	tests := []struct {
+		name            string
+		alertTitle      string
+		experimentalEnv bool
+		expectedType    string
+	}{
+		{
+			name:            "Standard investigation - Cluster has gone missing",
+			alertTitle:      "testingcluster cluster has gone missing",
+			experimentalEnv: false,
+			expectedType:    "ClusterHasGoneMissing",
+		},
+		{
+			name:            "Standard investigation - Cluster provisioning delay",
+			alertTitle:      "ClusterProvisioningDelay - production",
+			experimentalEnv: false,
+			expectedType:    "ClusterProvisioningDelay",
+		},
+		{
+			name:            "Experimental feature enabled - ClusterMonitoringErrorBudgetBurnSRE",
+			alertTitle:      "ClusterMonitoringErrorBudgetBurnSRE ",
+			experimentalEnv: true,
+			expectedType:    "ClusterMonitoringErrorBudgetBurnSRE",
+		},
+		{
+			name:            "Experimental feature disabled - ClusterMonitoringErrorBudgetBurnSRE",
+			alertTitle:      "ClusterMonitoringErrorBudgetBurnSRE detected",
+			experimentalEnv: false,
+			expectedType:    "",
+		},
+		{
+			name:            "No matching investigation",
+			alertTitle:      "Unrelated alert title",
+			experimentalEnv: false,
+			expectedType:    "",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			setExperimentalEnv(tt.experimentalEnv)
+			result := GetInvestigation(tt.alertTitle)
+
+			if tt.expectedType == "" {
+				if result != nil {
+					t.Errorf("Expected nil, but got %v", result.Name)
+				}
+			} else {
+				if result == nil || result.Name != tt.expectedType {
+					t.Errorf("Expected %v, but got %v", tt.expectedType, result)
+				}
+			}
+		})
+	}
+}