Fix queue shell task loading and ide autocomplete.

Author: dereuromark

composer.json

@@ -44,6 +44,7 @@
 		"psr-4": {
 			"Queue\\Test\\": "tests/",
 			"App\\": "tests/test_app/src/",
+			"Foo\\": "tests/test_app/plugins/Foo/src/",
 			"Cake\\Test\\": "vendor/cakephp/cakephp/tests/"
 		}
 	},

docs/CONTRIBUTING.md

@@ -0,0 +1,15 @@
+## Testing MySQL
+
+By default it will usually use SQLite DB (out of the box available).
+Not all tests currently work with SQLite or any non MySQL db yet.
+
+If you want to run all tests, including MySQL ones, you need to set
+```
+export db_dsn="mysql://root:[email protected]/cake_test"
+```
+before you actually run
+```
+php phpunit.phar
+```
+
+Make sure such a `cake_test` database exists.

src/Generator/Task/QueuedJobTask.php

@@ -45,12 +45,8 @@ protected function collectQueuedJobTasks() {
 
 		foreach ($tasks as $task) {
 			$className = App::className($task, 'Shell/Task', 'Task');
-
-			if (substr($task, 0, 6) === 'Queue.') {
-				$task = 'Queue.' . substr($task, 11);
-			} else {
-				$task = substr($task, 5);
-			}
+			list(, $task) = pluginSplit($task);
+			$task = substr($task, 5);
 			$result[$task] = $className;
 		}
 

src/Model/Table/QueuedJobsTable.php

@@ -504,7 +504,6 @@ public function clearDoublettes() {
 			$this->deleteAll([
 				'id' => array_slice($x, $start, 10),
 			]);
-			//debug(array_slice($x, $start, 10));
 			$start = $start + 100;
 		}
 	}

src/Queue/TaskFinder.php

@@ -14,6 +14,10 @@ class TaskFinder {
 	protected $tasks;
 
 	/**
+	 * Returns all possible Queue tasks.
+	 *
+	 * Makes sure that app tasks are prioritized over plugin ones.
+	 *
 	 * @return array
 	 */
 	public function allAppAndPluginTasks() {
@@ -26,26 +30,53 @@ public function allAppAndPluginTasks() {
 
 		foreach ($paths as $path) {
 			$Folder = new Folder($path);
-			$res = array_merge($this->tasks, $Folder->find('Queue.+\.php'));
-			foreach ($res as &$r) {
-				$r = basename($r, 'Task.php');
-			}
-			$this->tasks = $res;
+			$this->tasks = $this->getAppPaths($Folder);
 		}
 		$plugins = Plugin::loaded();
 		foreach ($plugins as $plugin) {
 			$pluginPaths = App::path('Shell/Task', $plugin);
 			foreach ($pluginPaths as $pluginPath) {
 				$Folder = new Folder($pluginPath);
-				$res = $Folder->find('Queue.+Task\.php');
-				foreach ($res as &$r) {
-					$r = $plugin . '.' . basename($r, 'Task.php');
-				}
-				$this->tasks = array_merge($this->tasks, $res);
+				$pluginTasks = $this->getPluginPaths($Folder, $plugin);
+				$this->tasks = array_merge($this->tasks, $pluginTasks);
 			}
 		}
 
 		return $this->tasks;
 	}
 
+	/**
+	 * @param \Cake\Filesystem\Folder $Folder
+	 *
+	 * @return array
+	 */
+	protected function getAppPaths(Folder $Folder) {
+		$res = array_merge($this->tasks, $Folder->find('Queue.+\.php'));
+		foreach ($res as &$r) {
+			$r = basename($r, 'Task.php');
+		}
+
+		return $res;
+	}
+
+	/**
+	 * @param \Cake\Filesystem\Folder $Folder
+	 * @param string $plugin
+	 *
+	 * @return array
+	 */
+	protected function getPluginPaths(Folder $Folder, $plugin) {
+		$res = $Folder->find('Queue.+Task\.php');
+		foreach ($res as $key => $r) {
+			$name = basename($r, 'Task.php');
+			if (in_array($name, $this->tasks)) {
+				unset($res[$key]);
+				continue;
+			}
+			$res[$key] = $plugin . '.' . $name;
+		}
+
+		return $res;
+	}
+
 }

tests/TestCase/Controller/QueueControllerTest.php

@@ -1,6 +1,7 @@
 <?php
 namespace Queue\Test\TestCase\Controller;
 
+use Cake\Datasource\ConnectionManager;
 use Cake\TestSuite\IntegrationTestCase;
 
 /**
@@ -23,9 +24,21 @@ class QueueControllerTest extends IntegrationTestCase {
 	 * @return void
 	 */
 	public function testIndex() {
+		$this->_needsConnection();
+
 		$this->get(['prefix' => 'admin', 'plugin' => 'Queue', 'controller' => 'Queue', 'action' => 'index']);
 
 		$this->assertResponseCode(200);
 	}
 
+	/**
+	 * Helper method for skipping tests that need a real connection.
+	 *
+	 * @return void
+	 */
+	protected function _needsConnection() {
+		$config = ConnectionManager::config('test');
+		$this->skipIf(strpos($config['driver'], 'Mysql') === false, 'Only Mysql is working yet for this.');
+	}
+
 }

