Feature: Added unit test for watcher #1529
Open
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: ayushrakesh <[email protected]>
Signed-off-by: ayushrakesh <[email protected]>
mateiidavid
reviewed
Jul 17, 2024
There was a problem hiding this comment.
@ayushrakesh thanks! I'm super excited about this, particularly since the watcher abstraction is such an important piece of the runtime crate. I see there's a bit more work to do here though. Let me know if you have any questions or if I can help out with anything.
Comment on lines
+160
to
+170
| // #[async_trait] | ||
| // trait ApiMode { | ||
| // type Value: Clone; | ||
|
|
||
| // async fn list(&self, lp: &ListParams) -> kube_client::Result<ObjectList<Self::Value>>; | ||
| // async fn watch( | ||
| // &self, | ||
| // wp: &WatchParams, | ||
| // version: &str, | ||
| // ) -> kube_client::Result<BoxStream<'static, kube_client::Result<WatchEvent<Self::Value>>>>; | ||
| // } |
There was a problem hiding this comment.
Was this commented as a mistake?
Comment on lines
+180
to
+183
| #[derive(Clone)] | ||
| struct TestResource { | ||
| // fields here | ||
| } |
There was a problem hiding this comment.
I wonder if we actually need a TestResource? Can we have our TestApiMode be generic over a K type that represents a k8s resource? Is the TestResource used to simplify this?
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.
Fixes #1528
Motivation
The primary problem is avoiding the accidental release of breaking changes to the watcher module in the future. The current testing approach was not adequate to catch all issues. particularly concerning how the watcher handles listing and watching resources in Kubernetes.
Solution
Creating a test-specific struct that implements the ApiMode trait. This test struct allows for injecting synthetic events and responses, simulating the behavior of an actual Kubernetes API server without making real API calls.