Correctly handle archiving sandboxes in Interactive

Author: prandla

cms/grading/Sandbox.py

@@ -712,6 +712,28 @@ def cleanup(self, delete: bool = False):
             # Delete the working directory.
             rmtree(self._outer_dir)
 
+    def archive_to_fobj(self, fobj: typing.IO[bytes]) -> bool:
+        """Archive the directory where the sandbox operated.
+
+        fobj: the file object the archive will be written to.
+        return: whether archiving succeeded.
+        """
+        metadata_path = self.get_root_path()
+        box_dir = self._home
+        with tarfile.open(fileobj=fobj, mode='w:gz') as tar_file:
+            try:
+                # Add metadata files
+                for x in os.listdir(metadata_path):
+                    tar_file.add(os.path.join(metadata_path, x), x)
+                # Add the box directory
+                tar_file.add(box_dir, "box")
+            except Exception:
+                logger.warning(
+                    "Failed to add files to sandbox archive", exc_info=True
+                )
+                return False
+        return True
+
     def archive(self, file_cacher: FileCacher) -> str | None:
         """Archive the directory where the sandbox operated.
 
@@ -724,20 +746,9 @@ def archive(self, file_cacher: FileCacher) -> str | None:
 
         with tempfile.TemporaryFile(dir=self.temp_dir) as sandbox_archive:
             # Archive the working directory
-            metadata_path = self.get_root_path()
-            box_dir = self._home
-            with tarfile.open(fileobj=sandbox_archive, mode='w:gz') as tar_file:
-                try:
-                    # Add metadata files
-                    for x in os.listdir(metadata_path):
-                        tar_file.add(os.path.join(metadata_path, x), x)
-                    # Add the box directory
-                    tar_file.add(box_dir, "box")
-                except Exception:
-                    logger.warning(
-                        "Failed to add files to sandbox archive", exc_info=True
-                    )
-
+            ok = self.archive_to_fobj(sandbox_archive)
+            if not ok:
+                return None
             # Put archive to FS
             sandbox_archive.seek(0)
             return file_cacher.put_file_from_fobj(

cms/grading/tasktypes/Interactive.py

@@ -240,7 +240,7 @@ def evaluate(self, job, file_cacher):
                 "concurrent": self.concurrent,
                 "temp_dir": tempdir,
                 "shard": file_cacher.service.shard if file_cacher.service else None,
-                "delete_sandbox": True,
+                "archive_sandbox": job.archive_sandbox,
             }
 
             keeper_path = os.path.join(
@@ -284,6 +284,11 @@ def evaluate(self, job, file_cacher):
             job.text = result["text"]
             job.admin_text = result.get("admin_text")
             job.plus = result.get("stats", {})
+            job.sandboxes = result["sandboxes"]
+            for k,v in result["sandbox_archives"].items():
+                digest = file_cacher.put_file_from_path(v, f"Sandbox {k}")
+                job.sandbox_digests[k] = digest
+
 
     def _executable_filename(self, codenames, language):
         """Return the filename of the executable."""

cms/grading/tasktypes/interactive_keeper.py

@@ -23,6 +23,7 @@
 import shutil
 import sys
 from functools import reduce
+import tempfile
 
 from cms.grading.Sandbox import Sandbox, wait_without_std
 from cms.grading.steps.evaluation import (
@@ -81,7 +82,7 @@ def main():
     concurrent = config.get("concurrent")
     temp_dir = config.get("temp_dir")
     shard = config.get("shard")
-    delete_sandbox = config.get("delete_sandbox")
+    archive_sandbox = config.get("archive_sandbox")
 
     pipes = []
     for i in range(process_limit):
@@ -259,19 +260,32 @@ def do_merge(a, b):
             outcome = score if score is not None else 0.0
             text = controller_text
 
+    job_sandboxes = []
+    job_sandbox_archives = {}
+
+    for box in [controller_sandbox] + solution_sandboxes:
+        job_sandboxes.append(box.get_root_path())
+        if archive_sandbox or not success:
+            with tempfile.NamedTemporaryFile('wb', dir=temp_dir, delete=False) as f:
+                ok = box.archive_to_fobj(f)
+                if ok:
+                    job_sandbox_archives[box.get_root_path()] = f.name
+
     result = {
         "success": success,
         "outcome": outcome,
         "text": text,
         "admin_text": admin_text,
         "stats": stats_user,
+        "sandboxes": job_sandboxes,
+        "sandbox_archives": job_sandbox_archives,
     }
     # Communicate results back to the worker
     print(json.dumps(result), flush=True)
 
-    controller_sandbox.cleanup(delete=delete_sandbox)
+    controller_sandbox.cleanup(delete=True)
     for s in solution_sandboxes:
-        s.cleanup(delete=delete_sandbox)
+        s.cleanup(delete=True)
 
 
 if __name__ == "__main__":