Convert a PR for 2.2-develop into 2.3-develop

bnymn · bnymn · commit 41e17938b6b3 · 2018-09-16T09:43:41.000-03:00
diff --git a/lib/internal/Magento/Framework/Config/ConfigOptionsListConstants.php b/lib/internal/Magento/Framework/Config/ConfigOptionsListConstants.php
@@ -19,6 +19,7 @@ class ConfigOptionsListConstants
     const CONFIG_PATH_CRYPT_KEY = 'crypt/key';
     const CONFIG_PATH_SESSION_SAVE = 'session/save';
     const CONFIG_PATH_RESOURCE_DEFAULT_SETUP = 'resource/default_setup/connection';
+    const CONFIG_PATH_DB_CONNECTION_DEFAULT_DRIVER_OPTIONS = 'db/connection/default/driver_options';
     const CONFIG_PATH_DB_CONNECTION_DEFAULT = 'db/connection/default';
     const CONFIG_PATH_DB_CONNECTIONS = 'db/connection';
     const CONFIG_PATH_DB_PREFIX = 'db/table_prefix';
@@ -62,6 +63,10 @@ class ConfigOptionsListConstants
     const INPUT_KEY_DB_MODEL = 'db-model';
     const INPUT_KEY_DB_INIT_STATEMENTS = 'db-init-statements';
     const INPUT_KEY_DB_ENGINE = 'db-engine';
+    const INPUT_KEY_DB_SSL_KEY = 'db-ssl-key';
+    const INPUT_KEY_DB_SSL_CERT = 'db-ssl-cert';
+    const INPUT_KEY_DB_SSL_CA = 'db-ssl-ca';
+    const INPUT_KEY_DB_SSL_VERIFY = 'db-ssl-verify';
     const INPUT_KEY_RESOURCE = 'resource';
     const INPUT_KEY_SKIP_DB_VALIDATION = 'skip-db-validation';
     const INPUT_KEY_CACHE_HOSTS = 'http-cache-hosts';
@@ -102,6 +107,16 @@ class ConfigOptionsListConstants
     const KEY_MODEL = 'model';
     const KEY_INIT_STATEMENTS = 'initStatements';
     const KEY_ACTIVE = 'active';
+    const KEY_DRIVER_OPTIONS = 'driver_options';
+    /**#@-*/
+
+    /**#@+
+     * Array keys for database driver options configurations
+     */
+    const KEY_MYSQL_SSL_KEY = \PDO::MYSQL_ATTR_SSL_KEY;
+    const KEY_MYSQL_SSL_CERT = \PDO::MYSQL_ATTR_SSL_CERT;
+    const KEY_MYSQL_SSL_CA = \PDO::MYSQL_ATTR_SSL_CA;
+    const KEY_MYSQL_SSL_VERIFY = \PDO::MYSQL_ATTR_SSL_VERIFY_SERVER_CERT;
     /**#@-*/
 
     /**
diff --git a/setup/src/Magento/Setup/Controller/DatabaseCheck.php b/setup/src/Magento/Setup/Controller/DatabaseCheck.php
@@ -5,6 +5,7 @@
  */
 namespace Magento\Setup\Controller;
 
+use Magento\Framework\Config\ConfigOptionsListConstants;
 use Magento\Setup\Validator\DbValidator;
 use Zend\Json\Json;
 use Zend\Mvc\Controller\AbstractActionController;
@@ -37,12 +38,43 @@ public function indexAction()
         try {
             $params = Json::decode($this->getRequest()->getContent(), Json::TYPE_ARRAY);
             $password = isset($params['password']) ? $params['password'] : '';
-            $this->dbValidator->checkDatabaseConnection($params['name'], $params['host'], $params['user'], $password);
+            $driverOptions = [];
+            if ($this->isDriverOptionsGiven($params)) {
+                if (empty($params['driverOptionsSslVerify'])) {
+                    $params['driverOptionsSslVerify'] = 0;
+                }
+                $driverOptions = [
+                    ConfigOptionsListConstants::KEY_MYSQL_SSL_KEY => $params['driverOptionsSslKey'],
+                    ConfigOptionsListConstants::KEY_MYSQL_SSL_CERT => $params['driverOptionsSslCert'],
+                    ConfigOptionsListConstants::KEY_MYSQL_SSL_CA => $params['driverOptionsSslCa'],
+                    ConfigOptionsListConstants::KEY_MYSQL_SSL_VERIFY => (int) $params['driverOptionsSslVerify'],
+                ];
+            }
+            $this->dbValidator->checkDatabaseConnectionWithDriverOptions(
+                $params['name'],
+                $params['host'],
+                $params['user'],
+                $password,
+                $driverOptions
+            );
             $tablePrefix = isset($params['tablePrefix']) ? $params['tablePrefix'] : '';
             $this->dbValidator->checkDatabaseTablePrefix($tablePrefix);
             return new JsonModel(['success' => true]);
         } catch (\Exception $e) {
             return new JsonModel(['success' => false, 'error' => $e->getMessage()]);
         }
     }
