feat: implement queue assertion helpers

src/Traits/TestingTrait.php

@@ -2,6 +2,10 @@
 
 namespace RonasIT\Support\Traits;
 
+use Illuminate\Support\Arr;
+use Illuminate\Support\Facades\Queue;
+use ReflectionClass;
+
 trait TestingTrait
 {
     use FixturesTrait;
@@ -18,4 +22,51 @@ protected function assertExceptionThrew(string $expectedClassName, string $expec
 
         $this->expectExceptionMessageMatches("/{$expectedMessage}/");
     }
+
+    protected function assertQueueEqualsFixture(string $fixture, bool $exportMode = false): void
+    {
+        $actualData = [];
+
+        foreach (Queue::pushedJobs() as $namespace => $jobs) {
+            $actualData[$namespace] = Arr::map($jobs, function ($job) {
+                $job = $this->getJobObject($job);
+
+                return $this->getObjectAttributes($job);
+            });
+        }
+
+        $this->assertEqualsFixture("queue_states/{$fixture}", $actualData, $exportMode);
+    }
+
+    protected function getJobObject(array $job): object
+    {
+        if (is_object($job['job'])) {
+            return $job['job'];
+        }
+
+        $data = Arr::wrap($job['data']);
+        $className = $job['job'];
+
+        return new $className(...$data);
+    }
+
+    protected function assertQueueEmpty(): void
+    {
+        $this->assertEquals([], Queue::pushedJobs(), 'Failed assert that faked queue is empty.');
+    }
+
+    protected function getObjectAttributes(object $object): array
+    {
+        $result = [];
+
+        $properties = (new ReflectionClass($object))->getProperties();
+
+        foreach ($properties as $property) {
+            $result[$property->getName()] = $property->isInitialized($object)
+                ? $property->getValue($object)
+                : null;
+        }
+
+        return json_decode(json_encode($result), true);
+    }
 }

tests/TestingTraitTest.php

@@ -2,12 +2,29 @@
 
 namespace RonasIT\Support\Tests;
 
+use Illuminate\Support\Carbon;
+use Illuminate\Support\Facades\Queue;
+use Illuminate\Support\Str;
 use RonasIT\Support\Exceptions\ModelFactoryNotFound;
+use RonasIT\Support\Tests\Support\Mock\Jobs\AnotherTestJob;
+use RonasIT\Support\Tests\Support\Mock\Jobs\TestJob;
+use RonasIT\Support\Tests\Support\Traits\TestingTraitTestTrait;
 use RonasIT\Support\Traits\TestingTrait;
 
 class TestingTraitTest extends TestCase
 {
-    use TestingTrait;
+    use TestingTrait, TestingTraitTestTrait;
+
+    public static int $laravelMajorVersion;
+
+    public function setUp(): void
+    {
+        parent::setUp();
+
+        Carbon::setTestNow('2020-01-01');
+
+        self::$laravelMajorVersion ??= (int) Str::before($this->app->version(), '.');
+    }
 
     public function testAssertExceptionThrew(): void
     {
@@ -26,4 +43,60 @@ public function testAssertExceptionThrewNotStrictly(): void
 
         throw new ModelFactoryNotFound('full error message');
     }
+
+    public function testAssertQueueEqualsFixture(): void
+    {
+        Queue::fake();
+
+        TestJob::dispatch('some payload', ['another payload'])->delay(now()->addMinute());
+
+        $this->assertQueueEqualsVersionedFixture(self::$laravelMajorVersion, 'assert_queue_equals');
+    }
+
+    public function testAssertQueueEqualsFixturePushAsClassName(): void
+    {
+        Queue::fake();
+
+        Queue::push(TestJob::class);
+
+        $this->assertQueueEqualsVersionedFixture(self::$laravelMajorVersion, 'assert_queue_equals_as_class_name');
+    }
+
+    public function testAssertQueueEqualsFixturePushAsStringWithParams(): void
+    {
+        Queue::fake();
+
+        Queue::push(TestJob::class, [
+            'payload' => 'some payload',
+            'anotherPayload' => ['another payload'],
+        ]);
+
+        $this->assertQueueEqualsVersionedFixture(self::$laravelMajorVersion, 'assert_queue_equals_as_class_name_with_params');
+    }
+
+    public function testAssertQueueEqualsFixturePushAsStringWithOneParam(): void
+    {
+        Queue::fake();
+
+        Queue::push(TestJob::class, 'some payload');
+
+        $this->assertQueueEqualsVersionedFixture(self::$laravelMajorVersion, 'assert_queue_equals_as_class_name_with_one_param');
+    }
+
+    public function testAssertQueueEqualsFixtureDifferentJobs(): void
+    {
+        Queue::fake();
+
+        TestJob::dispatch('some payload', ['another payload']);
+        AnotherTestJob::dispatch('some payload', ['another payload']);
+
+        $this->assertQueueEqualsVersionedFixture(self::$laravelMajorVersion, 'assert_queue_equals_different_jobs');
+    }
+
+    public function testAssertQueueEmpty()
+    {
+        Queue::fake();
+
+        $this->assertQueueEmpty();
+    }
 }

