Added media tasks

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

Author: bastianschwarz

.idea/inspectionProfiles/Project_Default.xml

@@ -18,6 +18,7 @@
 namespace de\codenamephp\deployer\base\functions;
 
 use Closure;
+use de\codenamephp\deployer\base\MissingConfigurationException;
 use Deployer\Deployer;
 use Deployer\Host\Host;
 use Deployer\Host\Localhost;
@@ -64,21 +65,28 @@ public function get(string $name, mixed $default = null) : mixed {
   }
 
   public function host(string ...$hostname) : Host|array {
-    $host = \Deployer\host(...$hostname);
-    if($host instanceof ObjectProxy) {
+    $hostOrHosts = \Deployer\host(...$hostname);
+    if($hostOrHosts instanceof ObjectProxy) {
       /**
        * We need to hack a little since ObjectProxy doesn't expose the contained objects
        *
        * @psalm-suppress PossiblyInvalidFunctionCall,InaccessibleProperty
        */
-      $host = array_values(
+      $hostOrHosts = array_values(
         array_filter(
-          (array) Closure::bind(static fn(ObjectProxy $objectProxy) : array => $objectProxy->objects, null, $host)($host),
-          static fn(mixed $host) : bool => $host instanceof Localhost
+          (array) Closure::bind(static fn(ObjectProxy $objectProxy) : array => $objectProxy->objects, null, $hostOrHosts)($hostOrHosts),
+          static fn(mixed $host) : bool => $host instanceof Host
         )
       );
     }
-    return $host;
+    return $hostOrHosts;
+  }
+
+  public function firstHost(string ...$hostname) : Host {
+    $hostOrHosts = $this->host(...$hostname);
+    if($hostOrHosts === []) throw new MissingConfigurationException(sprintf('No hosts were found for the given hostnames: [%s]', implode(',', $hostname)));
+
+    return is_array($hostOrHosts) ? array_values($hostOrHosts)[0] : $hostOrHosts;
   }
 
   public function getOption(string $name, mixed $default = null) : mixed {
@@ -126,7 +134,7 @@ public function parse(string $value) : string {
   public function parseOnHost(Host $host, string $value) : string {
     $finalValue = '';
     $this->on($host, function() use (&$finalValue, $value) { $finalValue = $this->parse($value); });
-    return $finalValue;
+    return (string) $finalValue;
   }
 
   public function run(string $command, ?array $options = [], ?int $timeout = null, ?int $idle_timeout = null, ?string $secret = null, ?array $env = null, ?bool $real_time_output = false, ?bool $no_throw = false) : string {

src/functions/All.php

@@ -17,6 +17,7 @@
 
 namespace de\codenamephp\deployer\base\functions;
 
+use de\codenamephp\deployer\base\MissingConfigurationException;
 use Deployer\Host\Host;
 
 /**
@@ -42,4 +43,13 @@ interface iHost {
    * @return Host|Host[]
    */
   public function host(string ...$hostname) : Host|array;
+
+  /**
+   * Same as host but only returns the first host that was found. If no host was found a MissingConfigurationException must be thrown
+   *
+   * @param string ...$hostname
+   * @return Host
+   * @throws MissingConfigurationException
+   */
+  public function firstHost(string ...$hostname) : Host;
 }

src/functions/iHost.php

@@ -0,0 +1,31 @@
+<?php declare(strict_types=1);
+/*
+ *   Copyright 2022 Bastian Schwarz <bastian@codename-php.de>.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *         http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+
+namespace de\codenamephp\deployer\base\ssh\client;
+
+use Deployer\Component\Ssh\Client;
+use Deployer\Host\Host;
+
+/**
+ * The \Deployer\Component\Ssh\Client has some static methods I want to use but still be able to test. Just don't write static methods folks ...
+ */
+final class StaticProxy implements iClient {
+
+  public function connectionOptionsString(Host $host) : string {
+    return Client::connectionOptionsString($host);
+  }
+}

src/ssh/client/StaticProxy.php

@@ -0,0 +1,34 @@
+<?php declare(strict_types=1);
+/*
+ *   Copyright 2022 Bastian Schwarz <bastian@codename-php.de>.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *         http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+
+namespace de\codenamephp\deployer\base\ssh\client;
+
+use Deployer\Host\Host;
+
+/**
+ * Interface for proxying the Deployer ssh client
+ */
+interface iClient {
+
+  /**
+   * Gets the connection options for an ssh call for the given host
+   *
+   * @param Host $host The host to get the connection options for
+   * @return string
+   */
+  public function connectionOptionsString(Host $host) : string;
+}

src/ssh/client/iClient.php

@@ -0,0 +1,112 @@
+<?php declare(strict_types=1);
+/*
+ *   Copyright 2022 Bastian Schwarz <bastian@codename-php.de>.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *         http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+
+namespace de\codenamephp\deployer\base\task\media;
+
+use de\codenamephp\deployer\base\functions\All;
+use de\codenamephp\deployer\base\functions\iAll;
+use de\codenamephp\deployer\base\functions\iInput;
+use de\codenamephp\deployer\base\hostCheck\DoNotRunOnProduction;
+use de\codenamephp\deployer\base\hostCheck\iHostCheck;
+use de\codenamephp\deployer\base\iConfigurationKeys;
+use de\codenamephp\deployer\base\MissingConfigurationException;
+use de\codenamephp\deployer\base\ssh\client\iClient;
+use de\codenamephp\deployer\base\ssh\client\StaticProxy;
+use de\codenamephp\deployer\base\task\iTask;
+use de\codenamephp\deployer\base\transferable\iTransferable;
+use de\codenamephp\deployer\base\UnsafeOperationException;
+use Deployer\Exception\RunException;
+
+/**
+ * Task to copy media between two remotes. The copy uses rsync over a ssh tunnel with agent forwarding so the remotes do not need each others credentials but
+ * the local credentials are used.
+ *
+ * @psalm-suppress PropertyNotSetInConstructor see https://github.com/vimeo/psalm/issues/4393
+ */
+final class Copy implements iTask {
+
+  public const OPTION_SOURCE_HOST = 'cpd:media:copy:sourceHost';
+
+  /**
+   * @var array<iTransferable>
+   */
+  private array $transferables;
+
+  /**
+   * @param array<iTransferable> $transferables Array of transferables to copy between two remotes
+   * @param iAll $deployerFunctions Deployer function to set options and run the copy
+   * @param iHostCheck $hostCheck HostCheck to prevent accidental execution
+   */
+  public function __construct(array             $transferables,
+                              public iAll       $deployerFunctions = new All(),
+                              public iHostCheck $hostCheck = new DoNotRunOnProduction(),
+                              public iClient    $sshClient = new StaticProxy()) {
+    $this->setTransferables(...$transferables);
+    $deployerFunctions->option(
+      self::OPTION_SOURCE_HOST,
+      null,
+      iInput::OPTION_VALUE_REQUIRED,
+      'The source host to copy the media from',
+      iConfigurationKeys::PRODUCTION
+    );
+  }
+
+  /**
+   * @return iTransferable[]
+   */
+  public function getTransferables() : array {
+    return $this->transferables;
+  }
+
+  public function setTransferables(iTransferable ...$transferables) : Copy {
+    $this->transferables = $transferables;
+    return $this;
+  }
+
+  /**
+   * Uses the option for the source host to get the source host, the target host is the host for the current stage and uses
+   * those hosts to build an ssh command that connects to the source host and an rsync command that will be executed on the source host
+   * and syncs to the target host.
+   *
+   * The idea is that ssh agent forwarding is enabled so the hosts can talk to each other using the local key.
+   *
+   * The base command is then used with all transferables so all folders are synced.
+   *
+   * The command cannot be run on the production stage
+   *
+   * @return void
+   * @throws UnsafeOperationException if the stage is production (more precisely: if the stage check fails)
+   * @throws MissingConfigurationException if one of the target or source host could not be found
+   * @throws RunException
+   */
+  public function __invoke() : void {
+    $this->hostCheck->check();
+
+    $sourceHost = $this->deployerFunctions->firstHost((string) $this->deployerFunctions->getOption(self::OPTION_SOURCE_HOST));
+    $targetHost = $this->deployerFunctions->currentHost();
+
+    $sshCommand = "ssh {$this->sshClient->connectionOptionsString($sourceHost)} {$sourceHost->getConnectionString()}";
+    $rsyncCommand = "rsync -e 'ssh -o StrictHostKeyChecking=no {$this->sshClient->connectionOptionsString($targetHost)}' -azP %s %s {$targetHost->getConnectionString()}:%s";
+
+    foreach($this->getTransferables() as $transferable) {
+      $sourcePath = $this->deployerFunctions->parseOnHost($sourceHost, $transferable->getLocalPath());
+      $targetPath = $this->deployerFunctions->parseOnHost($targetHost, $transferable->getRemotePath());
+
+      $this->deployerFunctions->runLocally(sprintf('%s "%s"', $sshCommand, sprintf($rsyncCommand, implode(' ', $transferable->getConfig()['options'] ?? []), $sourcePath, $targetPath)));
+    }
+  }
+}

src/task/media/Copy.php

@@ -0,0 +1,68 @@
+<?php declare(strict_types=1);
+/*
+ *   Copyright 2022 Bastian Schwarz <bastian@codename-php.de>.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *         http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+
+namespace de\codenamephp\deployer\base\task\media;
+
+use de\codenamephp\deployer\base\functions\All;
+use de\codenamephp\deployer\base\functions\iDownload;
+use de\codenamephp\deployer\base\task\iTask;
+use de\codenamephp\deployer\base\transferable\iTransferable;
+use Deployer\Exception\RunException;
+
+/**
+ * Pulls uploaded media (images, files, ...) from remote to local
+ *
+ * @psalm-suppress PropertyNotSetInConstructor see https://github.com/vimeo/psalm/issues/4393
+ */
+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();
+  }
+
+  /**
+   * @return iTransferable[]
+   */
+  public function getTransferables() : array {
+    return $this->transferables;
+  }
+
+  public function setTransferables(iTransferable ...$transferables) : Pull {
+    $this->transferables = $transferables;
+    return $this;
+  }
+
+  /**
+   * Iterates over the transferables and passes the localPath, remotePath and config on the download function
+   *
+   * @return void
+   * @throws RunException
+   */
+  public function __invoke() : void {
+    foreach($this->getTransferables() as $transferable) {
+      $this->deployerFunctions->download($transferable->getLocalPath(), $transferable->getRemotePath(), $transferable->getConfig());
+    }
+  }
+}