Coerce BaseBGPRow attribute values to expected types
#313
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
🦙 MegaLinter status: ✅ SUCCESS
See detailed report in MegaLinter reports MegaLinter is graciously provided by |
Test results 3 files 3 suites 1m 17s ⏱️ Results for commit 44e06b8. ♻️ This comment has been updated with latest results. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #313 +/- ##
=======================================
Coverage 97.31% 97.31%
=======================================
Files 64 64
Lines 7888 7895 +7
=======================================
+ Hits 7676 7683 +7
Misses 212 212 ☔ View full report in Codecov by Sentry. |
This requires Pydantic >= 2.7.0, as this is the first version that enables serialization warnings to be turned into errors/exceptions, which will trigger this test.
This fixes #312 by type-casting incoming attributes on BaseBGPRow. The expected Enum types have values designed to match the state strings from the BGP MIBs, so coercing the strings as early as possible should do.
While the code works, its always cleaner (and easier to type check) to refer to the Enum values rather than compare against string literals (which could be both redundant and incorrect).
johannaengland
force-pushed
the
bugfix/incorrect-bgp-value-types
branch
from
0d0ff96
to
44e06b8
Compare
|
johannaengland
approved these changes
Jul 23, 2024
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.
Scope and purpose
Fixes #312.
The issue could also have been fixed by ensuring the assigned types were correct to begin with, or by changing the type annotations of the dataclass to
strand ensure the Pydantic model coerces the values instead, but this is my initial suggestion.Contributor Checklist
Every pull request should have this checklist filled out, no matter how small it is.
More information about contributing to Zino can be found in the
README.