From 58d7302b495783edd6e0826c100ffa93acb0693d Mon Sep 17 00:00:00 2001
From: Etienne Baroux <barouxe@phelma.grenoble-inp.fr>
Date: Mon, 2 Jun 2014 12:17:37 +0200
Subject: [PATCH] [ticket/12602] Add files to print the cron list and test
 files.

PHPBB3-12602
---
 phpBB/config/console.yml                      |   8 ++
 phpBB/language/en/acp/common.php              |   1 +
 .../phpbb/console/command/cron/cron_list.php  |  80 ++++++++++++++
 tests/console/cron/cron_list_test.php         | 100 ++++++++++++++++++
 tests/console/cron/tasks/simple_not_ready.php |  13 +++
 .../cron/tasks/simple_not_runnable.php        |  18 ++++
 tests/console/cron/tasks/simple_ready.php     |  13 +++
 .../cron/tasks/simple_should_not_run.php      |  18 ++++
 8 files changed, 251 insertions(+)
 create mode 100644 phpBB/phpbb/console/command/cron/cron_list.php
 create mode 100644 tests/console/cron/cron_list_test.php
 create mode 100644 tests/console/cron/tasks/simple_not_ready.php
 create mode 100644 tests/console/cron/tasks/simple_not_runnable.php
 create mode 100644 tests/console/cron/tasks/simple_ready.php
 create mode 100644 tests/console/cron/tasks/simple_should_not_run.php

diff --git a/phpBB/config/console.yml b/phpBB/config/console.yml
index a102a8c609..9b0f0aa9a4 100644
--- a/phpBB/config/console.yml
+++ b/phpBB/config/console.yml
@@ -46,6 +46,14 @@ services:
         tags:
             - { name: console.command }
 
+    console.command.cron.list:
+        class: phpbb\console\command\cron\cron_list
+        arguments:
+            - @cron.manager
+            - @user
+        tags:
+            - { name: console.command }
+
     console.command.cron.run:
         class: phpbb\console\command\cron\run
         arguments:
