Added task name and description interfaces to make it compatible with registerTask()

Author: bastianschwarz

.idea/runConfigurations/All.xml

@@ -2,7 +2,8 @@
 
 namespace de\codenamephp\deployer\flow\task;
 
-use de\codenamephp\deployer\base\task\iTask;
+use de\codenamephp\deployer\base\task\iTaskWithDescription;
+use de\codenamephp\deployer\base\task\iTaskWithName;
 use de\codenamephp\deployer\command\runner\iRunner;
 use de\codenamephp\deployer\command\runner\WithDeployerFunctions;
 use de\codenamephp\deployer\flow\command\factory\iFlowCommandFactory;
@@ -13,7 +14,7 @@
  *
  * The flow command is created with the command factory using the command and arguments and run using the command runner
  */
-abstract class AbstractFlowTask implements iTask {
+abstract class AbstractFlowTask implements iTaskWithName, iTaskWithDescription {
 
   public function __construct(public iFlowCommandFactory $commandFactory = new WithBinaryFromDeployer(), public iRunner $commandRunner = new WithDeployerFunctions()) { }
 

src/task/AbstractFlowTask.php

@@ -14,8 +14,10 @@
 final class Generic extends AbstractFlowTask {
 
   public function __construct(public string       $command,
+                              public string       $taskName,
     /** @var array<int,string> */
                               public array        $arguments = [],
+                              public string       $taskDescription = '',
                               iFlowCommandFactory $commandFactory = new WithBinaryFromDeployer(),
                               iRunner             $commandRunner = new WithDeployerFunctions()) {
     parent::__construct($commandFactory, $commandRunner);
@@ -28,4 +30,12 @@ public function getCommand() : string {
   public function getArguments() : array {
     return $this->arguments;
   }
+
+  public function getDescription() : string {
+    return $this->taskDescription;
+  }
+
+  public function getName() : string {
+    return $this->taskName;
+  }
 }

src/task/Generic.php

@@ -15,6 +15,8 @@
  */
 final class Flush extends AbstractFlowTask {
 
+  public const NAME = 'flow:cache:flush';
+
   public function __construct(public bool         $force = false,
                               iFlowCommandFactory $commandFactory = new WithBinaryFromDeployer(),
                               iRunner             $commandRunner = new WithDeployerFunctions()) {
@@ -28,4 +30,12 @@ public function getCommand() : string {
   public function getArguments() : array {
     return $this->force ? ['--force'] : [];
   }
+
+  public function getDescription() : string {
+    return 'Flushes all configured caches.';
+  }
+
+  public function getName() : string {
+    return self::NAME;
+  }
 }

src/task/cache/Flush.php

@@ -11,11 +11,21 @@
  */
 final class Warmup extends AbstractFlowTask {
 
+  public const NAME = 'flow:cache:warmup';
+
   public function getCommand() : string {
     return 'cache:warmup';
   }
 
   public function getArguments() : array {
     return [];
   }
+
+  public function getDescription() : string {
+    return 'Fills caches for the next request.';
+  }
+
+  public function getName() : string {
+    return self::NAME;
+  }
 }

src/task/cache/Warmup.php

@@ -11,11 +11,21 @@
  */
 final class Migrate extends AbstractFlowTask {
 
+  public const NAME = 'flow:doctrine:migrate';
+
   public function getCommand() : string {
     return 'doctrine:migrate';
   }
 
   public function getArguments() : array {
     return [];
   }
+
+  public function getDescription() : string {
+    return 'Runs the doctrine database migrations';
+  }
+
+  public function getName() : string {
+    return self::NAME;
+  }
 }

src/task/doctrine/Migrate.php

@@ -11,11 +11,21 @@
  */
 final class Publish extends AbstractFlowTask {
 
+  public const NAME = 'flow:resource:publish';
+
   public function getCommand() : string {
     return 'resource:publish';
   }
 
   public function getArguments() : array {
     return [];
   }
+
+  public function getDescription() : string {
+    return 'Publish the resources to the public directory.';
+  }
+
+  public function getName() : string {
+    return self::NAME;
+  }
 }

src/task/resource/Publish.php

@@ -16,32 +16,39 @@ final class GenericTest extends TestCase {
   protected function setUp() : void {
     parent::setUp();
 
-    $this->sut = new Generic('');
+    $this->sut = new Generic('', '');
   }
 
   public function test__construct() : void {
     $command = 'some command';
     $arguments = ['some', 'arguments'];
     $commandFactory = $this->createMock(iFlowCommandFactory::class);
     $commandRunner = $this->createMock(iRunner::class);
+    $taskName = 'some task name';
+    $taskDescription = 'some task description';
 
-    $this->sut = new Generic($command, $arguments, $commandFactory, $commandRunner);
+    $this->sut = new Generic($command, $taskName, $arguments, $taskDescription, $commandFactory, $commandRunner);
 
     self::assertSame($command, $this->sut->getCommand());
     self::assertSame($arguments, $this->sut->getArguments());
     self::assertSame($commandFactory, $this->sut->commandFactory);
     self::assertSame($commandRunner, $this->sut->commandRunner);
+    self::assertSame($taskDescription, $this->sut->getDescription());
+    self::assertSame($taskName, $this->sut->getName());
   }
 
   public function test__construct_withoutOptionalArguments() : void {
     $command = 'some command';
+    $taskName = 'some task name';
 
-    $this->sut = new Generic($command);
+    $this->sut = new Generic($command, $taskName);
 
     self::assertSame($command, $this->sut->getCommand());
     self::assertSame([], $this->sut->getArguments());
     self::assertInstanceOf(WithBinaryFromDeployer::class, $this->sut->commandFactory);
     self::assertInstanceOf(WithDeployerFunctions::class, $this->sut->commandRunner);
+    self::assertSame($taskName, $this->sut->getName());
+    self::assertSame('', $this->sut->getDescription());
   }
 
   public function testGetCommand() : void {