Merge pull request #174 from cakephp/ci

Fix CI errors

Author: ADmad

.phive/phars.xml

@@ -1,4 +1,4 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phive xmlns="https://phar.io/phive">
-  <phar name="phpstan" version="2.1.17" installed="2.1.17" location="./tools/phpstan" copy="false"/>
+  <phar name="phpstan" version="2.1.31" installed="2.1.31" location="./tools/phpstan" copy="false"/>
 </phive>

composer.json

@@ -22,15 +22,15 @@
     },
     "require": {
         "php": ">=8.1",
-        "cakephp/cakephp": "^5.0.0",
+        "cakephp/cakephp": "^5.1.0",
         "enqueue/simple-client": "^0.10",
         "psr/log": "^3.0"
     },
     "require-dev": {
-        "cakephp/bake": "^3.0.0",
+        "cakephp/bake": "^3.5.1",
         "cakephp/cakephp-codesniffer": "^5.0",
         "enqueue/fs": "^0.10",
-        "phpunit/phpunit": "^10.1.0"
+        "phpunit/phpunit": "^10.5.32 || ^11.3.3 || ^12.0.9"
     },
     "suggest": {
         "cakephp/bake": "Required if you want to generate jobs.",

phpcs.xml.dist

@@ -1,7 +1,9 @@
 <?xml version="1.0"?>
 <ruleset name="CakePHP Queue">
-    <config name="installed_paths" value="../../cakephp/cakephp-codesniffer" />
     <rule ref="CakePHP" />
 
+    <file>src/</file>
+    <file>tests/</file>
+
     <exclude-pattern>tests/comparisons/*</exclude-pattern>
 </ruleset>

src/QueueManager.php

@@ -147,6 +147,16 @@ public static function getConfig(string $key): mixed
         return static::$_config[$key] ?? null;
     }
 
+    /**
+     * Get the configured queue keys.
+     *
+     * @return array List of configured queue configuration keys.
+     */
+    public static function configured(): array
+    {
+        return array_keys(static::$_config);
+    }
+
     /**
      * Remove a configured queue adapter.
      *

templates/bake/job.twig

@@ -13,14 +13,14 @@
  * @license       https://opensource.org/licenses/MIT MIT License
  */
 #}
-<?php
-declare(strict_types=1);
-
-namespace {{ namespace }}\Job;
-
-use Cake\Queue\Job\JobInterface;
-use Cake\Queue\Job\Message;
-use Interop\Queue\Processor;
+{{ element('Bake.file_header', {
+    namespace: "#{namespace}\\Job",
+    classImports: [
+        'Cake\\Queue\\Job\\JobInterface',
+        'Cake\\Queue\\Job\\Message',
+        'Interop\\Queue\\Processor',
+    ],
+}) }}
 
 /**
  * {{ name }} job
@@ -30,7 +30,7 @@ class {{ name }}Job implements JobInterface
 {% if maxAttempts %}
     /**
      * The maximum number of times the job may be attempted.
-     * 
+     *
      * @var int|null
      */
     public static $maxAttempts = {{ maxAttempts }};
@@ -39,7 +39,7 @@ class {{ name }}Job implements JobInterface
 {% if isUnique %}
     /**
      * Whether there should be only one instance of a job on the queue at a time. (optional property)
-     * 
+     *
      * @var bool
      */
     public static $shouldBeUnique = true;

tests/TestCase/Command/RequeueCommandTest.php

@@ -20,7 +20,7 @@
 use Cake\Core\Configure;
 use Cake\Log\Log;
 use Cake\Queue\QueueManager;
-use Cake\Queue\Test\TestCase\DebugLogTrait;
+use Cake\Queue\Test\TestCase\QueueTestTrait;
 use Cake\TestSuite\TestCase;
 use TestApp\Job\LogToDebugJob;
 
@@ -32,7 +32,7 @@
 class RequeueCommandTest extends TestCase
 {
     use ConsoleIntegrationTestTrait;
-    use DebugLogTrait;
+    use QueueTestTrait;
 
     protected array $fixtures = [
         'plugin.Cake/Queue.FailedJobs',

tests/TestCase/Command/WorkerCommandTest.php

@@ -14,6 +14,7 @@
  * @since         0.1.0
  * @license       https://opensource.org/licenses/MIT MIT License
  */
+
 namespace Cake\Queue\Test\TestCase\Command;
 
 use Cake\Console\TestSuite\ConsoleIntegrationTestTrait;
@@ -22,8 +23,10 @@
 use Cake\Queue\QueueManager;
 use Cake\Queue\Test\test_app\src\Job\LogToDebugWithServiceJob;
 use Cake\Queue\Test\test_app\src\Queue\TestCustomProcessor;
-use Cake\Queue\Test\TestCase\DebugLogTrait;
+use Cake\Queue\Test\TestCase\QueueTestTrait;
 use Cake\TestSuite\TestCase;
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\Attributes\RunInSeparateProcess;
 use TestApp\Job\LogToDebugJob;
 use TestApp\Job\RequeueJob;
 use TestApp\WelcomeMailerListener;
@@ -36,7 +39,7 @@
 class WorkerCommandTest extends TestCase
 {
     use ConsoleIntegrationTestTrait;
-    use DebugLogTrait;
+    use QueueTestTrait;
 
     /**
      * Test that command description prints out
@@ -49,9 +52,8 @@ public function testDescriptionOutput()
 
     /**
      * Test that queue will run for one second
-     *
-     * @runInSeparateProcess
      */
+    #[RunInSeparateProcess]
     public function testQueueProcessesStart()
     {
         Configure::write('Queue', [
@@ -66,9 +68,8 @@ public function testQueueProcessesStart()
 
     /**
      * Test that queue will run for one second with valid listener
-     *
-     * @runInSeparateProcess
      */
+    #[RunInSeparateProcess]
     public function testQueueProcessesWithListener()
     {
         Configure::write('Queue', [
@@ -84,9 +85,8 @@ public function testQueueProcessesWithListener()
 
     /**
      * Test that queue will abort when the passed config is not present in the app configuration.
-     *
-     * @runInSeparateProcess
      */
+    #[RunInSeparateProcess]
     public function testQueueWillAbortWithMissingConfig()
     {
         Configure::write('Queue', [
@@ -103,9 +103,8 @@ public function testQueueWillAbortWithMissingConfig()
 
     /**
      * Test that queue will abort with invalid listener
-     *
-     * @runInSeparateProcess
      */
+    #[RunInSeparateProcess]
     public function testQueueProcessesWithInvalidListener()
     {
         Configure::write('Queue', [
@@ -122,9 +121,8 @@ public function testQueueProcessesWithInvalidListener()
 
     /**
      * Test that queue will write to specified logger option
-     *
-     * @runInSeparateProcess
      */
+    #[RunInSeparateProcess]
     public function testQueueProcessesWithLogger()
     {
         Configure::write('Queue', [
@@ -157,10 +155,9 @@ public static function dataProviderCallableTypes(): array
 
     /**
      * Start up the worker queue, push a job, and see that it processes
-     *
-     * @dataProvider dataProviderCallableTypes
-     * @runInSeparateProcess
      */
+    #[RunInSeparateProcess]
+    #[DataProvider('dataProviderCallableTypes')]
     public function testQueueProcessesJob($callable)
     {
         $config = [
@@ -186,9 +183,8 @@ public function testQueueProcessesJob($callable)
 
     /**
      * Set the processor name, Start up the worker queue, push a job, and see that it processes
-     *
-     * @runInSeparateProcess
      */
+    #[RunInSeparateProcess]
     public function testQueueProcessesJobWithProcessor()
     {
         $config = [
@@ -213,9 +209,8 @@ public function testQueueProcessesJobWithProcessor()
 
     /**
      * Test non-default queue name
-     *
-     * @runInSeparateProcess
      */
+    #[RunInSeparateProcess]
     public function testQueueProcessesJobWithOtherQueue()
     {
         $config = [
@@ -241,9 +236,8 @@ public function testQueueProcessesJobWithOtherQueue()
 
     /**
      * Test max-attempts option
-     *
-     * @runInSeparateProcess
      */
+    #[RunInSeparateProcess]
     public function testQueueProcessesJobWithMaxAttempts()
     {
         $config = [
@@ -269,9 +263,8 @@ public function testQueueProcessesJobWithMaxAttempts()
 
     /**
      * Test DI service injection works in tasks
-     *
-     * @runInSeparateProcess
      */
+    #[RunInSeparateProcess]
     public function testQueueProcessesJobWithDIService()
     {
         $this->skipIf(version_compare(Configure::version(), '4.2', '<'), 'DI Container is only available since CakePHP 4.2');
@@ -297,9 +290,8 @@ public function testQueueProcessesJobWithDIService()
 
     /**
      * Test that queue will process when a unique cache is configured.
-     *
-     * @runInSeparateProcess
      */
+    #[RunInSeparateProcess]
     public function testQueueProcessesWithUniqueCacheConfigured()
     {
         $config = [
@@ -324,9 +316,8 @@ public function testQueueProcessesWithUniqueCacheConfigured()
 
     /**
      * Test that queue uses default processor when no processor is specified.
-     *
-     * @runInSeparateProcess
      */
+    #[RunInSeparateProcess]
     public function testQueueUsesDefaultProcessor()
     {
         $config = [
@@ -352,9 +343,8 @@ public function testQueueUsesDefaultProcessor()
 
     /**
      * Test that queue uses custom processor when specified in configuration.
-     *
-     * @runInSeparateProcess
      */
+    #[RunInSeparateProcess]
     public function testQueueUsesCustomProcessor()
     {
         $config = [
@@ -383,9 +373,8 @@ public function testQueueUsesCustomProcessor()
 
     /**
      * Test that queue aborts when custom processor class does not exist.
-     *
-     * @runInSeparateProcess
      */
+    #[RunInSeparateProcess]
     public function testQueueAbortsWithNonExistentProcessor()
     {
         $config = [
@@ -403,9 +392,8 @@ public function testQueueAbortsWithNonExistentProcessor()
 
     /**
      * Test that queue aborts when custom processor does not implement Interop\Queue\Processor.
-     *
-     * @runInSeparateProcess
      */
+    #[RunInSeparateProcess]
     public function testQueueAbortsWithInvalidProcessor()
     {
         $config = [
@@ -423,9 +411,8 @@ public function testQueueAbortsWithInvalidProcessor()
 
     /**
      * Test that custom processor works with listener configuration.
-     *
-     * @runInSeparateProcess
      */
+    #[RunInSeparateProcess]
     public function testCustomProcessorWithListener()
     {
         $config = [

tests/TestCase/Consumption/LimitAttemptsExtensionTest.php

@@ -10,7 +10,7 @@
 use Cake\Queue\Consumption\LimitConsumedMessagesExtension;
 use Cake\Queue\Queue\Processor as QueueProcessor;
 use Cake\Queue\QueueManager;
-use Cake\Queue\Test\TestCase\DebugLogTrait;
+use Cake\Queue\Test\TestCase\QueueTestTrait;
 use Cake\TestSuite\TestCase;
 use Enqueue\Consumption\ChainExtension;
 use Psr\Log\NullLogger;
@@ -19,7 +19,7 @@
 
 class LimitAttemptsExtensionTest extends TestCase
 {
-    use DebugLogTrait;
+    use QueueTestTrait;
 
     public function setUp(): void
     {
@@ -28,16 +28,6 @@ public function setUp(): void
         EventManager::instance()->setEventList(new EventList());
     }
 
-    /**
-     * @beforeClass
-     * @after
-     */
-    public static function dropConfigs()
-    {
-        Log::drop('debug');
-        QueueManager::drop('default');
-    }
-
     public function testMessageShouldBeRequeuedIfMaxAttemptsIsNotSet()
     {
         $consume = $this->setupQueue();

tests/TestCase/Consumption/RemoveUniqueJobIdFromCacheExtensionTest.php

@@ -9,29 +9,15 @@
 use Cake\Queue\Consumption\RemoveUniqueJobIdFromCacheExtension;
 use Cake\Queue\Queue\Processor as QueueProcessor;
 use Cake\Queue\QueueManager;
+use Cake\Queue\Test\TestCase\QueueTestTrait;
 use Cake\TestSuite\TestCase;
 use Enqueue\Consumption\ChainExtension;
 use Psr\Log\NullLogger;
 use TestApp\Job\UniqueJob;
 
 class RemoveUniqueJobIdFromCacheExtensionTest extends TestCase
 {
-    /**
-     * @beforeClass
-     * @after
-     */
-    public static function dropConfigs()
-    {
-        Log::drop('debug');
-
-        QueueManager::drop('default');
-
-        $cacheKey = QueueManager::getConfig('default')['uniqueCacheKey'] ?? null;
-        if ($cacheKey) {
-            Cache::clear($cacheKey);
-            Cache::drop($cacheKey);
-        }
-    }
+    use QueueTestTrait;
 
     public function testJobIsRemovedFromCacheAfterProcessing()
     {