DM-40638: Fix serialization of objects in watch events #197
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
When mocking the Kubernetes API, stop mocking the entire ApiClient, since we need to use its deserialize method to convert watch events to their proper types. Due to the other mocking, we should never make network calls, but mock the request method of ApiClient just in case.
In the Kubernetes mock, objects serialized into watch events were not being serialized properly. They were keeping the Python snake-case attribute names instead of the Kubernetes camel-case names. This prevented deserialization to Kubernetes model objects and was also confusing. Fix this by passing the serialize parameter to to_dict when serializing the objects, and restructure the code a bit to reduce duplicate work. Add an explicit test for proper object serialization and deserialization.
Update the documentation for watches and mention passing the type of the model explicitly into the Watch constructor. Mention the serialize parameter to the to_dict method. Add a change log entry for Kubernetes mock fixes.
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.
In the Kubernetes mock, objects serialized into watch events were not being serialized properly. They were keeping the Python snake-case attribute names instead of the Kubernetes camel-case names. This prevented deserialization to Kubernetes model objects and was also confusing.
Fix this by passing the serialize parameter to to_dict when serializing the objects, and restructure the code a bit to reduce duplicate work. Add an explicit test for proper object serialization and deserialization.
When mocking the Kubernetes API, stop mocking the entire ApiClient, since we need to use its deserialize method to convert watch events to their proper types. Due to the other mocking, we should never make network calls, but mock the request method of ApiClient just in case.