Merge branch 'main' into 6.0

Author: sebastianfeldmann

.github/workflows/integration.yml

@@ -3,7 +3,7 @@ name: "Integration"
 on:
   push:
     branches:
-      - "main"
+      - "*"
   pull_request:
 
 jobs:
@@ -12,10 +12,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        php: ['7.3', '7.4', '8.0']
-        include:
-          - php: "8.0"
-            composeroptions: "--ignore-platform-req=php"
+        php: ['7.3', '7.4', '8.0', '8.1']
     steps:
     - uses: actions/checkout@master
 
@@ -29,6 +26,9 @@ jobs:
     - name: PHP Version
       run: php -v
 
+    - name : Install tooling
+      run : GITHUB_AUTH_TOKEN=${{ secrets.GITHUB_TOKEN }} phive --no-progress --home ./.phive install --force-accept-unsigned --trust-gpg-keys 4AA394086372C20A,31C7E470E2138192,8E730BA25823D8B5,CF1A108D0E7AE720,2A8299CE842DD38C,661E97400F658E25
+
     - name: Update composer
       run: composer self-update
 
@@ -38,9 +38,6 @@ jobs:
     - name: Install dependencies
       run: composer install --prefer-dist --no-progress --no-suggest ${{ matrix.composeroptions }}
 
-    - name: Install tooling
-      run: GITHUB_AUTH_TOKEN=${{ secrets.GITHUB_TOKEN }} phive --no-progress --home ./.phive install --force-accept-unsigned --trust-gpg-keys 4AA394086372C20A,31C7E470E2138192,8E730BA25823D8B5,CF1A108D0E7AE720,2A8299CE842DD38C
-
     - name: Execute unit tests
       run: tools/phpunit --configuration=phpunit.xml
 

build.xml

@@ -135,7 +135,14 @@
       </fileset>
     </copy>
 
-    <!-- AMAZON AWS -->
+    <!-- SYMFONY -->
+    <copy todir="${basedir}/build/phar/lib/symfony/">
+      <fileset dir="${basedir}/vendor/symfony/">
+         <include name="**/*.php"/>
+      </fileset>
+    </copy>
+
+      <!-- AMAZON AWS -->
     <copy file="${basedir}/vendor/aws/aws-sdk-php/LICENSE" tofile="${basedir}/build/phar/lib/aws-sdk/LICENSE"/>
     <copy todir="${basedir}/build/phar/lib/aws-sdk">
       <fileset dir="${basedir}/vendor/aws/aws-sdk-php/src">
@@ -450,16 +457,6 @@
       </fileset>
     </copy>
 
-    <!-- Symfony libs -->
-    <copy file="${basedir}/vendor/symfony/options-resolver/LICENSE"
-          tofile="${basedir}/build/phar/lib/symfony/options-resolver/LICENSE"/>
-    <copy todir="${basedir}/build/phar/lib/symfony/options-resolver">
-      <fileset dir="${basedir}/vendor/symfony/options-resolver">
-        <include name="**/*.php"/>
-        <exclude name="**/Test*"/>
-      </fileset>
-    </copy>
-
     <!-- PHP-HTTP -->
     <copy file="${basedir}/vendor/php-http/httplug/LICENSE"
           tofile="${basedir}/build/phar/lib/php-http/httplug/LICENSE"/>

build/phar-autoload.php.in

@@ -48,7 +48,11 @@ if ($execute) {
     // dropbox collection helper
     require __PHPBU_PHAR_ROOT__ . '/lib/tightenco/Collect/Support/helpers.php';
     //require __PHPBU_PHAR_ROOT__ . '/lib/tightenco/Collect/Support/alias.php';
-    
+    // load the symfony polyfills
+    require __PHPBU_PHAR_ROOT__ . '/lib/symfony/polyfill-ctype/bootstrap.php';
+    require __PHPBU_PHAR_ROOT__ . '/lib/symfony/polyfill-mbstring/bootstrap.php';
+    require __PHPBU_PHAR_ROOT__ . '/lib/symfony/polyfill-php80/bootstrap.php';
+
     phpbu\App\Cmd::main();
 }
 

composer.json

