add allow-crds-mismatch flag, check suite version

Signed-off-by: Mattia Lavacca <[email protected]>

Author: mlavacca

conformance/experimental_conformance_test.go

@@ -47,6 +47,7 @@ var (
 	namespaceAnnotations map[string]string
 	implementation       *confv1a1.Implementation
 	mode                 string
+	allowCRDsMismatch    bool
 	conformanceProfiles  sets.Set[suite.ConformanceProfileName]
 	skipTests            []string
 )
@@ -81,6 +82,7 @@ func TestExperimentalConformance(t *testing.T) {
 	// experimental conformance flags
 	conformanceProfiles = suite.ParseConformanceProfiles(*flags.ConformanceProfiles)
 	mode = *flags.Mode
+	allowCRDsMismatch = *flags.AllowCRDsMismatch
 
 	if conformanceProfiles.Len() > 0 {
 		// if some conformance profiles have been set, run the experimental conformance suite...
@@ -124,6 +126,7 @@ func testExperimentalConformance(t *testing.T) {
 				SkipTests:                  skipTests,
 			},
 			Mode:                mode,
+			AllowCRDsMismatch:   allowCRDsMismatch,
 			Implementation:      *implementation,
 			ConformanceProfiles: conformanceProfiles,
 		})

conformance/utils/flags/experimental_flags.go

@@ -35,6 +35,7 @@ var (
 	ImplementationVersion      = flag.String("version", "", "Implementation's version to issue conformance to")
 	ImplementationContact      = flag.String("contact", "", "Comma-separated list of contact information for the maintainers")
 	Mode                       = flag.String("mode", DefaultMode, "The operating mode of the implementation.")
+	AllowCRDsMismatch          = flag.Bool("allow-crds-mismatch", false, "Flag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.")
 	ConformanceProfiles        = flag.String("conformance-profiles", "", "Comma-separated list of the conformance profiles to run")
 	ReportOutput               = flag.String("report-output", "", "The file where to write the conformance report")
 )

conformance/utils/suite/experimental_suite.go

@@ -97,10 +97,15 @@ type ExperimentalConformanceOptions struct {
 	Options
 
 	Mode                string
+	AllowCRDsMismatch   bool
 	Implementation      confv1a1.Implementation
 	ConformanceProfiles sets.Set[ConformanceProfileName]
 }
 
+const (
+	undefinedKeyword = "UNDEFINED"
+)
+
 // NewExperimentalConformanceTestSuite is a helper to use for creating a new ExperimentalConformanceTestSuite.
 func NewExperimentalConformanceTestSuite(options ExperimentalConformanceOptions) (*ExperimentalConformanceTestSuite, error) {
 	config.SetupTimeoutConfig(&options.TimeoutConfig)
@@ -117,7 +122,14 @@ func NewExperimentalConformanceTestSuite(options ExperimentalConformanceOptions)
 	}
 	apiVersion, apiChannel, err := getAPIVersionAndChannel(installedCRDs.Items)
 	if err != nil {
-		return nil, err
+		// in case an error is returned and the AllowCRDsMismatch flag is false, the suite fails.
+		// This is the default behavior but can be customized in case one wants to experiment
+		// with mixed versions/channels of the API.
+		if !options.AllowCRDsMismatch {
+			return nil, err
+		}
+		apiVersion = undefinedKeyword
+		apiChannel = undefinedKeyword
 	}
 
 	mode := flags.DefaultMode
@@ -395,5 +407,9 @@ func getAPIVersionAndChannel(crds []apiextensionsv1.CustomResourceDefinition) (v
 	if version == "" || channel == "" {
 		return "", "", errors.New("no Gateway API CRDs with the proper annotations found in the cluster")
 	}
+	if version != consts.BundleVersion {
+		return "", "", errors.New("the installed CRDs version is different from the suite version")
+	}
+
 	return version, channel, nil
 }

pkg/consts/consts.go

@@ -20,7 +20,16 @@ const (
 	// BundleVersionAnnotation is the annotation key used in the Gateway API CRDs to specify
 	// the installed Gateway API version.
 	BundleVersionAnnotation = "gateway.networking.k8s.io/bundle-version"
+
 	// ChannelAnnotation is the annotation key used in the Gateway API CRDs to specify
 	// the installed Gateway API channel.
 	ChannelAnnotation = "gateway.networking.k8s.io/channel"
+
+	// BundleVersion is the value used for the "gateway.networking.k8s.io/bundle-version" annotation.
+	// These value must be updated during the release process.
+	BundleVersion = "v1.0.0"
+
+	// ApprovalLink is the value used for the "api-approved.kubernetes.io" annotation.
+	// These value must be updated during the release process.
+	ApprovalLink = "https://github.com/kubernetes-sigs/gateway-api/pull/2466"
 )

pkg/generator/main.go

@@ -32,12 +32,6 @@ import (
 	"sigs.k8s.io/gateway-api/pkg/consts"
 )
 
-const (
-	// These values must be updated during the release process
-	bundleVersion = "v1.0.0"
-	approvalLink  = "https://github.com/kubernetes-sigs/gateway-api/pull/2466"
-)
-
 var standardKinds = map[string]bool{
 	"GatewayClass":   true,
 	"Gateway":        true,
@@ -103,9 +97,9 @@ func main() {
 			if crdRaw.ObjectMeta.Annotations == nil {
 				crdRaw.ObjectMeta.Annotations = map[string]string{}
 			}
-			crdRaw.ObjectMeta.Annotations[consts.BundleVersionAnnotation] = bundleVersion
+			crdRaw.ObjectMeta.Annotations[consts.BundleVersionAnnotation] = consts.BundleVersion
 			crdRaw.ObjectMeta.Annotations[consts.ChannelAnnotation] = channel
-			crdRaw.ObjectMeta.Annotations[apiext.KubeAPIApprovedAnnotation] = approvalLink
+			crdRaw.ObjectMeta.Annotations[apiext.KubeAPIApprovedAnnotation] = consts.ApprovalLink
 
 			// Prevent the top level metadata for the CRD to be generated regardless of the intention in the arguments
 			crd.FixTopLevelMetadata(crdRaw)