Merge pull request #400 from erkiaas/main

Add limit option to Elasticdump

Author: sebastianfeldmann

src/Backup/Source/Elasticdump.php

@@ -64,6 +64,14 @@ class Elasticdump extends SimulatorExecutable implements Simulator
      */
     private $type;
 
+    /**
+     * Number of documents to dump.
+     * --limit
+     *
+     * @var string
+     */
+    private $limit;
+
     /**
      * Setup
      *
@@ -89,6 +97,7 @@ protected function setupSourceData(array $conf)
     {
         $this->index = Util\Arr::getValue($conf, 'index', '');
         $this->type  = Util\Arr::getValue($conf, 'type', '');
+        $this->limit = Util\Arr::getValue($conf, 'limit', '');
     }
 
     /**
@@ -126,6 +135,7 @@ protected function createExecutable(Target $target) : Executable
                    ->credentials($this->user, $this->password)
                    ->dumpIndex($this->index)
                    ->dumpType($this->type)
+                   ->limit($this->limit)
                    ->dumpTo($target->getPathnamePlain());
         return $executable;
     }

src/Cli/Executable/Elasticdump.php

@@ -65,6 +65,14 @@ class Elasticdump extends Abstraction
      */
     private $dumpPathname;
 
+    /**
+     * Number of documents to dump.
+     * --limit
+     *
+     * @var string
+     */
+    private $limit;
+
     /**
      * Constructor.
      *
@@ -124,6 +132,18 @@ public function dumpTo($pathname)
         return $this;
     }
 
+    /**
+     * Set limit of documents to dump.
+     *
+     * @param  string $limit
+     * @return \phpbu\App\Cli\Executable\Elasticdump
+     */
+    public function limit($limit)
+    {
+        $this->limit = $limit;
+        return $this;
+    }
+
     /**
      * Set elastic credentials.
      *
@@ -159,6 +179,7 @@ protected function createCommandLine() : CommandLine
 
         $cmd->addOption('--input', $this->generateNodeUrl($this->host, $this->user, $this->password, $this->index));
         $cmd->addOptionIfNotEmpty('--type', $this->type);
+        $cmd->addOptionIfNotEmpty('--limit', $this->limit);
         $cmd->addOption('--output', $this->dumpPathname);
 
         return $process;

tests/phpbu/Backup/Source/ElasticdumpTest.php

@@ -52,6 +52,21 @@ public function testUser()
         $this->assertEquals('"' . PHPBU_TEST_BIN . '/' . $expected, $executable->getCommand());
     }
 
+    /**
+     * Tests Elasticdump::getExecutable
+     */
+    public function testLimit()
+    {
+        $target      = $this->createTargetMock('backup.json');
+        $elasticdump = new Elasticdump();
+        $elasticdump->setup(['pathToElasticdump' => PHPBU_TEST_BIN, 'limit' => '100']);
+
+        $executable = $elasticdump->getExecutable($target);
+        $expected   = 'elasticdump" --input=\'http://localhost:9200/\' --limit=\'100\' --output=\'backup.json\'';
+
+        $this->assertEquals('"' . PHPBU_TEST_BIN . '/' . $expected, $executable->getCommand());
+    }
+
     /**
      * Tests Elasticdump::backup
      */

tests/phpbu/Cli/Executable/ElasticdumpTest.php

@@ -77,6 +77,18 @@ public function testType()
         $this->assertEquals('"' . PHPBU_TEST_BIN . '/' . $expected, $elastic->getCommand());
     }
 
+    /**
+     * Tests Elasticdump::createCommand
+     */
+    public function testLimit()
+    {
+        $expected = 'elasticdump" --input=\'http://localhost:9200/\' --limit=\'500\' --output=\'./foo.json\'';
+        $elastic  = new Elasticdump(PHPBU_TEST_BIN);
+        $elastic->useHost('localhost:9200')->limit('500')->dumpTo('./foo.json');
+
+        $this->assertEquals('"' . PHPBU_TEST_BIN . '/' . $expected, $elastic->getCommand());
+    }
+
     /**
      * Tests Elasticdump::createCommandLine
      */