tests/fixtures/TestingTraitTest/queue_states/v11/assert_queue_equals.json

@@ -0,0 +1,21 @@
+{
+    "RonasIT\\Support\\Tests\\Support\\Mock\\Jobs\\TestJob": [
+        {
+            "tries": 5,
+            "payload": "some payload",
+            "anotherPayload": [
+                "another payload"
+            ],
+            "job": null,
+            "connection": null,
+            "queue": "some_queue",
+            "delay": "2020-01-01T00:01:00.000000Z",
+            "afterCommit": null,
+            "middleware": [],
+            "chained": [],
+            "chainConnection": null,
+            "chainQueue": null,
+            "chainCatchCallbacks": null
+        }
+    ]
+}

tests/fixtures/TestingTraitTest/queue_states/v11/assert_queue_equals_as_class_name.json

@@ -0,0 +1,19 @@
+{
+    "RonasIT\\Support\\Tests\\Support\\Mock\\Jobs\\TestJob": [
+        {
+            "tries": 5,
+            "payload": "",
+            "anotherPayload": [],
+            "job": null,
+            "connection": null,
+            "queue": "some_queue",
+            "delay": null,
+            "afterCommit": null,
+            "middleware": [],
+            "chained": [],
+            "chainConnection": null,
+            "chainQueue": null,
+            "chainCatchCallbacks": null
+        }
+    ]
+}

tests/fixtures/TestingTraitTest/queue_states/v11/assert_queue_equals_as_class_name_with_one_param.json

@@ -0,0 +1,19 @@
+{
+    "RonasIT\\Support\\Tests\\Support\\Mock\\Jobs\\TestJob": [
+        {
+            "tries": 5,
+            "payload": "some payload",
+            "anotherPayload": [],
+            "job": null,
+            "connection": null,
+            "queue": "some_queue",
+            "delay": null,
+            "afterCommit": null,
+            "middleware": [],
+            "chained": [],
+            "chainConnection": null,
+            "chainQueue": null,
+            "chainCatchCallbacks": null
+        }
+    ]
+}

tests/fixtures/TestingTraitTest/queue_states/v11/assert_queue_equals_as_class_name_with_params.json

@@ -0,0 +1,21 @@
+{
+    "RonasIT\\Support\\Tests\\Support\\Mock\\Jobs\\TestJob": [
+        {
+            "tries": 5,
+            "payload": "some payload",
+            "anotherPayload": [
+                "another payload"
+            ],
+            "job": null,
+            "connection": null,
+            "queue": "some_queue",
+            "delay": null,
+            "afterCommit": null,
+            "middleware": [],
+            "chained": [],
+            "chainConnection": null,
+            "chainQueue": null,
+            "chainCatchCallbacks": null
+        }
+    ]
+}

tests/fixtures/TestingTraitTest/queue_states/v11/assert_queue_equals_different_jobs.json

