Merge branch 'MAGETWO-89973' into 2.3-develop-pr9

ameysar · ameysar · commit efe1e4e6c92c · 2018-04-05T13:18:36.000+03:00
diff --git a/app/code/Magento/Amqp/Setup/ConfigOptionsList.php b/app/code/Magento/Amqp/Setup/ConfigOptionsList.php
@@ -25,6 +25,7 @@ class ConfigOptionsList implements ConfigOptionsListInterface
     const INPUT_KEY_QUEUE_AMQP_PASSWORD = 'amqp-password';
     const INPUT_KEY_QUEUE_AMQP_VIRTUAL_HOST = 'amqp-virtualhost';
     const INPUT_KEY_QUEUE_AMQP_SSL = 'amqp-ssl';
+    const INPUT_KEY_QUEUE_AMQP_SSL_OPTIONS = 'amqp-ssl-options';
 
     /**
      * Path to the values in the deployment config
@@ -35,6 +36,7 @@ class ConfigOptionsList implements ConfigOptionsListInterface
     const CONFIG_PATH_QUEUE_AMQP_PASSWORD = 'queue/amqp/password';
     const CONFIG_PATH_QUEUE_AMQP_VIRTUAL_HOST = 'queue/amqp/virtualhost';
     const CONFIG_PATH_QUEUE_AMQP_SSL = 'queue/amqp/ssl';
+    const CONFIG_PATH_QUEUE_AMQP_SSL_OPTIONS = 'queue/amqp/ssl_options';
 
     /**
      * Default values
@@ -109,6 +111,13 @@ public function getOptions()
                 'Amqp SSL',
                 self::DEFAULT_AMQP_SSL
             ),
+            new TextConfigOption(
+                self::INPUT_KEY_QUEUE_AMQP_SSL_OPTIONS,
+                TextConfigOption::FRONTEND_WIZARD_TEXTAREA,
+                self::CONFIG_PATH_QUEUE_AMQP_SSL_OPTIONS,
+                'Amqp SSL Options (JSON)',
+                self::DEFAULT_AMQP_SSL
+            ),
         ];
     }
 
@@ -140,6 +149,21 @@ public function createConfig(array $data, DeploymentConfig $deploymentConfig)
             if (!$this->isDataEmpty($data, self::INPUT_KEY_QUEUE_AMQP_SSL)) {
                 $configData->set(self::CONFIG_PATH_QUEUE_AMQP_SSL, $data[self::INPUT_KEY_QUEUE_AMQP_SSL]);
             }
+            if (!$this->isDataEmpty(
+                $data,
+                self::INPUT_KEY_QUEUE_AMQP_SSL_OPTIONS
+            )) {
+                $options = json_decode(
+                    $data[self::INPUT_KEY_QUEUE_AMQP_SSL_OPTIONS],
+                    true
+                );
+                if ($options !== null) {
+                    $configData->set(
+                        self::CONFIG_PATH_QUEUE_AMQP_SSL_OPTIONS,
+                        $options
+                    );
+                }
+            }
         }
 
         return [$configData];
@@ -154,12 +178,28 @@ public function validate(array $options, DeploymentConfig $deploymentConfig)
 
         if (isset($options[self::INPUT_KEY_QUEUE_AMQP_HOST])
             && $options[self::INPUT_KEY_QUEUE_AMQP_HOST] !== '') {
+            if (!$this->isDataEmpty(
+                $options,
+                self::INPUT_KEY_QUEUE_AMQP_SSL_OPTIONS
+            )) {
+                $sslOptions = json_decode(
+                    $options[self::INPUT_KEY_QUEUE_AMQP_SSL_OPTIONS],
+                    true
+                );
+            } else {
+                $sslOptions = null;
+            }
+            $isSslEnabled = !empty($options[self::INPUT_KEY_QUEUE_AMQP_SSL])
+                && $options[self::INPUT_KEY_QUEUE_AMQP_SSL] !== 'false';
+
             $result = $this->connectionValidator->isConnectionValid(
                 $options[self::INPUT_KEY_QUEUE_AMQP_HOST],
                 $options[self::INPUT_KEY_QUEUE_AMQP_PORT],
                 $options[self::INPUT_KEY_QUEUE_AMQP_USER],
                 $options[self::INPUT_KEY_QUEUE_AMQP_PASSWORD],
-                $options[self::INPUT_KEY_QUEUE_AMQP_VIRTUAL_HOST]
+                $options[self::INPUT_KEY_QUEUE_AMQP_VIRTUAL_HOST],
+                $isSslEnabled,
+                $sslOptions
             );
 
             if (!$result) {
diff --git a/app/code/Magento/Amqp/Setup/ConnectionValidator.php b/app/code/Magento/Amqp/Setup/ConnectionValidator.php
@@ -5,13 +5,27 @@
  */
 namespace Magento\Amqp\Setup;
 
