Merge pull request #13 from codenamephp/addTasks

Add tasks

Author: bastianschwarz

.idea/deployer.crontab.iml

@@ -52,5 +52,8 @@
     "composer-require-checker": "Checks for missing required composer packages",
     "infection": "Creates mutation tests to discover missing test coverage",
     "ci-all": "Runs all ci tools in sequence"
+  },
+  "require-dev": {
+    "mockery/mockery": "^1.5"
   }
 }

.idea/php.xml

@@ -24,6 +24,7 @@
   cacheDirectory=".cache/psalm"
   findUnusedBaselineEntry="true"
   findUnusedCode="true"
+  errorLevel="1"
 >
     <projectFiles>
         <directory name="src"/>

composer.json

@@ -0,0 +1,39 @@
+<?php declare(strict_types=1);
+
+namespace de\codenamephp\deployer\crontab\Task;
+
+use de\codenamephp\deployer\base\task\iTask;
+use de\codenamephp\deployer\command\runner\iRunner;
+use de\codenamephp\deployer\command\runner\WithDeployerFunctions;
+use de\codenamephp\deployer\crontab\Command\CrontabCommandFactoryInterface;
+use de\codenamephp\deployer\crontab\Command\WithBinaryFromDeployer;
+
+/**
+ * Abstract class for crontab commands that allows an optional user. If the user is given it is set with -u to the crontab command.
+ * The command to run is passed to the constructor and is executed by the command runner.
+ *
+ * Implementations can implement HasOptionsInterface to add additional options to the command.
+ */
+abstract class AbstractCrontabCommand implements iTask {
+
+  public function __construct(
+    public readonly ?string $user = null,
+    public readonly CrontabCommandFactoryInterface $crontabCommandFactory = new WithBinaryFromDeployer(),
+    public readonly iRunner $commandRunner = new WithDeployerFunctions()
+  ) {}
+
+  /**
+   * Checks for the HasOptionsInterface and if it's implemented the return value is used as base. Then adds the user option if it is set.
+   *
+   * @return array<int, string> The options to pass to the crontab command
+   */
+  final public function getOptionsWithUser() : array {
+    $options = $this instanceof HasOptionsInterface ? $this->getOptions() : [];
+    !$this->user ?: $options[] = "-u $this->user";
+    return $options;
+  }
+
+  final public function __invoke() : void {
+    $this->commandRunner->run($this->crontabCommandFactory->build($this->getOptionsWithUser()));
+  }
+}

psalm.xml

@@ -0,0 +1,28 @@
+<?php declare(strict_types=1);
+
+namespace de\codenamephp\deployer\crontab\Task;
+
+use de\codenamephp\deployer\base\task\iTaskWithDescription;
+use de\codenamephp\deployer\base\task\iTaskWithName;
+
+/**
+ * Deletes the crontab without asking for confirmation
+ *
+ * @psalm-api
+ */
+final class Delete extends AbstractCrontabCommand implements iTaskWithName, iTaskWithDescription {
+
+  public const NAME = 'crontab:delete';
+
+  public function getOptions() : array {
+    return ['-r'];
+  }
+
+  public function getDescription() : string {
+    return 'Deletes the crontab';
+  }
+
+  public function getName() : string {
+    return self::NAME;
+  }
+}

src/Task/AbstractCrontabCommand.php

@@ -0,0 +1,16 @@
+<?php declare(strict_types=1);
+
+namespace de\codenamephp\deployer\crontab\Task;
+
+/**
+ * Interface for tasks that have additional options
+ */
+interface HasOptionsInterface {
+
+  /**
+   * Returns the options for the task
+   *
+   * @return array<int, string> The options for the task
+   */
+  public function getOptions() : array;
+}

src/Task/Delete.php

@@ -0,0 +1,41 @@
+<?php declare(strict_types=1);
+
+namespace de\codenamephp\deployer\crontab\Task;
+
+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\crontab\Command\CrontabCommandFactoryInterface;
+use de\codenamephp\deployer\crontab\Command\WithBinaryFromDeployer;
+
+/**
+ * Installs the given crontab file
+ *
+ * @psalm-api
+ */
+final class Install extends AbstractCrontabCommand implements iTaskWithName, iTaskWithDescription, HasOptionsInterface {
+
+  public const NAME = 'crontab:install';
+
+  public function __construct(
+    public readonly string $file = '{{release_or_current_path}}/crontab',
+    ?string $user = null,
+    CrontabCommandFactoryInterface $crontabCommandFactory = new WithBinaryFromDeployer(),
+    iRunner $commandRunner = new WithDeployerFunctions()
+  ) {
+    parent::__construct($user, $crontabCommandFactory, $commandRunner);
+  }
+
+  public function getOptions() : array {
+    return [$this->file];
+  }
+
+  public function getDescription() : string {
+    return 'Installs the given crontab file.';
+  }
+
+  public function getName() : string {
+    return self::NAME;
+  }
+}

