feat(conformance): add version for conformance test report. (kubernetes-sigs#1133)

* feat(conformance): add version for conformance test report.

* add conformance.go update.

* remove redundancy.

* update release.md

* fix typos.

* fix typos.

* rename to version.go.

Author: zetxqx

RELEASE.md

@@ -2,6 +2,7 @@
 
 The Kubernetes Template Project is released on an as-needed basis. The process is as follows:
 
+1. Update `version/version.go` with the new semver tag
 1. An issue is proposing a new release with a changelog since the last release
 1. All [OWNERS](OWNERS) must LGTM this release
 1. An OWNER runs `git tag -s $VERSION` and inserts the changelog and pushes the tag with `git push $VERSION`

conformance/conformance.go

@@ -23,7 +23,6 @@ import (
 	"errors"
 	"fmt"
 	"io/fs"
-	"os"
 	"slices"
 	"testing"
 
@@ -41,11 +40,10 @@ import (
 	"k8s.io/apimachinery/pkg/util/sets"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	k8sconfig "sigs.k8s.io/controller-runtime/pkg/client/config"
-	"sigs.k8s.io/yaml"
 
 	// Import necessary types and utilities from the core Gateway API conformance suite.
-	gatewayv1 "sigs.k8s.io/gateway-api/apis/v1"            // Import core Gateway API types
-	confapis "sigs.k8s.io/gateway-api/conformance/apis/v1" // Report struct definition
+	gatewayv1 "sigs.k8s.io/gateway-api/apis/v1" // Import core Gateway API types
+	// Report struct definition
 	confflags "sigs.k8s.io/gateway-api/conformance/utils/flags"
 	apikubernetes "sigs.k8s.io/gateway-api/conformance/utils/kubernetes"
 	confsuite "sigs.k8s.io/gateway-api/conformance/utils/suite"
@@ -54,6 +52,7 @@ import (
 
 	// Import the test definitions package to access the ConformanceTests slice
 	"sigs.k8s.io/gateway-api-inference-extension/conformance/tests"
+	"sigs.k8s.io/gateway-api-inference-extension/version"
 
 	// Import test packages using blank identifier
 	// This triggers the init() functions in these packages, which register the tests
@@ -244,13 +243,11 @@ func RunConformanceWithOptions(t *testing.T, opts confsuite.ConformanceOptions)
 		t.Log("Generating Inference Extension conformance report")
 		report, err := cSuite.Report() // Use the existing report generation logic.
 		require.NoError(t, err, "error generating conformance report")
-
-		// TODO: Modify the report struct here if channel, version need to be modified.
-		// Example (requires adding fields to confapis.ConformanceReport):
-		// report.GatewayAPIInferenceExtensionChannel = opts.GatewayAPIInferenceExtensionChannel
-		// report.GatewayAPIInferenceExtensionVersion = opts.GatewayAPIInferenceExtensionVersion
-
-		err = writeReport(t.Logf, *report, opts.ReportOutputPath)
+		inferenceReport := GatewayAPIInferenceExtensionConformanceReport{
+			GatewayAPIInferenceExtensionVersion: version.BundleVersion,
+			ConformanceReport:                   *report,
+		}
+		err = inferenceReport.WriteReport(t.Logf, opts.ReportOutputPath)
 		require.NoError(t, err, "error writing conformance report")
 	}
 }
@@ -347,23 +344,3 @@ func ensureGatewayAvailableAndReady(t *testing.T, k8sClient client.Client, opts
 	require.NoErrorf(t, err, "shared gateway %s/%s did not get an address", gatewayNN.Namespace, gatewayNN.Name)
 	t.Logf("Shared Gateway %s/%s is ready.", gatewayNN.Namespace, gatewayNN.Name)
 }
-
-// writeReport writes the generated conformance report to the specified output file or logs it.
-// Adapted from the core Gateway API suite.
-func writeReport(logf func(string, ...any), report confapis.ConformanceReport, output string) error {
-	rawReport, err := yaml.Marshal(report)
-	if err != nil {
-		return fmt.Errorf("error marshaling report: %w", err)
-	}
-
-	if output != "" {
-		if err = os.WriteFile(output, rawReport, 0o600); err != nil {
-			return fmt.Errorf("error writing report file %s: %w", output, err)
-		}
-		logf("Conformance report written to %s", output)
-	} else {
-		// Log the report YAML to stdout if no output file is specified.
-		logf("Conformance report:\n%s", string(rawReport))
-	}
-	return nil
-}

conformance/conformancereport.go

@@ -0,0 +1,56 @@
+/*
+Copyright 2025 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 conformance contains the core setup and execution logic
+// for the Gateway API Inference Extension conformance test suite.
+package conformance
+
+import (
+	"fmt"
+	"os"
+
+	confapis "sigs.k8s.io/gateway-api/conformance/apis/v1"
+	"sigs.k8s.io/yaml"
+)
+
+// GatewayAPIInferenceExtensionConformanceReport is a report of conformance testing results of
+// gateway-api-inference-extension including the specific conformance profiles that were tested
+// and the results of the tests with summaries and statistics.
+type GatewayAPIInferenceExtensionConformanceReport struct {
+	// GatewayAPIInferenceExtensionVersion is the version of the gateway-api-inference-extension the tests run against.
+	GatewayAPIInferenceExtensionVersion string
+	// ConformanceReport is the fields reused from the gateway-api conformance reports.
+	confapis.ConformanceReport
+}
+
+// WriteReport writes the generated conformance report to the specified output file or logs it.
+func (report *GatewayAPIInferenceExtensionConformanceReport) WriteReport(logf func(string, ...any), output string) error {
+	rawReport, err := yaml.Marshal(*report)
+	if err != nil {
+		return fmt.Errorf("error marshaling report: %w", err)
+	}
+
+	if output != "" {
+		if err = os.WriteFile(output, rawReport, 0o600); err != nil {
+			return fmt.Errorf("error writing report file %s: %w", output, err)
+		}
+		logf("Conformance report written to %s", output)
+	} else {
+		// Log the report YAML to stdout if no output file is specified.
+		logf("Conformance report:\n%s", string(rawReport))
+	}
+	return nil
+}

conformance/reports/README.md

@@ -27,13 +27,14 @@ This folder stores conformance reports organized first by the version of the Gat
 
 ## Implementation Submissions
 
-Each implementation conformant with a specific profile of a specific version of the Gateway API Inference Extension should have its own folder within the corresponding version and profile directory (e.g., `/conformance/reports/v0.3.0/Gateway/my-implementation/`).
+Each implementation conformant with a specific profile of a specific version of the Gateway API Inference Extension should have its own folder within the corresponding version and profile directory (e.g., `/conformance/reports/v0.3.0/gateway/my-implementation/`).
 
 The implementation is the owner of its folder and is responsible for:
 
 1.  Uploading one or more conformance reports (YAML files).
 2.  Maintaining a mandatory `README.md` file within their folder, structured as follows:
 
+```
     # My Inference Gateway Implementation (Gateway Profile Conformance)
 
     General information about the My/Implementation project.
@@ -48,6 +49,7 @@ The implementation is the owner of its folder and is responsible for:
     ## Reproduce
 
     Instructions on how to reproduce the claimed report(s).
+```
 
 ### Table of Contents (within Implementation README)
 
@@ -89,7 +91,7 @@ To be accepted, submitted conformance reports must comply with the following rul
 
 Conformance reports demonstrating a `success` result for a specific profile (e.g., `Gateway`) should be submitted via Pull Request directly to this repository (`kubernetes-sigs/gateway-api-inference-extension`).
 
-1.  Create a new folder structure under `/conformance/reports/<extension-version>/<profile-name>/` named after your implementation (e.g., `/conformance/reports/v0.3.0/Gateway/my-implementation/`).
+1.  Create a new folder structure under `/conformance/reports/<extension-version>/<profile-name>/` named after your implementation (e.g., `/conformance/reports/v0.3.0/gateway/my-implementation/`).
 2.  Add your implementation's `README.md` to this folder, following the structure described above.
 3.  Add your generated conformance report YAML file(s) to this folder, ensuring they follow the naming convention `<Implementation Version>-<Mode>-<Profile>-report.yaml`.
 4.  Submit the Pull Request.

version/version.go

@@ -0,0 +1,22 @@
+/*
+Copyright 2025 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 version
+
+const (
+	// BundleVersion is the value used for labeling the version of the gateway-api-inference-extension.
+	BundleVersion = "v0.4.0-dev"
+)