Merge pull request #277 from jbouzekri

Pgdump sslmode

Author: sebastianfeldmann

.travis.yml

@@ -12,7 +12,7 @@ before_script:
   - if [ $TRAVIS_PHP_VERSION = "7.4" ]; then wget -O phpstan.phar https://github.com/phpstan/phpstan/releases/download/0.12.18/phpstan.phar ; fi
 
 script:
-  - php phpunit.phar --configuration ./build/travis-ci.phpunit.xml
+  - XDEBUG_MODE=coverage php phpunit.phar --configuration ./build/travis-ci.phpunit.xml
   - if [ $TRAVIS_PHP_VERSION = "7.4" ]; then php phpstan.phar analyse --no-progress -c phpstan.neon; fi
 
 notifications:

src/Backup/Source/Pgdump.php

@@ -169,6 +169,14 @@ class Pgdump extends SimulatorExecutable implements Simulator
      */
     private $noPrivileges;
 
+    /**
+     * Set SSL mode
+     * PGSSLMODE=allow pg_dump ...
+     *
+     * @var string
+     */
+    private $sslMode;
+
     /**
      * Setup
      *
@@ -196,6 +204,7 @@ private function setupConnection(array $conf)
         $this->port     = Util\Arr::getValue($conf, 'port', 0);
         $this->user     = Util\Arr::getValue($conf, 'user', '');
         $this->password = Util\Arr::getValue($conf, 'password', '');
+        $this->sslMode  = Util\Arr::getValue($conf, 'sslMode', '');
     }
 
     /**
@@ -264,6 +273,7 @@ protected function createExecutable(Target $target) : Executable
         $executable->credentials($this->user, $this->password)
                    ->useHost($this->host)
                    ->usePort($this->port)
+                   ->sslMode($this->sslMode)
                    ->dumpDatabase($this->database)
                    ->dumpSchemas($this->schemas)
                    ->excludeSchemas($this->excludeSchemas)

src/Cli/Executable/Pgdump.php

@@ -37,6 +37,14 @@ class Pgdump extends Abstraction implements Executable
      */
     private $port;
 
+    /**
+     * Set SSL mode
+     * PGSSLMODE=allow pg_dump ...
+     *
+     * @var string
+     */
+    private $sslMode;
+
     /**
      * User to connect with
      * --user=<username>
@@ -189,6 +197,20 @@ class Pgdump extends Abstraction implements Executable
         'tar'       => true,
     ];
 
+    /**
+     * List of available sslmode
+     *
+     * @var array
+     */
+    private $availableSslMode = [
+        'disable' => true,
+        'allow' => true,
+        'prefer' => true,
+        'require' => true,
+        'verify-ca' => true,
+        'verify-full' => true,
+    ];
+
     /**
      * Constructor.
      *
@@ -238,6 +260,21 @@ public function usePort(int $port) : Pgdump
         return $this;
     }
 
+    /**
+     * Set the sslmode
+     *
+     * @param string $sslMode
+     * @return Pgdump
+     */
+    public function sslMode(string $sslMode): Pgdump
+    {
+        if ($sslMode && !isset($this->availableSslMode[$sslMode])) {
+            throw new Exception('invalid sslMode');
+        }
+        $this->sslMode = $sslMode;
+        return $this;
+    }
+
     /**
      * Set database to dump.
      *
@@ -454,7 +491,8 @@ protected function createCommandLine() : CommandLine
     {
         $process  = new CommandLine();
         $password = $this->password ? 'PGPASSWORD=' . escapeshellarg($this->password) . ' ' : '';
-        $cmd      = new Cmd($password . $this->binary);
+        $sslMode  = $this->sslMode ? 'PGSSLMODE=' . escapeshellarg($this->sslMode) . ' ' : '';
+        $cmd      = new Cmd($sslMode . $password . $this->binary);
         $process->addCommand($cmd);
 
         // always disable password prompt

tests/phpbu/Backup/Source/InfluxdumpTest.php

@@ -115,7 +115,7 @@ public function testBackupFail()
         try {
             $influxd->backup($target, $appResult);
         } catch (Exception $e) {
-            $this->assertFileDoesNotExist($file);
+            $this->assertFileNotExists($file);
             throw $e;
         }
     }

tests/phpbu/Backup/Source/LdapdumpTest.php

@@ -200,7 +200,7 @@ public function testBackupFail()
         try {
             $ldap->backup($target, $appResult);
         } catch (Exception $e) {
-            $this->assertFileDoesNotExist($file);
+            $this->assertFileNotExists($file);
             throw $e;
         }
     }

tests/phpbu/Backup/Source/MysqldumpTest.php

@@ -338,7 +338,7 @@ public function testBackupFail()
         try {
             $mysqldump->backup($target, $appResult);
         } catch (Exception $e) {
-            $this->assertFileDoesNotExist($file);
+            $this->assertFileNotExists($file);
             throw $e;
         }
     }

tests/phpbu/Backup/Source/PgdumpTest.php

@@ -38,6 +38,23 @@ public function testDefault()
         );
     }
 
+    /**
+     * Tests Pgdump::getExecutable
+     */
+    public function testSslMode()
+    {
+        $target = $this->createTargetMock('foo.sql');
+        $pgDump = new Pgdump();
+        $pgDump->setup(['pathToPgdump' => PHPBU_TEST_BIN, 'sslMode' => 'require']);
+
+        $executable = $pgDump->getExecutable($target);
+
+        $this->assertEquals(
+            'PGSSLMODE=\'require\' ' . PHPBU_TEST_BIN . '/pg_dump -w --file=\'foo.sql\' --format=\'p\'',
+            $executable->getCommand()
+        );
+    }
+
     /**
      * Tests Pgdump::getExecutable
      */

tests/phpbu/Util/CliTest.php

@@ -181,10 +181,10 @@ public function testRemoveDir()
 
         Cli::removeDir($dirToDelete);
 
-        $this->assertFileDoesNotExist($file);
-        $this->assertFileDoesNotExist($fileInSub);
-        $this->assertFileDoesNotExist($subDir);
-        $this->assertFileDoesNotExist($dirToDelete);
+        $this->assertFileNotExists($file);
+        $this->assertFileNotExists($fileInSub);
+        $this->assertFileNotExists($subDir);
+        $this->assertFileNotExists($dirToDelete);
     }
 
     /**