Added mysqldump '--hex-blob' option

Author: sebastianfeldmann

doc/config/source/mysqldump.xml

@@ -4,7 +4,7 @@
   <option name="showStdErr" value="true" />
 
   <!-- optional, default=localhost -->
-  <option name="host" value="myhost" />
+  <option name="host" value="myHost" />
 
   <!-- optional, default=system user -->
   <option name="user" value="myUserName" />
@@ -29,4 +29,7 @@
 
   <!-- optional, default=false -->
   <option name="compress" value="true" />
+
+  <!-- optional, default=false -->
+  <option name="hexBlob" value="true" />
 </source>

src/Backup/Source/Mysqldump.php

@@ -106,6 +106,14 @@ class Mysqldump extends Cli implements Source
      */
     private $compress;
 
+    /**
+     * Dump blob fields as hex.
+     * --hex-blob
+     *
+     * @var boolean
+     */
+    private $hexBlob;
+
     /**
      * Dump only table structures
      * --no-data
@@ -136,6 +144,7 @@ public function setup(array $conf = array())
         $this->user            = Util\Arr::getValue($conf, 'user');
         $this->password        = Util\Arr::getValue($conf, 'password');
         $this->showStdErr      = Util\Str::toBoolean(Util\Arr::getValue($conf, 'showStdErr', ''), false);
+        $this->hexBlob         = Util\Str::toBoolean(Util\Arr::getValue($conf, 'hexBlob', ''), false);
         $this->quick           = Util\Str::toBoolean(Util\Arr::getValue($conf, 'quick', ''), false);
         $this->compress        = Util\Str::toBoolean(Util\Arr::getValue($conf, 'compress', ''), false);
         $this->noData          = Util\Str::toBoolean(Util\Arr::getValue($conf, 'noData', ''), false);
@@ -191,6 +200,7 @@ public function getExecutable(Target $target)
             $this->executable->credentials($this->user, $this->password)
                              ->useHost($this->host)
                              ->useQuickMode($this->quick)
+                             ->dumpBlobsHexadecimal($this->hexBlob)
                              ->useCompression($this->compress)
                              ->dumpTables($this->tables)
                              ->dumpDatabases($this->databases)

src/Cli/Executable/Mysqldump.php

@@ -98,6 +98,7 @@ class Mysqldump extends Abstraction implements Executable
 
     /**
      * Dump blob fields as hex.
+     * --hex-blob
      *
      * @var boolean
      */
@@ -171,6 +172,18 @@ public function useCompression($bool)
         return $this;
     }
 
+    /**
+     * Use '--hex-blob' to encode binary fields.
+     *
+     * @param  boolean $bool
+     * @return \phpbu\App\Cli\Executable\Mysqldump
+     */
+    public function dumpBlobsHexadecimal($bool)
+    {
+        $this->hexBlob = $bool;
+        return $this;
+    }
+
     /**
      * Set tables to dump.
      *

tests/phpbu/Backup/Source/MysqldumpTest.php

@@ -53,6 +53,21 @@ public function testDefault()
         $this->assertEquals($path . '/mysqldump --all-databases 2> /dev/null', $cmd);
     }
 
+    /**
+     * Tests Mysqldump::getExecutable
+     */
+    public function testHexBlob()
+    {
+        $target = $this->getTargetMock();
+        $path   = realpath(__DIR__ . '/../../../_files/bin');
+        $this->mysqldump->setup(array('pathToMysqldump' => $path, 'hexBlob' => 'true'));
+
+        $executable = $this->mysqldump->getExecutable($target);
+        $cmd        = $executable->getCommandLine();
+
+        $this->assertEquals($path . '/mysqldump --hex-blob --all-databases 2> /dev/null', $cmd);
+    }
+
     /**
      * Tests Mysqldump::backup
      */

tests/phpbu/Cli/Executable/MysqldumpTest.php

@@ -26,6 +26,19 @@ public function testDefault()
         $this->assertEquals($path . '/mysqldump --all-databases 2> /dev/null', $cmd);
     }
 
+    /**
+     * Tests Mysqldump::dumpBlobsHexadecimal
+     */
+    public function testHexBlob()
+    {
+        $path      = realpath(__DIR__ . '/../../../_files/bin');
+        $mysqldump = new Mysqldump($path);
+        $mysqldump->dumpBlobsHexadecimal(true);
+        $cmd       = $mysqldump->getCommandLine();
+
+        $this->assertEquals($path . '/mysqldump --hex-blob --all-databases 2> /dev/null', $cmd);
+    }
+
     /**
      * Tests Mysqldump::getCommandLine
      */