Get rid of LogFake and clean up test jobs

Author: marickvantuil

src/LogFake.php

@@ -13,13 +13,12 @@
 use Illuminate\Support\Carbon;
 use Illuminate\Support\Facades\DB;
 use Illuminate\Support\Facades\Event;
-use Illuminate\Support\Facades\Log;
 use Illuminate\Support\Facades\Queue;
 use Stackkit\LaravelGoogleCloudTasksQueue\CloudTasksApi;
 use Stackkit\LaravelGoogleCloudTasksQueue\Events\JobReleased;
-use Stackkit\LaravelGoogleCloudTasksQueue\LogFake;
 use Tests\Support\FailingJob;
 use Tests\Support\FailingJobWithExponentialBackoff;
+use Tests\Support\JobOutput;
 use Tests\Support\JobThatWillBeReleased;
 use Tests\Support\SimpleJob;
 use Tests\Support\User;
@@ -375,7 +374,7 @@ public function test_failing_method_on_job()
     {
         // Arrange
         CloudTasksApi::fake();
-        Log::swap(new LogFake());
+        Event::fake(JobOutput::class);
 
         // Act
         $this->dispatch(new FailingJob())
@@ -384,53 +383,54 @@ public function test_failing_method_on_job()
             ->runAndGetReleasedJob();
 
         // Assert
-        Log::assertLogged('FailingJob:failed');
+        Event::assertDispatched(fn (JobOutput $event) => $event->output === 'FailingJob:failed');
     }
 
     /** @test */
     public function test_queue_before_and_after_hooks()
     {
         // Arrange
         CloudTasksApi::fake();
-        Log::swap(new LogFake());
+        Event::fake(JobOutput::class);
 
         // Act
         Queue::before(function (JobProcessing $event) {
-            logger('Queue::before:'.$event->job->payload()['data']['commandName']);
+            event(new JobOutput('Queue::before:'.$event->job->payload()['data']['commandName']));
         });
         Queue::after(function (JobProcessed $event) {
-            logger('Queue::after:'.$event->job->payload()['data']['commandName']);
+            event(new JobOutput('Queue::after:'.$event->job->payload()['data']['commandName']));
         });
         $this->dispatch(new SimpleJob())->run();
 
         // Assert
-        Log::assertLogged('Queue::before:Tests\Support\SimpleJob');
-        Log::assertLogged('Queue::after:Tests\Support\SimpleJob');
+        Event::assertDispatched(fn (JobOutput $event) => $event->output === 'Queue::before:Tests\Support\SimpleJob');
+        Event::assertDispatched(fn (JobOutput $event) => $event->output === 'Queue::after:Tests\Support\SimpleJob');
     }
 
     /** @test */
     public function test_queue_looping_hook_not_supported_with_this_package()
     {
         // Arrange
         CloudTasksApi::fake();
-        Log::swap(new LogFake());
+        Event::fake(JobOutput::class);
 
         // Act
         Queue::looping(function () {
-            logger('Queue::looping');
+            event(new JobOutput('Queue::looping'));
         });
         $this->dispatch(new SimpleJob())->run();
 
         // Assert
-        Log::assertNotLogged('Queue::looping');
+        Event::assertDispatchedTimes(JobOutput::class, times: 1);
+        Event::assertDispatched(fn (JobOutput $event) => $event->output === 'SimpleJob:success');
     }
 
     /** @test */
     public function test_ignoring_jobs_with_deleted_models()
     {
         // Arrange
         CloudTasksApi::fake();
-        Log::swap(new LogFake());
+        Event::fake(JobOutput::class);
 
         $user1 = User::create([
             'name' => 'John',
@@ -452,7 +452,7 @@ public function test_ignoring_jobs_with_deleted_models()
         $job->runWithoutExceptionHandler();
 
         // Act
-        Log::assertLogged('UserJob:John');
+        Event::assertDispatched(fn (JobOutput $event) => $event->output === 'UserJob:John');
         CloudTasksApi::assertTaskNotDeleted($job->task->getName());
     }
 

tests/QueueTest.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Support;
+
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Foundation\Bus\Dispatchable;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Queue\SerializesModels;
+
+class BaseJob implements ShouldQueue
+{
+    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
+}

tests/Support/BaseJob.php

@@ -4,19 +4,12 @@
 
 namespace Tests\Support;
 
-use Illuminate\Bus\Queueable;
 use Illuminate\Contracts\Queue\ShouldBeEncrypted;
-use Illuminate\Contracts\Queue\ShouldQueue;
-use Illuminate\Foundation\Bus\Dispatchable;
-use Illuminate\Queue\InteractsWithQueue;
-use Illuminate\Queue\SerializesModels;
 
-class EncryptedJob implements ShouldBeEncrypted, ShouldQueue
+class EncryptedJob extends BaseJob implements ShouldBeEncrypted
 {
-    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
-
     public function handle()
     {
-        logger('EncryptedJob:success');
+        event(new JobOutput('EncryptedJob:success'));
     }
 }

tests/Support/EncryptedJob.php

@@ -4,40 +4,19 @@
 
 namespace Tests\Support;
 
-use Illuminate\Bus\Queueable;
-use Illuminate\Contracts\Queue\ShouldQueue;
-use Illuminate\Foundation\Bus\Dispatchable;
-use Illuminate\Queue\InteractsWithQueue;
-use Illuminate\Queue\SerializesModels;
+use Error;
 
-class FailingJob implements ShouldQueue
+class FailingJob extends BaseJob
 {
-    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
-
     public $tries = 3;
 
-    /**
-     * Create a new job instance.
-     *
-     * @return void
-     */
-    public function __construct()
-    {
-        //
-    }
-
-    /**
-     * Execute the job.
-     *
-     * @return void
-     */
     public function handle()
     {
-        throw new \Error('simulating a failing job');
+        throw new Error('simulating a failing job');
     }
 
-    public function failed(\Throwable $throwable)
+    public function failed()
     {
-        logger('FailingJob:failed');
+        event(new JobOutput('FailingJob:failed'));
     }
 }

tests/Support/FailingJob.php

@@ -4,23 +4,10 @@
 
 namespace Tests\Support;
 
-use Illuminate\Bus\Queueable;
-use Illuminate\Contracts\Queue\ShouldQueue;
-use Illuminate\Foundation\Bus\Dispatchable;
-use Illuminate\Queue\InteractsWithQueue;
-use Illuminate\Queue\SerializesModels;
-
-class FailingJobWithExponentialBackoff implements ShouldQueue
+class FailingJobWithExponentialBackoff extends FailingJob
 {
-    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
-
     public $tries = 5;
 
-    public function handle()
-    {
-        throw new \Error('simulating a failing job');
-    }
-
     public function backoff(): array
     {
         return [50, 60, 70];

tests/Support/FailingJobWithExponentialBackoff.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Support;
+
+class JobOutput
+{
+    public function __construct(public string $output)
+    {
+        //
+    }
+}

tests/Support/JobOutput.php

@@ -4,39 +4,17 @@
 
 namespace Tests\Support;
 
-use Illuminate\Bus\Queueable;
-use Illuminate\Contracts\Queue\ShouldQueue;
-use Illuminate\Foundation\Bus\Dispatchable;
-use Illuminate\Queue\InteractsWithQueue;
-use Illuminate\Queue\SerializesModels;
-
-class JobThatWillBeReleased implements ShouldQueue
+class JobThatWillBeReleased extends BaseJob
 {
-    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
-
-    private int $releaseDelay;
-
     public $tries = 3;
 
-    /**
-     * Create a new job instance.
-     *
-     * @return void
-     */
-    public function __construct(int $releaseDelay = 0)
+    public function __construct(private int $releaseDelay = 0)
     {
-        $this->releaseDelay = $releaseDelay;
+        //
     }
 
-    /**
-     * Execute the job.
-     *
-     * @return void
-     */
     public function handle()
     {
-        logger('JobThatWillBeReleased:beforeRelease');
         $this->release($this->releaseDelay);
-        logger('JobThatWillBeReleased:afterRelease');
     }
 }

tests/Support/JobThatWillBeReleased.php

@@ -33,6 +33,6 @@ public function __construct()
      */
     public function handle()
     {
-        logger('SimpleJob:success');
+        event(new JobOutput('SimpleJob:success'));
     }
 }

tests/Support/SimpleJob.php

@@ -30,6 +30,6 @@ public function __construct(User $user)
      */
     public function handle()
     {
-        logger('UserJob:'.$this->user->name);
+        event(new JobOutput('UserJob:'.$this->user->name));
     }
 }