Merge pull request #77 from amayer5125/queue-work-command

Namespace Worker Command

Author: markstory

docs/en/index.rst

@@ -228,11 +228,11 @@ options this array holds are the same options as those available for
 Run the worker
 ==============
 
-Once a message is queued, you may run a worker via the included ``worker`` shell:
+Once a message is queued, you may run a worker via the included ``queue worker`` shell:
 
 .. code-block:: bash
 
-    bin/cake worker
+    bin/cake queue worker
 
 This shell can take a few different options:
 

src/Command/WorkerCommand.php

@@ -33,6 +33,16 @@
  */
 class WorkerCommand extends Command
 {
+    /**
+     * Get the command name.
+     *
+     * @return string
+     */
+    public static function defaultName(): string
+    {
+        return 'queue worker';
+    }
+
     /**
      * Gets the option parser instance and configures it.
      *

src/Plugin.php

@@ -64,6 +64,8 @@ public function bootstrap(PluginApplicationInterface $app): void
      */
     public function console(CommandCollection $commands): CommandCollection
     {
-        return $commands->add('worker', WorkerCommand::class);
+        return $commands
+            ->add('queue worker', WorkerCommand::class)
+            ->add('worker', WorkerCommand::class);
     }
 }

tests/TestCase/Command/WorkerCommandTest.php

@@ -44,7 +44,7 @@ public function setUp(): void
      */
     public function testDescriptionOutput()
     {
-        $this->exec('worker --help');
+        $this->exec('queue worker --help');
         $this->assertOutputContains('Runs a queue worker');
     }
 
@@ -62,7 +62,7 @@ public function testQueueProcessesStart()
                 ],
             ],
         ]);
-        $this->exec('worker --max-runtime=1');
+        $this->exec('queue worker --max-runtime=1');
         $this->assertEmpty($this->getActualOutput());
     }
 
@@ -81,7 +81,7 @@ public function testQueueProcessesWithListener()
             ],
         ],
         ]);
-        $this->exec('worker --max-runtime=1');
+        $this->exec('queue worker --max-runtime=1');
         $this->assertEmpty($this->getActualOutput());
     }
 
@@ -101,7 +101,7 @@ public function testQueueWillAbortWithMissingConfig()
         ],
         ]);
 
-        $this->exec('worker --config=invalid_config --max-runtime=1');
+        $this->exec('queue worker --config=invalid_config --max-runtime=1');
         $this->assertErrorContains('Configuration key "invalid_config" was not found');
     }
 
@@ -121,7 +121,7 @@ public function testQueueProcessesWithInvalidListener()
         ],
         ]);
 
-        $this->exec('worker --max-runtime=1');
+        $this->exec('queue worker --max-runtime=1');
         $this->assertErrorContains('Listener class InvalidListener not found');
     }
 
@@ -145,7 +145,7 @@ public function testQueueProcessesWithLogger()
             'levels' => ['notice', 'info', 'debug'],
         ]);
 
-        $this->exec('worker --max-runtime=1 --logger=debug --verbose');
+        $this->exec('queue worker --max-runtime=1 --logger=debug --verbose');
         $this->assertDebugLogContains('Max Iterations: 0');
     }
 
@@ -177,7 +177,7 @@ public function testQueueProcessesJob()
         QueueManager::push($callable, $arguments, $options);
         QueueManager::drop('default');
 
-        $this->exec('worker --max-runtime=3 --logger=debug --verbose');
+        $this->exec('queue worker --max-runtime=3 --logger=debug --verbose');
 
         $this->assertDebugLogContains('Welcome mail sent');
     }
@@ -209,7 +209,7 @@ public function testQueueProcessesJobWithProcessor()
         QueueManager::push($callable, $arguments, $options);
         QueueManager::drop('default');
 
-        $this->exec('worker --max-runtime=3 --processor=processor-name --logger=debug --verbose');
+        $this->exec('queue worker --max-runtime=3 --processor=processor-name --logger=debug --verbose');
 
         $this->assertDebugLogContains('Welcome mail sent');
     }
@@ -242,7 +242,7 @@ public function testQueueProcessesJobWithOtherQueue()
         QueueManager::push($callable, $arguments, $options);
         QueueManager::drop('other');
 
-        $this->exec('worker --config=other --max-runtime=3 --processor=processor-name --logger=debug --verbose');
+        $this->exec('queue worker --config=other --max-runtime=3 --processor=processor-name --logger=debug --verbose');
 
         $this->assertDebugLogContains('Welcome mail sent');
     }