-use PhpAmqpLib\Connection\AMQPStreamConnection;
+use Magento\Framework\Amqp\Connection\Factory as ConnectionFactory;
+use Magento\Framework\Amqp\Connection\FactoryOptions;
 
 /**
  * Class ConnectionValidator - validates Amqp related settings
  */
 class ConnectionValidator
 {
+    /**
+     * @var ConnectionFactory
+     */
+    private $connectionFactory;
+
+    /**
+     * @param ConnectionFactory $connectionFactory
+     */
+    public function __construct(ConnectionFactory $connectionFactory)
+    {
+        $this->connectionFactory = $connectionFactory;
+    }
+
     /**
      * Checks Amqp Connection
      *
@@ -20,18 +34,33 @@ class ConnectionValidator
      * @param string $user
      * @param string $password
      * @param string $virtualHost
+     * @param bool $ssl
+     * @param string[]|null $sslOptions
      * @return bool true if the connection succeeded, false otherwise
      */
-    public function isConnectionValid($host, $port, $user, $password = '', $virtualHost = '')
-    {
+    public function isConnectionValid(
+        $host,
+        $port,
+        $user,
+        $password = '',
+        $virtualHost = '',
+        bool $ssl = false,
+        array $sslOptions = null
+    ) {
         try {
-            $connection = new AMQPStreamConnection(
-                $host,
-                $port,
-                $user,
-                $password,
-                $virtualHost
-            );
+            $options = new FactoryOptions();
+            $options->setHost($host);
+            $options->setPort($port);
+            $options->setUsername($user);
+            $options->setPassword($password);
+            $options->setVirtualHost($virtualHost);
+            $options->setSslEnabled($ssl);
+
+            if ($sslOptions) {
+                $options->setSslOptions($sslOptions);
+            }
+
+            $connection = $this->connectionFactory->create($options);
 
             $connection->close();
         } catch (\Exception $e) {
diff --git a/app/code/Magento/Amqp/Test/Unit/Setup/ConfigOptionsListTest.php b/app/code/Magento/Amqp/Test/Unit/Setup/ConfigOptionsListTest.php
@@ -47,7 +47,7 @@ protected function setUp()
             ConfigOptionsList::INPUT_KEY_QUEUE_AMQP_PASSWORD => 'password',
             ConfigOptionsList::INPUT_KEY_QUEUE_AMQP_VIRTUAL_HOST => 'virtual host',
             ConfigOptionsList::INPUT_KEY_QUEUE_AMQP_SSL => 'ssl',
-
+            ConfigOptionsList::INPUT_KEY_QUEUE_AMQP_SSL_OPTIONS => '{"ssl_option":"test"}',
         ];
 
         $this->objectManager = new ObjectManager($this);
@@ -113,7 +113,14 @@ public function testGetOptions()
                 ConfigOptionsList::CONFIG_PATH_QUEUE_AMQP_SSL,
                 'Amqp SSL',
                 ConfigOptionsList::DEFAULT_AMQP_SSL
-            )
+            ),
+            new TextConfigOption(
+                ConfigOptionsList::INPUT_KEY_QUEUE_AMQP_SSL_OPTIONS,
+                TextConfigOption::FRONTEND_WIZARD_TEXTAREA,
+                ConfigOptionsList::CONFIG_PATH_QUEUE_AMQP_SSL_OPTIONS,
+                'Amqp SSL Options (JSON)',
+                ConfigOptionsList::DEFAULT_AMQP_SSL
+            ),
         ];
         $this->assertEquals($expectedOptions, $this->model->getOptions());
     }