@@ -55,7 +55,7 @@
   "require-dev": {
     "sebastianfeldmann/git": "^3.2",
     "sebastianfeldmann/ftp": "^0.9",
-    "guzzlehttp/guzzle": "^5.3.3|^6.2.1|^7.0.0",
+    "guzzlehttp/guzzle": "^5.3.4|^6.5.8|^7.5.0",
     "aws/aws-sdk-php": "^3.10",
     "kunalvarma05/dropbox-php-sdk": "^0.2",
     "phpseclib/phpseclib": "^2.0",
@@ -65,7 +65,6 @@
     "php-opencloud/openstack": "^3.0",
     "arhitector/yandex": "^2.0",
     "microsoft/azure-storage-blob": "^1.4",
-    "captainhook/captainhook": "^5.0",
     "phpmailer/phpmailer": "^6.0"
   },
   "suggest": {
@@ -91,7 +90,7 @@
     }
   },
   "scripts": {
-    "post-autoload-dump": "vendor/bin/captainhook install -f -s",
+    "post-autoload-dump": "tools/captainhook install -f -s",
     "setup": "phive install",
     "test": "tools/phpunit",
     "analyse": "tools/phpstan analyse",

phive.xml

@@ -1,7 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phive xmlns="https://phar.io/phive">
-  <phar name="phpunit" version="^9.4.3" location="./tools/phpunit" copy="true" installed="9.5.19"/>
+  <phar name="captainhook" version="^5.10.0" location="./tools/captainhook" copy="true" installed="5.10.11"/>
+  <phar name="phpunit" version="^9.4.3" location="./tools/phpunit" copy="true" installed="9.5.21"/>
   <phar name="phpab" version="^1.20.0" location="./tools/phpab" copy="true" installed="1.27.1"/>
-  <phar name="phpcs" version="^3.5.2" location="./tools/phpcs" copy="true" installed="3.6.2"/>
+  <phar name="phpcs" version="^3.5.2" location="./tools/phpcs" copy="true" installed="3.7.1"/>
   <phar name="phpstan" version="^0.12.2" location="./tools/phpstan" copy="true" installed="0.12.99"/>
 </phive>

phpbu.xsd

@@ -122,6 +122,7 @@
     <xs:attribute name="bootstrap" type="xs:anyURI"/>
     <xs:attribute name="verbose" type="xs:boolean" default="false"/>
     <xs:attribute name="colors" type="xs:boolean" default="false"/>
+    <xs:attribute name="debug" type="xs:boolean" default="false"/>
   </xs:attributeGroup>
 
   <xs:group name="configGroup">

src/Backup/Source/Mysqldump.php

@@ -4,6 +4,8 @@
 use phpbu\App\Backup\Restore\Plan;
 use phpbu\App\Backup\Target;
 use phpbu\App\Cli\Executable;
+use phpbu\App\Cli\Executable\Mysql;
+use phpbu\App\Cli\Executable\Mysqlimport;
 use phpbu\App\Exception;
 use phpbu\App\Result;
 use phpbu\App\Util;
@@ -132,7 +134,7 @@ class Mysqldump extends SimulatorExecutable implements Simulator, Restorable
      * Lock tables option
      * --lock-tables
      *
-     * @var bool
+     * @var string
      */
     private $lockTables;
 
@@ -238,7 +240,7 @@ public function setup(array $conf = [])
         $this->sslCa              = Util\Arr::getValue($conf, 'sslCa', '');
         $this->hexBlob            = Util\Str::toBoolean(Util\Arr::getValue($conf, 'hexBlob', ''), false);
         $this->quick              = Util\Str::toBoolean(Util\Arr::getValue($conf, 'quick', ''), false);
-        $this->lockTables         = Util\Str::toBoolean(Util\Arr::getValue($conf, 'lockTables', ''), false);
+        $this->lockTables         = Util\Arr::getValue($conf, 'lockTables', '');
         $this->singleTransaction  = Util\Str::toBoolean(Util\Arr::getValue($conf, 'singleTransaction', ''), false);
         $this->compress           = Util\Str::toBoolean(Util\Arr::getValue($conf, 'compress', ''), false);
         $this->skipExtendedInsert = Util\Str::toBoolean(Util\Arr::getValue($conf, 'skipExtendedInsert', ''), false);
@@ -270,11 +272,11 @@ protected function setupSourceData(array $conf)
     /**
      * Execute the backup
      *
-     * @see    \phpbu\App\Backup\Source
-     * @param  \phpbu\App\Backup\Target $target
+     * @param  Target $target
      * @param  \phpbu\App\Result        $result
-     * @return \phpbu\App\Backup\Source\Status
+     * @return Status
      * @throws \phpbu\App\Exception
+     *@see    \phpbu\App\Backup\Source
      */
     public function backup(Target $target, Result $result) : Status
     {
@@ -318,9 +320,9 @@ public function backup(Target $target, Result $result) : Status
     /**
      * Restore the backup
      *
-     * @param  \phpbu\App\Backup\Target       $target
-     * @param  \phpbu\App\Backup\Restore\Plan $plan
-     * @return \phpbu\App\Backup\Source\Status
+     * @param Target $target
+     * @param Plan $plan
+     * @return Status
      */
     public function restore(Target $target, Plan $plan): Status
     {
@@ -353,8 +355,8 @@ public function restore(Target $target, Plan $plan): Status
     /**
      * Create the Executable to run the mysqldump command.
      *
-     * @param  \phpbu\App\Backup\Target $target
-     * @return \phpbu\App\Cli\Executable
+     * @param Target $target
+     * @return Executable
      */
     protected function createExecutable(Target $target) : Executable
     {
@@ -391,8 +393,8 @@ protected function createExecutable(Target $target) : Executable
     /**
      * Create backup status.
      *
-     * @param  \phpbu\App\Backup\Target $target
-     * @return \phpbu\App\Backup\Source\Status
+     * @param Target $target
+     * @return Status
      */
     protected function createStatus(Target $target) : Status
     {
@@ -414,7 +416,7 @@ protected function createStatus(Target $target) : Status
     /**
      * Can compression be handled via pipe operator.
      *
-     * @param  \phpbu\App\Backup\Target $target
+     * @param Target $target
      * @return bool
      */
     private function isHandlingCompression(Target $target) : bool
@@ -425,7 +427,7 @@ private function isHandlingCompression(Target $target) : bool
     /**
      * Return dump target path.
      *
-     * @param  \phpbu\App\Backup\Target $target
+     * @param Target $target
      * @return string
      */
     private function getDumpTarget(Target $target) : string
@@ -436,11 +438,11 @@ private function getDumpTarget(Target $target) : string
     /**
      * Create the Executable to run the mysql command.
      *
-     * @return \phpbu\App\Cli\Executable\Mysql
+     * @return Mysql
      */
-    private function createMysqlExecutable(): Executable\Mysql
+    private function createMysqlExecutable(): Mysql
     {
-        $executable = new Executable\Mysql($this->pathToMysql);
+        $executable = new Mysql($this->pathToMysql);
         $executable->credentials($this->user, $this->password)
             ->useHost($this->host)
             ->usePort($this->port)
@@ -457,11 +459,11 @@ private function createMysqlExecutable(): Executable\Mysql
      * @param string $sourceFilename
      * @param string $targetDatabase
      *
-     * @return \phpbu\App\Cli\Executable\Mysqlimport
+     * @return Mysqlimport
      */
-    private function createMysqlimportExecutable(string $sourceFilename, string $targetDatabase): Executable\Mysqlimport
+    private function createMysqlimportExecutable(string $sourceFilename, string $targetDatabase): Mysqlimport
     {
-        $executable = new Executable\Mysqlimport($this->pathToMysqlimport);
+        $executable = new Mysqlimport($this->pathToMysqlimport);
         $executable->setSourceAndTarget($sourceFilename, $targetDatabase)
             ->credentials($this->user, $this->password)
             ->useHost($this->host)

src/Backup/Source/Tar.php

@@ -224,9 +224,6 @@ protected function setupPath(array $conf)
             throw new Exception('path option is mandatory');
         }
         $this->path = Util\Path::toAbsolutePath($path, Configuration::getWorkingDirectory());
-        if (!file_exists($this->path)) {
-            throw new Exception('could not find directory to compress');
-        }
     }
 
     /**
@@ -329,10 +326,14 @@ private function handleIncrementalBackup(Executable\Tar $executable): void
      *
      * @throws \phpbu\App\Exception
      */
-    private function validatePath()
+    private function validatePath(): void
     {
+        if (!file_exists($this->path)) {
+            throw new Exception(sprintf('Could not find directory to compress at "%s".', $this->path));
+        }
+
         if (!is_dir($this->path)) {
-            throw new Exception('path to compress has to be a directory');
+            throw new Exception(sprintf('Cannot compress at path "%s": not a directory.', $this->path));
         }
     }
 

src/Backup/Sync/Sftp.php

@@ -63,8 +63,8 @@ public function setup(array $config)
     {
         // make sure either password or private key is configured
         if (!Util\Arr::isSetAndNotEmptyString($config, 'password')
-         && !Util\Arr::isSetAndNotEmptyString($config, 'private_key')) {
-            throw new Exception('\'password\' or \'private_key\' must be presented');
+         && !Util\Arr::isSetAndNotEmptyString($config, 'key')) {
+            throw new Exception('\'password\' or \'key\' must be presented');
         }
         parent::setup($config);