Improve testability of batched jobs (#44075)

* Track batched jobs * Add helper to fake batch jobs * formatting * formatting Co-authored-by: Taylor Otwell <taylor@laravel.com>
laravel · Sep 12, 2022 · a155ccd · a155ccd
1 parent eff2275
commit a155ccd
Show file tree

Hide file tree

Showing 3 changed files with 52 additions and 10 deletions.
diff --git a/src/Illuminate/Support/Testing/Fakes/BatchRepositoryFake.php b/src/Illuminate/Support/Testing/Fakes/BatchRepositoryFake.php
@@ -13,6 +13,13 @@
 
 class BatchRepositoryFake implements BatchRepository
 {
+    /**
+     * The batches stored in the repository.
+     *
+     * @var \Illuminate\Bus\Batch[]
+     */
+    protected $batches = [];
+
     /**
      * Retrieve a list of batches.
      *
@@ -22,7 +29,7 @@ class BatchRepositoryFake implements BatchRepository
      */
     public function get($limit, $before)
     {
-        return [];
+        return $this->batches;
     }
 
     /**
@@ -33,7 +40,7 @@ public function get($limit, $before)
      */
     public function find(string $batchId)
     {
-        //
+        return $this->batches[$batchId] ?? null;
     }
 
     /**
@@ -44,10 +51,12 @@ public function find(string $batchId)
      */
     public function store(PendingBatch $batch)
     {
-        return new Batch(
+        $id = (string) Str::orderedUuid();
+
+        $this->batches[$id] = new Batch(
             new QueueFake(Facade::getFacadeApplication()),
             $this,
-            (string) Str::orderedUuid(),
+            $id,
             $batch->name,
             count($batch->jobs),
             count($batch->jobs),
@@ -58,6 +67,8 @@ public function store(PendingBatch $batch)
             null,
             null
         );
+
+        return $this->batches[$id];
     }
 
     /**
@@ -104,7 +115,9 @@ public function incrementFailedJobs(string $batchId, string $jobId)
      */
     public function markAsFinished(string $batchId)
     {
-        //
+        if (isset($this->batches[$batchId])) {
+            $this->batches[$batchId]->finishedAt = now();
+        }
     }
 
     /**
@@ -115,7 +128,9 @@ public function markAsFinished(string $batchId)
      */
     public function cancel(string $batchId)
     {
-        //
+        if (isset($this->batches[$batchId])) {
+            $this->batches[$batchId]->cancelledAt = now();
+        }
     }
 
     /**
@@ -126,7 +141,7 @@ public function cancel(string $batchId)
      */
     public function delete(string $batchId)
     {
-        //
+        unset($this->batches[$batchId]);
     }
 
     /**

diff --git a/src/Illuminate/Support/Testing/Fakes/BusFake.php b/src/Illuminate/Support/Testing/Fakes/BusFake.php
@@ -28,6 +28,13 @@ class BusFake implements QueueingDispatcher
      */
     protected $jobsToFake;
 
+    /**
+     * The fake repository to track batched jobs.
+     *
+     * @var \Illuminate\Bus\BatchRepository
+     */
+    protected $batchRepository;
+
     /**
      * The commands that have been dispatched.
      *
@@ -66,8 +73,8 @@ class BusFake implements QueueingDispatcher
     public function __construct(QueueingDispatcher $dispatcher, $jobsToFake = [])
     {
         $this->dispatcher = $dispatcher;
-
         $this->jobsToFake = Arr::wrap($jobsToFake);
+        $this->batchRepository = new BatchRepositoryFake;
     }
 
     /**
@@ -634,7 +641,7 @@ public function chain($jobs)
      */
     public function findBatch(string $batchId)
     {
-        //
+        return $this->batchRepository->find($batchId);
     }
 
     /**
@@ -658,7 +665,7 @@ public function recordPendingBatch(PendingBatch $pendingBatch)
     {
         $this->batches[] = $pendingBatch;
 
-        return (new BatchRepositoryFake)->store($pendingBatch);
+        return $this->batchRepository->store($pendingBatch);
     }
 
     /**

diff --git a/tests/Support/SupportTestingBusFakeTest.php b/tests/Support/SupportTestingBusFakeTest.php
@@ -468,6 +468,26 @@ public function testAssertNothingBatched()
             $this->assertThat($e, new ExceptionMessage('Batched jobs were dispatched unexpectedly.'));
         }
     }
+
+    public function testFindBatch()
+    {
+        $this->assertNull($this->fake->findBatch('non-existent-batch'));
+
+        $batch = $this->fake->batch([])->dispatch();
+
+        $this->assertSame($batch, $this->fake->findBatch($batch->id));
+    }
+
+    public function testBatchesCanBeCancelled()
+    {
+        $batch = $this->fake->batch([])->dispatch();
+
+        $this->assertFalse($batch->cancelled());
+
+        $batch->cancel();
+
+        $this->assertTrue($batch->cancelled());
+    }
 }
 
 class BusJobStub