Skip to content

Commit

Permalink
Update conformance tests guidance in alignment with GEP-2162 (#3502)
Browse files Browse the repository at this point in the history
  • Loading branch information
LiorLieberman authored Dec 16, 2024
1 parent 8e365c6 commit f48c7e2
Showing 1 changed file with 18 additions and 5 deletions.
23 changes: 18 additions & 5 deletions geps/gep-696/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,25 @@ the content into the GEP as online documents are easier to lose

## Conformance Details

(This section describes the names to be used for the feature or
features in conformance tests and profiles.
(from https://github.com/kubernetes-sigs/gateway-api/blob/main/geps/gep-2162/index.md#standardize-features-and-conformance-tests-names)

These should be `CamelCase` names that specify the feature as
precisely as possible, and are particularly important for
Extended features, since they may be surfaced to users.)
#### Feature Names

Every feature should:

1. Start with the resource name. i.e HTTPRouteXXX
2. Follow the PascalCase convention. Note that the resource name in the string should come as is and not be converted to PascalCase, i.e HTTPRoutePortRedirect and not HttpRoutePortRedirect.
3. Not exceed 128 characters.
4. Contain only letters and numbers

### Conformance tests

Conformance tests file names should try to follow the the `pascal-case-name.go` format.
For example for `HTTPRoutePortRedirect` - the test file would be `httproute-port-redirect.go`.

Treat this guidance as "best effort" because we might have test files that check the combination of several features and can't follow the same format.

In any case, the conformance tests file names should be meaningful and easy to understand.

## Alternatives

Expand Down

0 comments on commit f48c7e2

Please sign in to comment.