Verify that WrapPayloadWithEnvelope is exhaustive #11454
Conversation
This file contains hidden or 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
Make sure that it covers all types with reflection.
marvin-tigera
added
release-note-required
fasaxc
added
docs-not-required
marvin-tigera
added
release-note-required
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a reflection-based unit test to verify that the WrapPayloadWithEnvelope function handles all possible ToDataplane payload types, addressing the risk that new payload types might be added without updating this critical function. The PR also updates logging utilities to support benchmarks.
- Adds comprehensive test coverage for
WrapPayloadWithEnvelopeusing protobuf reflection to enumerate all payload types - Changes logging utility parameters from
*testing.Ttotesting.TBinterface to support both tests and benchmarks - Includes a benchmark to measure performance of the wrapping function
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| libcalico-go/lib/logutils/logutils.go | Updated function signatures from *testing.T to testing.TB interface to support both tests and benchmarks |
| felix/dataplane/external/ext_dataplane_test.go | Added new test file with mainline test, exhaustive payload type test using reflection, and performance benchmark |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
fasaxc
added
docs-not-required
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
The
WrapPayloadWithEnvelopefunction is supposed to cover allToDataplanepayload types, but it's easy to forget to update it when adding one (especially when merging code to enterprise, where there are more types).Add a reflection-based UT that checks that all possible types are covered. I also experimented with replacing the function with a reflection-based one, but that was 6x slower and this is close to the critical path in some cases.
Related issues/PRs
Todos
Release Note
Reminder for the reviewer
Make sure that this PR has the correct labels and milestone set.
Every PR needs one
docs-*label.docs-pr-required: This change requires a change to the documentation that has not been completed yet.docs-completed: This change has all necessary documentation completed.docs-not-required: This change has no user-facing impact and requires no docs.Every PR needs one
release-note-*label.release-note-required: This PR has user-facing changes. Most PRs should have this label.release-note-not-required: This PR has no user-facing changes.Other optional labels:
cherry-pick-candidate: This PR should be cherry-picked to an earlier release. For bug fixes only.needs-operator-pr: This PR is related to install and requires a corresponding change to the operator.