Merge pull request #6 from webdevvie/feature/identifier-and-status-request

Status retrieval for task with id and return task entity id on adding the task to the queue

Author: webdevvie

Entity/Task.php

@@ -14,13 +14,41 @@
  */
 class Task
 {
+    /**
+     * The task is awaiting start
+     */
     const STATUS_NEW = 'new';
+
+    /**
+     * The task is in progress.. awaiting completion (or failure)
+     */
     const STATUS_WORKING = 'working';
+
+    /**
+     * Unused at this time
+     */
     const STATUS_STALLED = 'stalled';
+
+    /**
+     * The task failed executing ( the command returned an exitcode !=0)
+     */
     const STATUS_FAILED = 'failed';
+
+    /**
+     * The task was manually restarted
+     */
     const STATUS_RESTARTED = 'restarted';
+
+    /**
+     * The task was completed successfully
+     */
     const STATUS_DONE = 'done';
 
+    /**
+     * The Task entity was not found when searching for it.
+     */
+    const STATUS_GONE = 'gone';
+
     /**
      * @var integer
      *

Service/TaskQueueService.php

@@ -76,11 +76,29 @@ public function getDefaultTube()
     {
         return $this->defaultTube;
     }
+
+    /**
+     * Returns the current status of a task
+     *
+     * @param integer $taskId
+     * @return string
+     */
+    public function getStatusOfTaskWithId($taskId)
+    {
+        $task = $this->taskRepo->find($taskId);
+        if(!($task instanceof Task))
+        {
+            //the task was not found
+            return Task::STATUS_GONE;
+        }
+        return $task->getStatus();
+    }
+
     /**
      * @param TaskDescriptionInterface $task
      * @param string $tube (optional) the tube to use
      * @throws TaskQueueServiceException
-     * @return void
+     * @return integer
      */
     public function queueTask(TaskDescriptionInterface $task, $tube = null)
     {
@@ -97,6 +115,8 @@ public function queueTask(TaskDescriptionInterface $task, $tube = null)
         $this->beanstalk
             ->useTube($tube)
             ->put($stringVersion);
+
+        return $taskEntity->getId();
     }
 
     /**

Tests/Service/TaskQueueServiceTest.php

@@ -58,6 +58,49 @@ public function setUp()
         $this->setupEntityManagerMock();
     }
 
+    /**
+     * Test if the proper status is returned in case a task is not found for the Id
+     *
+     * @return void
+     */
+    public function testIfGettingTaskStatusWorksIfThereIsNoSuchTask()
+    {
+        $this->taskRepository->shouldReceive('find')->andReturn(null);
+        $service = new TaskQueueService(
+            $this->entityManager,
+            $this->pheanStalkProxy,
+            $this->serializer,
+            $this->params
+        );
+        $response = $service->getStatusOfTaskWithId(1);
+        $this->assertEquals(Task::STATUS_GONE, $response, 'Expected "gone" Response!');
+    }
+
+    /**
+     * Test if the proper status is returned in case a task is found
+     *
+     * @return void
+     */
+    public function testIfGettingTaskStatusWorksIfThereIsATask()
+    {
+        $exampleTask = new ExampleTaskDescription();
+        $stringVersion = get_class($exampleTask) .
+            "::" .
+            $this->serializer->serialize($exampleTask, 'json');
+        $taskEntity = new Task($exampleTask, $stringVersion, 'gtldtube');
+        $taskEntity->setStatus(Task::STATUS_DONE);
+
+        $this->taskRepository->shouldReceive('find')->andReturn($taskEntity);
+        $service = new TaskQueueService(
+            $this->entityManager,
+            $this->pheanStalkProxy,
+            $this->serializer,
+            $this->params
+        );
+        $response = $service->getStatusOfTaskWithId(1);
+        $this->assertEquals(Task::STATUS_DONE, $response, 'Expected "done" Response!');
+    }
+
     /**
      * Test the queueing of tasks
      *
@@ -105,6 +148,7 @@ public function testMarkDone()
         );
         $service->markDone($workPackage);
     }
+
     /**
      * tests the status update call in the service
      *
@@ -142,7 +186,6 @@ public function testRegenerate()
         $id = 1;
 
 
-
         $exampleTask = new ExampleTaskDescription();
 
         $stringVersion = get_class($exampleTask) . "::" . $this->serializer->serialize($exampleTask, 'json');
@@ -221,7 +264,6 @@ public function testReserveFilled()
     }
 
 
-
     /**
      * Sets up the example task into the (mocked) queue and in the (mocked) database
      *