Add 'protocol' option to mysqldump - issue #189

Author: sebastianfeldmann

src/Backup/Source/Mysqldump.php

@@ -43,6 +43,14 @@ class Mysqldump extends SimulatorExecutable implements Simulator
      */
     private $port;
 
+    /**
+     * Port to connect to
+     * --protocol <TCP|SOCKET|PIPE|MEMORY>
+     *
+     * @var string
+     */
+    private $protocol;
+
     /**
      * User to connect with
      * --user <username>
@@ -183,6 +191,7 @@ public function setup(array $conf = [])
         $this->pathToMysqldump   = Util\Arr::getValue($conf, 'pathToMysqldump', '');
         $this->host              = Util\Arr::getValue($conf, 'host', '');
         $this->port              = Util\Arr::getValue($conf, 'port', 0);
+        $this->protocol          = Util\Arr::getValue($conf, 'protocol', '');
         $this->user              = Util\Arr::getValue($conf, 'user', '');
         $this->password          = Util\Arr::getValue($conf, 'password', '');
         $this->gtidPurged        = Util\Arr::getValue($conf, 'gtidPurged', '');
@@ -256,6 +265,7 @@ protected function createExecutable(Target $target) : Executable
         $executable->credentials($this->user, $this->password)
                    ->useHost($this->host)
                    ->usePort($this->port)
+                   ->useProtocol($this->protocol)
                    ->useQuickMode($this->quick)
                    ->lockTables($this->lockTables)
                    ->dumpBlobsHexadecimal($this->hexBlob)

src/Cli/Executable/Mysqldump.php

@@ -39,6 +39,14 @@ class Mysqldump extends Abstraction implements Executable
      */
     private $port;
 
+    /**
+     * The connection protocol
+     * --protocol
+     *
+     * @var string
+     */
+    private $protocol;
+
     /**
      * User to connect with
      * --user <username>
@@ -227,6 +235,18 @@ public function usePort(int $port) : Mysqldump
         return $this;
     }
 
+    /**
+     * Set the connection protocol.
+     *
+     * @param  string $protocol
+     * @return \phpbu\App\Cli\Executable\Mysqldump
+     */
+    public function useProtocol(string $protocol) : Mysqldump
+    {
+        $this->protocol = $protocol;
+        return $this;
+    }
+
     /**
      * Use '-q' quick mode.
      *
@@ -435,6 +455,7 @@ protected function createCommandLine() : CommandLine
         $cmd->addOptionIfNotEmpty('--password', $this->password);
         $cmd->addOptionIfNotEmpty('--host', $this->host);
         $cmd->addOptionIfNotEmpty('--port', $this->port);
+        $cmd->addOptionIfNotEmpty('--protocol', $this->protocol);
         $cmd->addOptionIfNotEmpty('--lock-tables', $this->lockTables, false);
         $cmd->addOptionIfNotEmpty('--single-transaction', $this->singleTransaction, false);
         $cmd->addOptionIfNotEmpty('-q', $this->quick, false);

tests/phpbu/Backup/Source/MysqldumpTest.php

@@ -99,6 +99,20 @@ public function testPort()
         $this->assertEquals(PHPBU_TEST_BIN . '/mysqldump --port=\'4711\' --all-databases', $executable->getCommand());
     }
 
+    /**
+     * Tests Mysqldump::getExecutable
+     */
+    public function testProtocol()
+    {
+        $target    = $this->createTargetMock();
+        $mysqldump = new Mysqldump();
+        $mysqldump->setup(['pathToMysqldump' => PHPBU_TEST_BIN, 'protocol' => 'TCP']);
+
+        $executable = $mysqldump->getExecutable($target);
+
+        $this->assertEquals(PHPBU_TEST_BIN . '/mysqldump --protocol=\'TCP\' --all-databases', $executable->getCommand());
+    }
+
     /**
      * Tests Mysqldump::getExecutable
      */

tests/phpbu/Cli/Executable/MysqldumpTest.php

@@ -30,7 +30,7 @@ public function testDefault()
     /**
      * Tests Mysqldump::getCommandPrintable
      */
-    public function __testDefaultPrintable()
+    public function testDefaultPrintable()
     {
         $mysqldump = new Mysqldump(PHPBU_TEST_BIN);
         $cmd       = $mysqldump->getCommandPrintable();
@@ -139,6 +139,18 @@ public function testUsePort()
         $this->assertEquals(PHPBU_TEST_BIN . '/mysqldump --port=\'1234\' --all-databases', $cmd);
     }
 
+    /**
+     * Tests Mysqldump::useProtocol
+     */
+    public function testUseProtocol()
+    {
+        $mysqldump = new Mysqldump(PHPBU_TEST_BIN);
+        $mysqldump->useProtocol('TCP');
+        $cmd       = $mysqldump->getCommand();
+
+        $this->assertEquals(PHPBU_TEST_BIN . '/mysqldump --protocol=\'TCP\' --all-databases', $cmd);
+    }
+
     /**
      * Tests Mysqldump::getCommand
      */