test(policy): Reduce duplication in outbound policy API tests #13543
Conversation
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
Signed-off-by: Alex Leong <alex@buoyant.io>
Signed-off-by: Alex Leong <alex@buoyant.io>
Signed-off-by: Alex Leong <alex@buoyant.io>
Signed-off-by: Alex Leong <alex@buoyant.io>
Signed-off-by: Alex Leong <alex@buoyant.io>
Signed-off-by: Alex Leong <alex@buoyant.io>
Signed-off-by: Alex Leong <alex@buoyant.io>
zaharidichev
approved these changes
Jan 10, 2025
policy-test/src/outbound_api.rs
Outdated
| @@ -418,7 +389,7 @@ pub fn assert_tls_backend_matches_parent( | |||
| } | |||
| } | |||
|
|
|||
| assert_resource_meta(&backend.metadata, parent, port) | |||
| //assert_resource_meta(&backend.metadata, parent, port) | |||
policy-test/src/outbound_api.rs
Outdated
| @@ -464,7 +435,7 @@ pub fn assert_tcp_backend_matches_parent( | |||
| } | |||
| } | |||
|
|
|||
| assert_resource_meta(&backend.metadata, parent, port) | |||
| //assert_resource_meta(&backend.metadata, parent, port) | |||
Signed-off-by: Alex Leong <alex@buoyant.io>
|
Good catch, @zaharidichev, those lines were actually in helper methods that are no longer used and can be removed entirely. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change refactors the outbound policy API integration tests to reduce duplication and to be more principled about what combinations of routes and parents are tested. The outbound policy API supports many route types (Linkerd HTTPRoute, gateway HTTPRoute, GRPCRoute, TCPRoute, and TLSRoute) and each of these routes may be attached to up to two parent types (Service and EgressNetwork). Many behaviors of the outbound policy API are shared between these route and parent types and in order to test these behaviors, many tests were duplicated for each combination of types. This resulted in a large amount of duplication and made it difficult to determine exactly which combinations were being tested and if any combinations were missed. It also required that the duplicated tests be kept in sync and allowed the possibility that the tests could accidentally drift apart over time resulting in inconsistent test coverage.
We introduce the TestRoute and TestParent traits which capture the common properties of routes and parents respectively and refactor the outbound policy API tests to be generic over these types and then explicitly invoke the test with the combinations of types to which the tested behavior applies. In cases where the tested behavior is specific to a particular type rather than being common to all types, a type specific test remains.