Skip to content

Commit 1c233f6

Browse files
shaneuttk8s-ci-robot
authored andcommitted
chore: remove references to conformance profiles
There were a few references to conformance profiles in the godoc for the conformance test suite features. These references existed because this work originally came from the conformance profiles project branch which was work in progress, however since this change was cherry-picked out it needs to stand alone so referring to the not-yet-added conformance profiles work would be confusing.
1 parent 3c33da3 commit 1c233f6

File tree

1 file changed

+13
-14
lines changed

1 file changed

+13
-14
lines changed

conformance/utils/suite/features.go

+13-14
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ import "k8s.io/apimachinery/pkg/util/sets"
2727
type SupportedFeature string
2828

2929
// -----------------------------------------------------------------------------
30-
// Features - All Profiles (Core)
30+
// Features - Standard (Core)
3131
// -----------------------------------------------------------------------------
3232

3333
const (
@@ -38,7 +38,7 @@ const (
3838
)
3939

4040
// StandardCoreFeatures are the features that are required to be conformant with
41-
// the Core API features. All conformance profiles include this standard set.
41+
// the Core API features (e.g. GatewayClass, Gateway, e.t.c.).
4242
//
4343
// TODO: we need clarity for standard vs experimental features.
4444
// See: https://github.com/kubernetes-sigs/gateway-api/issues/1891
@@ -47,7 +47,7 @@ var StandardCoreFeatures = sets.New(
4747
)
4848

4949
// -----------------------------------------------------------------------------
50-
// Features - All Profiles (Extended)
50+
// Features - Standard (Extended)
5151
// -----------------------------------------------------------------------------
5252

5353
const (
@@ -76,7 +76,7 @@ var StandardExtendedFeatures = sets.New(
7676
).Insert(StandardCoreFeatures.UnsortedList()...)
7777

7878
// -----------------------------------------------------------------------------
79-
// Features - HTTP Conformance Profile (Core)
79+
// Features - HTTPRoute Conformance (Core)
8080
// -----------------------------------------------------------------------------
8181

8282
const (
@@ -85,13 +85,13 @@ const (
8585
)
8686

8787
// HTTPCoreFeatures includes all SupportedFeatures needed to be conformant with
88-
// the HTTP conformance profile at a Core level of support.
88+
// the HTTPRoute.
8989
var HTTPCoreFeatures = sets.New(
9090
SupportHTTPRoute,
9191
)
9292

9393
// -----------------------------------------------------------------------------
94-
// Features - HTTP Conformance Profile (Extended)
94+
// Features - HTTPRoute Conformance (Extended)
9595
// -----------------------------------------------------------------------------
9696

9797
const (
@@ -120,9 +120,9 @@ const (
120120
SupportHTTPRoutePathRewrite SupportedFeature = "HTTPRoutePathRewrite"
121121
)
122122

123-
// HTTPExtendedFeatures includes all the supported features for the HTTP conformance
124-
// profile and can be used to opt-in to run all HTTP tests (including extended
125-
// and experimental features).
123+
// HTTPExtendedFeatures includes all the supported features for HTTPRoute
124+
// conformance and can be used to opt-in to run all HTTPRoute tests, including
125+
// extended features.
126126
var HTTPExtendedFeatures = sets.New(
127127
SupportHTTPRouteQueryParamMatching,
128128
SupportHTTPRouteMethodMatching,
@@ -135,16 +135,16 @@ var HTTPExtendedFeatures = sets.New(
135135
).Insert(HTTPCoreFeatures.UnsortedList()...)
136136

137137
// -----------------------------------------------------------------------------
138-
// Features - TLS Conformance Profile
138+
// Features - TLSRoute Conformance (Core)
139139
// -----------------------------------------------------------------------------
140140

141141
const (
142142
// This option indicates support for TLSRoute
143143
SupportTLSRoute SupportedFeature = "TLSRoute"
144144
)
145145

146-
// TLSCoreFeatures includes all the supported features for the TLS conformance
147-
// profile at a Core level of support.
146+
// TLSCoreFeatures includes all the supported features for the TLSRoute API at
147+
// a Core level of support.
148148
var TLSCoreFeatures = sets.New(
149149
SupportTLSRoute,
150150
)
@@ -156,8 +156,7 @@ var TLSCoreFeatures = sets.New(
156156
// AllFeatures contains all the supported features and can be used to run all
157157
// conformance tests with `all-features` flag.
158158
//
159-
// NOTE: as new profiles and levels are added, they should be inserted into
160-
// this set.
159+
// NOTE: as new feature sets are added they should be inserted into this set.
161160
var AllFeatures = sets.New[SupportedFeature]().
162161
Insert(StandardExtendedFeatures.UnsortedList()...).
163162
Insert(HTTPExtendedFeatures.UnsortedList()...).

0 commit comments

Comments
 (0)