@@ -167,6 +174,7 @@ public function getCreateConfigDataProvider()
                     ConfigOptionsList::INPUT_KEY_QUEUE_AMQP_PASSWORD => 'password',
                     ConfigOptionsList::INPUT_KEY_QUEUE_AMQP_VIRTUAL_HOST => 'virtual host',
                     ConfigOptionsList::INPUT_KEY_QUEUE_AMQP_SSL => 'ssl',
+                    ConfigOptionsList::INPUT_KEY_QUEUE_AMQP_SSL_OPTIONS => '{"ssl_option":"test"}',
                 ],
                 ['queue' =>
                     ['amqp' =>
@@ -177,6 +185,7 @@ public function getCreateConfigDataProvider()
                             'password' => 'password',
                             'virtualhost' => 'virtual host',
                             'ssl' => 'ssl',
+                            'ssl_options' => ['ssl_option' => 'test'],
                          ]
                     ]
                 ],
@@ -189,6 +198,7 @@ public function getCreateConfigDataProvider()
                     ConfigOptionsList::INPUT_KEY_QUEUE_AMQP_PASSWORD => 'password',
                     ConfigOptionsList::INPUT_KEY_QUEUE_AMQP_VIRTUAL_HOST => 'virtual host',
                     ConfigOptionsList::INPUT_KEY_QUEUE_AMQP_SSL => 'ssl',
+                    ConfigOptionsList::INPUT_KEY_QUEUE_AMQP_SSL_OPTIONS => '{"ssl_option":"test"}',
                 ],
                 ['queue' =>
                     ['amqp' =>
@@ -199,6 +209,7 @@ public function getCreateConfigDataProvider()
                             'password' => 'password',
                             'virtualhost' => 'virtual host',
                             'ssl' => 'ssl',
+                            'ssl_options' => ['ssl_option' => 'test'],
                          ]
                     ]
                 ],
diff --git a/lib/internal/Magento/Framework/Amqp/Config.php b/lib/internal/Magento/Framework/Amqp/Config.php
@@ -5,10 +5,12 @@
  */
 namespace Magento\Framework\Amqp;
 
+use Magento\Framework\Amqp\Connection\FactoryOptions;
 use Magento\Framework\App\DeploymentConfig;
-use PhpAmqpLib\Connection\AMQPStreamConnection;
+use Magento\Framework\App\ObjectManager;
+use PhpAmqpLib\Connection\AbstractConnection;
 use PhpAmqpLib\Channel\AMQPChannel;
-use PhpAmqpLib\Connection\AMQPSSLConnection;
+use Magento\Framework\Amqp\Connection\Factory as ConnectionFactory;
 
 /**
  * Reads the Amqp config in the deployed environment configuration
@@ -44,7 +46,7 @@ class Config
     private $deploymentConfig;
 
     /**
-     * @var AMQPStreamConnection
+     * @var AbstractConnection
      */
     private $connection;
 
@@ -67,6 +69,11 @@ class Config
      */
     private $connectionName;
 
+    /**
+     * @var ConnectionFactory
+     */
+    private $connectionFactory;
+
     /**
      * Initialize dependencies.
      *
@@ -88,12 +95,18 @@ class Config
      *
      * @param DeploymentConfig $config
      * @param string $connectionName
+     * @param ConnectionFactory|null $connectionFactory
      * @since 100.0.0
      */
