Merge pull request #230 from angelfs

Add ssl-ca option to mysqldump

Author: sebastianfeldmann

doc/config/source/mysqldump.json

@@ -18,6 +18,7 @@
     "skipTriggers": false,
     "routines": true,
     "gtidPurged": "AUTO",
+    "sslCa": "/var/www/html/BaltimoreCyberTrustRoot.crt.pem",
     "pathToMysqldump": "/path/to/custom/bin"
   }
 }

doc/config/source/mysqldump.xml

@@ -51,6 +51,9 @@
   <!-- optional, default=none, accepted=ON,OFF,AUTO -->
   <option name="gtidPurged" value="ON" />
 
+  <!-- optional, default=none -->
+  <option name="sslCa" value="/var/www/html/BaltimoreCyberTrustRoot.crt.pem" />
+
   <!-- define your custom mysqldump executable location -->
   <option name="pathToMysqldump" value="/path/to/custom/bin" />
 </source>

src/Backup/Source/Mysqldump.php

@@ -184,6 +184,14 @@ class Mysqldump extends SimulatorExecutable implements Simulator, Restorable
      */
     private $gtidPurged;
 
+    /**
+     * SSL CA
+     * --ssl-ca
+     *
+     * @var string
+     */
+    private $sslCa;
+
     /**
      * Dump procedures and functions
      * --routines
@@ -220,6 +228,7 @@ public function setup(array $conf = [])
         $this->user               = Util\Arr::getValue($conf, 'user', '');
         $this->password           = Util\Arr::getValue($conf, 'password', '');
         $this->gtidPurged         = Util\Arr::getValue($conf, 'gtidPurged', '');
+        $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);
@@ -331,6 +340,7 @@ protected function createExecutable(Target $target) : Executable
                    ->lockTables($this->lockTables)
                    ->dumpBlobsHexadecimal($this->hexBlob)
                    ->addGTIDStatement($this->gtidPurged)
+                   ->useSslCa($this->sslCa)
                    ->useCompression($this->compress)
                    ->skipExtendedInsert($this->skipExtendedInsert)
                    ->dumpTables($this->tables)

src/Cli/Executable/Mysqldump.php

@@ -140,6 +140,14 @@ class Mysqldump extends Abstraction implements Executable
      */
     private $gtidPurged;
 
+    /**
+     * SSL CA
+     * --ssl-ca
+     *
+     * @var string
+     */
+    private $sslCa;
+
     /**
      * Table separated data files
      * --tab
@@ -399,6 +407,18 @@ public function addGTIDStatement(string $purge)
         return $this;
     }
 
+    /**
+     * Allow to use SSL CA option
+     *
+     * @param  string $sslCa
+     * @return \phpbu\App\Cli\Executable\Mysqldump
+     */
+    public function useSslCa(string $sslCa)
+    {
+        $this->sslCa = $sslCa;
+        return $this;
+    }
+
     /**
      * Produce table separated data files
      *
@@ -483,6 +503,7 @@ protected function createCommandLine() : CommandLine
         $cmd->addOptionIfNotEmpty('--skip-extended-insert', $this->skipExtendedInsert, false);
         $cmd->addOptionIfNotEmpty('--hex-blob', $this->hexBlob, false);
         $cmd->addOptionIfNotEmpty('--set-gtid-purged', $this->gtidPurged);
+        $cmd->addOptionIfNotEmpty('--ssl-ca', $this->sslCa);
         $cmd->addOptionIfNotEmpty('--routines', $this->routines, false);
         $cmd->addOptionIfNotEmpty('--skip-triggers', $this->skipTriggers, false);
 

tests/phpbu/Backup/Source/MysqldumpTest.php

@@ -150,6 +150,23 @@ public function testGtidPurged()
         );
     }
 
+    /**
+     * Tests Mysqldump::getExecutable
+     */
+    public function testSslCa()
+    {
+        $target    = $this->createTargetMock('/tmp/foo');
+        $mysqldump = new Mysqldump();
+        $mysqldump->setup(['pathToMysqldump' => PHPBU_TEST_BIN, 'sslCa' => '/var/www/html/BaltimoreCyberTrustRoot.crt.pem']);
+
+        $executable = $mysqldump->getExecutable($target);
+
+        $this->assertEquals(
+            PHPBU_TEST_BIN . '/mysqldump --ssl-ca=\'/var/www/html/BaltimoreCyberTrustRoot.crt.pem\' --all-databases > /tmp/foo',
+            $executable->getCommand()
+        );
+    }
+
     /**
      * Tests Mysqldump::getExecutable
      */

tests/phpbu/Cli/Executable/MysqldumpTest.php

@@ -254,6 +254,18 @@ public function testGTIDInvalid()
         );
     }
 
+    /**
+     * Tests Mysqldump::getCommand
+     */
+    public function testUseSslCa()
+    {
+        $mysqldump = new Mysqldump(PHPBU_TEST_BIN);
+        $mysqldump->useSslCa('/var/www/html/BaltimoreCyberTrustRoot.crt.pem');
+        $cmd       = $mysqldump->getCommand();
+
+        $this->assertEquals(PHPBU_TEST_BIN . '/mysqldump --ssl-ca=\'/var/www/html/BaltimoreCyberTrustRoot.crt.pem\' --all-databases', $cmd);
+    }
+
     /**
      * Tests Mysqldump::getCommand
      */