Allow -namespace-annotations to annotate namespaces created by the tests

Signed-off-by: [email protected]

Author: kflynn

conformance/conformance_test.go

@@ -53,6 +53,7 @@ func TestConformance(t *testing.T) {
 	exemptFeatures := suite.ParseSupportedFeatures(*flags.ExemptFeatures)
 	skipTests := suite.ParseSkipTests(*flags.SkipTests)
 	namespaceLabels := suite.ParseNamespaceLabels(*flags.NamespaceLabels)
+	namespaceAnnotations := suite.ParseNamespaceAnnotations(*flags.NamespaceAnnotations)
 
 	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)
@@ -70,6 +71,7 @@ func TestConformance(t *testing.T) {
 		ExemptFeatures:             exemptFeatures,
 		EnableAllSupportedFeatures: *flags.EnableAllSupportedFeatures,
 		NamespaceLabels:            namespaceLabels,
+		NamespaceAnnotations:       namespaceAnnotations,
 		SkipTests:                  skipTests,
 	})
 	cSuite.Setup(t)

conformance/experimental_conformance_test.go

@@ -39,15 +39,16 @@ import (
 )
 
 var (
-	cfg                 *rest.Config
-	k8sClientset        *kubernetes.Clientset
-	mgrClient           client.Client
-	supportedFeatures   sets.Set[suite.SupportedFeature]
-	exemptFeatures      sets.Set[suite.SupportedFeature]
-	namespaceLabels     map[string]string
-	implementation      *confv1a1.Implementation
-	conformanceProfiles sets.Set[suite.ConformanceProfileName]
-	skipTests           []string
+	cfg                  *rest.Config
+	k8sClientset         *kubernetes.Clientset
+	mgrClient            client.Client
+	supportedFeatures    sets.Set[suite.SupportedFeature]
+	exemptFeatures       sets.Set[suite.SupportedFeature]
+	namespaceLabels      map[string]string
+	namespaceAnnotations map[string]string
+	implementation       *confv1a1.Implementation
+	conformanceProfiles  sets.Set[suite.ConformanceProfileName]
+	skipTests            []string
 )
 
 func TestExperimentalConformance(t *testing.T) {
@@ -73,6 +74,7 @@ func TestExperimentalConformance(t *testing.T) {
 	exemptFeatures = suite.ParseSupportedFeatures(*flags.ExemptFeatures)
 	skipTests = suite.ParseSkipTests(*flags.SkipTests)
 	namespaceLabels = suite.ParseNamespaceLabels(*flags.NamespaceLabels)
+	namespaceAnnotations = suite.ParseNamespaceAnnotations(*flags.NamespaceAnnotations)
 
 	// experimental conformance flags
 	conformanceProfiles = suite.ParseConformanceProfiles(*flags.ConformanceProfiles)
@@ -115,6 +117,7 @@ func testExperimentalConformance(t *testing.T) {
 				ExemptFeatures:             exemptFeatures,
 				EnableAllSupportedFeatures: *flags.EnableAllSupportedFeatures,
 				NamespaceLabels:            namespaceLabels,
+				NamespaceAnnotations:       namespaceAnnotations,
 				SkipTests:                  skipTests,
 			},
 			Implementation:      *implementation,

conformance/utils/flags/flags.go

@@ -32,4 +32,5 @@ var (
 	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")
+	NamespaceAnnotations       = flag.String("namespace-annotations", "", "Comma-separated list of name=value annotations to add to test namespaces")
 )

conformance/utils/kubernetes/apply.go

@@ -40,7 +40,8 @@ import (
 // Applier prepares manifests depending on the available options and applies
 // them to the Kubernetes cluster.
 type Applier struct {
-	NamespaceLabels map[string]string
+	NamespaceLabels      map[string]string
+	NamespaceAnnotations map[string]string
 
 	// GatewayClass will be used as the spec.gatewayClassName when applying Gateway resources
 	GatewayClass string
@@ -82,6 +83,23 @@ func (a Applier) prepareNamespace(t *testing.T, uObj *unstructured.Unstructured)
 		err = unstructured.SetNestedStringMap(uObj.Object, labels, "metadata", "labels")
 	}
 	require.NoErrorf(t, err, "error setting labels on Namespace %s", uObj.GetName())
+
+	annotations, _, err := unstructured.NestedStringMap(uObj.Object, "metadata", "annotations")
+	require.NoErrorf(t, err, "error getting annotations on Namespace %s", uObj.GetName())
+
+	for k, v := range a.NamespaceAnnotations {
+		if annotations == nil {
+			annotations = map[string]string{}
+		}
+
+		annotations[k] = v
+	}
+
+	// SetNestedStringMap converts nil to an empty map
+	if annotations != nil {
+		err = unstructured.SetNestedStringMap(uObj.Object, annotations, "metadata", "annotations")
+	}
+	require.NoErrorf(t, err, "error setting annotations on Namespace %s", uObj.GetName())
 }
 
 // prepareResources uses the options from an Applier to tweak resources given by

conformance/utils/suite/experimental_suite.go

@@ -159,7 +159,8 @@ func NewExperimentalConformanceTestSuite(s ExperimentalConformanceOptions) (*Exp
 		BaseManifests:    s.BaseManifests,
 		MeshManifests:    s.MeshManifests,
 		Applier: kubernetes.Applier{
-			NamespaceLabels: s.NamespaceLabels,
+			NamespaceLabels:      s.NamespaceLabels,
+			NamespaceAnnotations: s.NamespaceAnnotations,
 		},
 		SupportedFeatures: s.SupportedFeatures,
 		TimeoutConfig:     s.TimeoutConfig,

conformance/utils/suite/suite.go

@@ -55,15 +55,16 @@ type ConformanceTestSuite struct {
 
 // Options can be used to initialize a ConformanceTestSuite.
 type Options struct {
-	Client           client.Client
-	Clientset        clientset.Interface
-	RestConfig       *rest.Config
-	GatewayClassName string
-	Debug            bool
-	RoundTripper     roundtripper.RoundTripper
-	BaseManifests    string
-	MeshManifests    string
-	NamespaceLabels  map[string]string
+	Client               client.Client
+	Clientset            clientset.Interface
+	RestConfig           *rest.Config
+	GatewayClassName     string
+	Debug                bool
+	RoundTripper         roundtripper.RoundTripper
+	BaseManifests        string
+	MeshManifests        string
+	NamespaceLabels      map[string]string
+	NamespaceAnnotations map[string]string
 
 	// CleanupBaseResources indicates whether or not the base test
 	// resources such as Gateways should be cleaned up after the run.
@@ -118,7 +119,8 @@ func New(s Options) *ConformanceTestSuite {
 		BaseManifests:    s.BaseManifests,
 		MeshManifests:    s.MeshManifests,
 		Applier: kubernetes.Applier{
-			NamespaceLabels: s.NamespaceLabels,
+			NamespaceLabels:      s.NamespaceLabels,
+			NamespaceAnnotations: s.NamespaceAnnotations,
 		},
 		SupportedFeatures: s.SupportedFeatures,
 		TimeoutConfig:     s.TimeoutConfig,
@@ -261,6 +263,22 @@ func ParseNamespaceLabels(f string) map[string]string {
 	return res
 }
 
+// ParseNamespaceAnnotations parses flag arguments and converts the string to
+// map[string]string containing annotation key/value pairs.
+func ParseNamespaceAnnotations(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
+}
+
 // ParseSkipTests parses flag arguments and converts the string to
 // []string containing the tests to be skipped.
 func ParseSkipTests(t string) []string {