refactor tests

clickonmedia · Mar 8, 2024 · 39899d5 · 39899d5
2 parents 172b865 + e4e269f
commit 39899d5
Show file tree

Hide file tree

Showing 5 changed files with 86 additions and 79 deletions.
diff --git a/src/LongRunningTask.php b/src/LongRunningTask.php
@@ -3,8 +3,8 @@
 namespace Clickonmedia\Monitor;
 
 use Carbon\Carbon;
-use Clickonmedia\Monitor\Enums\TaskResult;
 use Clickonmedia\Monitor\Enums\LogItemStatus;
+use Clickonmedia\Monitor\Enums\TaskResult;
 use Clickonmedia\Monitor\Jobs\RunLongRunningTaskJob;
 use Clickonmedia\Monitor\Models\LongRunningTaskLogItem;
 use Exception;
@@ -13,6 +13,12 @@ abstract class LongRunningTask
 {
     protected array $meta = [];
 
+    abstract public function check(LongRunningTaskLogItem $logItem): TaskResult;
+
+    public function onFail(LongRunningTaskLogItem $logItem, Exception $exception): ?TaskResult {
+        return TaskResult::StopChecking;
+    }
+
     public static function make()
     {
         return new static();
@@ -55,8 +61,4 @@ public function stopCheckingAt(): Carbon
     {
         return now()->addSeconds(config('long-running-tasks-monitor.keep_checking_for_in_seconds'));
     }
-
-    abstract public function check(LongRunningTaskLogItem $logItem): TaskResult;
-
-    abstract public function onFail(LongRunningTaskLogItem $logItem, Exception $exception): ?TaskResult;
 }
diff --git a/tests/Jobs/RunLongingTaskJobTest.php b/tests/Jobs/RunLongingTaskJobTest.php
diff --git a/tests/LongRunningTaskTest.php b/tests/LongRunningTaskTest.php
@@ -1,7 +1,9 @@
 <?php
 
 use Clickonmedia\Monitor\Enums\LogItemStatus;
+use Clickonmedia\Monitor\Enums\TaskResult;
 use Clickonmedia\Monitor\Jobs\RunLongRunningTaskJob;
+use Clickonmedia\Monitor\LongRunningTask;
 use Clickonmedia\Monitor\Models\LongRunningTaskLogItem;
 use Clickonmedia\Monitor\Tests\TestSupport\LongRunningTasks\LongRunningTestTask;
 use Illuminate\Support\Facades\Queue;
@@ -22,3 +24,79 @@
 
     Queue::assertPushed(RunLongRunningTaskJob::class);
 });
+
+it('can handle a pending task that will complete', function () {
+    $task = new class extends LongRunningTask {
+        public function check(LongRunningTaskLogItem $logItem): TaskResult
+        {
+            return TaskResult::StopChecking;
+        }
+    };
+
+    $task->start();
+
+    expect(LongRunningTaskLogItem::first())
+        ->status->toBe(LogItemStatus::Completed)
+        ->attempt->toBe(1)
+        ->run_count->toBe(1);
+});
+
+it('can handle a pending task that needs a couple of runs to complete', function () {
+    $task = new class extends LongRunningTask {
+        public function check(LongRunningTaskLogItem $logItem): TaskResult
+        {
+            return $logItem->run_count < 5
+                ? TaskResult::ContinueChecking
+                : TaskResult::StopChecking;
+        }
+    };
+
+    $task->start();
+
+    expect(LongRunningTaskLogItem::first())
+        ->run_count->toBe(5)
+        ->status->toBe(LogItemStatus::Completed)
+        ->last_check_started_at->not()->toBeNull()
+        ->last_check_ended_at->not()->toBeNull();
+});
+
+it('will can handle a task that always fails', function () {
+    $task = new class extends LongRunningTask {
+        public function check(LongRunningTaskLogItem $logItem): TaskResult
+        {
+            throw new Exception();
+        }
+    };
+
+    $task->start();
+
+    expect(LongRunningTaskLogItem::first())
+        ->status->toBe(LogitemStatus::Failed)
+        ->run_count->toBe(1)
+        ->latest_exception->toHaveKeys(['message', 'trace']);
+});
+
+it('can handle a task that will recover', function () {
+    $task = new class extends LongRunningTask {
+        public function check(LongRunningTaskLogItem $logItem): TaskResult
+        {
+            if ($logItem->run_count < 3) {
+                throw new Exception();
+            }
+
+            return TaskResult::StopChecking;
+        }
+
+        public function onFail(LongRunningTaskLogItem $logItem, Exception $exception): ?TaskResult
+        {
+            return TaskResult::ContinueChecking;
+        }
+    };
+
+    $task->start();
+
+    expect(LongRunningTaskLogItem::first())
+        ->status->toBe(LogitemStatus::Completed)
+        ->run_count->toBe(3)
+        ->latest_exception->toBeNull();
+});
diff --git a/tests/Pest.php b/tests/Pest.php
@@ -3,5 +3,5 @@
 use Clickonmedia\Monitor\Tests\TestCase;
 
 uses(TestCase::class)
-    ->beforeEach(fn() => ray()->newScreen($this->name()))
+    ->beforeEach(fn () => ray()->newScreen($this->name()))
     ->in(__DIR__);
diff --git a/tests/TestSupport/LongRunningTasks/LongRunningTestTask.php b/tests/TestSupport/LongRunningTasks/LongRunningTestTask.php
@@ -10,18 +10,8 @@
 
 class LongRunningTestTask extends LongRunningTask
 {
-    public static ?Closure $checkClosure = null;
 
     public function check(LongRunningTaskLogItem $logItem): TaskResult
-    {
-        if (self::$checkClosure) {
-            return (self::$checkClosure)($logItem);
-        }
-
-        return TaskResult::StopChecking;
-    }
-
-    public function onFail(LongRunningTaskLogItem $logItem, Exception $exception): TaskResult
     {
         return TaskResult::StopChecking;
     }