Merge pull request #292 from jbouzekri

Add support for uri in mongodump

Author: sebastianfeldmann

src/Backup/Source/Mongodump.php

@@ -35,6 +35,14 @@ class Mongodump extends SimulatorExecutable implements Simulator
      */
     private $useIPv6;
 
+    /**
+     * Uri to connect to
+     * --uri <uri>
+     *
+     * @var string
+     */
+    private $uri;
+
     /**
      * Host to connect to
      * --host <hostname:port>
@@ -113,6 +121,8 @@ public function setup(array $conf = [])
 
         $this->pathToMongodump = Util\Arr::getValue($conf, 'pathToMongodump', '');
         $this->useIPv6         = Util\Str::toBoolean(Util\Arr::getValue($conf, 'ipv6', ''), false);
+
+        $this->setupValidation();
     }
 
     /**
@@ -137,12 +147,32 @@ protected function setupSourceData(array $conf)
      */
     protected function setupCredentials(array $conf)
     {
+        $this->uri                    = Util\Arr::getValue($conf, 'uri', '');
         $this->host                   = Util\Arr::getValue($conf, 'host', '');
         $this->user                   = Util\Arr::getValue($conf, 'user', '');
         $this->password               = Util\Arr::getValue($conf, 'password', '');
         $this->authenticationDatabase = Util\Arr::getValue($conf, 'authenticationDatabase', '');
     }
 
+    /**
+     * Validate source setup
+     *
+     * @throws \phpbu\App\Exception
+     */
+    protected function setupValidation()
+    {
+        if (empty($this->uri)) {
+            return;
+        }
+
+        // If uri is set, cannot set other configurations
+        foreach (['user', 'host', 'password', 'authenticationDatabase', 'databases'] as $attr) {
+            if (!empty($this->{$attr})) {
+                throw new Exception("cannot specify $attr and uri");
+            }
+        }
+    }
+
     /**
      * Execute the backup.
      *
@@ -177,6 +207,7 @@ protected function createExecutable(Target $target) : Executable
         $executable = new Executable\Mongodump($this->pathToMongodump);
         $executable->dumpToDirectory($this->getDumpDir($target))
                    ->useIpv6($this->useIPv6)
+                   ->useUri($this->uri)
                    ->useHost($this->host)
                    ->credentials($this->user, $this->password, $this->authenticationDatabase)
                    ->dumpDatabases($this->databases)

src/Cli/Executable/Mongodump.php

@@ -36,6 +36,14 @@ class Mongodump extends Abstraction implements Executable
      */
     private $useIPv6;
 
+    /**
+     * Uri to connect to
+     * --uri <uri>
+     *
+     * @var string
+     */
+    private $uri;
+
     /**
      * Host to connect to
      * --host <hostname:port>
@@ -135,6 +143,18 @@ public function useIpv6(bool $bool) : Mongodump
         return $this;
     }
 
+    /**
+     * Set uri to dump from
+     *
+     * @param string $uri
+     * @return \phpbu\App\Cli\Executable\Mongodump
+     */
+    public function useUri(string $uri) : Mongodump
+    {
+        $this->uri = $uri;
+        return $this;
+    }
+
     /**
      * Set host to dump from.
      *
@@ -228,6 +248,7 @@ protected function createCommandLine() : CommandLine
 
         $cmd->addOption('--out', $this->dumpDir, ' ');
         $cmd->addOptionIfNotEmpty('--ipv6', $this->useIPv6, false);
+        $cmd->addOptionIfNotEmpty('--uri', $this->uri, true, ' ');
         $cmd->addOptionIfNotEmpty('--host', $this->host, true, ' ');
         $cmd->addOptionIfNotEmpty('--username', $this->user, true, ' ');
         $cmd->addOptionIfNotEmpty('--password', $this->password, true, ' ');

tests/phpbu/Backup/Source/MongodumpTest.php

@@ -75,4 +75,26 @@ public function testBackupFail()
         $mongodump->setup(['pathToMongodump' => PHPBU_TEST_BIN]);
         $mongodump->backup($target, $appResult);
     }
+
+    /**
+     * Tests Mongodump::backup
+     *
+     * @testWith ["user", "myuser"]
+     *           ["host", "myhost"]
+     *           ["password", "mypassword"]
+     *           ["authenticationDatabase", "myAuthenticationDatabase"]
+     */
+    public function testUriNotCompatibleWithOtherSettings($key, $value)
+    {
+        $this->expectException('phpbu\App\Exception');
+
+        $runner = $this->getRunnerMock();
+        $runner->expects($this->never())
+            ->method('run');
+
+        $conf = array_merge(['uri' => 'mymongouri'], [$key => $value]);
+
+        $mongo = new Mongodump($runner);
+        $mongo->setup($conf);
+    }
 }

tests/phpbu/Cli/Executable/MongodumpTest.php

@@ -152,4 +152,18 @@ public function testExcludeCollectionsWithPrefix()
             $mongo->getCommand()
         );
     }
+
+    /**
+     * Tests Mongodump::createCommandLine
+     */
+    public function testUri()
+    {
+        $mongo = new Mongodump(PHPBU_TEST_BIN);
+        $mongo->dumpToDirectory('./dump')->useUri('mymongouri');
+
+        $this->assertEquals(
+            PHPBU_TEST_BIN . '/mongodump --out \'./dump' . '\' --uri \'mymongouri\'',
+            $mongo->getCommand()
+        );
+    }
 }