@@ -0,0 +1,36 @@
+{
+  "RonasIT\\Support\\Tests\\Support\\Mock\\Jobs\\TestJob": [
+    {
+      "tries": 5,
+      "payload": "some payload",
+      "anotherPayload": [
+        "another payload"
+      ],
+      "job": null,
+      "connection": null,
+      "queue": "some_queue",
+      "delay": null,
+      "afterCommit": null,
+      "middleware": [],
+      "chained": [],
+      "chainConnection": null,
+      "chainQueue": null,
+      "chainCatchCallbacks": null
+    }
+  ],
+  "RonasIT\\Support\\Tests\\Support\\Mock\\Jobs\\AnotherTestJob": [
+    {
+      "tries": 5,
+      "job": null,
+      "connection": null,
+      "queue": null,
+      "delay": null,
+      "afterCommit": null,
+      "middleware": [],
+      "chained": [],
+      "chainConnection": null,
+      "chainQueue": null,
+      "chainCatchCallbacks": null
+    }
+  ]
+}

tests/fixtures/TestingTraitTest/queue_states/v12/assert_queue_equals.json

@@ -0,0 +1,23 @@
+{
+    "RonasIT\\Support\\Tests\\Support\\Mock\\Jobs\\TestJob": [
+        {
+            "tries": 5,
+            "payload": "some payload",
+            "anotherPayload": [
+                "another payload"
+            ],
+            "job": null,
+            "connection": null,
+            "queue": "some_queue",
+            "messageGroup": null,
+            "deduplicator": null,
+            "delay": "2020-01-01T00:01:00.000000Z",
+            "afterCommit": null,
+            "middleware": [],
+            "chained": [],
+            "chainConnection": null,
+            "chainQueue": null,
+            "chainCatchCallbacks": null
+        }
+    ]
+}

tests/fixtures/TestingTraitTest/queue_states/v12/assert_queue_equals_as_class_name.json

@@ -0,0 +1,21 @@
+{
+    "RonasIT\\Support\\Tests\\Support\\Mock\\Jobs\\TestJob": [
+        {
+            "tries": 5,
+            "payload": "",
+            "anotherPayload": [],
+            "job": null,
+            "connection": null,
+            "queue": "some_queue",
+            "messageGroup": null,
+            "deduplicator": null,
+            "delay": null,
+            "afterCommit": null,
+            "middleware": [],
+            "chained": [],
+            "chainConnection": null,
+            "chainQueue": null,
+            "chainCatchCallbacks": null
+        }
+    ]
+}

tests/fixtures/TestingTraitTest/queue_states/v12/assert_queue_equals_as_class_name_with_one_param.json

@@ -0,0 +1,21 @@
+{
+    "RonasIT\\Support\\Tests\\Support\\Mock\\Jobs\\TestJob": [
+        {
+            "tries": 5,
+            "payload": "some payload",
+            "anotherPayload": [],
+            "job": null,
+            "connection": null,
+            "queue": "some_queue",
+            "messageGroup": null,
+            "deduplicator": null,
+            "delay": null,
+            "afterCommit": null,
+            "middleware": [],
+            "chained": [],
+            "chainConnection": null,
+            "chainQueue": null,
+            "chainCatchCallbacks": null
+        }
+    ]
+}

tests/fixtures/TestingTraitTest/queue_states/v12/assert_queue_equals_as_class_name_with_params.json

@@ -0,0 +1,23 @@
+{
+    "RonasIT\\Support\\Tests\\Support\\Mock\\Jobs\\TestJob": [
+        {
+            "tries": 5,
+            "payload": "some payload",
+            "anotherPayload": [
+                "another payload"
+            ],
+            "job": null,
+            "connection": null,
+            "queue": "some_queue",
+            "messageGroup": null,
+            "deduplicator": null,
+            "delay": null,
+            "afterCommit": null,
+            "middleware": [],
+            "chained": [],
+            "chainConnection": null,
+            "chainQueue": null,
+            "chainCatchCallbacks": null
+        }
+    ]
+}