Add test for requeue

Author: euromark

.travis.yml

@@ -3,6 +3,8 @@ language: php
 php:
   - 5.3
   - 5.4
+  - 5.5
+  - 5.6
 
 env:
   - CAKE_VERSION=master

Console/Command/Task/QueueRetryExampleTask.php

@@ -0,0 +1,133 @@
+<?php
+/**
+ * @author MGriesbach@gmail.com
+ * @license http://www.opensource.org/licenses/mit-license.php The MIT License
+ * @link http://github.com/MSeven/cakephp_queue
+ */
+App::uses('AppShell', 'Console/Command');
+
+/**
+ * A Simple QueueTask example.
+ *
+ */
+class QueueRetryExampleTask extends AppShell {
+
+/**
+ * Adding the QueueTask Model
+ *
+ * @var array
+ */
+	public $uses = array(
+		'Queue.QueuedTask'
+	);
+
+/**
+ * ZendStudio Codecomplete Hint
+ *
+ * @var QueuedTask
+ */
+	public $QueuedTask;
+
+/**
+ * Timeout for run, after which the Task is reassigned to a new worker.
+ *
+ * @var int
+ */
+	public $timeout = 10;
+
+/**
+ * Number of times a failed instance of this task should be restarted before giving up.
+ *
+ * @var int
+ */
+	public $retries = 5;
+
+/**
+ * Stores any failure messages triggered during run()
+ *
+ * @var string
+ */
+	public $failureMessage = '';
+
+/**
+ * @var bool
+ */
+	public $autoUnserialize = true;
+
+/**
+ *  Constructs this Shell instance.
+ *
+ * @param ConsoleOutput $stdout A ConsoleOutput object for stdout.
+ * @param ConsoleOutput $stderr A ConsoleOutput object for stderr.
+ * @param ConsoleInput $stdin A ConsoleInput object for stdin.
+ */
+	public function __construct($stdout = null, $stderr = null, $stdin = null) {
+		parent::__construct($stdout, $stderr, $stdin);
+
+		$this->file = TMP . 'task_retry.txt';
+	}
+
+/**
+ * Example add functionality.
+ * Will create one example job in the queue, which later will be executed using run();
+ *
+ * @return void
+ */
+	public function add() {
+		$this->out('CakePHP Queue Retry Example task.');
+		$this->hr();
+		$this->out('This is a very simple example of a QueueTask and how retries work.');
+		$this->out('I will now add an example Job into the Queue.');
+		$this->out('This job will only produce some console output on the worker that it runs on.');
+		$this->out(' ');
+		$this->out('To run a Worker use:');
+		$this->out('	cake Queue.Queue runworker');
+		$this->out(' ');
+		$this->out('You can find the sourcecode of this task in: ');
+		$this->out(__FILE__);
+		$this->out(' ');
+
+		file_put_contents($this->file, '0');
+
+		/*
+		 * Adding a task of type 'example' with no additionally passed data
+		 */
+		if ($this->QueuedTask->createJob('RetryExample', null)) {
+			$this->out('OK, job created, now run the worker');
+		} else {
+			$this->err('Could not create Job');
+		}
+	}
+
+/**
+ * Example run function.
+ * This function is executed, when a worker is executing a task.
+ * The return parameter will determine, if the task will be marked completed, or be requeued.
+ *
+ * @param array $data The array passed to QueuedTask->createJob()
+ * @return bool Success
+ */
+	public function run($data) {
+		$count = (int)file_get_contents($this->file);
+
+		$this->hr();
+		$this->out('CakePHP Queue Example task.');
+		$this->hr();
+
+		if ($count < 3) {
+			$count++;
+			file_put_contents($this->file, (string)$count);
+			$this->out(' ->Sry, the Retry Example Job failed. Try again.<-');
+			$this->out(' ');
+			$this->out(' ');
+			return false;
+		}
+
+		$this->out(' ->Success, the Retry Example Job was run.<-');
+		$this->out(' ');
+		$this->out(' ');
+
+		unlink($this->file);
+		return true;
+	}
+}

README.md

@@ -1,13 +1,16 @@
 # CakePHP Queue Plugin
+[![Build Status](https://api.travis-ci.org/dereuromark/cakephp-queue.png)](https://travis-ci.org/dereuromark/cakephp-queue)
+[![License](https://poser.pugx.org/dereuromark/cakephp-queue/license.png)](https://packagist.org/packages/dereuromark/cakephp-queue)
+[![Total Downloads](https://poser.pugx.org/dereuromark/cakephp-queue/d/total.png)](https://packagist.org/packages/dereuromark/cakephp-queue)
 
-modified by Mark Scherer (dereuromark)
-- cake2.x support
-- some minor fixes
-- added crontasks (as a different approach on specific problems)
-- possible Tools Plugin dependencies for frontend access via /admin/queue
+Modified by Mark Scherer (dereuromark)
+- CakePHP2.x support
+- Some minor fixes
+- Added crontasks (as a different approach on specific problems)
+- Possible (optional) Tools Plugin dependencies for frontend access via /admin/queue
 
-new:
-- config key "queue" is now "Queue" ($config['Queue'][...])
+New:
+- Config key "queue" is now "Queue" ($config['Queue'][...])
 
 
 ## Background:
@@ -35,13 +38,11 @@ The Queue Plugin provides a simple method to create and run such non-user-intera
 While you can run multiple workers, and can (to some extend) spread these workers to different machines via a shared database,
 you should seriously consider using a more advanced system for high volume/high number of workers systems.
 
-### Status
-[![Build Status](https://api.travis-ci.org/dereuromark/cakephp-queue.png)](https://travis-ci.org/dereuromark/cakephp-queue)
-
-
 ## Installation:
 
 * Copy the files in this directory into APP/Plugin/Queue
+  Ideally, using composer and `require dereuromark/cakephp-queue`
+
 * Enable the plugin within your APP/Config/bootstrap.php (unless you loadAll)
 
 		CakePlugin::load('Queue');

Test/Case/Console/Command/QueueShellTest.php

@@ -94,6 +94,21 @@ public function testAdd() {
 		$this->assertTrue(in_array('Running Job of type "Example"', $this->QueueShell->out));
 	}
 
+	/**
+	 * QueueShellTest::testRetry()
+	 *
+	 * @return void
+	 */
+	public function testRetry() {
+		$this->QueueShell->args[] = 'RetryExample';
+		$result = $this->QueueShell->add();
+		$this->assertEmpty($this->QueueShell->out);
+
+		$result = $this->QueueShell->runworker();
+		//debug($this->QueueShell->out);
+		$this->assertTrue(in_array('Job did not finish, requeued.', $this->QueueShell->out));
+	}
+
 }
 
 class TestQueueShell extends QueueShell {