Allow Jobs to force the keeping of the sandbox

Author: lw

cms/grading/Job.py

@@ -78,7 +78,7 @@ class Job(object):
     def __init__(self, operation=None,
                  task_type=None, task_type_parameters=None,
                  language=None, multithreaded_sandbox=False,
-                 shard=None, sandboxes=None, info=None,
+                 shard=None, keep_sandbox=False, sandboxes=None, info=None,
                  success=None, text=None,
                  files=None, managers=None, executables=None):
         """Initialization.
@@ -92,6 +92,9 @@ def __init__(self, operation=None,
         multithreaded_sandbox (boolean): whether the sandbox should
             allow multithreading.
         shard (int|None): the shard of the Worker completing this job.
+        keep_sandbox (bool): whether to forcefully keep the sandbox,
+            even if other conditions (the config, the sandbox status)
+            don't warrant it.
         sandboxes ([string]|None): the paths of the sandboxes used in
             the Worker during the execution of the job.
         info (string|None): a human readable description of the job.
@@ -126,6 +129,7 @@ def __init__(self, operation=None,
         self.language = language
         self.multithreaded_sandbox = multithreaded_sandbox
         self.shard = shard
+        self.keep_sandbox = keep_sandbox
         self.sandboxes = sandboxes
         self.info = info
 
@@ -147,6 +151,7 @@ def export_to_dict(self):
             'language': self.language,
             'multithreaded_sandbox': self.multithreaded_sandbox,
             'shard': self.shard,
+            'keep_sandbox': self.keep_sandbox,
             'sandboxes': self.sandboxes,
             'info': self.info,
             'success': self.success,
@@ -250,7 +255,7 @@ class CompilationJob(Job):
 
     def __init__(self, operation=None, task_type=None,
                  task_type_parameters=None,
-                 shard=None, sandboxes=None, info=None,
+                 shard=None, keep_sandbox=False, sandboxes=None, info=None,
                  language=None, multithreaded_sandbox=False,
                  files=None, managers=None,
                  success=None, compilation_success=None,
@@ -267,7 +272,7 @@ def __init__(self, operation=None, task_type=None,
 
         Job.__init__(self, operation, task_type, task_type_parameters,
                      language, multithreaded_sandbox,
-                     shard, sandboxes, info, success, text,
+                     shard, keep_sandbox, sandboxes, info, success, text,
                      files, managers, executables)
         self.compilation_success = compilation_success
         self.plus = plus
@@ -436,7 +441,7 @@ class EvaluationJob(Job):
     """
     def __init__(self, operation=None, task_type=None,
                  task_type_parameters=None, shard=None,
-                 sandboxes=None, info=None,
+                 keep_sandbox=False, sandboxes=None, info=None,
                  language=None, multithreaded_sandbox=False,
                  files=None, managers=None, executables=None,
                  input=None, output=None,
@@ -468,7 +473,7 @@ def __init__(self, operation=None, task_type=None,
         """
         Job.__init__(self, operation, task_type, task_type_parameters,
                      language, multithreaded_sandbox,
-                     shard, sandboxes, info, success, text,
+                     shard, keep_sandbox, sandboxes, info, success, text,
                      files, managers, executables)
         self.input = input
         self.output = output

cms/grading/tasktypes/Batch.py

@@ -252,7 +252,7 @@ def compile(self, job, file_cacher):
                 Executable(executable_filename, digest)
 
         # Cleanup.
-        delete_sandbox(sandbox, job.success)
+        delete_sandbox(sandbox, job.success, job.keep_sandbox)
 
     def evaluate(self, job, file_cacher):
         """See TaskType.evaluate."""
@@ -361,4 +361,4 @@ def evaluate(self, job, file_cacher):
         job.text = text
         job.plus = stats
 
-        delete_sandbox(sandbox, job.success)
+        delete_sandbox(sandbox, job.success, job.keep_sandbox)

cms/grading/tasktypes/Communication.py

@@ -243,7 +243,7 @@ def compile(self, job, file_cacher):
                 Executable(executable_filename, digest)
 
         # Cleanup.
-        delete_sandbox(sandbox, job.success)
+        delete_sandbox(sandbox, job.success, job.keep_sandbox)
 
     def evaluate(self, job, file_cacher):
         """See TaskType.evaluate."""
@@ -427,9 +427,9 @@ def evaluate(self, job, file_cacher):
         job.text = text
         job.plus = stats_user
 
-        delete_sandbox(sandbox_mgr, job.success)
+        delete_sandbox(sandbox_mgr, job.success, job.keep_sandbox)
         for s in sandbox_user:
-            delete_sandbox(s, job.success)
-        if not config.keep_sandbox:
+            delete_sandbox(s, job.success, job.keep_sandbox)
+        if job.success and not config.keep_sandbox and not job.keep_sandbox:
             for d in fifo_dir:
                 rmtree(d)

cms/grading/tasktypes/TwoSteps.py

@@ -217,7 +217,7 @@ def compile(self, job, file_cacher):
                 Executable(executable_filename, digest)
 
         # Cleanup
-        delete_sandbox(sandbox, job.success)
+        delete_sandbox(sandbox, job.success, job.keep_sandbox)
 
     def evaluate(self, job, file_cacher):
         """See TaskType.evaluate."""
@@ -352,5 +352,5 @@ def evaluate(self, job, file_cacher):
         job.text = text
         job.plus = stats
 
-        delete_sandbox(first_sandbox, job.success)
-        delete_sandbox(second_sandbox, job.success)
+        delete_sandbox(first_sandbox, job.success, job.keep_sandbox)
+        delete_sandbox(second_sandbox, job.success, job.keep_sandbox)

cms/grading/tasktypes/util.py

@@ -76,19 +76,21 @@ def create_sandbox(file_cacher, name=None):
     return sandbox
 
 
-def delete_sandbox(sandbox, success=True):
+def delete_sandbox(sandbox, success=True, keep_sandbox=False):
     """Delete the sandbox, if the configuration and job was ok.
 
     sandbox (Sandbox): the sandbox to delete.
     success (boolean): if the job succeeded (no system errors).
+    keep_sandbox (bool): whether to keep the sandbox regardless of other
+        conditions.
 
     """
     # If the job was not successful, we keep the sandbox around.
     if not success:
         logger.warning("Sandbox %s kept around because job did not succeeded.",
                        sandbox.get_root_path())
 
-    delete = success and not config.keep_sandbox
+    delete = success and not config.keep_sandbox and not keep_sandbox
     try:
         sandbox.cleanup(delete=delete)
     except (IOError, OSError):
@@ -265,7 +267,7 @@ def eval_output(file_cacher, job, checker_codename,
             sandbox, checker_digest, job.input, job.output,
             EVAL_USER_OUTPUT_FILENAME)
 
-        delete_sandbox(sandbox, success)
+        delete_sandbox(sandbox, success, job.keep_sandbox)
         return success, outcome, text
 
     else: