Merge remote-tracking branch 'dg/master' into custom

Author: arxeiss

composer.json

@@ -14,7 +14,7 @@
 		}
 	],
 	"require": {
-		"php": ">=7.1",
+		"php": ">=7.4",
 		"ext-zlib": "*",
 		"phpseclib/phpseclib": "^3.0"
 	},
@@ -35,7 +35,7 @@
 	"bin": ["deployment"],
 	"extra": {
 		"branch-alias": {
-			"dev-master": "3.4-dev"
+			"dev-master": "3.5-dev"
 		}
 	}
 }

readme.md

@@ -66,10 +66,3 @@ ignoreTracked = "
 **Reason why I want this?**
 Sometimes I want to do a quick deploy, but first I have to run `composer install --no-dev`, run deployment, and run `composer install` which takes time. With this solution, it is possible to ignore the vendor folder, but keep those files tracked for future full deploy.
 
-### 5. Return non-zero code when deploy fails
-- When deploy fails, non-zero code is returned. This means, exit code is not zero, which signaling error.
-- This is great especially for running in a pipeline
-- See commit [b3e62a8d](https://github.com/arxeiss/ftp-deployment/commit/b3e62a8dd67a685a2618582768392c0d5e766efa)
-
-**Reason why I want this?**
-I used FTP Deployment in the Gitlab pipeline. Deploy failed, but the whole job succeded because the exit code was 0.

src/Deployment/CliRunner.php

@@ -16,8 +16,7 @@
  */
 class CliRunner
 {
-	/** @var array */
-	public $defaults = [
+	public array $defaults = [
 		'local' => '',
 		'fileOutputDir' => '',
 		'passivemode' => true,
@@ -34,19 +33,17 @@ class CliRunner
 	];
 
 	/** @var string[] */
-	public $ignoreMasks = ['*.bak', '.svn', '.git*', 'Thumbs.db', '.DS_Store', '.idea'];
+	public array $ignoreMasks = ['*.bak', '.svn', '.git*', 'Thumbs.db', '.DS_Store', '.idea'];
 
-	/** @var Logger */
-	private $logger;
+	private Logger $logger;
 
-	/** @var string */
-	private $configFile;
+	private string $configFile;
 
-	/** @var string|null  test|generate|null */
-	private $mode;
+	/** test|generate|null */
+	private ?string $mode;
 
 	/** @var array[] */
-	private $batches = [];
+	private array $batches = [];
 
 
 	public function run(): ?int
@@ -72,50 +69,48 @@ public function run(): ?int
 		$time = time();
 		$this->logger->log('Started at ' . date('[Y/m/d H:i]'));
 		$this->logger->log("Config file is $this->configFile");
+		$res = 0;
 
-		$returnCode = 1;
 
-		try{
-			foreach ($this->batches as $name => $batch) {
-				$this->logger->log("\nDeploying $name");
+		foreach ($this->batches as $name => $batch) {
+			$this->logger->log("\nDeploying $name");
 
-				$deployment = $this->createDeployer($batch);
-				$deployment->tempDir = $tempDir;
+			$deployment = $this->createDeployer($batch);
+			$deployment->tempDir = $tempDir;
 
-				if ($this->mode === 'generate') {
-					$this->logger->log('Scanning files');
-					$localPaths = $deployment->collectPaths();
-					$this->logger->log('Saved ' . $deployment->writeDeploymentFile($localPaths));
-					continue;
-				}
-
-				if ($deployment->testMode) {
-					$this->logger->log('Test mode', 'lime');
-				} else if($deployment->fileOutputDir) {
-					$this->logger->log('File Output mode', 'teal');
-				} else {
-					$this->logger->log('Live mode', 'aqua');
-				}
-				if (!$deployment->allowDelete) {
-					$this->logger->log('Deleting disabled');
-				}
+			if ($this->mode === 'generate') {
+				$this->logger->log('Scanning files');
+				$localPaths = $deployment->collectPaths();
+				$this->logger->log('Saved ' . $deployment->writeDeploymentFile($localPaths));
+				continue;
+			}
 
+			if ($deployment->testMode) {
+				$this->logger->log('Test mode', 'lime');
+			} else if($deployment->fileOutputDir) {
+				$this->logger->log('File Output mode', 'teal');
+			} else {
+				$this->logger->log('Live mode', 'aqua');
+			}
+			if (!$deployment->allowDelete) {
+				$this->logger->log('Deleting disabled');
+			}
 
+			try{
 				$deployment->deploy();
-				$this->logger->log("\n\n");
+			} catch (JobException | ServerException $e) {
+				$this->logger->log("Error: {$e->getMessage()} in {$e->getFile()}:{$e->getLine()}\n\n$e", 'red');
+				$res = 1;
 			}
-			$returnCode = 0;
-		} catch (JobException | ServerException $e) {
-			$this->logger->log("Error: {$e->getMessage()} in {$e->getFile()}:{$e->getLine()}\n\n$e", 'red');
 			$this->logger->log("\n\n");
 		}
 
 		$time = time() - $time;
 		$this->logger->log(
 			'Finished at ' . date('[Y/m/d H:i]') . " (in $time seconds)\n----------------------------------------------\n\n",
-			$returnCode === 0 ? 'lime' : 'red'
+			$res === 0 ? 'lime' : 'red'
 		);
-		return $returnCode;
+		return $res;
 	}
 
 
@@ -124,7 +119,7 @@ private function createDeployer(array $config): Deployer
 		if (
 			empty($config['remote'])
 			|| !($urlParts = parse_url($config['remote']))
-			|| !isset($urlParts['scheme'], $urlParts['host'])
+			|| !isset($urlParts['scheme'])
 		) {
 			throw new \Exception("Missing or invalid 'remote' URL in config.");
 		}
@@ -191,8 +186,10 @@ private function createDeployer(array $config): Deployer
 		$deployment->deploymentFile = empty($config['deploymentfile'])
 			? $deployment->deploymentFile
 			: $config['deploymentfile'];
-		$deployment->allowDelete = $config['allowdelete'];
-		$deployment->alwaysRunActions = $config['alwaysrunactions'];
+
+		$deployment->allowDelete = (bool) $config['allowdelete'];
+		$deployment->alwaysRunActions = (bool)$config['alwaysrunactions'];
+
 		$deployment->toPurge = self::toArray($config['purge'], true);
 		$deployment->runBefore = self::toArray($config['before'], true);
 		$deployment->runAfterUpload = self::toArray($config['afterupload'], true);
@@ -241,23 +238,24 @@ private function setupPhp(): void
 
 	private function loadConfig(): ?array
 	{
-		$cmd = new CommandLine(<<<'XX'
 
-FTP deployment v3.4 - Pavel Kutáč edit
+		$cmd = new CommandLine(
+			<<<'XX'
+				FTP deployment v3.5 - Pavel Kutáč edit
 
-See more on https://github.com/arxeiss/ftp-deployment
-and original on https://github.com/dg/ftp-deployment
--------------------
-Usage:
-	deployment <config_file> [-t | --test]
+				See more on https://github.com/arxeiss/ftp-deployment
+				and original on https://github.com/dg/ftp-deployment
+				-------------------
+				Usage:
+					deployment <config_file> [-t | --test]
 
-Options:
-	-t | --test       Run in test-mode.
-	--section <name>  Only deploys the named section.
-	--generate        Only generates deployment file.
-	--no-progress     Hide the progress indicators.
+				Options:
+					-t | --test       Run in test-mode.
+					--section <name>  Only deploys the named section.
+					--generate        Only generates deployment file.
+					--no-progress     Hide the progress indicators.
 
-XX
+				XX
 		, [
 			'config' => [CommandLine::REALPATH => true],
 		]);

src/Deployment/CommandLine.php

@@ -24,16 +24,15 @@ class CommandLine
 		VALUE = 'default';
 
 	/** @var array[] */
-	private $options = [];
+	private array $options = [];
 
 	/** @var string[] */
-	private $aliases = [];
+	private array $aliases = [];
 
 	/** @var string[] */
-	private $positional = [];
+	private array $positional = [];
 
-	/** @var string */
-	private $help;
+	private string $help;
 
 
 	public function __construct(string $help, array $defaults = [])