Merge lp:~rockstar/launchpad/job-suspended-status into lp:launchpad

[Paul Hummer]

[Paul Hummer (rockstar)]

This branch adds a JobStatus.SUSPENDED state, as well as suspend and resume
methods for IJob interfaces. Jobs can only be suspended if they are in a
waiting state, and suspended jobs can only transition to waiting.

[Muharem Hrnjadovic (al-maisan)]

Looks good!

review: Approve (code)

=== modified file 'lib/lp/services/job/interfaces/job.py'
--- lib/lp/services/job/interfaces/job.py	2010-01-04 21:15:39 +0000
+++ lib/lp/services/job/interfaces/job.py	2010-01-11 22:52:17 +0000
@@ -56,6 +56,12 @@
         The job was run, but failed.  Will not be run again.
         """)
 
+    SUSPENDED = DBItem(4, """
+        Suspended
+
+        The job is suspended, so should not be run.
+        """)
+
 
 class IJob(Interface):
     """Basic attributes of a job."""
@@ -101,6 +107,16 @@
     def queue():
         """Mark the job as queued for processing."""
 
+    def suspend():
+        """Mark the job as suspended.
+
+        Only waiting jobs can be suspended."""
+
+    def resume():
+        """Mark the job as waiting.
+
+        Only suspended jobs can be resumed."""
+
 
 class IRunnableJob(IJob):
     """Interface for jobs that can be run via the JobRunner."""

=== modified file 'lib/lp/services/job/model/job.py'
--- lib/lp/services/job/model/job.py	2009-12-10 19:37:06 +0000
+++ lib/lp/services/job/model/job.py	2010-01-11 22:52:17 +0000
@@ -60,13 +60,16 @@
     # List of the valid target states from a given state.
     _valid_transitions = {
         JobStatus.WAITING:
-            (JobStatus.RUNNING,),
+            (JobStatus.RUNNING,
+             JobStatus.SUSPENDED),
         JobStatus.RUNNING:
             (JobStatus.COMPLETED,
              JobStatus.FAILED,
              JobStatus.WAITING),
         JobStatus.FAILED: (),
         JobStatus.COMPLETED: (),
+        JobStatus.SUSPENDED:
+            (JobStatus.WAITING,),
     }
 
     def _set_status(self, status):
@@ -116,6 +119,16 @@
         self._set_status(JobStatus.WAITING)
         self.date_finished = datetime.datetime.now(UTC)
 
+    def suspend(self):
+        """See `IJob`."""
+        self._set_status(JobStatus.SUSPENDED)
+
+    def resume(self):
+        """See `IJob`."""
+        if self.status is not JobStatus.SUSPENDED:
+            raise InvalidTransition(self._status, JobStatus.WAITING)
+        self._set_status(JobStatus.WAITING)
+
 
 Job.ready_jobs = Select(
     Job.id,

=== modified file 'lib/lp/services/job/tests/test_job.py'
--- lib/lp/services/job/tests/test_job.py	2009-12-09 20:03:31 +0000
+++ lib/lp/services/job/tests/test_job.py	2010-01-11 22:52:17 +0000
@@ -153,6 +153,52 @@
         job = Job(_status=JobStatus.FAILED)
         self.assertRaises(InvalidTransition, job.queue)
 
+    def test_suspend(self):
+        """A job that is in the WAITING state can be suspended."""
+        job = Job(_status=JobStatus.WAITING)
+        job.suspend()
+        self.assertEqual(
+            job.status,
+            JobStatus.SUSPENDED)
+
+    def test_suspend_when_running(self):
+        """When a job is running, attempting to suspend is invalid."""
+        job = Job(_status=JobStatus.RUNNING)
+        self.assertRaises(InvalidTransition, job.suspend)
+
+    def test_suspend_when_completed(self):
+        """When a job is completed, attempting to suspend is invalid."""
+        job = Job(_status=JobStatus.COMPLETED)
+        self.assertRaises(InvalidTransition, job.suspend)
+
+    def test_suspend_when_failed(self):
+        """When a job is failed, attempting to suspend is invalid."""
+        job = Job(_status=JobStatus.FAILED)
+        self.assertRaises(InvalidTransition, job.suspend)
+
+    def test_resume(self):
+        """A job that is suspended can be resumed."""
+        job = Job(_status=JobStatus.SUSPENDED)
+        job.resume()
+        self.assertEqual(
+            job.status,
+            JobStatus.WAITING)
+
+    def test_resume_when_running(self):
+        """When a job is running, attempting to resume is invalid."""
+        job = Job(_status=JobStatus.RUNNING)
+        self.assertRaises(InvalidTransition, job.resume)
+
+    def test_resume_when_completed(self):
+        """When a job is completed, attempting to resume is invalid."""
+        job = Job(_status=JobStatus.COMPLETED)
+        self.assertRaises(InvalidTransition, job.resume)
+
+    def test_resume_when_failed(self):
+        """When a job is failed, attempting to resume is invalid."""
+        job = Job(_status=JobStatus.FAILED)
+        self.assertRaises(InvalidTransition, job.resume)
+
 
 class TestReadiness(TestCase):
     """Test the implementation of readiness."""