Redo tests

Author: marickvantuil

README.md

@@ -195,15 +195,3 @@ This package verifies that the token is digitally signed by Google. Only Google
 More information about OpenID Connect:
 
 https://developers.google.com/identity/protocols/oauth2/openid-connect
-
-# Running tests
-
-The test suite uses a emulated version of Google Tasks, thanks to aertje/cloud-tasks-emulator.
-
-To start running the tests locally, first start all Docker services:
-
-```
-docker compose up -d
-```
-
-This will start the emulator, MySQL and Postgres.

docker-compose.yml

@@ -1,10 +1,4 @@
 services:
-  gcloud-tasks-emulator:
-    image: ghcr.io/aertje/cloud-tasks-emulator:latest
-    command: -host 0.0.0.0 -openid-issuer http://localhost:8980 -port 8123 -queue "projects/my-test-project/locations/europe-west6/queues/barbequeue"
-    ports:
-      - "${TASKS_PORT:-8123}:8123"
-      - 8980:8980
   mysql:
     image: mysql:8
     ports:
@@ -18,4 +12,4 @@ services:
       - 5432:5432
     environment:
       POSTGRES_PASSWORD: 'my-secret-pw'
-      POSTGRES_DB: 'cloudtasks'
+      POSTGRES_DB: 'cloudtasks'

phpunit.xml

@@ -10,10 +10,8 @@
          stopOnFailure="false">
     <testsuites>
         <testsuite name="Testsuite">
-            <file>tests/ConfigTest.php</file>
-            <file>tests/GooglePublicKeyTest.php</file>
-            <file>tests/QueueTest.php</file>
-            <file>tests/TaskHandlerTest.php</file>
+            <file>./tests/ConfigTest.php</file>
+            <file>./tests/TaskHandlerTest.php</file>
         </testsuite>
     </testsuites>
     <php>
@@ -24,7 +22,6 @@
         <env name="SESSION_DRIVER" value="array"/>
         <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="mysql" />
         <env name="DB_HOST" value="127.0.0.1" />
         <env name="DB_PORT" value="3306" />

setup-test-env.php

@@ -57,17 +57,20 @@ function env() {
             'handler' => 'http://docker.for.mac.localhost:8080/handle-task',
             'service_account_email' => 'info@stackkit.io',
         ];
+        $queue['failed']['driver'] = 'database-uuids';
         file_put_contents('./tests/laravel/config/queue.php', '<?php return ' . var_export($queue, true) . ';');
     }
 
     exec('
         cd ./tests/laravel &&
         mkdir -p tests/Support &&
         cp ../../tests/support/SimpleJob.php tests/support/SimpleJob.php &&
+        cp ../../tests/support/FailingJob.php tests/support/FailingJob.php &&
+        cp ../../tests/support/FailingJobWithDelay.php tests/support/FailingJobWithDelay.php &&
         composer require stackkit/laravel-google-cloud-tasks-queue &&
         php artisan migrate
     ');
 }
 
 echo "Started dev server on port 8080!\n";
-exec('cd ./tests/laravel && php artisan serve --port=8080 --no-ansi');
+exec('cd ./tests/laravel && php artisan serve --host=0.0.0.0 --port=8080 --no-ansi');

src/CloudTasksApi.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stackkit\LaravelGoogleCloudTasksQueue;
+
+use Illuminate\Support\Facades\Facade;
+
+class CloudTasksApi extends Facade
+{
+    protected static function getFacadeAccessor()
+    {
+        return 'cloud-tasks-api';
+    }
+
+    public static function fake(): void
+    {
+        self::swap(new CloudTasksApiFake());
+    }
+}

src/CloudTasksApiConcrete.php

@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stackkit\LaravelGoogleCloudTasksQueue;
+
+use Google\Cloud\Tasks\V2\CloudTasksClient;
+use Google\Cloud\Tasks\V2\RetryConfig;
+use Google\Cloud\Tasks\V2\Task;
+
+class CloudTasksApiConcrete implements CloudTasksApiContract
+{
+    /**
+     * @var CloudTasksClient $client
+     */
+    private $client;
+
+    public function __construct(CloudTasksClient $client)
+    {
+        $this->client = $client;
+    }
+
+    public function getRetryConfig(string $queueName): RetryConfig
+    {
+        return $this->client->getQueue($queueName)->getRetryConfig();
+    }
+
+    public function createTask(string $queueName, Task $task): Task
+    {
+        // TODO: Implement createTask() method.
+    }
+
+    public function deleteTask(string $taskName): void
+    {
+        // TODO: Implement deleteTask() method.
+    }
+
+    public function getRetryUntilTimestamp(CloudTasksJob $job): ?int
+    {
+        // TODO: Implement getRetryUntilTimestamp() method.
+    }
+}

