Skip to content

Commit e326c10

Browse files
authored
fix(python): close client when Sandbox entry fails (#4367)
* fix(python): close client when Sandbox entry fails Signed-off-by: Eric Curtin <eric.curtin@docker.com> * test(python): share client patch helper Signed-off-by: Eric Curtin <eric.curtin@docker.com> --------- Signed-off-by: Eric Curtin <eric.curtin@docker.com>
1 parent 66696eb commit e326c10

2 files changed

Lines changed: 105 additions & 7 deletions

File tree

‎python/openshell/sandbox.py‎

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1643,16 +1643,25 @@ def __enter__(self) -> Sandbox:
16431643
"name, labels, and workload_template cannot be set when attaching to an existing sandbox"
16441644
)
16451645

1646-
client = SandboxClient.from_active_cluster(
1646+
self._client = SandboxClient.from_active_cluster(
16471647
cluster=self._cluster,
16481648
timeout=self._timeout,
16491649
auto_refresh=self._auto_refresh,
16501650
write_back=self._write_back,
16511651
insecure=self._insecure,
16521652
client_credentials=self._client_credentials,
16531653
)
1654-
self._client = client
1654+
try:
1655+
self._open_session(self._client)
1656+
except BaseException:
1657+
# Python skips __exit__ when __enter__ raises, so release here
1658+
# and keep the original error even if the close fails.
1659+
with contextlib.suppress(Exception):
1660+
self._release()
1661+
raise
1662+
return self
16551663

1664+
def _open_session(self, client: SandboxClient) -> None:
16561665
if self._sandbox_input is None and self._workload_template is not None:
16571666
self._session = client.create_session_from_template(
16581667
workspace=self._workspace,
@@ -1684,7 +1693,12 @@ def __enter__(self) -> Sandbox:
16841693
)
16851694
self._session = SandboxSession(client, ready)
16861695

1687-
return self
1696+
def _release(self) -> None:
1697+
client = self._client
1698+
self._session = None
1699+
self._client = None
1700+
if client is not None:
1701+
client.close()
16881702

16891703
def __exit__(self, *args: object) -> None:
16901704
try:
@@ -1708,10 +1722,7 @@ def __exit__(self, *args: object) -> None:
17081722
f"unsupported deletion outcome: {result.outcome}"
17091723
)
17101724
finally:
1711-
if self._client is not None:
1712-
self._client.close()
1713-
self._session = None
1714-
self._client = None
1725+
self._release()
17151726

17161727
def exec(
17171728
self,

‎python/openshell/sandbox_cleanup_test.py‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,3 +156,90 @@ def test_context_cleanup_handles_absence_and_intercepted_errors(
156156
assert state.closed == [True]
157157
assert managed._client is None
158158
assert managed._session is None
159+
160+
161+
class _EntryFailureClient:
162+
"""Fails the named client call and records close()."""
163+
164+
def __init__(self, fail_at, close_error=None):
165+
self.fail_at = fail_at
166+
self.close_error = close_error
167+
self.closed = 0
168+
self.error = RuntimeError(f"{fail_at} failed")
169+
170+
def _step(self, name):
171+
if name == self.fail_at:
172+
raise self.error
173+
return SimpleNamespace(sandbox=SimpleNamespace(name="s1"))
174+
175+
def create_session(self, **_kwargs):
176+
return self._step("create_session")
177+
178+
def create_session_from_template(self, **_kwargs):
179+
return self._step("create_session_from_template")
180+
181+
def get_session(self, *_args, **_kwargs):
182+
return self._step("get_session")
183+
184+
def wait_ready(self, *_args, **_kwargs):
185+
self._step("wait_ready")
186+
return SimpleNamespace(name="s1", workspace="default")
187+
188+
def close(self):
189+
self.closed += 1
190+
if self.close_error is not None:
191+
raise self.close_error
192+
193+
194+
def _use_client(monkeypatch, client):
195+
monkeypatch.setattr(
196+
SandboxClient, "from_active_cluster", classmethod(lambda _cls, **_kw: client)
197+
)
198+
199+
200+
@pytest.mark.parametrize(
201+
("fail_at", "kwargs"),
202+
[
203+
("create_session", {}),
204+
("create_session_from_template", {"workload_template": "t"}),
205+
("get_session", {"sandbox": "existing"}),
206+
("wait_ready", {}),
207+
("wait_ready", {"sandbox": "existing"}),
208+
],
209+
)
210+
def test_context_entry_failure_closes_client(monkeypatch, fail_at, kwargs):
211+
client = _EntryFailureClient(fail_at)
212+
_use_client(monkeypatch, client)
213+
managed = Sandbox(workspace="default", delete_on_exit=False, **kwargs)
214+
215+
with pytest.raises(RuntimeError) as observed, managed:
216+
pass
217+
218+
assert observed.value is client.error
219+
assert client.closed == 1
220+
assert managed._client is None
221+
assert managed._session is None
222+
223+
224+
def test_context_entry_failure_keeps_original_error_when_close_fails(monkeypatch):
225+
client = _EntryFailureClient("wait_ready", close_error=OSError("close failed"))
226+
_use_client(monkeypatch, client)
227+
managed = Sandbox(workspace="default")
228+
229+
with pytest.raises(RuntimeError) as observed, managed:
230+
pass
231+
232+
assert observed.value is client.error
233+
assert client.closed == 1
234+
assert managed._client is None
235+
assert managed._session is None
236+
237+
238+
def test_context_closes_client_once_on_success(monkeypatch):
239+
client = _EntryFailureClient(None)
240+
_use_client(monkeypatch, client)
241+
242+
with Sandbox(workspace="default", delete_on_exit=False):
243+
assert client.closed == 0
244+
245+
assert client.closed == 1

0 commit comments

Comments
 (0)