Add flags for SupportedFeatures and ExemptFeatures in conformance tests. #1394

gyohuangxin · 2022-09-20T02:43:14Z

What type of PR is this?

/kind feature

What this PR does / why we need it:

This PR add flags for SupportedFeatures and ExemptFeatures in conformance tests.

Examples:

// conformance tests with supported features 
go test ./conformance --gateway-class nginx -v -supported-features ReferenceGrant
go test ./conformance --gateway-class nginx -v -supported-features ReferenceGrant,HTTPRouteQueryParamMatching,HTTPRouteMethodMatchig

// conformance tests with exempt features
go test ./conformance --gateway-class nginx -v -exempt-features ReferenceGrant

Which issue(s) this PR fixes:

Fixes #1391

Does this PR introduce a user-facing change?:

1. Add flags for SupportedFeatures and ExemptFeatures in conformance tests.
2. Remove suite.SupportReferenceGrant as the default value of SupportedFeatures.
3. Replace `Features:    []suite.SupportedFeature{suite.SupportReferenceGrant}` from Features list to `Exemptions:  []suite.ExemptFeature{suite.ExemptReferenceGrant}` on all tests.

k8s-ci-robot · 2022-09-20T02:43:23Z

Hi @gyohuangxin. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

conformance/utils/flags/flags.go

mikemorris · 2022-09-20T18:10:19Z

