generated from kubernetes/kubernetes-template-project
-
Notifications
You must be signed in to change notification settings - Fork 162
Add None handling to sandbox/gateway/snapshot wait
#414
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
nadolskit
wants to merge
3
commits into
kubernetes-sigs:main
Choose a base branch
from
nadolskit:fix-nonetype-not-subscriptable
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+115
−0
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
109 changes: 109 additions & 0 deletions
109
clients/python/agentic-sandbox-client/k8s_agent_sandbox/test/unit/test_sandbox_client.py
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| # Copyright 2026 The Kubernetes Authors. | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| import unittest | ||
| import logging | ||
| from unittest.mock import MagicMock, patch | ||
|
|
||
| from k8s_agent_sandbox.sandbox_client import SandboxClient | ||
| from k8s_agent_sandbox.constants import POD_NAME_ANNOTATION | ||
|
|
||
| logger = logging.getLogger(__name__) | ||
|
|
||
|
|
||
| class TestSandboxClientWatchNoneEvents(unittest.TestCase): | ||
| """Tests that watch streams gracefully handle None events. | ||
|
|
||
| The `watch` api can yield `None` when the underlying | ||
| connection times out/drops/etc. These tests verify that the watch | ||
| loop can handle this gracefully. | ||
| """ | ||
|
|
||
| def setUp(self): | ||
| with patch.object(SandboxClient, "__init__", return_value=None): | ||
| self.client = SandboxClient("test-template") | ||
|
|
||
| self.client.custom_objects_api = MagicMock() | ||
| self.client.claim_name = "test-claim" | ||
| self.client.sandbox_name = None | ||
| self.client.pod_name = None | ||
| self.client.annotations = None | ||
| self.client.namespace = "default" | ||
| self.client.sandbox_ready_timeout = 10 | ||
| self.client.gateway_ready_timeout = 10 | ||
| self.client.gateway_name = "test-gateway" | ||
| self.client.gateway_namespace = "default" | ||
| self.client.base_url = None | ||
| self.client.tracing_manager = None | ||
|
|
||
| @patch("k8s_agent_sandbox.sandbox_client.watch.Watch") | ||
| def test_wait_for_sandbox_ready_skips_none_events(self, mock_watch_cls): | ||
| """None events from the watch stream should be skipped, not crash.""" | ||
| mock_watch = MagicMock() | ||
| mock_watch_cls.return_value = mock_watch | ||
|
|
||
| ready_event = { | ||
| "type": "MODIFIED", | ||
| "object": { | ||
| "metadata": { | ||
| "name": "test-sandbox", | ||
| "annotations": {POD_NAME_ANNOTATION: "test-pod"}, | ||
| }, | ||
| "status": { | ||
| "conditions": [ | ||
| {"type": "Ready", "status": "True"}, | ||
| ], | ||
| }, | ||
| }, | ||
| } | ||
| mock_watch.stream.return_value = [None, None, ready_event] | ||
| self.client._wait_for_sandbox_ready() | ||
|
|
||
| self.assertEqual(self.client.sandbox_name, "test-sandbox") | ||
| self.assertEqual(self.client.pod_name, "test-pod") | ||
|
|
||
| @patch("k8s_agent_sandbox.sandbox_client.watch.Watch") | ||
| def test_wait_for_sandbox_ready_all_none_times_out(self, mock_watch_cls): | ||
| """A stream of only None events should exhaust the watch and raise TimeoutError.""" | ||
| mock_watch = MagicMock() | ||
| mock_watch_cls.return_value = mock_watch | ||
|
|
||
| mock_watch.stream.return_value = [None, None, None] | ||
|
|
||
| with patch.object(self.client, "__exit__"): | ||
| with self.assertRaises(TimeoutError): | ||
| self.client._wait_for_sandbox_ready() | ||
|
|
||
| @patch("k8s_agent_sandbox.sandbox_client.watch.Watch") | ||
| def test_wait_for_gateway_ip_skips_none_events(self, mock_watch_cls): | ||
| """None events in the gateway watch should be skipped.""" | ||
| mock_watch = MagicMock() | ||
| mock_watch_cls.return_value = mock_watch | ||
|
|
||
| gateway_ready_event = { | ||
| "type": "MODIFIED", | ||
| "object": { | ||
| "status": { | ||
| "addresses": [{"value": "10.0.0.1"}], | ||
| }, | ||
| }, | ||
| } | ||
| mock_watch.stream.return_value = [None, gateway_ready_event] | ||
|
|
||
| self.client._wait_for_gateway_ip() | ||
| self.assertEqual(self.client.base_url, "http://10.0.0.1") | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| unittest.main() | ||
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.
Uh oh!
There was an error while loading. Please reload this page.