Made deployer functions and host checks constructor arguments so they can be tested

Signed-off-by: Bastian Schwarz <bastian@codename-php.de>

Author: bastianschwarz

.idea/runConfigurations/Default.xml

@@ -34,11 +34,11 @@
     "sort-packages": true
   },
   "scripts": {
-    "phive-update": "phive update && git add tools/* phive.xml && git commit -m 'Updated phive dependencies'",
-    "phpunit": "tools/phpunit.phar -c test/phpunit.dist.xml test/",
-    "psalm": "tools/psalm --threads=10 --long-progress --no-diff",
-    "composer-unused": "tools/composer-unused --no-progress --no-interaction",
-    "composer-require-checker": "tools/composer-require-checker --no-interaction",
+    "phive-update": "XDEBUG_MODE=off phive update && git add tools/* phive.xml && git commit -m 'Updated phive dependencies'",
+    "phpunit": "XDEBUG_MODE=coverage tools/phpunit.phar -c test/phpunit.dist.xml test/",
+    "psalm": "XDEBUG_MODE=off tools/psalm --threads=10 --long-progress --no-diff",
+    "composer-unused": "XDEBUG_MODE=off tools/composer-unused --no-progress --no-interaction",
+    "composer-require-checker": "XDEBUG_MODE=off tools/composer-require-checker --no-interaction",
     "infection": "XDEBUG_MODE=coverage tools/infection --min-msi=100 --min-covered-msi=100 --threads=4 --no-progress --show-mutations",
     "ci-all": [
       "@phpunit",

composer.json

@@ -16,7 +16,7 @@
   -->
 <phive xmlns="https://phar.io/phive">
   <phar name="phpunit" version="^9.5" installed="9.5.13" location="./tools/phpunit.phar" copy="true"/>
-  <phar name="psalm" version="^4.18" installed="4.20.0" location="./tools/psalm" copy="true"/>
+  <phar name="psalm" version="^4.20" installed="4.20.0" location="./tools/psalm" copy="true"/>
   <phar name="composer-unused" version="^0.7" installed="0.7.12" location="./tools/composer-unused" copy="true"/>
   <phar name="composer-require-checker" version="^2.1.0" installed="2.1.0" location="./tools/composer-require-checker" copy="true"/>
   <phar name="infection" version="^0.26" installed="0.26.4" location="./tools/infection" copy="true"/>

phive.xml

@@ -30,16 +30,17 @@
  */
 final class Pull implements iTask {
 
-  public iDownload $deployerFunctions;
-
   /**
    * @var array<iTransferable>
    */
   private array $transferables;
 
-  public function __construct(iTransferable ...$transferables) {
-    $this->transferables = $transferables;
-    $this->deployerFunctions = new All();
+  /**
+   * @param array<iTransferable> $transferables The transferables to pull
+   * @param iDownload $deployerFunctions Executes the download
+   */
+  public function __construct(array $transferables, public iDownload $deployerFunctions = new All()) {
+    $this->setTransferables(...$transferables);
   }
 
   /**

src/task/media/Pull.php

@@ -21,6 +21,7 @@
 use de\codenamephp\deployer\base\functions\iUpload;
 use de\codenamephp\deployer\base\hostCheck\DoNotRunOnProduction;
 use de\codenamephp\deployer\base\hostCheck\iHostCheck;
+use de\codenamephp\deployer\base\hostCheck\SkippableByOption;
 use de\codenamephp\deployer\base\task\iTask;
 use de\codenamephp\deployer\base\transferable\iTransferable;
 use de\codenamephp\deployer\base\UnsafeOperationException;
@@ -33,19 +34,20 @@
  */
 final class Push implements iTask {
 
-  public iUpload $deployerFunctions;
-
-  public iHostCheck $hostCheck;
-
   /**
    * @var array<iTransferable>
    */
   private array $transferables;
 
-  public function __construct(iTransferable ...$transferables) {
-    $this->transferables = $transferables;
-    $this->deployerFunctions = new All();
-    $this->hostCheck = new DoNotRunOnProduction();
+  /**
+   * @param array<iTransferable> $transferables The transferables to push
+   * @param iUpload $deployerFunctions Executes the upload
+   * @param iHostCheck $hostCheck Makes sure that the task is not accidentally executed on production
+   */
+  public function __construct(array             $transferables,
+                              public iUpload    $deployerFunctions = new All(),
+                              public iHostCheck $hostCheck = new SkippableByOption(new DoNotRunOnProduction())) {
+    $this->setTransferables(...$transferables);
   }
 
   /**

src/task/media/Push.php

@@ -30,15 +30,26 @@ final class PullTest extends TestCase {
   protected function setUp() : void {
     parent::setUp();
 
-    $this->sut = new Pull();
+    $deployerFunctions = $this->createMock(iDownload::class);
+
+    $this->sut = new Pull([], $deployerFunctions);
   }
 
   public function test__construct() : void {
     $transferable1 = $this->createMock(iTransferable::class);
     $transferable2 = $this->createMock(iTransferable::class);
-    $this->sut = new Pull($transferable1, $transferable2);
+    $deployerFunctions = $this->createMock(iDownload::class);
+
+    $this->sut = new Pull([$transferable1, $transferable2], $deployerFunctions);
 
     self::assertSame([$transferable1, $transferable2], $this->sut->getTransferables());
+    self::assertSame($deployerFunctions, $this->sut->deployerFunctions);
+  }
+
+  public function test__construct_withoutOptionalParameters() : void {
+    $this->sut = new Pull([]);
+
+    self::assertSame([], $this->sut->getTransferables());
     self::assertInstanceOf(All::class, $this->sut->deployerFunctions);
   }
 

test/task/media/PullTest.php

@@ -17,9 +17,7 @@
 
 namespace de\codenamephp\deployer\base\test\task\media;
 
-use de\codenamephp\deployer\base\functions\All;
 use de\codenamephp\deployer\base\functions\iUpload;
-use de\codenamephp\deployer\base\hostCheck\DoNotRunOnProduction;
 use de\codenamephp\deployer\base\hostCheck\iHostCheck;
 use de\codenamephp\deployer\base\task\media\Push;
 use de\codenamephp\deployer\base\transferable\iTransferable;
@@ -32,18 +30,23 @@ final class PushTest extends TestCase {
   protected function setUp() : void {
     parent::setUp();
 
-    $this->sut = new Push();
+    $deployerFunctions = $this->createMock(iUpload::class);
+    $hostCheck = $this->createMock(iHostCheck::class);
+
+    $this->sut = new Push([], $deployerFunctions, $hostCheck);
   }
 
   public function test__construct() : void {
     $transferables1 = $this->createMock(iTransferable::class);
     $transferables2 = $this->createMock(iTransferable::class);
+    $deployerFunctions = $this->createMock(iUpload::class);
+    $hostCheck = $this->createMock(iHostCheck::class);
 
-    $this->sut = new Push($transferables1, $transferables2);
+    $this->sut = new Push([$transferables1, $transferables2], $deployerFunctions, $hostCheck);
 
     self::assertSame([$transferables1, $transferables2], $this->sut->getTransferables());
-    self::assertInstanceOf(All::class, $this->sut->deployerFunctions);
-    self::assertInstanceOf(DoNotRunOnProduction::class, $this->sut->hostCheck);
+    self::assertSame($deployerFunctions, $this->sut->deployerFunctions);
+    self::assertSame($hostCheck, $this->sut->hostCheck);
   }
 
   public function test__invoke() : void {