src/Task/HasOptionsInterface.php

@@ -0,0 +1,28 @@
+<?php declare(strict_types=1);
+
+namespace de\codenamephp\deployer\crontab\Task;
+
+use de\codenamephp\deployer\base\task\iTaskWithDescription;
+use de\codenamephp\deployer\base\task\iTaskWithName;
+
+/**
+ * Lists the crontab ... should have been called 'List' but that is a reserved word
+ *
+ * @psalm-api
+ */
+final class Show extends AbstractCrontabCommand implements iTaskWithName, iTaskWithDescription {
+
+  public const NAME = 'crontab:show';
+
+  public function getOptions() : array {
+    return ['-l'];
+  }
+
+  public function getDescription() : string {
+    return 'Shows the crontab';
+  }
+
+  public function getName() : string {
+    return self::NAME;
+  }
+}

src/Task/Install.php

@@ -0,0 +1,71 @@
+<?php declare(strict_types=1);
+
+namespace de\codenamephp\deployer\crontab\test\Task;
+
+use de\codenamephp\deployer\command\iCommand;
+use de\codenamephp\deployer\command\runner\iRunner;
+use de\codenamephp\deployer\command\runner\WithDeployerFunctions;
+use de\codenamephp\deployer\crontab\Command\CrontabCommandFactoryInterface;
+use de\codenamephp\deployer\crontab\Command\WithBinaryFromDeployer;
+use de\codenamephp\deployer\crontab\Task\AbstractCrontabCommand;
+use de\codenamephp\deployer\crontab\Task\HasOptionsInterface;
+use Mockery;
+use PHPUnit\Framework\TestCase;
+
+final class AbstractCrontabCommandTest extends TestCase {
+
+  use Mockery\Adapter\Phpunit\MockeryPHPUnitIntegration;
+
+  public function testGetOptionsWithUser() : void {
+    $sut = $this->getMockForAbstractClass(AbstractCrontabCommand::class);
+
+    self::assertSame([], $sut->getOptionsWithUser());
+  }
+
+  public function testGetOptionsWithUser_withSetUser() : void {
+    $sut = $this->getMockForAbstractClass(AbstractCrontabCommand::class, ['some user']);
+
+    self::assertSame(['-u some user'], $sut->getOptionsWithUser());
+  }
+
+  public function testGetOptionsWithUser_withSetUser_andOptions() : void {
+    $sut = Mockery::mock(AbstractCrontabCommand::class, HasOptionsInterface::class, ['some user'])->makePartial();
+    $sut->allows('getOptions')->once()->andReturn(['some option']);
+
+    self::assertSame(['some option', '-u some user'], $sut->getOptionsWithUser());
+  }
+
+  public function test__construct() : void {
+    $sut = $this->getMockForAbstractClass(AbstractCrontabCommand::class);
+
+    self::assertNull($sut->user);
+    self::assertInstanceOf(WithBinaryFromDeployer::class, $sut->crontabCommandFactory);
+    self::assertInstanceOf(WithDeployerFunctions::class, $sut->commandRunner);
+  }
+
+  public function test__construct_withOptionalArguments() : void {
+    $user = 'some user';
+    $crontabCommandFactory = $this->createMock(CrontabCommandFactoryInterface::class);
+    $commandRunner = $this->createMock(iRunner::class);
+
+    $sut = $this->getMockForAbstractClass(AbstractCrontabCommand::class, [$user, $crontabCommandFactory, $commandRunner]);
+
+    self::assertSame($user, $sut->user);
+    self::assertSame($crontabCommandFactory, $sut->crontabCommandFactory);
+    self::assertSame($commandRunner, $sut->commandRunner);
+  }
+
+  public function test__invoke() : void {
+    $user = 'some user';
+    $command = $this->createMock(iCommand::class);
+
+    $crontabCommandFactory = $this->createMock(CrontabCommandFactoryInterface::class);
+    $crontabCommandFactory->expects(self::once())->method('build')->with(['-u some user'])->willReturn($command);
+
+    $commandRunner = $this->createMock(iRunner::class);
+    $commandRunner->expects(self::once())->method('run')->with($command);
+
+    $sut = $this->getMockForAbstractClass(AbstractCrontabCommand::class, [$user, $crontabCommandFactory, $commandRunner]);
+    $sut->__invoke();
+  }
+}