-    public function __construct(DeploymentConfig $config, $connectionName = 'amqp')
-    {
+    public function __construct(
+        DeploymentConfig $config,
+        $connectionName = 'amqp',
+        ConnectionFactory $connectionFactory = null
+    ) {
         $this->deploymentConfig = $config;
         $this->connectionName = $connectionName;
+        $this->connectionFactory = $connectionFactory
+            ?: ObjectManager::getInstance()->get(ConnectionFactory::class);
     }
 
     /**
@@ -121,6 +134,27 @@ public function getValue($key)
         return isset($this->data[$key]) ? $this->data[$key] : null;
     }
 
+    /**
+     * @return AbstractConnection
+     */
+    private function createConnection(): AbstractConnection
+    {
+        $sslEnabled = trim($this->getValue(self::SSL)) === 'true';
+        $options = new FactoryOptions();
+        $options->setHost($this->getValue(self::HOST));
+        $options->setPort($this->getValue(self::PORT));
+        $options->setUsername($this->getValue(self::USERNAME));
+        $options->setPassword($this->getValue(self::PASSWORD));
+        $options->setVirtualHost($this->getValue(self::VIRTUALHOST));
+        $options->setSslEnabled($sslEnabled);
+        /** @var array $sslOptions */
+        if ($sslOptions = $this->getValue(self::SSL_OPTIONS)) {
+            $options->setSslOptions($sslOptions);
+        }
+
+        return $this->connectionFactory->create($options);
+    }
+
     /**
      * Return Amqp channel
      *
@@ -131,8 +165,7 @@ public function getValue($key)
     public function getChannel()
     {
         if (!isset($this->connection) || !isset($this->channel)) {
-            $this->connection = $this->getValue(self::SSL) ? $this->createSecureConnection() :
-                $this->createUnsecureConnection();
+            $this->connection = $this->createConnection();
 
             $this->channel = $this->connection->channel();
         }
@@ -179,43 +212,4 @@ private function closeConnection()
             unset($this->connection);
         }
     }
-
-    /**
-     * @return AMQPStreamConnection
-     */
-    private function createUnsecureConnection()
-    {
-        return new AMQPStreamConnection(
-            $this->getValue(self::HOST),
-            $this->getValue(self::PORT),
-            $this->getValue(self::USERNAME),
-            $this->getValue(self::PASSWORD),
-            $this->getValue(self::VIRTUALHOST)
-        );
-    }
-
-    /**
-     * Create secure connection to AMQP server.
-     *
-     * Note: when you are passing empty array of SSL options PHP-AMQPLIB will actually create unsecure connection.
-     *
-     * @return AMQPSSLConnection
-     */
-    private function createSecureConnection()
-    {
-        $sslOptions = $this->getValue(self::SSL_OPTIONS);
-
-        if (empty($sslOptions)) {
-            $sslOptions = ['verify_peer' => true];
-        }
-
-        return new AMQPSSLConnection(
-            $this->getValue(self::HOST),
-            $this->getValue(self::PORT),
-            $this->getValue(self::USERNAME),
-            $this->getValue(self::PASSWORD),
-            $this->getValue(self::VIRTUALHOST),
-            $sslOptions
-        );
-    }
 }
diff --git a/lib/internal/Magento/Framework/Amqp/Connection/Factory.php b/lib/internal/Magento/Framework/Amqp/Connection/Factory.php
@@ -0,0 +1,45 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Framework\Amqp\Connection;
+
+use Magento\Framework\App\ObjectManager;
+use PhpAmqpLib\Connection\AbstractConnection;
+use PhpAmqpLib\Connection\AMQPSSLConnection;
+use PhpAmqpLib\Connection\AMQPStreamConnection;
+
+/**
+ * Create connection based on options.
+ */
+class Factory
+{
+    /**
+     * Create connection according to given options.
+     *
+     * @param FactoryOptions $options
+     * @return AbstractConnection
+     */
+    public function create(FactoryOptions $options): AbstractConnection
+    {
+        $connectionType = $options->isSslEnabled() ? AMQPSSLConnection::class : AMQPStreamConnection::class;
+        $parameters = [
+            'host' => $options->getHost(),
+            'port' => $options->getPort(),
+            'user' => $options->getUsername(),
+            'password' => $options->getPassword(),
+            'vhost' => $options->getVirtualHost() !== null ? $options->getVirtualHost() : '/',
+        ];
+
+        if ($options->isSslEnabled()) {
+            $parameters['ssl_options'] = $options->getSslOptions() !== null
+                ? $options->getSslOptions()
+                : ['verify_peer' => true];
+        }
+
+        return ObjectManager::getInstance()->create($connectionType, $parameters);
+    }
+}
diff --git a/lib/internal/Magento/Framework/Amqp/Connection/FactoryOptions.php b/lib/internal/Magento/Framework/Amqp/Connection/FactoryOptions.php
diff --git a/lib/internal/Magento/Framework/Amqp/Test/Unit/Connection/FactoryTest.php b/lib/internal/Magento/Framework/Amqp/Test/Unit/Connection/FactoryTest.php
