Skip to content
Python

Sandbox: a failed creation removes its folder, so no copied credential is left behind

Devika Vermaf1d3711d78a8
diff --git a/coworker/sandbox/providers/openshell.py b/coworker/sandbox/providers/openshell.py
index 32df2892..b3b3f45a 100644
--- a/coworker/sandbox/providers/openshell.py
+++ b/coworker/sandbox/providers/openshell.py
@@ -129,6 +129,13 @@ class OpenShellProvider:
# -- lifecycle --------------------------------------------------------------------
def create(self) -> None:
+ try:
+ self._create()
+ except Exception:
+ self.destroy() # never leave a copied credential behind
+ raise
+
+ def _create(self) -> None:
preflight()
for root in self.roots:
if not os.path.isdir(root["path"]):
diff --git a/coworker/sandbox/providers/seatbelt.py b/coworker/sandbox/providers/seatbelt.py
index f28edf5a..50abf920 100644
--- a/coworker/sandbox/providers/seatbelt.py
+++ b/coworker/sandbox/providers/seatbelt.py
@@ -152,6 +152,13 @@ class SeatbeltProvider:
return env
def create(self) -> None:
+ try:
+ self._create()
+ except Exception:
+ self.destroy() # never leave a copied credential behind
+ raise
+
+ def _create(self) -> None:
preflight()
os.makedirs(os.path.join(self._dir, "tmp", "cache"), exist_ok=True)
if self.network:
diff --git a/coworker/sandbox/workspace.py b/coworker/sandbox/workspace.py
index 41175c79..11308b79 100644
--- a/coworker/sandbox/workspace.py
+++ b/coworker/sandbox/workspace.py
@@ -83,7 +83,11 @@ class RunnerWorkspace(Workspace):
if registry is not None:
registry.reap() # sandboxes left behind by a server that is gone
registry.check_room()
- provider.create()
+ try:
+ provider.create()
+ except Exception:
+ provider.destroy() # a half-made sandbox may already hold copied credentials
+ raise
try:
self.client = RunnerClient(provider.open_runner)
self.hello = self.client.connect()
diff --git a/tests/test_sandbox_credentials.py b/tests/test_sandbox_credentials.py
index d6ad4779..f9c43e5c 100644
--- a/tests/test_sandbox_credentials.py
+++ b/tests/test_sandbox_credentials.py
@@ -205,3 +205,20 @@ def test_ssh_and_gh_copies_work_inside_seatbelt_and_ssh_goes_through_the_proxy(t
ws.close()
fake.close()
assert not Path(provider.copied.home).exists() # the copies died with the sandbox
+
+
+def test_a_failed_creation_leaves_no_copied_credential_behind(tmp_path, monkeypatch):
+ from coworker.sandbox.providers import seatbelt
+
+ home = _home(tmp_path)
+ grants = creds.granted([{"name": "ssh", "enabled": True}], home=str(home))
+ provider = seatbelt.SeatbeltProvider(roots=[{"path": str(tmp_path), "writable": True}], cwd=tmp_path, credentials=grants, network=False)
+ folder = provider._dir
+
+ def broken() -> None:
+ raise seatbelt.SeatbeltUnavailable("no sandbox today")
+
+ monkeypatch.setattr(seatbelt, "preflight", broken)
+ with pytest.raises(seatbelt.SeatbeltUnavailable):
+ provider.create()
+ assert not os.path.exists(folder)