Add conformance test flag to set implementation labels on mesh namespaces (#1957)

* Add labels to mesh namespaces

* add doc

* remove MeshNamespaceLabels

* one more

* update doc

* tweak wording

* add unit tests

Author: frankbu

conformance/conformance_test.go

@@ -18,7 +18,6 @@ limitations under the License.
 package conformance_test
 
 import (
-	"strings"
 	"testing"
 
 	"sigs.k8s.io/gateway-api/apis/v1alpha2"
@@ -27,7 +26,6 @@ import (
 	"sigs.k8s.io/gateway-api/conformance/utils/flags"
 	"sigs.k8s.io/gateway-api/conformance/utils/suite"
 
-	"k8s.io/apimachinery/pkg/util/sets"
 	"k8s.io/client-go/kubernetes"
 	_ "k8s.io/client-go/plugin/pkg/client/auth"
 	"k8s.io/client-go/rest"
@@ -52,8 +50,10 @@ func TestConformance(t *testing.T) {
 	v1alpha2.AddToScheme(client.Scheme())
 	v1beta1.AddToScheme(client.Scheme())
 
-	supportedFeatures := parseSupportedFeatures(*flags.SupportedFeatures)
-	exemptFeatures := parseSupportedFeatures(*flags.ExemptFeatures)
+	supportedFeatures := suite.ParseSupportedFeatures(*flags.SupportedFeatures)
+	exemptFeatures := suite.ParseSupportedFeatures(*flags.ExemptFeatures)
+
+	namespaceLabels := suite.ParseNamespaceLabels(*flags.NamespaceLabels)
 
 	t.Logf("Running conformance tests with %s GatewayClass\n cleanup: %t\n debug: %t\n enable all features: %t \n supported features: [%v]\n exempt features: [%v]",
 		*flags.GatewayClassName, *flags.CleanupBaseResources, *flags.ShowDebug, *flags.EnableAllSupportedFeatures, *flags.SupportedFeatures, *flags.ExemptFeatures)
@@ -68,21 +68,9 @@ func TestConformance(t *testing.T) {
 		SupportedFeatures:          supportedFeatures,
 		ExemptFeatures:             exemptFeatures,
 		EnableAllSupportedFeatures: *flags.EnableAllSupportedFeatures,
+		NamespaceLabels:            namespaceLabels,
 	})
 	cSuite.Setup(t)
 
 	cSuite.Run(t, tests.ConformanceTests)
 }
-
-// parseSupportedFeatures parses flag arguments and converts the string to
-// sets.Set[suite.SupportedFeature]
-func parseSupportedFeatures(f string) sets.Set[suite.SupportedFeature] {
-	if f == "" {
-		return nil
-	}
-	res := sets.Set[suite.SupportedFeature]{}
-	for _, value := range strings.Split(f, ",") {
-		res.Insert(suite.SupportedFeature(value))
-	}
-	return res
-}

conformance/mesh/manifests.yaml

@@ -4,7 +4,7 @@ kind: Namespace
 metadata:
   name: gateway-conformance-mesh
   labels:
-    gateway-conformance: infra
+    gateway-conformance: mesh
 ---
 
 apiVersion: apps/v1

conformance/utils/flags/flags.go

@@ -30,4 +30,5 @@ var (
 	SupportedFeatures          = flag.String("supported-features", "", "Supported features included in conformance tests suites")
 	ExemptFeatures             = flag.String("exempt-features", "", "Exempt Features excluded from conformance tests suites")
 	EnableAllSupportedFeatures = flag.Bool("all-features", false, "Whether to enable all supported features for conformance tests")
+	NamespaceLabels            = flag.String("namespace-labels", "", "Comma-separated list of name=value labels to add to test namespaces")
 )

conformance/utils/kubernetes/apply.go

@@ -65,11 +65,11 @@ func (a Applier) prepareGatewayClass(t *testing.T, uObj *unstructured.Unstructur
 }
 
 // prepareNamespace adjusts the Namespace labels.
-func prepareNamespace(t *testing.T, uObj *unstructured.Unstructured, namespaceLabels map[string]string) {
+func (a Applier) prepareNamespace(t *testing.T, uObj *unstructured.Unstructured) {
 	labels, _, err := unstructured.NestedStringMap(uObj.Object, "metadata", "labels")
 	require.NoErrorf(t, err, "error getting labels on Namespace %s", uObj.GetName())
 
-	for k, v := range namespaceLabels {
+	for k, v := range a.NamespaceLabels {
 		if labels == nil {
 			labels = map[string]string{}
 		}
@@ -109,7 +109,7 @@ func (a Applier) prepareResources(t *testing.T, decoder *yaml.YAMLOrJSONDecoder)
 		}
 
 		if uObj.GetKind() == "Namespace" && uObj.GetObjectKind().GroupVersionKind().Group == "" {
-			prepareNamespace(t, &uObj, a.NamespaceLabels)
+			a.prepareNamespace(t, &uObj)
 		}
 
 		resources = append(resources, uObj)

conformance/utils/suite/suite.go

@@ -18,6 +18,7 @@ package suite
 
 import (
 	"embed"
+	"strings"
 	"testing"
 
 	"k8s.io/apimachinery/pkg/util/sets"
@@ -224,3 +225,32 @@ func (test *ConformanceTest) Run(t *testing.T, suite *ConformanceTestSuite) {
 
 	test.Test(t, suite)
 }
+
+// ParseSupportedFeatures parses flag arguments and converts the string to
+// sets.Set[suite.SupportedFeature]
+func ParseSupportedFeatures(f string) sets.Set[SupportedFeature] {
+	if f == "" {
+		return nil
+	}
+	res := sets.Set[SupportedFeature]{}
+	for _, value := range strings.Split(f, ",") {
+		res.Insert(SupportedFeature(value))
+	}
+	return res
+}
+
+// ParseNamespaceLables parses flag arguments and converts the string to
+// map[string]string containing label key/value pairs.
+func ParseNamespaceLabels(f string) map[string]string {
+	if f == "" {
+		return nil
+	}
+	res := map[string]string{}
+	for _, kv := range strings.Split(f, ",") {
+		parts := strings.Split(kv, "=")
+		if len(parts) == 2 {
+			res[parts[0]] = parts[1]
+		}
+	}
+	return res
+}

conformance/utils/suite/suite_test.go

@@ -0,0 +1,69 @@
+/*
+Copyright 2023 The Kubernetes Authors.
+
+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 suite
+
+import (
+	"reflect"
+	"testing"
+
+	"k8s.io/apimachinery/pkg/util/sets"
+)
+
+func TestParseSupportedFeatures(t *testing.T) {
+	flags := []string{
+		"",
+		"a",
+		"b,c,d",
+	}
+
+	s1 := sets.Set[SupportedFeature]{}
+	s1.Insert(SupportedFeature("a"))
+	s2 := sets.Set[SupportedFeature]{}
+	s2.Insert(SupportedFeature("b"))
+	s2.Insert(SupportedFeature("c"))
+	s2.Insert(SupportedFeature("d"))
+	features := []sets.Set[SupportedFeature]{nil, s1, s2}
+
+	for i, f := range flags {
+		expect := features[i]
+		got := ParseSupportedFeatures(f)
+		if !reflect.DeepEqual(got, expect) {
+			t.Errorf("Unexpected features from flags '%s', expected: %v, got: %v", f, expect, got)
+		}
+	}
+}
+
+func TestParseNamespaceLabels(t *testing.T) {
+	flags := []string{
+		"",
+		"a=b",
+		"b=c,d=e,f=g",
+	}
+	labels := []map[string]string{
+		nil,
+		{"a": "b"},
+		{"b": "c", "d": "e", "f": "g"},
+	}
+
+	for i, f := range flags {
+		expect := labels[i]
+		got := ParseNamespaceLabels(f)
+		if !reflect.DeepEqual(got, expect) {
+			t.Errorf("Unexpected labels from flags '%s', expected: %v, got: %v", f, expect, got)
+		}
+	}
+}

site-src/concepts/conformance.md

@@ -126,6 +126,14 @@ feature and any relevant API features, e.g:
 go test ./conformance/... -args -supported-features=Mesh,Gateway,HTTPRoute
 ```
 
+#### Namespace Labels
+
+If labels are needed on namespaces used for testing, you can use
+the `-namespace-labels` flag to pass one or more `name=value` labels to
+set on the test namespaces. For mesh testing, this flag can be used if
+an implementation requires labels on namespaces that host mesh workloads,
+for example, to enable sidecar injection.
+
 #### Excluding Tests
 
 The `Gateway` and `ReferenceGrant` features are enabled by default.