Add test to assert queue failed driver works

Author: marickvantuil

phpunit.xml

@@ -23,6 +23,7 @@
         <env name="MAIL_DRIVER" value="log"/>
         <env name="QUEUE_DRIVER" value="cloudtasks"/>
         <env name="GOOGLE_APPLICATION_CREDENTIALS" value="./tests/Support/gcloud-key-valid.json" />
+        <env name="DB_CONNECTION" value="sqlite" />
     </php>
 
     <filter>

tests/TaskHandlerTest.php

@@ -7,6 +7,7 @@
 use Google\Cloud\Tasks\V2\CloudTasksClient;
 use Illuminate\Cache\Events\CacheHit;
 use Illuminate\Cache\Events\KeyWritten;
+use Illuminate\Support\Facades\DB;
 use Illuminate\Support\Facades\Event;
 use Illuminate\Support\Facades\Mail;
 use Mockery;
@@ -45,8 +46,22 @@ protected function setUp(): void
         $googlePublicKey->shouldReceive('getPublicKey')->andReturnNull();
         $googlePublicKey->shouldReceive('getKidFromOpenIdToken')->andReturnNull();
 
+        $cloudTasksClient = Mockery::mock(new CloudTasksClient());
+
+        // Ensure we don't fetch the Queue name and attempts each test...
+        $cloudTasksClient->shouldReceive('queueName')->andReturn('my-queue');
+        $cloudTasksClient->shouldReceive('getQueue')->andReturn(new class {
+            public function getRetryConfig() {
+                return new class {
+                    public function getMaxAttempts() {
+                        return 3;
+                    }
+                };
+            }
+        });
+
         $this->handler = new TaskHandler(
-            new CloudTasksClient(),
+            $cloudTasksClient,
             request(),
             $this->jwt,
             $googlePublicKey
@@ -66,21 +81,6 @@ public function it_needs_an_authorization_header()
         $this->handler->handle();
     }
 
-    /** @test */
-    public function the_authorization_header_must_contain_a_valid_gcloud_token()
-    {
-        request()->headers->add([
-            'Authorization' => 'Bearer 123',
-        ]);
-
-        $this->expectException(CloudTasksException::class);
-        $this->expectExceptionMessage('Could not decode incoming task');
-
-        $this->handler->handle();
-
-        // @todo - test with a valid token, not sure how to do that right now
-    }
-
     /** @test */
     public function it_will_validate_the_token_iss()
     {
@@ -144,8 +144,46 @@ public function it_runs_the_incoming_job()
         Mail::assertSent(TestMailable::class);
     }
 
+    /** @test */
+    public function after_max_attempts_it_will_log_to_failed_table()
+    {
+        $this->request->headers->add(['X-Cloudtasks-Queuename' => 'my-queue']);
+
+        $this->request->headers->add(['X-CloudTasks-TaskRetryCount' => 1]);
+        try {
+            $this->handler->handle($this->failingJob());
+        } catch (\Throwable $e) {
+            //
+        }
+
+        $this->assertCount(0, DB::table('failed_jobs')->get());
+
+        $this->request->headers->add(['X-CloudTasks-TaskRetryCount' => 2]);
+        try {
+            $this->handler->handle($this->failingJob());
+        } catch (\Throwable $e) {
+            //
+        }
+
+        $this->assertDatabaseHas('failed_jobs', [
+            'connection' => 'cloudtasks',
+            'queue' => 'my-queue',
+            'payload' => rtrim($this->failingJobPayload()),
+        ]);
+    }
+
     private function simpleJob()
     {
         return json_decode(file_get_contents(__DIR__ . '/Support/test-job-payload.json'), true);
     }
+
+    private function failingJobPayload()
+    {
+        return file_get_contents(__DIR__ . '/Support/failing-job-payload.json');
+    }
+
+    private function failingJob()
+    {
+        return json_decode(file_get_contents(__DIR__ . '/Support/failing-job-payload.json'), true);
+    }
 }

tests/TestCase.php

@@ -2,10 +2,30 @@
 
 namespace Tests;
 
-use Illuminate\Support\Facades\Artisan;
-
 class TestCase extends \Orchestra\Testbench\TestCase
 {
+    public static $migrated = false;
+
+    protected function setUp()
+    {
+        parent::setUp();
+
+        // There is probably a more sane way to do this
+        if (!static::$migrated) {
+            unlink(database_path('database.sqlite'));
+            touch(database_path('database.sqlite'));
+
+            foreach(glob(database_path('migrations/*.php')) as $file) {
+                unlink($file);
+            }
+
+            $this->artisan('queue:failed-table');
+            $this->artisan('migrate');
+
+            static::$migrated = true;
+        }
+    }
+
     /**
      * Get package providers.  At a minimum this is the package being tested, but also
      * would include packages upon which our package depends, e.g. Cartalyst/Sentry
@@ -45,6 +65,9 @@ protected function getEnvironmentSetUp($app)
             'handler' => 'https://localhost/my-handler',
             'service_account_email' => '[email protected]',
         ]);
+
+        $app['config']->set('database.default', 'sqlite');
+        $app['config']->set('database.connections.sqlite.database', database_path('database.sqlite'));
     }
 
     protected function setConfigValue($key, $value)