MAGECLOUD-343: Method for exporting a DB Backup of production site

src/App/Container.php

@@ -6,15 +6,19 @@
 namespace Magento\MagentoCloud\App;
 
 use Magento\MagentoCloud\Command\Build;
+use Magento\MagentoCloud\Command\DbDump;
 use Magento\MagentoCloud\Command\Deploy;
 use Magento\MagentoCloud\Command\ConfigDump;
 use Magento\MagentoCloud\Command\PostDeploy;
 use Magento\MagentoCloud\Config\ValidatorInterface;
 use Magento\MagentoCloud\Config\Validator as ConfigValidator;
+use Magento\MagentoCloud\DB\Data\ConnectionInterface;
+use Magento\MagentoCloud\DB\Data\ReadConnection;
 use Magento\MagentoCloud\Filesystem\DirectoryCopier;
 use Magento\MagentoCloud\Process\ProcessInterface;
 use Magento\MagentoCloud\Process\ProcessComposite;
 use Magento\MagentoCloud\Process\Build as BuildProcess;
+use Magento\MagentoCloud\Process\DbDump as DbDumpProcess;
 use Magento\MagentoCloud\Process\Deploy as DeployProcess;
 use Magento\MagentoCloud\Process\ConfigDump as ConfigDumpProcess;
 use Magento\MagentoCloud\Process\PostDeploy as PostDeployProcess;
@@ -253,6 +257,18 @@ function () use ($root, $config) {
                     ],
                 ]);
             });
+        $this->container->when(DbDump::class)
+            ->needs(ProcessInterface::class)
+            ->give(function () {
+                return $this->container->makeWith(ProcessComposite::class, [
+                    'processes' => [
+                        $this->container->make(DbDumpProcess\DbDump::class),
+                    ],
+                ]);
+            });
+        $this->container->when(DbDumpProcess\DbDump::class)
+            ->needs(ConnectionInterface::class)
+            ->give(ReadConnection::class);
         $this->container->when(PostDeploy::class)
             ->needs(ProcessInterface::class)
             ->give(function () {

src/Application.php

@@ -9,6 +9,7 @@
 use Magento\MagentoCloud\Command\Build;
 use Magento\MagentoCloud\Command\Deploy;
 use Magento\MagentoCloud\Command\ConfigDump;
+use Magento\MagentoCloud\Command\DbDump;
 use Magento\MagentoCloud\Command\PostDeploy;
 use Psr\Container\ContainerInterface;
 
@@ -54,6 +55,7 @@ protected function getDefaultCommands()
                 $this->container->get(Build::class),
                 $this->container->get(Deploy::class),
                 $this->container->get(ConfigDump::class),
+                $this->container->get(DbDump::class),
                 $this->container->get(PostDeploy::class),
             ]
         );

src/Command/DbDump.php

@@ -0,0 +1,69 @@
+<?php
+/**
+ * Copyright © Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\MagentoCloud\Command;
+
+use Magento\MagentoCloud\Process\ProcessInterface;
+use Psr\Log\LoggerInterface;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+/**
+ * Class DbDump for safely creating backup of database
+ */
+class DbDump extends Command
+{
+    const NAME = 'db-dump';
+
+    /**
+     * @var LoggerInterface
+     */
+    private $logger;
+
+    /**
+     * @var ProcessInterface
+     */
+    private $process;
+
+    /**
+     * @param ProcessInterface $process
+     * @param LoggerInterface $logger
+     */
+    public function __construct(ProcessInterface $process, LoggerInterface $logger)
+    {
+        $this->process = $process;
+        $this->logger = $logger;
+
+        parent::__construct();
+    }
+
+    /**
+     * @inheritdoc
+     */
+    protected function configure()
+    {
+        $this->setName(self::NAME)
+            ->setDescription('Creates backup of database');
+
+        parent::configure();
+    }
+
+    /**
+     * @inheritdoc
+     */
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        try {
+            $this->logger->info('Starting backup.');
+            $this->process->execute();
+            $this->logger->info('Backup completed.');
+        } catch (\Exception $exception) {
+            $this->logger->critical($exception->getMessage());
+
+            throw $exception;
+        }
+    }
+}

src/DB/Data/ConnectionInterface.php

@@ -0,0 +1,47 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\MagentoCloud\DB\Data;
+
+/**
+ * Database connection data interface
+ */
+interface ConnectionInterface
+{
+    /**
+     * Returns DB host name or IP address
+     *
+     * @return string
+     */
+    public function getHost();
+
+    /**
+     * Returns TCP/IP port number to use for the connection
+     *
+     * @return int
+     */
+    public function getPort();
+
+    /**
+     * Returns DB name
+     *
+     * @return string
+     */
+    public function getDbName();
+
+    /**
+     * Returns user name for connecting to the server
+     *
+     * @return string
+     */
+    public function getUser();
+
+    /**
+     * Returns password to use when connecting to the server
+     *
+     * @return string|null
+     */
+    public function getPassword();
+}

src/DB/Data/ReadConnection.php

@@ -0,0 +1,96 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\MagentoCloud\DB\Data;
+
+use Magento\MagentoCloud\Config\Environment;
+
+/**
+ * Data for read only connection to database.
+ * Should be used for backup or other read operations.
+ */
+class ReadConnection implements ConnectionInterface
+{
+    /**
+     * Resource of environment data
+     * @var Environment
+     */
+    private $environment;
+
+    /**
+     * @param Environment $environment
+     */
+    public function __construct(Environment $environment)
+    {
+        $this->environment = $environment;
+    }
+
+    /**
+     * Checks whether project is integration or not.
+     *
+     * @return bool Return true if project is integration, otherwise return false (for staging or production)
+     */
+    private function isIntegration()
+    {
+        //return empty($_ENV['REGISTRY']);
+        //while $_ENV['REGISTRY'] is not approved by platform we check the DB host name
+        //TODO: use method from Environment class which will be implemented in MAGECLOUD-1122
+        return $this->environment->getDbHost() === 'database.internal';
+    }
+
+    /**
+     * Returns the host name for backup.
+     * Integration project has only one node and host should be used the same as retrieved from environment variables.
+     * Production or staging projects have 3 nodes but for read operations we need to connect to localhost
+     * with 3304 port and this connection will proxy to appropriate server.
+     *
+     * @return string
+     */
+    public function getHost()
+    {
+        return $this->isIntegration() ? $this->environment->getDbHost() : '127.0.0.1';
+    }
+
+    /**
+     * Returns ports for DB connection for backup.
+     * There are several available ports:
+     *  - 3306 - talks to master DB
+     *  - 3307 - talks to local node
+     *  - 3304 - is used for read only operations
+     * For production or staging server we cannot make such operations as backup from active master,
+     * so we should always use 3304 for them for localhost, this connection will proxy to appropriate server.
+     * For integration we have only one node and 3306 is always used.
+     *
+     * @return int
+     */
+    public function getPort()
+    {
+        return $this->isIntegration() ? 3306 : 3304;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getDbName()
+    {
+        return $this->environment->getDbName();
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getUser()
+    {
+        return $this->environment->getDbUser();
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getPassword()
+    {
+        return $this->environment->getDbPassword();
+    }
+}