Merge pull request #2801 from mlavacca/conformance-report-mode

feat: mode introduced to conformance report API

Author: k8s-ci-robot

conformance/apis/v1alpha1/conformancereport.go

@@ -34,6 +34,9 @@ type ConformanceReport struct {
 	// test report was made for.
 	GatewayAPIVersion string `json:"gatewayAPIVersion"`
 
+	// Mode is the operating mode the implementation used to run conformance tests.
+	Mode string `json:"mode"`
+
 	// ProfileReports is a list of the individual reports for each conformance
 	// profile that was enabled for a test run.
 	ProfileReports []ProfileReport `json:"profiles"`

conformance/experimental_conformance_test.go

@@ -45,6 +45,7 @@ var (
 	namespaceLabels      map[string]string
 	namespaceAnnotations map[string]string
 	implementation       *confv1a1.Implementation
+	mode                 string
 	conformanceProfiles  sets.Set[suite.ConformanceProfileName]
 	skipTests            []string
 )
@@ -77,6 +78,7 @@ func TestExperimentalConformance(t *testing.T) {
 
 	// experimental conformance flags
 	conformanceProfiles = suite.ParseConformanceProfiles(*flags.ConformanceProfiles)
+	mode = *flags.Mode
 
 	if conformanceProfiles.Len() > 0 {
 		// if some conformance profiles have been set, run the experimental conformance suite...
@@ -119,6 +121,7 @@ func testExperimentalConformance(t *testing.T) {
 				NamespaceAnnotations:       namespaceAnnotations,
 				SkipTests:                  skipTests,
 			},
+			Mode:                mode,
 			Implementation:      *implementation,
 			ConformanceProfiles: conformanceProfiles,
 		})

conformance/utils/flags/experimental_flags.go

@@ -19,14 +19,22 @@ limitations under the License.
 // among the various suites that are all run by the same Makefile invocation.
 package flags
 
-import "flag"
+import (
+	"flag"
+)
+
+const (
+	// DefaultMode is the operating mode to default to in case no mode is specified.
+	DefaultMode = "default"
+)
 
 var (
 	ImplementationOrganization = flag.String("organization", "", "Implementation's Organization to issue conformance to")
 	ImplementationProject      = flag.String("project", "", "Implementation's project to issue conformance to")
 	ImplementationURL          = flag.String("url", "", "Implementation's url to issue conformance to")
 	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.")
 	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

@@ -31,6 +31,7 @@ import (
 	"sigs.k8s.io/gateway-api/conformance"
 	confv1a1 "sigs.k8s.io/gateway-api/conformance/apis/v1alpha1"
 	"sigs.k8s.io/gateway-api/conformance/utils/config"
+	"sigs.k8s.io/gateway-api/conformance/utils/flags"
 	"sigs.k8s.io/gateway-api/conformance/utils/kubernetes"
 	"sigs.k8s.io/gateway-api/conformance/utils/roundtripper"
 )
@@ -47,6 +48,10 @@ import (
 type ExperimentalConformanceTestSuite struct {
 	ConformanceTestSuite
 
+	// mode is the operating mode of the implementation.
+	// The default value for it is "default".
+	mode string
+
 	// implementation contains the details of the implementation, such as
 	// organization, project, etc.
 	implementation confv1a1.Implementation
@@ -78,6 +83,7 @@ type ExperimentalConformanceTestSuite struct {
 type ExperimentalConformanceOptions struct {
 	Options
 
+	Mode                string
 	Implementation      confv1a1.Implementation
 	ConformanceProfiles sets.Set[ConformanceProfileName]
 }
@@ -91,12 +97,18 @@ func NewExperimentalConformanceTestSuite(s ExperimentalConformanceOptions) (*Exp
 		roundTripper = &roundtripper.DefaultRoundTripper{Debug: s.Debug, TimeoutConfig: s.TimeoutConfig}
 	}
 
+	mode := flags.DefaultMode
+	if s.Mode != "" {
+		mode = s.Mode
+	}
+
 	suite := &ExperimentalConformanceTestSuite{
 		results:                     make(map[string]testResult),
 		extendedUnsupportedFeatures: make(map[ConformanceProfileName]sets.Set[SupportedFeature]),
 		extendedSupportedFeatures:   make(map[ConformanceProfileName]sets.Set[SupportedFeature]),
 		conformanceProfiles:         s.ConformanceProfiles,
 		implementation:              s.Implementation,
+		mode:                        mode,
 	}
 
 	// test suite callers are required to provide a conformance profile OR at
@@ -281,6 +293,7 @@ func (suite *ExperimentalConformanceTestSuite) Report() (*confv1a1.ConformanceRe
 			Kind:       "ConformanceReport",
 		},
 		Date:              time.Now().Format(time.RFC3339),
+		Mode:              suite.mode,
 		Implementation:    suite.implementation,
 		GatewayAPIVersion: "TODO",
 		ProfileReports:    profileReports.list(),