BUG/MEDIUM: avoid double quotes

in rules generated from annotations

Author: hdurand0710

deploy/tests/e2e/cors/cors_test.go

@@ -20,6 +20,7 @@ import (
 	"net/http"
 
 	"github.com/haproxytech/kubernetes-ingress/deploy/tests/e2e"
+	"github.com/haproxytech/kubernetes-ingress/pkg/annotations/common"
 )
 
 const (
@@ -105,7 +106,7 @@ func (suite *CorsSuite) eventuallyReturnsWithNoContentOption(expectedHeaders, un
 }
 
 func q(value string) string {
-	return "\"" + value + "\""
+	return common.EnsureQuoted(value)
 }
 
 func (suite *CorsSuite) Default(ingressCors bool) func() {

pkg/annotations/common/main.go

@@ -75,3 +75,21 @@ func GetValuesAndIndices(annotationName string, annotations ...map[string]string
 	}
 	return result
 }
+
+// EnsureQuoted ensures that a string starts and ends with a double quote.
+// It adds a quote to the beginning if one is not already present,
+// and adds a quote to the end if one is not already present.
+func EnsureQuoted(s string) string {
+	newS := s
+	if s == "\"" || s == "" {
+		newS = "\"\""
+		return newS
+	}
+	if !strings.HasPrefix(newS, "\"") {
+		newS = "\"" + newS
+	}
+	if !strings.HasSuffix(newS, "\"") {
+		newS += "\""
+	}
+	return newS
+}

pkg/annotations/ingress/reqSetHdr.go

@@ -42,7 +42,7 @@ func (a *SetHdr) Process(k store.K8s, annotations ...map[string]string) (err err
 		}
 		a.rules.Add(&rules.SetHdr{
 			HdrName:   param[:indexSpace],
-			HdrFormat: "\"" + param[indexSpace+1:] + "\"",
+			HdrFormat: common.EnsureQuoted(param[indexSpace+1:]),
 			Response:  a.response,
 		})
 	}

pkg/annotations/ingress/resSetCORS.go

@@ -93,7 +93,7 @@ func (a ResSetCORSAnn) Process(k store.K8s, annotations ...map[string]string) (e
 					return fmt.Errorf("unsupported HTTP method '%s' in cors-allow-methods configuration", methods[i])
 				}
 			}
-			input = "\"" + strings.Join(methods, ", ") + "\""
+			input = common.EnsureQuoted(strings.Join(methods, ", "))
 		}
 		a.parent.rules.Add(&rules.SetHdr{
 			HdrName:       "Access-Control-Allow-Methods",
@@ -109,7 +109,7 @@ func (a ResSetCORSAnn) Process(k store.K8s, annotations ...map[string]string) (e
 		input = strings.Join(strings.Fields(input), "") // strip spaces
 		a.parent.rules.Add(rules.SetHdr{
 			HdrName:       "Access-Control-Allow-Headers",
-			HdrFormat:     "\"" + input + "\"",
+			HdrFormat:     common.EnsureQuoted(input),
 			AfterResponse: true,
 			CondTest:      a.parent.acl,
 			Cond:          "if",

test/annotations/common_test.go

@@ -0,0 +1,69 @@
+package annotations_test
+
+import (
+	"testing"
+
+	"github.com/haproxytech/kubernetes-ingress/pkg/annotations/common"
+)
+
+func TestEnsureQuoted(t *testing.T) {
+	tests := []struct {
+		name  string
+		input string
+		want  string
+	}{
+		{
+			name:  "simple string",
+			input: "test",
+			want:  "\"test\"",
+		},
+		{
+			name:  "already quoted",
+			input: "\"test\"",
+			want:  "\"test\"",
+		},
+		{
+			name:  "empty string",
+			input: "",
+			want:  "\"\"",
+		},
+		{
+			name:  "starts with quote",
+			input: "\"test",
+			want:  "\"test\"",
+		},
+		{
+			name:  "ends with quote",
+			input: "test\"",
+			want:  "\"test\"",
+		},
+		{
+			name:  "single quote",
+			input: "\"",
+			want:  "\"\"",
+		},
+		{
+			name:  "empty quoted string",
+			input: "\"\"",
+			want:  "\"\"",
+		},
+		{
+			name:  "string with internal quotes",
+			input: "te\"st",
+			want:  "\"te\"st\"",
+		},
+		{
+			name:  "string with leading/trailing spaces",
+			input: " test ",
+			want:  "\" test \"",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if got := common.EnsureQuoted(tt.input); got != tt.want {
+				t.Errorf("EnsureQuoted() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}