fix: preserve log cleanup failures

This commit is contained in:
Kurt Himebauch committed 2026-11-05 14:42:22 -05:00
1 parent ff686d7c3b
commit 11c0763fba
3 files changed
+63 -15

No files matched your search

+30 -13
View File
@@ -470,7 +470,7 @@ def unpack_logs(archive: Path, destination: Path, session_id: str) -> None:
for name in extracted - previous:
target = managed_target(name)
if target is None or target.exists():
raise ControlError(f"Refusing to overwrite an unrelated file: {target}", "LOG_PULL_FAILED")
raise ControlError(f"Refusing to overwrite an unrelated file: {name}", "LOG_PULL_FAILED")
if manifest.is_symlink() or (manifest.exists() and not manifest.is_file()):
raise ControlError("The managed log list is not a regular file", "LOG_PULL_FAILED")
backed_up = {}
@@ -511,7 +511,7 @@ def unpack_logs(archive: Path, destination: Path, session_id: str) -> None:
target = managed_target(name)
if target is not None and target.is_file():
target.unlink()
if manifest.exists() and not manifest.is_symlink():
if manifest_backup.is_file() and manifest.exists() and not manifest.is_symlink():
manifest.unlink()
for name, backup in backed_up.items():
target = managed_target(name)
@@ -846,6 +846,7 @@ def execute(args: argparse.Namespace, adb: str, serial: str) -> dict:
raise ControlError("No session artifact directory is available", "NO_SESSION_LOGS")
destination = Path(args.destination or session["id"]).expanduser().resolve()
exported = provider_call(adb, serial, "logs", timeout=args.timeout + 40)
cleanup_error = None
if (exported.get("error") or {}).get("code") == "UNKNOWN_COMMAND":
# Older builds have no logs method; their private folder only pulls on a rooted device.
result = run_adb(adb, serial, "pull", remote_dir, str(destination), timeout=120)
@@ -862,6 +863,20 @@ def execute(args: argparse.Namespace, adb: str, serial: str) -> dict:
request_dir == remote_zip.parent and request_dir.parent.name == "agent-logs" and
re.fullmatch(r"[0-9a-fA-F-]{36}", request_dir.name)):
cleanup = ["shell", "rm", "-rf", str(request_dir)]
def cleanup_export():
try:
cleaned = run_adb(adb, serial, *cleanup, timeout=30)
if cleaned.returncode == 0:
return None
detail = (cleaned.stderr or cleaned.stdout).decode(errors="replace").strip()
except Exception as error:
detail = str(error)
return ControlError(
"Could not remove the exported log archive; it may remain in shared storage" +
(f": {detail}" if detail else ""),
"LOG_CLEANUP_FAILED",
)
try:
if exported.get("sessionId", session["id"]) != session["id"]:
raise ControlError("A new session started while the logs were exported; run logs again",
@@ -869,21 +884,23 @@ def execute(args: argparse.Namespace, adb: str, serial: str) -> dict:
with tempfile.TemporaryDirectory() as temp:
local_zip = Path(temp) / "logs.zip"
result = run_adb(adb, serial, "pull", zip_path, str(local_zip), timeout=120)
if result.returncode == 0:
unpack_logs(local_zip, destination, session["id"])
finally:
if result.returncode != 0:
detail = (result.stderr or result.stdout).decode(errors="replace").strip()
raise ControlError(detail or "adb pull failed", "LOG_PULL_FAILED")
unpack_logs(local_zip, destination, session["id"])
except Exception:
cleanup_error = cleanup_export()
if cleanup_error:
print(cleanup_error, file=sys.stderr)
raise
else:
# The copy sits in shared storage, so it does not outlive the pull.
cleaned = run_adb(adb, serial, *cleanup, timeout=30)
if cleaned.returncode != 0:
detail = (cleaned.stderr or cleaned.stdout).decode(errors="replace").strip()
raise ControlError(
"Could not remove the exported log archive; it may remain in shared storage" +
(f": {detail}" if detail else ""),
"LOG_CLEANUP_FAILED",
)
cleanup_error = cleanup_export()
if result.returncode != 0:
detail = (result.stderr or result.stdout).decode(errors="replace").strip()
raise ControlError(detail or "adb pull failed", "LOG_PULL_FAILED")
if cleanup_error:
raise cleanup_error
return add_serial({"ok": True, "command": "logs", "sessionId": session["id"], "path": str(destination)}, serial)
if command == "screenshot":
+32 -1
View File
@@ -581,6 +581,15 @@ class DroiddeckctlTest(FakeAdbTest):
self.assertEqual("LOG_CLEANUP_FAILED", out["error"]["code"])
self.assertIn("may remain in shared storage", out["error"]["message"])
def test_logs_keep_pull_failure_primary_when_remote_cleanup_fails(self):
self.configure({"state": ended_state(),
"logs": {"ok": True, "sessionId": "s1", "zip": EXPORTED_ZIP,
"cleanupDir": EXPORTED_DIR}}, fail_cleanup=True)
code, out = self.run_ctl("logs", "latest", str(self.dir / "artifacts"))
self.assertEqual(6, code)
self.assertEqual("LOG_PULL_FAILED", out["error"]["code"])
self.assertIn("Permission denied", out["error"]["message"])
def test_logs_replace_the_previous_snapshot_and_preserve_unrelated_files(self):
destination = self.dir / "artifacts"
destination.mkdir()
@@ -620,7 +629,7 @@ class DroiddeckctlTest(FakeAdbTest):
self.assertEqual("current", (destination / "session.log").read_text())
def test_logs_roll_back_a_failed_manifest_commit_and_can_retry(self):
destination = self.dir / "artifacts"
destination = (self.dir / "artifacts").resolve()
destination.mkdir()
(destination / "notes.txt").write_text("keep me")
first = self.dir / "first.zip"
@@ -657,6 +666,28 @@ class DroiddeckctlTest(FakeAdbTest):
self.assertFalse((destination / "steam/console.log").exists())
self.assertEqual("keep me", (destination / "notes.txt").read_text())
def test_logs_preserve_the_old_manifest_when_its_backup_fails(self):
destination = self.dir / "artifacts"
destination.mkdir()
archive = self.dir / "logs.zip"
with zipfile.ZipFile(archive, "w") as z:
z.writestr("s1/session.log", "current")
manifest = destination / ".droiddeckctl-managed-logs.json"
manifest.write_text(json.dumps(["old.log"]))
original = manifest.read_bytes()
real_replace = ctl.os.replace
def fail_manifest_backup(source, target):
if Path(source) == manifest:
raise OSError("injected manifest backup failure")
return real_replace(source, target)
with unittest.mock.patch.object(ctl.os, "replace", side_effect=fail_manifest_backup):
with self.assertRaises(ctl.ControlError):
ctl.unpack_logs(archive, destination, "s1")
self.assertEqual(original, manifest.read_bytes())
def test_logs_from_an_older_build_fall_back_to_the_private_folder(self):
self.configure({"state": ended_state()})
code, out = self.run_ctl("logs", "latest", str(self.dir / "artifacts"))