conformance/conformance_test.go

 	cSuite := suite.New(suite.Options{
 		Client:               client,
 		GatewayClassName:     *flags.GatewayClassName,
 		Debug:                *flags.ShowDebug,
 		CleanupBaseResources: *flags.CleanupBaseResources,
-		SupportedFeatures: []suite.SupportedFeature{
-			suite.SupportReferenceGrant,


I believe the original intent of having this specific feature hardcoded was to include ReferenceGrant in the default set of conformance tests - I'm not sure if we should try to keep a "default supported features" list somehow (feels awkward), or instead just change conformance tests currently enabled with the flag to instead switch to an ExemptFeature flag to opt-out.

Maybe we can make a "default supported features" which runs all the conformance tests, and we can change enabled tests with SupportedFeatures flag or just opt-out tests with ExemptFeatures flag. What do you think?

I think we could just remove the suite.SupportReferenceGrant constant, and remove it from the Features list on all conformance tests that currently expect it to be set.

This keeps those tests included by default, still allows using the ExemptReferenceGrant flag to opt-out, avoids any complexity of an extra "default" list, and feels okay given that we're intending to promote ReferenceGrant to v1beta1 in the upcoming v0.6.0 Gateway API release.

@mikemorris Thanks for your reply, I can understand it basically. What to do are:

Remove suite.SupportReferenceGrant as the default value of SupportedFeatures

Remove suite.SupportReferenceGrant from Features list on all tests, such as https://github.com/kubernetes-sigs/gateway-api/blob/main/conformance/tests/gateway-secret-invalid-reference-grant.go#L37. Then replace it to Exemptions: []suite.ExemptFeature{ suite.ExemptReferenceGrant, },, so that --exempt-features ExemptReferenceGrant flag can be set to opt-out.

Can I confirm it is correct?

Yes, that should be correct @gyohuangxin!

I think we can then do:
3. Remove the constant at

gateway-api/conformance/utils/suite/suite.go

Lines 47 to 48 in 583e4e2

// This option indicates support for the ReferenceGrant object.

SupportReferenceGrant SupportedFeature = "ReferenceGrant"

In upcoming Gateway API v0.6.0, all implementations should assume ReferenceGrant is supported unless explicitly setting ExemptReferenceGrant.

@mikemorris Thanks! I've updated the code and the "user-facing change" section per your comments, please review again.

mikemorris · 2022-09-20T18:10:31Z

/ok-to-test

@gyohuangxin Could you add a changelog entry in the "user-facing change" section?

gyohuangxin · 2022-09-21T01:53:29Z

/ok-to-test

@gyohuangxin Could you add a changelog entry in the "user-facing change" section?

Updated the "user-facing change" section.

gyohuangxin · 2022-09-22T06:21:50Z

@aryan9600 @mikemorris Any more comments?

Signed-off-by: Huang Xin <xin1.huang@intel.com>

…eatures and remove suite.SupportReferenceGrant from Features list on all tests. Signed-off-by: Huang Xin <xin1.huang@intel.com>

mikemorris · 2022-09-29T18:49:47Z

/assign @mikemorris

mikemorris · 2022-09-29T18:51:22Z

/lgtm

mikemorris · 2022-09-29T18:51:49Z

/assign @shaneutt

gyohuangxin · 2022-09-30T08:37:05Z

@shaneutt Can you help review it? Thanks.

gyohuangxin · 2022-10-04T17:04:42Z

@shaneutt Cloud you please have a look on that?

robscott · 2022-10-04T18:22:40Z

Thanks @gyohuangxin!

/approve

k8s-ci-robot · 2022-10-04T18:22:48Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: gyohuangxin, robscott

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [robscott]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot added kind/feature Categorizes issue or PR as related to a new feature. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Sep 20, 2022

k8s-ci-robot requested review from mikemorris and robscott September 20, 2022 02:43

k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Sep 20, 2022

aryan9600 reviewed Sep 20, 2022

View reviewed changes

conformance/utils/flags/flags.go Outdated Show resolved Hide resolved

mikemorris reviewed Sep 20, 2022

View reviewed changes

k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Sep 20, 2022

gyohuangxin added 2 commits September 28, 2022 13:50

Add flags for SupportedFeature and ExemptFeature in conformance tests.

0bfc24a

Signed-off-by: Huang Xin <xin1.huang@intel.com>

Remove suite.SupportReferenceGrant as the default value of SupportedF…

c7c0164

…eatures and remove suite.SupportReferenceGrant from Features list on all tests. Signed-off-by: Huang Xin <xin1.huang@intel.com>

gyohuangxin force-pushed the flags_supportedFeature branch from 92bec8a to c7c0164 Compare September 28, 2022 15:28

gyohuangxin requested review from mikemorris and removed request for robscott September 28, 2022 15:35

k8s-ci-robot assigned mikemorris Sep 29, 2022

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 29, 2022

k8s-ci-robot assigned shaneutt Sep 29, 2022

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 4, 2022

k8s-ci-robot merged commit 09fd6ff into kubernetes-sigs:main Oct 4, 2022

skriss mentioned this pull request Oct 7, 2022

Gateway API: use -supported-features flag to opt into extended conformance tests from main projectcontour/contour#4779

Closed

gyohuangxin mentioned this pull request Nov 4, 2022

REQUEST: New membership for gyohuangxin kubernetes/org#3817

Closed

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add flags for SupportedFeatures and ExemptFeatures in conformance tests. #1394

Add flags for SupportedFeatures and ExemptFeatures in conformance tests. #1394

gyohuangxin commented Sep 20, 2022 •

edited

Loading

k8s-ci-robot commented Sep 20, 2022

mikemorris Sep 20, 2022

gyohuangxin Sep 21, 2022

mikemorris Sep 22, 2022

gyohuangxin Sep 23, 2022

mikemorris Sep 26, 2022 •

edited

Loading

gyohuangxin Sep 28, 2022

mikemorris commented Sep 20, 2022

gyohuangxin commented Sep 21, 2022

gyohuangxin commented Sep 22, 2022

mikemorris commented Sep 29, 2022 •

edited

Loading

mikemorris commented Sep 29, 2022

mikemorris commented Sep 29, 2022

gyohuangxin commented Sep 30, 2022

gyohuangxin commented Oct 4, 2022

robscott commented Oct 4, 2022

k8s-ci-robot commented Oct 4, 2022

	// This option indicates support for the ReferenceGrant object.
	SupportReferenceGrant SupportedFeature = "ReferenceGrant"

Add flags for SupportedFeatures and ExemptFeatures in conformance tests. #1394

Add flags for SupportedFeatures and ExemptFeatures in conformance tests. #1394

Conversation

gyohuangxin commented Sep 20, 2022 • edited Loading

k8s-ci-robot commented Sep 20, 2022

mikemorris Sep 20, 2022

Choose a reason for hiding this comment

gyohuangxin Sep 21, 2022

Choose a reason for hiding this comment

mikemorris Sep 22, 2022

Choose a reason for hiding this comment

gyohuangxin Sep 23, 2022

Choose a reason for hiding this comment

mikemorris Sep 26, 2022 • edited Loading

Choose a reason for hiding this comment

gyohuangxin Sep 28, 2022

Choose a reason for hiding this comment

mikemorris commented Sep 20, 2022

gyohuangxin commented Sep 21, 2022

gyohuangxin commented Sep 22, 2022

mikemorris commented Sep 29, 2022 • edited Loading

mikemorris commented Sep 29, 2022

mikemorris commented Sep 29, 2022

gyohuangxin commented Sep 30, 2022

gyohuangxin commented Oct 4, 2022

robscott commented Oct 4, 2022

k8s-ci-robot commented Oct 4, 2022

gyohuangxin commented Sep 20, 2022 •

edited

Loading

mikemorris Sep 26, 2022 •

edited

Loading

mikemorris commented Sep 29, 2022 •

edited

Loading