Add database to Github Actions and add fixes for other Laravel versions

Author: marickvantuil

.github/workflows/run-tests.yml

@@ -44,9 +44,22 @@ jobs:
           extensions: mbstring, dom, fileinfo
           coverage: none
 
+      - name: Set up MySQL
+        run: |
+          sudo /etc/init.d/mysql start
+          mysql -e 'CREATE DATABASE test;' -uroot -proot
+
       - name: Install dependencies
         run: |
           composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" --no-interaction --no-update
           composer update --prefer-stable --prefer-dist --no-interaction --no-suggest
       - name: Execute tests
-        run: vendor/bin/phpunit
+        env:
+          CI_DB_DRIVER: mysql
+          CI_DB_HOST: 127.0.0.1
+          CI_DB_PORT: 3306
+          CI_DB_DATABASE: test
+          CI_DB_USERNAME: root
+          CI_DB_PASSWORD: root
+        run: |
+          vendor/bin/phpunit

phpunit.xml

@@ -21,6 +21,7 @@
         <env name="CACHE_DRIVER" value="array"/>
         <env name="SESSION_DRIVER" value="array"/>
         <env name="MAIL_DRIVER" value="log"/>
+        <env name="GOOGLE_APPLICATION_CREDENTIALS" value="./tests/Support/gcloud-key-valid.json" />
         <env name="QUEUE_DRIVER" value="cloudtasks"/>
         <env name="DB_CONNECTION" value="mysql" />
         <env name="DB_HOST" value="127.0.0.1" />

src/CloudTasksJob.php

@@ -33,6 +33,11 @@ public function getJobId()
         return $this->job['uuid'];
     }
 
+    public function uuid(): string
+    {
+        return $this->job['uuid'];
+    }
+
     public function getRawBody()
     {
         return json_encode($this->job);

src/CloudTasksQueue.php

@@ -11,6 +11,7 @@
 use Illuminate\Contracts\Queue\Queue as QueueContract;
 use Illuminate\Queue\Queue as LaravelQueue;
 use Illuminate\Support\InteractsWithTime;
+use Illuminate\Support\Str;
 
 class CloudTasksQueue extends LaravelQueue implements QueueContract
 {
@@ -60,7 +61,12 @@ protected function pushToCloudTasks($queue, $payload, $delay = 0, $attempts = 0)
         $httpRequest = $this->createHttpRequest();
         $httpRequest->setUrl($this->config['handler']);
         $httpRequest->setHttpMethod(HttpMethod::POST);
-        $httpRequest->setBody($payload);
+        $httpRequest->setBody(
+            // Laravel 7+ jobs have a uuid, but Laravel 6 doesn't have it.
+            // Since we are using and expecting the uuid in some places
+            // we will add it manually here if it's not present yet.
+            $this->withUuid($payload)
+        );
 
         $task = $this->createTask();
         $task->setHttpRequest($httpRequest);
@@ -80,6 +86,17 @@ protected function pushToCloudTasks($queue, $payload, $delay = 0, $attempts = 0)
         event(new TaskCreated($createdTask));
     }
 
+    private function withUuid(string $payload): string
+    {
+        $decoded = json_decode($payload, true);
+
+        if (!isset($decoded['uuid'])) {
+            $decoded['uuid'] = (string) Str::uuid();
+        }
+
+        return json_encode($decoded);
+    }
+
     public function pop($queue = null)
     {
         // TODO: Implement pop() method.

src/LogFake.php

@@ -7,51 +7,51 @@
 use PHPUnit\Framework\Assert as PHPUnit;
 use Psr\Log\LoggerInterface;
 
-class LogFake implements LoggerInterface
+class LogFake
 {
     private array $loggedMessages = [];
 
-    public function emergency(\Stringable|string $message, array $context = []): void
+    public function emergency(string $message, array $context = []): void
     {
         $this->loggedMessages[] = $message;
     }
 
-    public function alert(\Stringable|string $message, array $context = []): void
+    public function alert(string $message, array $context = []): void
     {
         $this->loggedMessages[] = $message;
     }
 
-    public function critical(\Stringable|string $message, array $context = []): void
+    public function critical(string $message, array $context = []): void
     {
         $this->loggedMessages[] = $message;
     }
 
-    public function error(\Stringable|string $message, array $context = []): void
+    public function error(string $message, array $context = []): void
     {
         $this->loggedMessages[] = $message;
     }
 
-    public function warning(\Stringable|string $message, array $context = []): void
+    public function warning(string $message, array $context = []): void
     {
         $this->loggedMessages[] = $message;
     }
 
-    public function notice(\Stringable|string $message, array $context = []): void
+    public function notice(string $message, array $context = []): void
     {
         $this->loggedMessages[] = $message;
     }
 
-    public function info(\Stringable|string $message, array $context = []): void
+    public function info(string $message, array $context = []): void
     {
         $this->loggedMessages[] = $message;
     }
 
-    public function debug(\Stringable|string $message, array $context = []): void
+    public function debug(string $message, array $context = []): void
     {
         $this->loggedMessages[] = $message;
     }
 
-    public function log($level, \Stringable|string $message, array $context = []): void
+    public function log($level, string $message, array $context = []): void
     {
         $this->loggedMessages[] = $message;
     }

tests/TaskHandlerTest.php

@@ -5,17 +5,21 @@
 use Firebase\JWT\ExpiredException;
 use Google\Cloud\Tasks\V2\RetryConfig;
 use Google\Protobuf\Duration;
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Queue\Events\JobExceptionOccurred;
 use Illuminate\Queue\Events\JobFailed;
 use Illuminate\Queue\Events\JobProcessed;
 use Illuminate\Queue\Events\JobProcessing;
+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\CloudTasksException;
 use Stackkit\LaravelGoogleCloudTasksQueue\CloudTasksJob;
 use Stackkit\LaravelGoogleCloudTasksQueue\LogFake;
 use Stackkit\LaravelGoogleCloudTasksQueue\OpenIdVerificator;
+use Stackkit\LaravelGoogleCloudTasksQueue\StackkitCloudTask;
 use Tests\Support\FailingJob;
 use Tests\Support\SimpleJob;
 use UnexpectedValueException;
@@ -107,14 +111,9 @@ public function it_can_run_a_task()
         Event::fake([JobProcessing::class, JobProcessed::class]);
 
         // Act
-        $this->dispatch(new SimpleJob())->run();
+        $this->dispatch(new SimpleJob())->runWithoutExceptionHandler();
 
         // Assert
-        Event::assertDispatchedTimes(JobProcessing::class, 1);
-        Event::assertDispatchedTimes(JobProcessed::class, 1);
-        Event::assertDispatched(JobProcessed::class, function (JobProcessed $event) {
-            return $event->job->resolveName() === 'Tests\\Support\\SimpleJob';
-        });
         Log::assertLogged('SimpleJob:success');
     }
 
@@ -243,16 +242,17 @@ public function test_max_attempts_in_combination_with_retry_until()
                 ->setMaxRetryDuration(new Duration(['seconds' => 3]))
         );
         CloudTasksApi::partialMock()->shouldReceive('getRetryUntilTimestamp')->andReturn(time() + 1)->byDefault();
-        Event::fake([JobExceptionOccurred::class, JobFailed::class]);
+
         $job = $this->dispatch(new FailingJob());
 
         // Act & Assert
         $job->run();
         $job->run();
 
         # After 2 attempts both Laravel versions should report the same: 2 errors and 0 failures.
-        Event::assertDispatchedTimes(JobExceptionOccurred::class, 2);
-        Event::assertNotDispatched(JobFailed::class);
+        $task = StackkitCloudTask::whereTaskUuid($job->payload['uuid'])->firstOrFail();
+        $this->assertEquals(2, $task->getNumberOfAttempts());
+        $this->assertEquals('error', $task->status);
 
         $job->run();
 
@@ -261,15 +261,15 @@ public function test_max_attempts_in_combination_with_retry_until()
         # Laravel 8+: don't fail because retryUntil has not yet passed.
 
         if (version_compare(app()->version(), '8.0.0', '<')) {
-            Event::assertDispatched(JobFailed::class);
+            $this->assertEquals('failed', $task->fresh()->status);
             return;
         } else {
-            Event::assertNotDispatched(JobFailed::class);
+            $this->assertEquals('error', $task->fresh()->status);
         }
 
         CloudTasksApi::shouldReceive('getRetryUntilTimestamp')->andReturn(time() - 1);
         $job->run();
 
-        Event::assertDispatched(JobFailed::class);
+        $this->assertEquals('failed', $task->fresh()->status);
     }
 }