src/CloudTasksApiContract.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stackkit\LaravelGoogleCloudTasksQueue;
+
+use Google\Cloud\Tasks\V2\RetryConfig;
+use Google\Cloud\Tasks\V2\Task;
+
+interface CloudTasksApiContract
+{
+    public function getRetryConfig(string $queueName): RetryConfig;
+    public function createTask(string $queueName, Task $task): Task;
+    public function deleteTask(string $taskName): void;
+    public function getRetryUntilTimestamp(CloudTasksJob $job): ?int;
+}

src/CloudTasksApiFake.php

@@ -0,0 +1,87 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stackkit\LaravelGoogleCloudTasksQueue;
+
+use Closure;
+use Google\Cloud\Tasks\V2\RetryConfig;
+use Google\Cloud\Tasks\V2\Task;
+use Google\Protobuf\Duration;
+use Illuminate\Support\Arr;
+use Illuminate\Support\Str;
+use PHPUnit\Framework\Assert;
+
+class CloudTasksApiFake implements CloudTasksApiContract
+{
+    public array $createdTasks = [];
+    public array $deletedTasks = [];
+
+    public function getRetryConfig(string $queueName): RetryConfig
+    {
+        $retryConfig = new RetryConfig();
+
+        $retryConfig
+            ->setMinBackoff((new Duration(['seconds' => 0])))
+            ->setMaxBackoff((new Duration(['seconds' => 0])));
+
+        return $retryConfig;
+    }
+
+    public function createTask(string $queueName, Task $task): Task
+    {
+        $task->setName(Str::uuid()->toString());
+
+        $this->createdTasks[] = compact('queueName', 'task');
+
+        return $task;
+    }
+
+    public function deleteTask(string $taskName): void
+    {
+        $this->deletedTasks[] = $taskName;
+    }
+
+    public function getRetryUntilTimestamp(CloudTasksJob $job): ?int
+    {
+        return null;
+    }
+
+    public function assertTaskDeleted(string $taskName): void
+    {
+        $taskUuids = array_map(function ($fullTaskName) {
+            return Arr::last(explode('/', $fullTaskName));
+        }, $this->deletedTasks);
+
+        Assert::assertTrue(
+            in_array($taskName, $taskUuids),
+            'The task [' . $taskName . '] should have been deleted but it is not.'
+        );
+    }
+
+    public function assertTaskNotDeleted(string $taskName): void
+    {
+        $taskUuids = array_map(function ($fullTaskName) {
+            return Arr::last(explode('/', $fullTaskName));
+        }, $this->deletedTasks);
+
+        Assert::assertTrue(
+            ! in_array($taskName, $taskUuids),
+            'The task [' . $taskName . '] should not have been deleted but it was.'
+        );
+    }
+
+    public function assertDeletedTaskCount(int $count): void
+    {
+        Assert::assertCount($count, $this->deletedTasks);
+    }
+
+    public function assertTaskCreated(Closure $closure): void
+    {
+        $count = count(array_filter($this->createdTasks, function ($createdTask) use ($closure) {
+            return $closure($createdTask['task'], $createdTask['queueName']);
+        }));
+
+        Assert::assertTrue($count > 0, 'Task was not created.');
+    }
+}

src/CloudTasksJob.php

@@ -17,13 +17,15 @@ class CloudTasksJob extends LaravelJob implements JobContract
     /**
      * @var CloudTasksQueue
      */
-    private $cloudTasksQueue;
+    public $cloudTasksQueue;
 
     public function __construct($job, CloudTasksQueue $cloudTasksQueue)
     {
         $this->job = $job;
         $this->container = Container::getInstance();
         $this->cloudTasksQueue = $cloudTasksQueue;
+        $command = unserialize($job['data']['command']);
+        $this->queue = $command->queue;
     }
 
     public function getJobId()
@@ -87,4 +89,11 @@ public function delete()
 
         $this->cloudTasksQueue->delete($this);
     }
+
+    public function fire()
+    {
+        $this->attempts++;
+
+        parent::fire();
+    }
 }

src/CloudTasksQueue.php

@@ -18,7 +18,7 @@ class CloudTasksQueue extends LaravelQueue implements QueueContract
 
     private $client;
     private $default;
-    private $config;
+    public $config;
 
     public function __construct(array $config, CloudTasksClient $client)
     {
@@ -75,7 +75,9 @@ protected function pushToCloudTasks($queue, $payload, $delay = 0, $attempts = 0)
 
         MonitoringService::make()->addToMonitor($queue, $task);
 
-        $this->client->createTask($queueName, $task);
+        $createdTask = CloudTasksApi::createTask($queueName, $task);
+
+        event(new TaskCreated($createdTask));
     }
 
     public function pop($queue = null)
@@ -100,14 +102,16 @@ public function delete(CloudTasksJob $job)
     {
         $config = $this->config;
 
+        $queue = $job->getQueue() ?: $this->config['queue']; // @todo: make this a helper method somewhere.
+
         $taskName = $this->client->taskName(
             $config['project'],
             $config['location'],
-            $job->getQueue(),
+            $queue,
             request()->header('X-Cloudtasks-Taskname')
         );
 
-        $this->client->deleteTask($taskName);
+        CloudTasksApi::deleteTask($taskName);
     }
 
     /**