Merge branch 'feature/cron-task'

Author: wachterjohannes

.styleci.yml

@@ -0,0 +1,13 @@
+preset: symfony
+
+enabled:
+    - concat_with_spaces
+    - ordered_use
+    - short_array_syntax
+
+disabled:
+    - concat_without_spaces
+    - phpdoc_align
+    - phpdoc_indent
+    - phpdoc_to_comment
+    - blankline_after_open_tag

CHANGELOG.md

@@ -1,4 +1,5 @@
 # CHANGELOG
 
 * dev-master
-    * ENHANCEMENT #- Moved command name to service definition   
+    * ENHANCEMENT #-- Moved command name to service definition   
+    * FEATURE     #13 Added options to command schedule task for cron tasks

composer.json

@@ -11,7 +11,7 @@
     ],
     "require": {
         "php": "~5.5 || ~7.0",
-        "php-task/php-task": "0.1.*",
+        "php-task/php-task": "dev-master",
         "symfony/http-kernel": "^2.6",
         "symfony/dependency-injection": "^2.6",
         "symfony/config": "^2.6",

src/Command/RunHandlerCommand.php

@@ -7,7 +7,6 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 use Task\Handler\RegistryInterface;
-use Task\SchedulerInterface;
 
 /**
  * Run pending tasks.
@@ -46,10 +45,14 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $handler = $input->getArgument('handler');
         $workload = $input->getArgument('workload');
 
-        $output->writeln(sprintf('Run command "%s" with workload "%s"', $handler, $workload));
+        if ($output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE) {
+            $output->writeln(sprintf('Run command "%s" with workload "%s"', $handler, $workload));
+        }
 
         $result = $this->registry->run($handler, $workload);
 
-        $output->writeln(sprintf('Result: "%s"', $result));
+        if ($output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE) {
+            $output->writeln(sprintf('Result: %s', json_encode($result)));
+        }
     }
 }

src/Command/ScheduleTaskCommand.php

@@ -5,6 +5,7 @@
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 use Task\SchedulerInterface;
 
@@ -35,16 +36,42 @@ protected function configure()
         $this
             ->setDescription('Run pending tasks')
             ->addArgument('handler', InputArgument::REQUIRED)
-            ->addArgument('workload', InputArgument::OPTIONAL);
+            ->addArgument('workload', InputArgument::OPTIONAL)
+            ->addOption('cron-expression', 'c', InputOption::VALUE_REQUIRED)
+            ->addOption('end-date', 'e', InputOption::VALUE_REQUIRED)
+            ->addOption('key', 'k', InputOption::VALUE_REQUIRED);
     }
 
     /**
      * {@inheritdoc}
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
-        $this->scheduler
-            ->createTask($input->getArgument('handler'), $input->getArgument('workload'))
-            ->schedule();
+        $handler = $input->getArgument('handler');
+        $workload = $input->getArgument('workload');
+        $cronExpression = $input->getOption('cron-expression');
+        $endDateString = $input->getOption('end-date');
+        $key = $input->getOption('key');
+
+        if ($output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE) {
+            $output->writeln(sprintf('Schedule task "%s" with workload "%s"', $handler, $workload));
+        }
+
+        $taskBuilder = $this->scheduler->createTask($input->getArgument('handler'), $input->getArgument('workload'));
+
+        if ($cronExpression !== null) {
+            $endDate = null;
+            if ($endDateString !== null) {
+                $endDate = new \DateTime($endDateString);
+            }
+
+            $taskBuilder->cron($cronExpression, new \DateTime(), $endDate);
+        }
+
+        if ($key !== null) {
+            $taskBuilder->setKey($key);
+        }
+
+        $taskBuilder->schedule();
     }
 }

src/DependencyInjection/TaskExtension.php

@@ -15,7 +15,7 @@
 class TaskExtension extends Extension
 {
     /**
-     * {@inheritDoc}
+     * {@inheritdoc}
      */
     public function load(array $configs, ContainerBuilder $container)
     {

src/Entity/Task.php

@@ -118,6 +118,7 @@ public function getKey()
 
     /**
      * @param string $key
+     *
      * @return $this
      */
     public function setKey($key)

tests/Functional/SchedulerTest.php

@@ -3,8 +3,6 @@
 namespace Functional;
 
 use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
-use Symfony\Component\HttpFoundation\Request;
-use Symfony\Component\HttpFoundation\Response;
 use Task\SchedulerInterface;
 use Task\Storage\StorageInterface;
 use Task\Task;

tests/Unit/Command/ScheduleTaskCommandTest.php

@@ -24,15 +24,22 @@ public function testConfigure()
     public function runProvider()
     {
         return [
+            ['test-handler'],
             ['test-handler', 'test-workload'],
             ['test-handler-1', 'test-workload-1'],
+            ['test-handler', 'test-workload', '1 * * * *'],
+            ['test-handler', 'test-workload', '1 * * * *', '+1 week'],
+            ['test-handler', 'test-workload', '1 * * * *', '+1 week', 'test-key'],
+            ['test-handler', 'test-workload', '1 * * * *', null, 'test-key'],
+            ['test-handler', 'test-workload', null, null, 'test-key'],
+            ['test-handler', 'test-workload', null, '+1 week', 'test-key'],
         ];
     }
 
     /**
      * @dataProvider runProvider
      */
-    public function testRun($handler, $workload)
+    public function testRun($handler, $workload = null, $cronExpression = null, $endDateString = null, $key = null)
     {
         $taskBuilder = $this->prophesize(TaskBuilderInterface::class);
 
@@ -46,14 +53,34 @@ public function testRun($handler, $workload)
 
         $input->getArgument('handler')->willReturn($handler);
         $input->getArgument('workload')->willReturn($workload);
+        $input->getOption('cron-expression')->willReturn($cronExpression);
+        $input->getOption('end-date')->willReturn($endDateString);
+        $input->getOption('key')->willReturn($key);
 
         $scheduler = $this->prophesize(SchedulerInterface::class);
         $command = new ScheduleTaskCommand('task:schedule:task', $scheduler->reveal());
 
         $scheduler->createTask($handler, $workload)->shouldBeCalledTimes(1)->willReturn($taskBuilder->reveal());
 
-        $command->run($input->reveal(), $output->reveal());
+        if ($key !== null) {
+            $taskBuilder->setKey($key)->shouldBeCalled();
+        } else {
+            $taskBuilder->setKey(Argument::any())->shouldNotBeCalled();
+        }
+        if ($cronExpression !== null) {
+            $endDate = null;
+            if ($endDateString !== null) {
+                $endDate = new \DateTime($endDateString);
+            }
 
+            $taskBuilder->cron($cronExpression, Argument::type(\DateTime::class), $endDate)->shouldBeCalled()
+                ->willReturn($taskBuilder->reveal());
+        } else {
+            $taskBuilder->cron(Argument::any(), Argument::any(), Argument::any())->shouldNotBeCalled()
+                ->willReturn($taskBuilder->reveal());
+        }
         $taskBuilder->schedule()->shouldBeCalledTimes(1);
+
+        $command->run($input->reveal(), $output->reveal());
     }
 }

tests/Unit/DependencyInjection/TaskCompilerPassTest.php

@@ -2,7 +2,6 @@
 
 namespace Unit\DependencyInjection;
 
-use Prophecy\Argument;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Definition;
 use Task\TaskBundle\DependencyInjection\HandlerCompilerPass;
@@ -29,17 +28,17 @@ public function testProcess()
                         [
                             TaskCompilerPass::INTERVAL_ATTRIBUTE => 'daily',
                             TaskCompilerPass::WORKLOAD_ATTRIBUTE => 'test-workload',
-                            TaskCompilerPass::KEY_ATTRIBUTE => 'test-key'
+                            TaskCompilerPass::KEY_ATTRIBUTE => 'test-key',
                         ],
                     ],
                     'id-2' => [
                         [
                             TaskCompilerPass::INTERVAL_ATTRIBUTE => 'daily',
-                            TaskCompilerPass::KEY_ATTRIBUTE => 'test-key-1'
+                            TaskCompilerPass::KEY_ATTRIBUTE => 'test-key-1',
                         ],
                         [
                             TaskCompilerPass::INTERVAL_ATTRIBUTE => 'daily',
-                            TaskCompilerPass::WORKLOAD_ATTRIBUTE => 'test-workload-2'
+                            TaskCompilerPass::WORKLOAD_ATTRIBUTE => 'test-workload-2',
                         ],
                     ],
                 ]