-
Notifications
You must be signed in to change notification settings - Fork 360
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add experimental conformance support (#1780)
* feat: add experimental conformance support Signed-off-by: bitliu <bitliu@tencent.com> * 👽 Update Signed-off-by: bitliu <bitliu@tencent.com> * 🎨 Update Signed-off-by: bitliu <bitliu@tencent.com> * 🎨 Update Signed-off-by: bitliu <bitliu@tencent.com> * 🔀 Update Signed-off-by: bitliu <bitliu@tencent.com> * 🎨 Update Signed-off-by: bitliu <bitliu@tencent.com> * 🎨 Update Signed-off-by: bitliu <bitliu@tencent.com> * 🎨 Update Signed-off-by: bitliu <bitliu@tencent.com> * 🎨 Update Signed-off-by: bitliu <bitliu@tencent.com> * 🎨 Update Signed-off-by: bitliu <bitliu@tencent.com> * 🎨 Update Signed-off-by: bitliu <bitliu@tencent.com> * 🎨 Update Signed-off-by: bitliu <bitliu@tencent.com> * 🎨 Update Signed-off-by: bitliu <bitliu@tencent.com> * 🎨 Update Signed-off-by: bitliu <bitliu@tencent.com> * 🎨 Update Signed-off-by: bitliu <bitliu@tencent.com> * 🎨 Update Signed-off-by: bitliu <bitliu@tencent.com> * 🎨 Update Signed-off-by: bitliu <bitliu@tencent.com> * 🎨 Update Signed-off-by: bitliu <bitliu@tencent.com> * 🎨 Update Signed-off-by: bitliu <bitliu@tencent.com> * 🎨 Update Signed-off-by: bitliu <bitliu@tencent.com> * 🎨 Update Signed-off-by: bitliu <bitliu@tencent.com> * 🎨 Update Signed-off-by: bitliu <bitliu@tencent.com> * 🎨 Update Signed-off-by: bitliu <bitliu@tencent.com> * 🎨 Update Signed-off-by: bitliu <bitliu@tencent.com> * update Signed-off-by: bitliu <bitliu@tencent.com> * 🎨 Update Signed-off-by: bitliu <bitliu@tencent.com> * 🧪 Test Signed-off-by: bitliu <bitliu@tencent.com> * 🎨 Final update Signed-off-by: bitliu <bitliu@tencent.com> * 🎨 Update Signed-off-by: bitliu <bitliu@tencent.com> * 🎨 Update Signed-off-by: bitliu <bitliu@tencent.com> * 🎨 Update Signed-off-by: bitliu <bitliu@tencent.com> * 🎨 Update Signed-off-by: bitliu <bitliu@tencent.com> * 🎨 Update Signed-off-by: bitliu <bitliu@tencent.com> --------- Signed-off-by: bitliu <bitliu@tencent.com>
- Loading branch information
Showing
4 changed files
with
184 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| name: Experimental Conformance Test | ||
| on: | ||
| push: | ||
| paths: | ||
| - 'charts/gateway-helm/crds/gatewayapi-crds.yaml' | ||
| pull_request: | ||
| paths: | ||
| - 'charts/gateway-helm/crds/gatewayapi-crds.yaml' | ||
| - 'test/conformance/*.go' | ||
| # Add workflow_dispatch to trigger this workflow manually by maintainers. | ||
| workflow_dispatch: | ||
|
|
||
| jobs: | ||
| experimental-conformance-test: | ||
| runs-on: ubuntu-latest | ||
| strategy: | ||
| matrix: | ||
| version: [ v1.26.6, v1.27.3, v1.28.0 ] | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - uses: ./tools/github-actions/setup-deps | ||
|
|
||
| # gateway api experimental conformance | ||
| - name: Run Experimental Conformance Tests | ||
| env: | ||
| CONFORMANCE_REPORT_PATH: conformance-report-k8s-${{ matrix.version }}.yaml | ||
| KIND_NODE_TAG: ${{ matrix.version }} | ||
| IMAGE_PULL_POLICY: IfNotPresent | ||
| run: make experimental-conformance | ||
|
|
||
| - name: Upload Conformance Report | ||
| uses: actions/upload-artifact@v3 | ||
| with: | ||
| name: conformance-report-k8s-${{ matrix.version }} | ||
| path: ./test/conformance/conformance-report-k8s-${{ matrix.version }}.yaml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,134 @@ | ||
| //go:build experimental | ||
| // +build experimental | ||
|
|
||
| // Copyright Envoy Gateway Authors | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| // The full text of the Apache license is available in the LICENSE file at | ||
| // the root of the repo. | ||
|
|
||
| package conformance | ||
|
|
||
| import ( | ||
| "os" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| "k8s.io/apimachinery/pkg/util/sets" | ||
| "k8s.io/client-go/kubernetes" | ||
| "k8s.io/client-go/rest" | ||
| "sigs.k8s.io/controller-runtime/pkg/client" | ||
| "sigs.k8s.io/controller-runtime/pkg/client/config" | ||
| "sigs.k8s.io/yaml" | ||
|
|
||
| "sigs.k8s.io/gateway-api/apis/v1alpha2" | ||
| "sigs.k8s.io/gateway-api/apis/v1beta1" | ||
| confv1a1 "sigs.k8s.io/gateway-api/conformance/apis/v1alpha1" | ||
| "sigs.k8s.io/gateway-api/conformance/tests" | ||
| "sigs.k8s.io/gateway-api/conformance/utils/flags" | ||
| "sigs.k8s.io/gateway-api/conformance/utils/suite" | ||
| ) | ||
|
|
||
| var ( | ||
| cfg *rest.Config | ||
| k8sClientset *kubernetes.Clientset | ||
| mgrClient client.Client | ||
| implementation *confv1a1.Implementation | ||
| conformanceProfiles sets.Set[suite.ConformanceProfileName] | ||
| skipTests []string | ||
| ) | ||
|
|
||
| func TestExperimentalConformance(t *testing.T) { | ||
| var err error | ||
| cfg, err = config.GetConfig() | ||
| if err != nil { | ||
| t.Fatalf("Error loading Kubernetes config: %v", err) | ||
| } | ||
| mgrClient, err = client.New(cfg, client.Options{}) | ||
| if err != nil { | ||
| t.Fatalf("Error initializing Kubernetes client: %v", err) | ||
| } | ||
| k8sClientset, err = kubernetes.NewForConfig(cfg) | ||
| if err != nil { | ||
| t.Fatalf("Error initializing Kubernetes REST client: %v", err) | ||
| } | ||
|
|
||
| err = v1alpha2.AddToScheme(mgrClient.Scheme()) | ||
| assert.NoError(t, err) | ||
| err = v1beta1.AddToScheme(mgrClient.Scheme()) | ||
| assert.NoError(t, err) | ||
|
|
||
| // experimental conformance flags | ||
| conformanceProfiles = sets.New( | ||
| suite.HTTPConformanceProfileName, | ||
| suite.TLSConformanceProfileName, | ||
| ) | ||
|
|
||
| // if some conformance profiles have been set, run the experimental conformance suite... | ||
| implementation, err = suite.ParseImplementation( | ||
| *flags.ImplementationOrganization, | ||
| *flags.ImplementationProject, | ||
| *flags.ImplementationURL, | ||
| *flags.ImplementationVersion, | ||
| *flags.ImplementationContact, | ||
| ) | ||
| if err != nil { | ||
| t.Fatalf("Error parsing implementation's details: %v", err) | ||
| } | ||
|
|
||
| experimentalConformance(t) | ||
| } | ||
|
|
||
| func experimentalConformance(t *testing.T) { | ||
| t.Logf("Running experimental conformance tests with %s GatewayClass\n cleanup: %t\n debug: %t\n enable all features: %t \n conformance profiles: [%v]", | ||
| *flags.GatewayClassName, *flags.CleanupBaseResources, *flags.ShowDebug, *flags.EnableAllSupportedFeatures, conformanceProfiles) | ||
|
|
||
| cSuite, err := suite.NewExperimentalConformanceTestSuite( | ||
| suite.ExperimentalConformanceOptions{ | ||
| Options: suite.Options{ | ||
| Client: mgrClient, | ||
| RestConfig: cfg, | ||
| // This clientset is needed in addition to the client only because | ||
| // controller-runtime client doesn't support non CRUD sub-resources yet (https://github.com/kubernetes-sigs/controller-runtime/issues/452). | ||
| Clientset: k8sClientset, | ||
| GatewayClassName: *flags.GatewayClassName, | ||
| Debug: *flags.ShowDebug, | ||
| CleanupBaseResources: *flags.CleanupBaseResources, | ||
| SkipTests: skipTests, | ||
| SupportedFeatures: sets.Set[suite.SupportedFeature]{}.Insert(suite.HTTPRouteExtendedFeatures.UnsortedList()...), | ||
| }, | ||
| Implementation: *implementation, | ||
| ConformanceProfiles: conformanceProfiles, | ||
| }) | ||
| if err != nil { | ||
| t.Fatalf("error creating experimental conformance test suite: %v", err) | ||
| } | ||
|
|
||
| cSuite.Setup(t) | ||
| err = cSuite.Run(t, tests.ConformanceTests) | ||
| if err != nil { | ||
| t.Fatalf("error running conformance profile report: %v", err) | ||
| } | ||
| report, err := cSuite.Report() | ||
| if err != nil { | ||
| t.Fatalf("error generating conformance profile report: %v", err) | ||
| } | ||
|
|
||
| err = experimentalConformanceReport(t.Logf, *report, *flags.ReportOutput) | ||
| assert.NoError(t, err) | ||
| } | ||
|
|
||
| func experimentalConformanceReport(logf func(string, ...any), report confv1a1.ConformanceReport, output string) error { | ||
| rawReport, err := yaml.Marshal(report) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| if output != "" { | ||
| if err = os.WriteFile(output, rawReport, 0600); err != nil { | ||
| return err | ||
| } | ||
| } | ||
| logf("Conformance report:\n%s", string(rawReport)) | ||
|
|
||
| return nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters