chore: improve validateClusterStatName

Signed-off-by: zirain <[email protected]>

Author: zirain

api/v1alpha1/validation/envoyproxy_validate.go

@@ -11,6 +11,7 @@ import (
 	"net"
 	"net/netip"
 	"regexp"
+	"strings"
 
 	"github.com/dominikbraun/graph"
 	utilerrors "k8s.io/apimachinery/pkg/util/errors"
@@ -296,32 +297,34 @@ func validateFilterOrder(filterOrder []egv1a1.FilterPosition) error {
 	return nil
 }
 
-func ValidateRouteStatName(routeStatName string) error {
-	supportedOperators := map[string]bool{
+var (
+	routeStatSupportedOperators = map[string]bool{
 		egv1a1.StatFormatterRouteName:      true,
 		egv1a1.StatFormatterRouteNamespace: true,
 		egv1a1.StatFormatterRouteKind:      true,
 		egv1a1.StatFormatterRouteRuleName:  true,
 	}
 
-	if err := validateStatName(routeStatName, supportedOperators); err != nil {
-		return fmt.Errorf("unable to configure Route Stat Name: %w", err)
-	}
-
-	return nil
-}
-
-func ValidateClusterStatName(clusterStatName string) error {
-	supportedOperators := map[string]bool{
+	clusterStatSupportedOperators = map[string]bool{
 		egv1a1.StatFormatterRouteName:       true,
 		egv1a1.StatFormatterRouteNamespace:  true,
 		egv1a1.StatFormatterRouteKind:       true,
 		egv1a1.StatFormatterRouteRuleName:   true,
 		egv1a1.StatFormatterRouteRuleNumber: true,
 		egv1a1.StatFormatterBackendRefs:     true,
 	}
+)
+
+func ValidateRouteStatName(routeStatName string) error {
+	if err := validateStatName(routeStatName, routeStatSupportedOperators); err != nil {
+		return fmt.Errorf("unable to configure Route Stat Name: %w", err)
+	}
 
-	if err := validateStatName(clusterStatName, supportedOperators); err != nil {
+	return nil
+}
+
+func ValidateClusterStatName(clusterStatName string) error {
+	if err := validateStatName(clusterStatName, clusterStatSupportedOperators); err != nil {
 		return fmt.Errorf("unable to configure Cluster Stat Name: %w", err)
 	}
 
@@ -331,6 +334,9 @@ func ValidateClusterStatName(clusterStatName string) error {
 func validateStatName(statName string, supportedOperators map[string]bool) error {
 	var unsupportedOperators []string
 	matches := statNameRegex.FindAllString(statName, -1)
+	if len(matches) == 0 && strings.Contains(statName, "%") {
+		return fmt.Errorf("unable to configure Cluster Stat Name with invalid operator")
+	}
 	for _, operator := range matches {
 		if _, ok := supportedOperators[operator]; !ok {
 			unsupportedOperators = append(unsupportedOperators, operator)

api/v1alpha1/validation/envoyproxy_validate_test.go

@@ -964,3 +964,44 @@ func TestGetEnvoyProxyComponentLevelArgs(t *testing.T) {
 		})
 	}
 }
+
+func TestValidateClusterStatName(t *testing.T) {
+	testCases := []struct {
+		name     string
+		statName string
+		expected bool
+	}{
+		{
+			name:     "valid cluster stat name with supported operators",
+			statName: "%ROUTE_NAME%/%ROUTE_NAMESPACE%/%BACKEND_REFS%",
+			expected: true,
+		},
+		{
+			name:     "invalid cluster stat name with unsupported operators",
+			statName: "%ROUTE_NAME%/%FOO%/%BAR%",
+			expected: false,
+		},
+		{
+			name:     "valid cluster stat name",
+			statName: "any_custom_name",
+			expected: true,
+		},
+		{
+			name:     "invalid cluster stat name",
+			statName: "%ROUTE_NAME",
+			expected: false,
+		},
+	}
+
+	for i := range testCases {
+		tc := testCases[i]
+		t.Run(tc.name, func(t *testing.T) {
+			errs := ValidateClusterStatName(tc.statName)
+			if tc.expected {
+				require.NoError(t, errs)
+			} else {
+				require.Error(t, errs)
+			}
+		})
+	}
+}