MCLOUD-8063: ECE-Tools dump alternative location (#65)

Author: dyushkin

src/Command/DbDump.php

@@ -28,6 +28,7 @@ class DbDump extends Command
     public const NAME = 'db-dump';
     public const ARGUMENT_DATABASES = 'databases';
     public const OPTION_REMOVE_DEFINERS = 'remove-definers';
+    public const OPTION_DUMP_DIRECTORY = 'dump-directory';
 
     /**
      * @var DumpProcessor
@@ -78,6 +79,12 @@ protected function configure(): void
             InputOption::VALUE_NONE,
             'Remove definers from the database dump'
         );
+        $this->addOption(
+            self::OPTION_DUMP_DIRECTORY,
+            'a',
+            InputOption:: VALUE_REQUIRED,
+            'Use alternative directory for saving dump'
+        );
 
         parent::configure();
     }
@@ -116,7 +123,8 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $this->logger->info('Starting backup.');
             $this->dumpProcessor->execute(
                 (bool)$input->getOption(self::OPTION_REMOVE_DEFINERS),
-                $databases
+                $databases,
+                (string)$input->getOption(self::OPTION_DUMP_DIRECTORY)
             );
             $this->logger->info('Backup completed.');
         } catch (\Exception $exception) {

src/DB/DumpGenerator.php

@@ -85,14 +85,20 @@ public function __construct(
      * @param string $database
      * @param ConnectionInterface $connectionData
      * @param bool $removeDefiners
+     * @param string $alternativeDestination
      *
      * @throws UndefinedPackageException
      * @throws ShellException
      */
-    public function create(string $database, ConnectionInterface $connectionData, bool $removeDefiners)
-    {
+    public function create(
+        string $database,
+        ConnectionInterface $connectionData,
+        bool $removeDefiners,
+        string $alternativeDestination
+    ) {
         $dumpFileName = sprintf(self::DUMP_FILE_NAME_TEMPLATE, $database, time());
-        $temporaryDirectory = sys_get_temp_dir();
+        $temporaryDirectory = !empty($alternativeDestination) ? $alternativeDestination
+            : $this->directoryList->getVar();
         $dumpFile = $temporaryDirectory . '/' . $dumpFileName;
         $lockFile = $this->directoryList->getVar() . '/' . self::LOCK_FILE_NAME;
 

src/DB/DumpProcessor.php

@@ -126,13 +126,14 @@ public function __construct(
      *
      * @param array $databases
      * @param bool $removeDefiners
+     * @param string $alternativeDestination
      *
      * @throws ConfigException
      * @throws FileSystemException
      * @throws GenericException
      * @throws UndefinedPackageException
      */
-    public function execute(bool $removeDefiners, array $databases = [])
+    public function execute(bool $removeDefiners, array $databases = [], string $alternativeDestination = '')
     {
         try {
             if (empty($databases)) {
@@ -157,7 +158,8 @@ public function execute(bool $removeDefiners, array $databases = [])
                 $this->dumpGenerator->create(
                     self::DATABASE_MAP[$connection],
                     $this->connectionFactory->create($connection),
-                    $removeDefiners
+                    $removeDefiners,
+                    $alternativeDestination
                 );
             }
         } finally {

src/Test/Functional/Acceptance/BackupDbCest.php

@@ -118,7 +118,7 @@ private function partRunDbDumpWithoutSplitDbArch(CliTester $I)
             $this->expectedLogs,
             [
                 'INFO: Start creation DB dump for main database...',
-                'INFO: Finished DB dump for main database, it can be found here: /tmp/dump-main',
+                'INFO: Finished DB dump for main database, it can be found here: /app/var/dump-main',
             ]
         ));
         $I->doNotSeeInOutput(['quote', 'sales']);
@@ -153,11 +153,11 @@ private function partRunDbDumpWithSplitDbArch(CliTester $I)
             $this->expectedLogs,
             [
                 'INFO: Start creation DB dump for main database...',
-                'INFO: Finished DB dump for main database, it can be found here: /tmp/dump-main',
+                'INFO: Finished DB dump for main database, it can be found here: /app/var/dump-main',
                 'INFO: Start creation DB dump for quote database...',
-                'INFO: Finished DB dump for quote database, it can be found here: /tmp/dump-quote',
+                'INFO: Finished DB dump for quote database, it can be found here: /app/var/dump-quote',
                 'INFO: Start creation DB dump for sales database...',
-                'INFO: Finished DB dump for sales database, it can be found here: /tmp/dump-sales',
+                'INFO: Finished DB dump for sales database, it can be found here: /app/var/dump-sales',
             ]
         ));
 
@@ -167,9 +167,9 @@ private function partRunDbDumpWithSplitDbArch(CliTester $I)
             $this->expectedLogs,
             [
                 'INFO: Start creation DB dump for quote database...',
-                'INFO: Finished DB dump for quote database, it can be found here: /tmp/dump-quote',
+                'INFO: Finished DB dump for quote database, it can be found here: /app/var/dump-quote',
                 'INFO: Start creation DB dump for sales database...',
-                'INFO: Finished DB dump for sales database, it can be found here: /tmp/dump-sales',
+                'INFO: Finished DB dump for sales database, it can be found here: /app/var/dump-sales',
             ]
         ));
         $I->doNotSeeInOutput('main');

src/Test/Unit/DB/DumpGeneratorTest.php

@@ -132,7 +132,7 @@ public function testCreate(bool $removeDefiners)
                 $dumpFilePath,
                 $removeDefiners
             ));
-        $this->dumpGenerator->create('main', $this->connectionDataMock, $removeDefiners);
+        $this->dumpGenerator->create('main', $this->connectionDataMock, $removeDefiners, '');
     }
 
     /**
@@ -173,7 +173,7 @@ public function testCreateWithException()
             ))
             ->willThrowException($exception);
         $this->expectExceptionObject($exception);
-        $this->dumpGenerator->create('main', $this->connectionDataMock, false);
+        $this->dumpGenerator->create('main', $this->connectionDataMock, false, '');
     }
 
     public function testFailedCreationLockFile()
@@ -190,7 +190,7 @@ public function testFailedCreationLockFile()
             ->with('Could not get the lock file!');
         $this->shellMock->expects($this->never())
             ->method('execute');
-        $this->dumpGenerator->create('main', $this->connectionDataMock, false);
+        $this->dumpGenerator->create('main', $this->connectionDataMock, false, '');
     }
 
     public function testLockedFile()
@@ -207,7 +207,7 @@ public function testLockedFile()
             );
         $this->shellMock->expects($this->never())
             ->method('execute');
-        $this->dumpGenerator->create('main', $this->connectionDataMock, false);
+        $this->dumpGenerator->create('main', $this->connectionDataMock, false, '');
     }
 
     private function getDumpFilePath(string $type): string