+
+    /**
+     * @param array $params
+     * @return boolean
+     */
+    private function isDriverOptionsGiven($params)
+    {
+        return !(
+            empty($params['driverOptionsSslKey']) ||
+            empty($params['driverOptionsSslCert']) ||
+            empty($params['driverOptionsSslCa'])
+        );
+    }
 }
diff --git a/setup/src/Magento/Setup/Model/ConfigGenerator.php b/setup/src/Magento/Setup/Model/ConfigGenerator.php
@@ -14,6 +14,7 @@
 use Magento\Framework\Config\ConfigOptionsListConstants;
 use Magento\Framework\App\State;
 use Magento\Framework\Math\Random;
+use Magento\Setup\Model\ConfigOptionsList\DriverOptions;
 
 /**
  * Creates deployment config data based on user input array
@@ -61,6 +62,11 @@ class ConfigGenerator
      */
     private $cryptKeyGenerator;
 
+    /**
+     * @var DriverOptions
+     */
+    private $driverOptions;
+
     /**
      * Constructor
      *
@@ -73,12 +79,14 @@ public function __construct(
         Random $random,
         DeploymentConfig $deploymentConfig,
         ConfigDataFactory $configDataFactory = null,
-        CryptKeyGeneratorInterface $cryptKeyGenerator = null
+        CryptKeyGeneratorInterface $cryptKeyGenerator = null,
+        DriverOptions $driverOptions = null
     ) {
         $this->random = $random;
         $this->deploymentConfig = $deploymentConfig;
         $this->configDataFactory = $configDataFactory ?? ObjectManager::getInstance()->get(ConfigDataFactory::class);
         $this->cryptKeyGenerator = $cryptKeyGenerator ?? ObjectManager::getInstance()->get(CryptKeyGenerator::class);
+        $this->driverOptions = $driverOptions ?? ObjectManager::getInstance()->get(DriverOptions::class);
     }
 
     /**
@@ -179,6 +187,9 @@ public function createDbConfig(array $data)
             $configData->set($dbConnectionPrefix . ConfigOptionsListConstants::KEY_ACTIVE, '1');
         }
 
+        $driverOptions = $this->driverOptions->getDriverOptions($data);
+        $configData->set($dbConnectionPrefix . ConfigOptionsListConstants::KEY_DRIVER_OPTIONS, $driverOptions);
+
         return $configData;
     }
 
diff --git a/setup/src/Magento/Setup/Model/ConfigOptionsList.php b/setup/src/Magento/Setup/Model/ConfigOptionsList.php
@@ -12,6 +12,7 @@
 use Magento\Framework\Setup\Option\FlagConfigOption;
 use Magento\Framework\Setup\Option\SelectConfigOption;
 use Magento\Framework\Setup\Option\TextConfigOption;
+use Magento\Setup\Model\ConfigOptionsList\DriverOptions;
 use Magento\Setup\Validator\DbValidator;
 
 /**
@@ -47,19 +48,28 @@ class ConfigOptionsList implements ConfigOptionsListInterface
         \Magento\Setup\Model\ConfigOptionsList\PageCache::class
     ];
 
+    /**
+     * @var DriverOptions
+     */
+    private $driverOptions;
+
     /**
      * Constructor
      *
      * @param ConfigGenerator $configGenerator
      * @param DbValidator $dbValidator
      */