tests/TestCase.php

@@ -42,6 +42,17 @@ protected function getPackageProviders($app)
         ];
     }
 
+    /**
+     * Define database migrations.
+     *
+     * @return void
+     */
+    protected function defineDatabaseMigrations()
+    {
+        $this->loadMigrationsFrom(__DIR__ . '/../migrations');
+        $this->loadMigrationsFrom(__DIR__ . '/../vendor/orchestra/testbench-core/laravel/migrations');
+    }
+
     /**
      * Define environment setup.
      *
@@ -54,6 +65,17 @@ protected function getEnvironmentSetUp($app)
             unlink($file);
         }
 
+        $app['config']->set('database.default', 'testbench');
+        $app['config']->set('database.connections.testbench', [
+            'driver'   => 'mysql',
+            'host' => env('CI_DB_HOST', env('DB_HOST')),
+            'port' => env('CI_DB_PORT', env('DB_PORT')),
+            'database' => env('CI_DB_DATABASE', env('DB_DATABASE')),
+            'username' => env('CI_DB_USERNAME', env('DB_USERNAME')),
+            'password' => env('CI_DB_PASSWORD', env('DB_PASSWORD')),
+            'prefix'   => '',
+        ]);
+
         $app['config']->set('cache.default', 'file');
         $app['config']->set('queue.default', 'my-cloudtasks-connection');
         $app['config']->set('queue.connections.my-cloudtasks-connection', [
@@ -65,6 +87,7 @@ protected function getEnvironmentSetUp($app)
             'service_account_email' => 'info@stackkit.io',
         ]);
         $app['config']->set('queue.failed.driver', 'database-uuids');
+        $app['config']->set('queue.failed.database', 'testbench');
     }
 
     protected function setConfigValue($key, $value)
@@ -168,4 +191,9 @@ protected function addIdTokenToHeader(?Closure $closure = null): void
 
         request()->headers->set('Authorization', 'Bearer ' . $token);
     }
+
+    protected function assertDatabaseCount($table, int $count, $connection = null)
+    {
+        $this->assertEquals($count, DB::connection($connection)->table($table)->count());
+    }
 }