diff --git a/phpBB/language/en/acp/common.php b/phpBB/language/en/acp/common.php
index 838a73caed..36de5e07ad 100644
--- a/phpBB/language/en/acp/common.php
+++ b/phpBB/language/en/acp/common.php
@@ -223,6 +223,7 @@ $lang = array_merge($lang, array(
 
 	'BACK'					=> 'Back',
 
+	'CLI_DESCRIPTION_CRON_LIST'	=> 'Print the cron list.',
 	'CLI_DESCRIPTION_CRON_RUN'				=> 'Runs all ready cron tasks.',
 	'CLI_DESCRIPTION_CRON_RUN_ARGUMENT_1'	=> 'Name of the task to be run',
 
diff --git a/phpBB/phpbb/console/command/cron/cron_list.php b/phpBB/phpbb/console/command/cron/cron_list.php
new file mode 100644
index 0000000000..0018d9542d
--- /dev/null
+++ b/phpBB/phpbb/console/command/cron/cron_list.php
@@ -0,0 +1,80 @@
+<?php
+/**
+*
+* @package phpBB3
+* @copyright (c) 2014 phpBB Group
+* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
+*
+*/
+namespace phpbb\console\command\cron;
+
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class cron_list extends \phpbb\console\command\command
+{
+	/** @var \phpbb\cron\manager */
+	protected $cron_manager;
+
+	/** @var \phpbb\user */
+	protected $user;
+
+	public function __construct(\phpbb\cron\manager $cron_manager, \phpbb\user $user)
+	{
+		$this->cron_manager = $cron_manager;
+		$this->user = $user;
+		parent::__construct();
+	}
+
+	protected function configure()
+	{
+		$this
+			->setName('cron:list')
+			->setDescription($this->user->lang('CLI_DESCR_CRON_LIST'))
+		;
+	}
+
+	protected function execute(InputInterface $input, OutputInterface $output)
+	{
+		$tasks = $this->cron_manager->get_tasks();
+
+		if (empty($tasks))
+		{
+			$output->writeln($this->user->lang('NO_TASK'));
+			return;
+		}
+
+		$ready_tasks = array();
+		$not_ready_tasks = array();
+		foreach ($tasks as $task)
+		{
+			if ($task->is_ready())
+			{
+				$ready_tasks[] = $task;
+			}
+			else
+			{
+				$not_ready_tasks[] = $task;
+			}
+		}
+
+		if (!empty($ready_tasks))
+		{
+			$output->writeln('<info>' . $this->user->lang('TASKS_READY') . '</info>');
+			foreach ($ready_tasks as $task)
+			{
+				$output->writeln($task->get_name());
+			}
+			$output->writeln('');
+		}
+
+		if (!empty($not_ready_tasks))
+		{
+			$output->writeln('<info>' . $this->user->lang('TASKS_NOT_READY') . '</info>');
+			foreach ($not_ready_tasks as $task)
+			{
+				$output->writeln($task->get_name());
+			}
+		}
+	}
+}
diff --git a/tests/console/cron/cron_list_test.php b/tests/console/cron/cron_list_test.php
new file mode 100644
index 0000000000..12fac4a832
--- /dev/null
+++ b/tests/console/cron/cron_list_test.php
@@ -0,0 +1,100 @@
+<?php
+/**
+ *
+ * @package testing
+ * @copyright (c) 2014 phpBB Group
+ * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
+ *
+ */
+
+require_once dirname(__FILE__) . '/tasks/simple.php';
+require_once dirname(__FILE__) . '/tasks/simple_not_ready.php';
+use Symfony\Component\Console\Application;
+use Symfony\Component\Console\Tester\CommandTester;
+use phpbb\console\command\cron\cron_list;
+
+class phpbb_console_command_cron_list_test extends phpbb_test_case
+{
+	/** @var \phpbb\cron\manager */
+	protected $cron_manager;
+
+	/** @var \phpbb\user */
+	protected $user;
+
+	protected $command_name;
+
+	protected function setUp()
+	{
+		$this->user = $this->getMock('\phpbb\user');
+		$this->user->method('lang')->will($this->returnArgument(0));
+	}
+
+	public function test_no_task()
+	{
+		$tasks = array();
+		$this->get_cron_manager($tasks);
+		$command_tester = $this->get_command_tester();
+		$command_tester->execute(array('command' => $this->command_name, '--no-ansi' => true));
+		$this->assertContains('NO_TASK', $command_tester->getDisplay());
+	}
+
+	public function test_only_ready()
+	{
+		$tasks = array(
+			new phpbb_cron_task_simple(),
+			new phpbb_cron_task_simple()
+		);
+		$this->get_cron_manager($tasks);
+		$command_tester = $this->get_command_tester();
+		$command_tester->execute(array('command' => $this->command_name, '--no-ansi' => true));
+		$this->assertContains('TASKS_READYcommand1command2', preg_replace('/\s+/', '', $command_tester->getDisplay()));
+	}
+
+	public function test_only_not_ready()
+	{
+		$tasks = array(
+			new phpbb_cron_task_simple_not_ready(),
+			new phpbb_cron_task_simple_not_ready()
+		);
+		$this->get_cron_manager($tasks);
+		$command_tester = $this->get_command_tester();
+		$command_tester->execute(array('command' => $this->command_name, '--no-ansi' => true));
+		$this->assertContains('TASKS_NOT_READYcommand1command2', preg_replace('/\s+/', '', $command_tester->getDisplay()));
+	}
+
+	public function test_both_ready()
+	{
+		$tasks = array(
+			new phpbb_cron_task_simple(),
+			new phpbb_cron_task_simple(),
+			new phpbb_cron_task_simple_not_ready(),
+			new phpbb_cron_task_simple_not_ready()
+		);
+		$this->get_cron_manager($tasks);
+		$command_tester = $this->get_command_tester();
+		$command_tester->execute(array('command' => $this->command_name, '--no-ansi' => true));
+		$this->assertSame('TASKS_READYcommand1command2TASKS_NOT_READYcommand3command4', preg_replace('/\s+/', '', $command_tester->getDisplay()));
+	}
+
+	public function get_cron_manager(array $tasks)
+	{
+		global $pathEx, $phpbb_root_path;
+		$i = 1;
+		foreach ($tasks as $task)
+		{
+			$task->set_name('command' . $i);
+			$i++;
+		}
+		$this->cron_manager = new \phpbb\cron\manager($tasks, $phpbb_root_path, $pathEx);
+	}
+
+	public function get_command_tester()
+	{
+		$application = new Application();
+		$application->add(new cron_list($this->cron_manager, $this->user));
+
+		$command = $application->find('cron:list');
+		$this->command_name = $command->getName();
+		return new CommandTester($command);
+	}
+}
diff --git a/tests/console/cron/tasks/simple_not_ready.php b/tests/console/cron/tasks/simple_not_ready.php
new file mode 100644
index 0000000000..887768e5fe
--- /dev/null
+++ b/tests/console/cron/tasks/simple_not_ready.php
@@ -0,0 +1,13 @@
+<?php
+
+class phpbb_cron_task_simple_not_ready extends \phpbb\cron\task\base
+{
+	public function run()
+	{
+	}
+
+	public function should_run()
+	{
+		return false;
+	}
+}
diff --git a/tests/console/cron/tasks/simple_not_runnable.php b/tests/console/cron/tasks/simple_not_runnable.php
new file mode 100644
index 0000000000..4951b5b4b9
--- /dev/null
+++ b/tests/console/cron/tasks/simple_not_runnable.php
@@ -0,0 +1,18 @@
+<?php
+
+class phpbb_cron_task_core_simple_not_runnable extends \phpbb\cron\task\base
+{
+	public function get_name()
+	{
+		return get_class($this);
+	}
+
+	public function run()
+	{
+	}
+
+	public function is_runnable()
+	{
+		return false;
+	}
+}
diff --git a/tests/console/cron/tasks/simple_ready.php b/tests/console/cron/tasks/simple_ready.php
new file mode 100644
index 0000000000..245d9ba738
--- /dev/null
+++ b/tests/console/cron/tasks/simple_ready.php
@@ -0,0 +1,13 @@
+<?php
+
+class phpbb_cron_task_core_simple_ready extends \phpbb\cron\task\base
+{
+	public function get_name()
+	{
+		return get_class($this);
+	}
+
+	public function run()
+	{
+	}
+}
diff --git a/tests/console/cron/tasks/simple_should_not_run.php b/tests/console/cron/tasks/simple_should_not_run.php
new file mode 100644
index 0000000000..7bd9df31b6
--- /dev/null
+++ b/tests/console/cron/tasks/simple_should_not_run.php
@@ -0,0 +1,18 @@
+<?php
+
+class phpbb_cron_task_core_simple_should_not_run extends \phpbb\cron\task\base
+{
+	public function get_name()
+	{
+		return get_class($this);
+	}
+
+	public function run()
+	{
+	}
+
+	public function should_run()
+	{
+		return false;
+	}
+}