-    public function __construct(ConfigGenerator $configGenerator, DbValidator $dbValidator)
-    {
+    public function __construct(
+        ConfigGenerator $configGenerator,
+        DbValidator $dbValidator,
+        DriverOptions $driverOptions = null
+    ) {
         $this->configGenerator = $configGenerator;
         $this->dbValidator = $dbValidator;
         foreach ($this->configOptionsListClasses as $className) {
             $this->configOptionsCollection[] = \Magento\Framework\App\ObjectManager::getInstance()->get($className);
         }
+        $this->driverOptions = $driverOptions ?? \Magento\Framework\App\ObjectManager::getInstance()->get(DriverOptions::class);
     }
 
     /**
@@ -150,6 +160,36 @@ public function getOptions()
                 ConfigOptionsListConstants::CONFIG_PATH_CACHE_HOSTS,
                 'http Cache hosts'
             ),
+            new TextConfigOption(
+                ConfigOptionsListConstants::INPUT_KEY_DB_SSL_KEY,
+                TextConfigOption::FRONTEND_WIZARD_TEXT,
+                ConfigOptionsListConstants::CONFIG_PATH_DB_CONNECTION_DEFAULT_DRIVER_OPTIONS .
+                '/' . ConfigOptionsListConstants::KEY_MYSQL_SSL_KEY,
+                'Full path of client key file in order to establish db connection through SSL',
+                null
+            ),
+            new TextConfigOption(
+                ConfigOptionsListConstants::INPUT_KEY_DB_SSL_CERT,
+                TextConfigOption::FRONTEND_WIZARD_TEXT,
+                ConfigOptionsListConstants::CONFIG_PATH_DB_CONNECTION_DEFAULT_DRIVER_OPTIONS .
+                '/' . ConfigOptionsListConstants::KEY_MYSQL_SSL_CERT,
+                'Full path of client certificate file in order to establish db connection through SSL',
+                null
+            ),
+            new TextConfigOption(
+                ConfigOptionsListConstants::INPUT_KEY_DB_SSL_CA,
+                TextConfigOption::FRONTEND_WIZARD_TEXT,
+                ConfigOptionsListConstants::CONFIG_PATH_DB_CONNECTION_DEFAULT_DRIVER_OPTIONS .
+                '/' . ConfigOptionsListConstants::KEY_MYSQL_SSL_CA,
+                'Full path of server certificate file in order to establish db connection through SSL',
+                null
+            ),
+            new FlagConfigOption(
+                ConfigOptionsListConstants::INPUT_KEY_DB_SSL_VERIFY,
+                ConfigOptionsListConstants::CONFIG_PATH_DB_CONNECTION_DEFAULT_DRIVER_OPTIONS .
+                '/' . ConfigOptionsListConstants::KEY_MYSQL_SSL_VERIFY,
+                'Verify server certification'
+            ),
         ];
 
         foreach ($this->configOptionsCollection as $configOptionsList) {
@@ -334,12 +374,14 @@ private function validateDbSettings(array $options, DeploymentConfig $deployment
         ) {
             try {
                 $options = $this->getDbSettings($options, $deploymentConfig);
+                $driverOptions = $this->driverOptions->getDriverOptions($options);
 
-                $this->dbValidator->checkDatabaseConnection(
+                $this->dbValidator->checkDatabaseConnectionWithDriverOptions(
                     $options[ConfigOptionsListConstants::INPUT_KEY_DB_NAME],
                     $options[ConfigOptionsListConstants::INPUT_KEY_DB_HOST],
                     $options[ConfigOptionsListConstants::INPUT_KEY_DB_USER],
-                    $options[ConfigOptionsListConstants::INPUT_KEY_DB_PASSWORD]
+                    $options[ConfigOptionsListConstants::INPUT_KEY_DB_PASSWORD],
+                    $driverOptions
                 );
             } catch (\Exception $exception) {
                 $errors[] = $exception->getMessage();
diff --git a/setup/src/Magento/Setup/Model/ConfigOptionsList/DriverOptions.php b/setup/src/Magento/Setup/Model/ConfigOptionsList/DriverOptions.php
@@ -0,0 +1,38 @@
+<?php declare(strict_types=1);
+namespace Magento\Setup\Model\ConfigOptionsList;
+
+use Magento\Framework\Config\ConfigOptionsListConstants;
+
+class DriverOptions
+{
+    /**
+     * @params array $options
+     * @return array
+     */
+    public function getDriverOptions($options)
+    {
+        $driverOptionKeys = [
+            ConfigOptionsListConstants::KEY_MYSQL_SSL_KEY => ConfigOptionsListConstants::INPUT_KEY_DB_SSL_KEY,
+            ConfigOptionsListConstants::KEY_MYSQL_SSL_CERT => ConfigOptionsListConstants::INPUT_KEY_DB_SSL_CERT,
+            ConfigOptionsListConstants::KEY_MYSQL_SSL_CA => ConfigOptionsListConstants::INPUT_KEY_DB_SSL_CA,
+            ConfigOptionsListConstants::KEY_MYSQL_SSL_VERIFY => ConfigOptionsListConstants::INPUT_KEY_DB_SSL_VERIFY
+        ];
+        $driverOptions = [];
+        foreach ($driverOptionKeys as $configKey => $driverOptionKey) {
+            if ($this->optionExists($options, $driverOptionKey)) {
+                $driverOptions[$configKey] = $options[$driverOptionKey];
+            }
+        }
+        return $driverOptions;
+    }
+
+    /**
+     * @param array $options
+     * @param string $driverOptionKey
+     * @return bool
+     */
+    private function optionExists($options, $driverOptionKey)
+    {
+        return $options[$driverOptionKey] === false || !empty($options[$driverOptionKey]);
+    }
+}
diff --git a/setup/src/Magento/Setup/Model/Installer.php b/setup/src/Magento/Setup/Model/Installer.php
@@ -1334,7 +1334,32 @@ private function deleteDeploymentConfig()
      */
     private function assertDbAccessible()
     {
-        $this->dbValidator->checkDatabaseConnection(
+        $driverOptionKeys = [
+            ConfigOptionsListConstants::KEY_MYSQL_SSL_KEY =>
+                ConfigOptionsListConstants::CONFIG_PATH_DB_CONNECTION_DEFAULT_DRIVER_OPTIONS . '/' .
+                ConfigOptionsListConstants::KEY_MYSQL_SSL_KEY,
+
+            ConfigOptionsListConstants::KEY_MYSQL_SSL_CERT =>
+                ConfigOptionsListConstants::CONFIG_PATH_DB_CONNECTION_DEFAULT_DRIVER_OPTIONS . '/' .
+                ConfigOptionsListConstants::KEY_MYSQL_SSL_CERT,
+
+            ConfigOptionsListConstants::KEY_MYSQL_SSL_CA =>
+                ConfigOptionsListConstants::CONFIG_PATH_DB_CONNECTION_DEFAULT_DRIVER_OPTIONS . '/' .
+                ConfigOptionsListConstants::KEY_MYSQL_SSL_CA,
+
+            ConfigOptionsListConstants::KEY_MYSQL_SSL_VERIFY =>
+                ConfigOptionsListConstants::CONFIG_PATH_DB_CONNECTION_DEFAULT_DRIVER_OPTIONS . '/' .
+                ConfigOptionsListConstants::KEY_MYSQL_SSL_VERIFY
+        ];
+        $driverOptions = [];
+        foreach ($driverOptionKeys as $driverOptionKey => $driverOptionConfig) {
+            $config = $this->deploymentConfig->get($driverOptionConfig);
+            if ($config !== null) {
+                $driverOptions[$driverOptionKey] = $config;
+            }
+        }
+
+        $this->dbValidator->checkDatabaseConnectionWithDriverOptions(
             $this->deploymentConfig->get(
                 ConfigOptionsListConstants::CONFIG_PATH_DB_CONNECTION_DEFAULT .
                 '/' . ConfigOptionsListConstants::KEY_NAME
@@ -1350,7 +1375,8 @@ private function assertDbAccessible()
             $this->deploymentConfig->get(
                 ConfigOptionsListConstants::CONFIG_PATH_DB_CONNECTION_DEFAULT .
                 '/' . ConfigOptionsListConstants::KEY_PASSWORD
-            )
+            ),
+            $driverOptions
         );
         $prefix = $this->deploymentConfig->get(
             ConfigOptionsListConstants::CONFIG_PATH_DB_CONNECTION_DEFAULT .
diff --git a/setup/src/Magento/Setup/Model/RequestDataConverter.php b/setup/src/Magento/Setup/Model/RequestDataConverter.php
@@ -51,6 +51,14 @@ private function convertDeploymentConfigForm(array $source)
             isset($source['db']['tablePrefix']) ? $source['db']['tablePrefix'] : '';
         $result[BackendConfigOptionsList::INPUT_KEY_BACKEND_FRONTNAME] = isset($source['config']['address']['admin'])
             ? $source['config']['address']['admin'] : '';
+        $result[SetupConfigOptionsList::INPUT_KEY_DB_SSL_KEY] = isset($source['db']['driverOptionsSslKey'])
+            ? $source['db']['driverOptionsSslKey'] : '';
+        $result[SetupConfigOptionsList::INPUT_KEY_DB_SSL_CERT] = isset($source['db']['driverOptionsSslCert'])
+            ? $source['db']['driverOptionsSslCert'] : '';
+        $result[SetupConfigOptionsList::INPUT_KEY_DB_SSL_CA] = isset($source['db']['driverOptionsSslCa'])
+            ? $source['db']['driverOptionsSslCa'] : '';
+        $result[SetupConfigOptionsList::INPUT_KEY_DB_SSL_VERIFY] = isset($source['db']['driverOptionsSslVerify'])
+            ? $source['db']['driverOptionsSslVerify'] : '';
         $result[SetupConfigOptionsList::INPUT_KEY_ENCRYPTION_KEY] = isset($source['config']['encrypt']['key'])
             ? $source['config']['encrypt']['key'] : null;
         $result[SetupConfigOptionsList::INPUT_KEY_SESSION_SAVE] = isset($source['config']['sessionSave']['type'])
diff --git a/setup/src/Magento/Setup/Test/Unit/Model/ConfigGeneratorTest.php b/setup/src/Magento/Setup/Test/Unit/Model/ConfigGeneratorTest.php
@@ -11,6 +11,7 @@
 use Magento\Framework\Config\Data\ConfigData;
 use Magento\Framework\Config\Data\ConfigDataFactory;
 use Magento\Setup\Model\ConfigGenerator;
+use Magento\Setup\Model\ConfigOptionsList\DriverOptions;
 
 class ConfigGeneratorTest extends \PHPUnit\Framework\TestCase
 {
@@ -29,6 +30,11 @@ class ConfigGeneratorTest extends \PHPUnit\Framework\TestCase
      */
     private $configDataMock;
 
+    /**
+     * @var DriverOptions
+     */
+    private $driverOptionsMock;
+
     public function setUp()
     {
         $objectManager = new \Magento\Framework\TestFramework\Unit\Helper\ObjectManager($this);
@@ -50,11 +56,17 @@ public function setUp()
         $configDataFactoryMock->method('create')
             ->willReturn($this->configDataMock);
 
+        $this->driverOptionsMock = $this->getMockBuilder(DriverOptions::class)
+            ->disableOriginalConstructor()
+            ->setMethods(['getDriverOptions'])
+            ->getMock();
+
         $this->model = $objectManager->getObject(
             ConfigGenerator::class,
             [
                 'deploymentConfig'  => $this->deploymentConfigMock,
                 'configDataFactory' => $configDataFactoryMock,
+                'driverOptions'     => $this->driverOptionsMock,
             ]
         );
     }
diff --git a/setup/src/Magento/Setup/Test/Unit/Model/ConfigOptionsListTest.php b/setup/src/Magento/Setup/Test/Unit/Model/ConfigOptionsListTest.php
@@ -33,12 +33,18 @@ class ConfigOptionsListTest extends \PHPUnit\Framework\TestCase
      */
     private $dbValidator;
 
+    /**
+     * @var ConfigOptionsList\DriverOptions
+     */
+    private $driverOptionsMock;
+
     protected function setUp()
     {
         $this->generator = $this->createMock(\Magento\Setup\Model\ConfigGenerator::class);
         $this->deploymentConfig = $this->createMock(\Magento\Framework\App\DeploymentConfig::class);
         $this->dbValidator = $this->createMock(\Magento\Setup\Validator\DbValidator::class);
-        $this->object = new ConfigOptionsList($this->generator, $this->dbValidator);
+        $this->driverOptionsMock = $this->createMock(ConfigOptionsList\DriverOptions::class);
+        $this->object = new ConfigOptionsList($this->generator, $this->dbValidator, $this->driverOptionsMock);
     }
 
     public function testGetOptions()
@@ -155,7 +161,10 @@ private function prepareValidationMocks()
             ->disableOriginalConstructor()
             ->getMock();
         $this->dbValidator->expects($this->once())->method('checkDatabaseTablePrefix')->willReturn($configDataMock);
-        $this->dbValidator->expects($this->once())->method('checkDatabaseConnection')->willReturn($configDataMock);
+        $this->dbValidator
+            ->expects($this->once())
+            ->method('checkDatabaseConnectionWithDriverOptions')
+            ->willReturn($configDataMock);
     }
 
     /**
diff --git a/setup/src/Magento/Setup/Test/Unit/Module/ConfigGeneratorTest.php b/setup/src/Magento/Setup/Test/Unit/Module/ConfigGeneratorTest.php
diff --git a/setup/src/Magento/Setup/Validator/AdminCredentialsValidator.php b/setup/src/Magento/Setup/Validator/AdminCredentialsValidator.php
diff --git a/setup/src/Magento/Setup/Validator/DbValidator.php b/setup/src/Magento/Setup/Validator/DbValidator.php
diff --git a/setup/view/magento/setup/add-database.phtml b/setup/view/magento/setup/add-database.phtml
