kubernetes-sigs / gateway-api

Repository for the next iteration of composite service (e.g. Ingress) and load balancing APIs.
https://gateway-api.sigs.k8s.io
Apache License 2.0
1.75k stars 453 forks source link

Cumbersome experimental conformance reporting suite UX #2205

Open sunjayBhatia opened 1 year ago

sunjayBhatia commented 1 year ago

Currently in Contour we use these conformance suite options to ensure we run all tests by default, but intentionally have to exclude a few that either don't apply or don't pass. In our case, we exclude the Mesh feature and one of the extended support HTTPProxy tests.

Doing this in the experimental conformance suite currently is not as simple as that to get the full report on supported extended features out. Instead you need something like:

    cSuite, err := suite.NewExperimentalConformanceTestSuite(suite.ExperimentalConformanceOptions{
        Options: suite.Options{
                        ...
                        // Note this vs. using the EnableAllSupportedFeatures and ExemptFeatures field
            SupportedFeatures: suite.AllFeatures.Delete(suite.MeshCoreFeatures.UnsortedList()...),
            SkipTests: []string{
                tests.HTTPRouteRedirectPortAndScheme.ShortName,
            },
        },
        Implementation: conformance_v1alpha1.Implementation{
                         ...
        },
        ConformanceProfiles: sets.New(
            suite.HTTPConformanceProfileName,
            suite.TLSConformanceProfileName,
        ),
    })

It would be great if using the same suite.Options setup was possible between the two versions, especially if the current one is eventually replaced by the version that can report conformance results.

Notes:

shaneutt commented 1 year ago

Seems like a good area for improvement, thank you for trying out the experimental conformance profile test suite and providing some feedback!

/triage accepted

I don't think we need to necessarily worry about this for GA however, so I'm not intending to add it to that milestone for now but instead as something to follow up on post-GA:

/priority important-longterm

Ultimately the experimental suite should in time (as we graduate beyond experimental) replace the current test suite so in theory this gets resolved as a bi-product of normal progression? However if there's some more immediate need or something I've missed here please do let me know.

/cc @mlavacca

mlavacca commented 1 year ago

Thanks @sunjayBhatia, this would look like a good improvement in usability

Ultimately the experimental suite should in time (as we graduate beyond experimental) replace the current test suite so in theory this gets resolved as a bi-product of normal progression? However if there's some more immediate need or something I've missed here please do let me know.

+1, even if we should be careful not to lose track of this one, even because when the experimental will become the new standard, most likely we'll be deleting the standard one (or deprecating it), and we should take care of adding this improvement there.

k8s-triage-robot commented 1 month ago

This issue has not been updated in over 1 year, and should be re-triaged.

You can:

For more details on the triage process, see https://www.kubernetes.dev/docs/guide/issue-triage/

/remove-triage accepted