Add target option and remove PHP 7.4 support

Author: hlecorche

.github/workflows/tests.yml

@@ -14,7 +14,7 @@ jobs:
             matrix:
                 include:
                     #Mini (for each Symfony version)
-                    -   php-version: '7.4'
+                    -   php-version: '8.0'
                         symfony-version: '5.4.*'
                         composer-flags: '--prefer-stable --prefer-lowest'
                         description: 'with SF 5.4.* lowest'
@@ -51,7 +51,6 @@ jobs:
                         description: 'with SF 7.1.* dev'
 
                     #PHP versions
-                    -   php-version: '7.4'
                     -   php-version: '8.0'
                     -   php-version: '8.1'
                     -   php-version: '8.2'
@@ -63,7 +62,7 @@ jobs:
                         coding-standards: true
 
                     #Static Analysis (min PHP version)
-                    -   php-version: '7.4'
+                    -   php-version: '8.0'
                         description: 'with Static Analysis'
                         static-analysis: true
 

.php-cs-fixer.dist.php

@@ -19,8 +19,8 @@
         '@Symfony' => true,
         '@Symfony:risky' => true,
         '@DoctrineAnnotation' => true,
-        '@PHP74Migration' => true,
-        '@PHP74Migration:risky' => true,
+        '@PHP80Migration' => true,
+        '@PHP80Migration:risky' => true,
         '@PHPUnit84Migration:risky' => true,
         'array_syntax' => ['syntax' => 'short'],
         'fopen_flags' => true,

README.md

@@ -31,18 +31,17 @@ ecommit_deploy_rsync:
     #Environments configuration
     environments:
         my_server1: #Environment name
-            hostname: myserver.com #SSH hostname - Required
-            username: myuser #SSH username - Required
-            dir: /home/remote_dir #SSH remote directory - Required
-            #port: 22 #Port - Not required - Default value: 22
+            #Target - Required
+            #The target can be either an SSH target or a local target
+            #SSH target format: ssh://<username>@<hostname>:<path> or ssh://<username>@<hostname>:<port>:<path>
+            #Local target format: file://<path>
+            target: ssh://[email protected]:/home/remote_dir
             #rsync_options: [] #Rsync command options - Not required - Default values: [] - If not defined, the global rsync_options is used
             #ignore_file: #Rsync ignore file - Not required - Default value: null - If not defined, the global ignore_file option is used
 
         #You can define others environments :
         #my_server2:
-            #hostname: myserver2.com
-            #username: myser
-            #dir: /home/remote_dir
+            #target: ssh://[email protected]:/home/remote_dir
 
     #Rsync global configuration
     #rsync:

UPGRADE-2.0.md

@@ -0,0 +1,36 @@
+# UPGRADE FROM 1.x to 2.0
+
+The following options have been removed and replaced by the option `target` :
+* `hostname`
+* `port`
+* `username`
+* `dir`
+
+Before :
+
+```yaml
+ecommit_deploy_rsync:
+    environments:
+        my_server1:
+            hostname: myserver.com
+            username: myuser
+            dir: /home/remote_dir
+
+        my_server2:
+            hostname: myserver2.com
+            port: 23
+            username: myuser
+            dir: /home/remote_dir
+```
+
+After :
+
+```yaml
+ecommit_deploy_rsync:
+    environments:
+        my_server1:
+            target: ssh://[email protected]:/home/remote_dir
+
+        my_server2:
+            target: ssh://[email protected]:23:/home/remote_dir
+```

composer.json

@@ -18,11 +18,11 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "1.x-dev"
+            "dev-master": "2.x-dev"
         }
     },
     "require": {
-        "php": "^7.4|^8.0",
+        "php": "^8.0",
         "ext-mbstring": "*",
         "symfony/config": "^5.4|^6.4|^7.0",
         "symfony/console": "^5.4|^6.4|^7.0",

src/Command/DeployRsyncCommand.php

@@ -26,6 +26,9 @@
 #[AsCommand(name: 'ecommit:deploy-rsync', description: 'Deploy the application with RSYNC and SSH')]
 final class DeployRsyncCommand extends Command
 {
+    public const TARGET_FILE_REGEX = '/^file:\/\/(?<path>.+)$/';
+    public const TARGET_SSH_REGEX = '/^ssh:\/\/(?<username>.+)@(?<hostname>[^:]+)(:(?<port>\d+)){0,1}:(?<path>.+)$/';
+
     /**
      * @var array
      */
@@ -92,10 +95,17 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         if ($ignoreFile) {
             $command[] = '--exclude-from='.$ignoreFile;
         }
-        $command[] = '-e';
-        $command[] = sprintf('ssh -p%s', $environment['port']);
-        $command[] = $this->getDirPath($this->projetDir);
-        $command[] = sprintf('%s@%s:%s', $environment['username'], $environment['hostname'], $this->getDirPath($environment['dir']));
+        if (preg_match(self::TARGET_FILE_REGEX, $environment['target'], $targetPats)) {
+            $command[] = $this->getDirPath($this->projetDir);
+            $command[] = $this->getDirPath($targetPats['path']);
+        } elseif (preg_match(self::TARGET_SSH_REGEX, $environment['target'], $targetPats)) {
+            $command[] = '-e';
+            $command[] = sprintf('ssh -p%s', (isset($targetPats['port']) && '' !== $targetPats['port']) ? $targetPats['port'] : 22);
+            $command[] = $this->getDirPath($this->projetDir);
+            $command[] = sprintf('%s@%s:%s', $targetPats['username'], $targetPats['hostname'], $this->getDirPath($targetPats['path']));
+        } else {
+            throw new \Exception('Invalid target');
+        }
 
         foreach ($this->executeProcess($command) as $data) {
             $output->writeln($data);

src/DependencyInjection/Configuration.php

@@ -13,6 +13,7 @@
 
 namespace Ecommit\DeployRsyncBundle\DependencyInjection;
 
+use Ecommit\DeployRsyncBundle\Command\DeployRsyncCommand;
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
 
@@ -33,10 +34,12 @@ public function getConfigTreeBuilder(): TreeBuilder
                     ->normalizeKeys(false)
                     ->arrayPrototype()
                         ->children()
-                            ->scalarNode('hostname')->isRequired()->end()
-                            ->integerNode('port')->defaultValue(22)->end()
-                            ->scalarNode('username')->isRequired()->end()
-                            ->scalarNode('dir')->isRequired()->end()
+                            ->scalarNode('target')->isRequired()
+                                ->validate()
+                                    ->ifTrue(fn (mixed $value) => !\is_string($value) || (!preg_match(DeployRsyncCommand::TARGET_FILE_REGEX, $value) && !preg_match(DeployRsyncCommand::TARGET_SSH_REGEX, $value)))
+                                    ->thenInvalid('Invalid target')
+                                ->end()
+                            ->end()
                             ->arrayNode('rsync_options')->prototype('scalar')->end()->end()
                             ->scalarNode('ignore_file')->end()
                         ->end()