tests/TestCase/Generator/Task/QueuedJobGeneratorTest.php

@@ -28,12 +28,13 @@ public function testCollect() {
 
 		$expected = [
 			'\Queue\Model\Table\QueuedJobsTable::createJob(0)' => [
-				'Queue.Email' => '\Queue\Shell\Task\QueueEmailTask::class',
-				'Queue.Example' => '\Queue\Shell\Task\QueueExampleTask::class',
-				'Queue.Execute' => '\Queue\Shell\Task\QueueExecuteTask::class',
-				'Queue.ProgressExample' => '\Queue\Shell\Task\QueueProgressExampleTask::class',
-				'Queue.RetryExample' => '\Queue\Shell\Task\QueueRetryExampleTask::class',
-				'Queue.SuperExample' => '\Queue\Shell\Task\QueueSuperExampleTask::class',
+				'Email' => '\Queue\Shell\Task\QueueEmailTask::class',
+				'Example' => '\Queue\Shell\Task\QueueExampleTask::class',
+				'Execute' => '\Queue\Shell\Task\QueueExecuteTask::class',
+				'ProgressExample' => '\Queue\Shell\Task\QueueProgressExampleTask::class',
+				'RetryExample' => '\Queue\Shell\Task\QueueRetryExampleTask::class',
+				'SuperExample' => '\Queue\Shell\Task\QueueSuperExampleTask::class',
+				'Foo' => '\App\Shell\Task\QueueFooTask::class',
 			],
 		];
 		$this->assertSame($expected, $result);

tests/TestCase/Model/Table/QueuedJobsTableTest.php

@@ -7,6 +7,7 @@
 
 namespace Queue\Test\TestCase\Model\Table;
 
+use Cake\Datasource\ConnectionManager;
 use Cake\I18n\Time;
 use Cake\ORM\TableRegistry;
 use Cake\TestSuite\TestCase;
@@ -100,6 +101,8 @@ public function testCreateAndCount() {
 	 * @return void
 	 */
 	public function testCreateAndFetch() {
+		$this->_needsConnection();
+
 		//$capabilities is a list of tasks the worker can run.
 		$capabilities = [
 			'task1' => [
@@ -152,6 +155,8 @@ public function testCreateAndFetch() {
 	 * @return void
 	 */
 	public function testSequence() {
+		$this->_needsConnection();
+
 		//$capabilities is a list of tasks the worker can run.
 		$capabilities = [
 			'task1' => [
@@ -176,9 +181,7 @@ public function testSequence() {
 		foreach (range(0, 4) as $num) {
 			$this->QueuedJobs->clearKey();
 			$array[$num] = $this->QueuedJobs->requestJob($capabilities);
-			//debug($job);ob_flush();
 			$jobData = unserialize($array[$num]['data']);
-			//debug($jobData);ob_flush();
 			$this->assertEquals($num, $jobData['tasknum']);
 		}
 		// now mark them as done
@@ -217,9 +220,11 @@ public function testNotBefore() {
 	 * Test Job reordering depending on 'notBefore' field.
 	 * Jobs with an expired notbefore field should be executed before any other job without specific timing info.
 	 *
-	 * @return null
+	 * @return void
 	 */
 	public function testNotBeforeOrder() {
+		$this->_needsConnection();
+
 		$capabilities = [
 			'task1' => [
 				'name' => 'task1',
@@ -279,6 +284,8 @@ public function testNotBeforeOrder() {
 	 * @return void
 	 */
 	public function testRateLimit() {
+		$this->_needsConnection();
+
 		$capabilities = [
 			'task1' => [
 				'name' => 'task1',
@@ -363,7 +370,7 @@ public function testRateLimit() {
 	}
 
 	/**
-	 * Are those tests still valid?
+	 * Are those tests still valid? //FIXME
 	 *
 	 * @return void
 	 */
@@ -401,7 +408,7 @@ public function _testRequeueAfterTimeout() {
 	 * Tests whether the timeout of second tasks doesn't interfere with
 	 * requeue of tasks
 	 *
-	 * Are those tests still valid?
+	 * Are those tests still valid? //FIXME
 	 *
 	 * @return void
 	 */
@@ -444,6 +451,8 @@ public function _testRequeueAfterTimeout2() {
 	 * @return void
 	 */
 	public function testRequestGroup() {
+		$this->_needsConnection();
+
 		$capabilities = [
 			'task1' => [
 				'name' => 'task1',
@@ -513,6 +522,8 @@ public function testRequestGroup() {
 	 * @return void
 	 */
 	public function testPriority() {
+		$this->_needsConnection();
+
 		$capabilities = [
 			'task1' => [
 				'name' => 'task1',
@@ -536,4 +547,14 @@ public function testPriority() {
 		$this->assertSame(['key' => 'k2'], $data);
 	}
 
+	/**
+	 * Helper method for skipping tests that need a real connection.
+	 *
+	 * @return void
+	 */
+	protected function _needsConnection() {
+		$config = ConnectionManager::config('test');
+		$this->skipIf(strpos($config['driver'], 'Mysql') === false, 'Only Mysql is working yet for this.');
+	}
+
 }

tests/TestCase/Queue/TaskFinderTest.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace Queue\Test\TestCase\Shell;
+
+use Cake\TestSuite\TestCase;
+use Queue\Queue\TaskFinder;
+
+class TaskFinderTest extends TestCase {
+
+	/**
+	 * @var \Queue\Shell\QueueShell|\PHPUnit_Framework_MockObject_MockObject
+	 */
+	public $QueueShell;
+
+	/**
+	 * @var \Tools\TestSuite\ConsoleOutput
+	 */
+	public $out;
+
+	/**
+	 * @var \Tools\TestSuite\ConsoleOutput
+	 */
+	public $err;
+
+	/**
+	 * Fixtures to load
+	 *
+	 * @var array
+	 */
+	public $fixtures = [
+		'plugin.Queue.QueuedJobs',
+		'plugin.Queue.QueueProcesses',
+	];
+
+	/**
+	 * Setup Defaults
+	 *
+	 * @return void
+	 */
+	public function setUp() {
+		parent::setUp();
+	}
+
+	/**
+	 * @return void
+	 */
+	public function testAllAppAndPluginTasks() {
+		$this->taskFinder = new TaskFinder();
+
+		$result = $this->taskFinder->allAppAndPluginTasks();
+		$this->assertCount(7, $result);
+		$this->assertArraySubset(['QueueFoo'], $result);
+		$this->assertTrue(!in_array('Foo.QueueFoo', $result));
+	}
+
+}