MAGECLOUD-1875: Search engine for Elastic search 5.0 support (#219)

shiftedreality · web-flow · commit 37cb38846967 · 2018-03-30T12:08:35.000-05:00
diff --git a/composer.json b/composer.json
@@ -52,10 +52,10 @@
     "test": [
       "phpcs src --standard=tests/static/phpcs-ruleset.xml -p -n",
       "phpmd src xml tests/static/phpmd-ruleset.xml",
-      "phpunit --configuration tests/unit/phpunit.xml.dist"
+      "phpunit --configuration tests/unit"
     ],
-    "test-coverage": "phpunit --configuration tests/unit/phpunit.xml.dist --coverage-clover tests/unit/tmp/clover.xml && php tests/unit/code-coverage.php tests/unit/tmp/clover.xml 85",
-    "test-coverage-generate": "phpunit --configuration tests/unit/phpunit.xml.dist --coverage-html tests/unit/tmp/coverage"
+    "test-coverage": "phpunit --configuration tests/unit --coverage-clover tests/unit/tmp/clover.xml && php tests/unit/code-coverage.php tests/unit/tmp/clover.xml",
+    "test-coverage-generate": "phpunit --configuration tests/unit --coverage-html tests/unit/tmp/coverage"
   },
   "prefer-stable": true
 }
diff --git a/src/Http/ClientFactory.php b/src/Http/ClientFactory.php
@@ -33,7 +33,7 @@ public function __construct(ContainerInterface $container)
      * Creates a Client instance.
      *
      * @param array $config
-     * @return ClientInterface
+     * @return Client|ClientInterface
      */
     public function create(array $config = []): ClientInterface
     {
diff --git a/src/Process/Deploy/InstallUpdate/ConfigUpdate/SearchEngine.php b/src/Process/Deploy/InstallUpdate/ConfigUpdate/SearchEngine.php
@@ -9,6 +9,7 @@
 use Magento\MagentoCloud\Config\Shared\Writer as SharedWriter;
 use Magento\MagentoCloud\Config\Environment;
 use Magento\MagentoCloud\Config\Stage\DeployInterface;
+use Magento\MagentoCloud\Http\ClientFactory;
 use Magento\MagentoCloud\Package\MagentoVersion;
 use Magento\MagentoCloud\Process\ProcessInterface;
 use Psr\Log\LoggerInterface;
@@ -48,27 +49,36 @@ class SearchEngine implements ProcessInterface
      */
     private $magentoVersion;
 
+    /**
+     * @var ClientFactory
+     */
+    private $clientFactory;
+
     /**
      * @param Environment $environment
      * @param LoggerInterface $logger
      * @param EnvWriter $envWriter
      * @param SharedWriter $sharedWriter
      * @param DeployInterface $stageConfig
+     * @param MagentoVersion $version
+     * @param ClientFactory $client
      */
     public function __construct(
         Environment $environment,
         LoggerInterface $logger,
         EnvWriter $envWriter,
         SharedWriter $sharedWriter,
         DeployInterface $stageConfig,
-        MagentoVersion $version
+        MagentoVersion $version,
+        ClientFactory $client
     ) {
         $this->environment = $environment;
         $this->logger = $logger;
         $this->envWriter = $envWriter;
         $this->sharedWriter = $sharedWriter;
         $this->stageConfig = $stageConfig;
         $this->magentoVersion = $version;
+        $this->clientFactory = $client;
     }
 
     /**
@@ -88,6 +98,7 @@ public function execute()
         // 2.1.x requires search config to be written to the shared config file: MAGECLOUD-1317
         if (!$this->magentoVersion->isGreaterOrEqual('2.2')) {
             $this->sharedWriter->update($config);
+
             return;
         }
         $this->envWriter->update($config);
@@ -141,6 +152,26 @@ private function getSolrConfiguration(array $config)
      */
     private function getElasticSearchConfiguration(array $config)
     {
+        try {
+            $response = $this->clientFactory->create()->get(sprintf(
+                '%s:%s',
+                $config['host'],
+                $config['port']
+            ));
+            $esConfiguration = $response->getBody()->getContents();
+            $esConfiguration = json_decode($esConfiguration, true);
+
+            if (isset($esConfiguration['version']['number']) && $esConfiguration['version']['number'] >= 5) {
+                return [
+                    'engine' => 'elasticsearch5',
+                    'elasticsearch5_server_hostname' => $config['host'],
+                    'elasticsearch5_server_port' => $config['port'],
+                ];
+            }
+        } catch (\Exception $exception) {
+            $this->logger->warning($exception->getMessage());
+        }
+
         return [
             'engine' => 'elasticsearch',
             'elasticsearch_server_hostname' => $config['host'],
diff --git a/src/Test/Unit/Process/Deploy/InstallUpdate/ConfigUpdate/SearchEngineTest.php b/src/Test/Unit/Process/Deploy/InstallUpdate/ConfigUpdate/SearchEngineTest.php
@@ -5,14 +5,18 @@
  */
 namespace Magento\MagentoCloud\Test\Unit\Process\Deploy\InstallUpdate\ConfigUpdate;
 
+use GuzzleHttp\Client;
+use GuzzleHttp\Psr7\Response;
 use Magento\MagentoCloud\Config\Deploy\Writer as EnvWriter;
 use Magento\MagentoCloud\Config\Shared\Writer as SharedWriter;
 use Magento\MagentoCloud\Config\Environment;
 use Magento\MagentoCloud\Config\Stage\DeployInterface;
+use Magento\MagentoCloud\Http\ClientFactory;
 use Magento\MagentoCloud\Package\MagentoVersion;
 use Magento\MagentoCloud\Process\Deploy\InstallUpdate\ConfigUpdate\SearchEngine;
 use PHPUnit\Framework\TestCase;
 use PHPUnit_Framework_MockObject_MockObject as Mock;
+use Psr\Http\Message\StreamInterface;
 use Psr\Log\LoggerInterface;
 
 /**
@@ -55,6 +59,11 @@ class SearchEngineTest extends TestCase
      */
     private $magentoVersionMock;
 
+    /**
+     * @var ClientFactory|Mock
+     */
+    private $clientFactoryMock;
+
     /**
      * @inheritdoc
      */
@@ -66,14 +75,16 @@ protected function setUp()
         $this->loggerMock = $this->getMockForAbstractClass(LoggerInterface::class);
         $this->stageConfigMock = $this->getMockForAbstractClass(DeployInterface::class);
         $this->magentoVersionMock = $this->createMock(MagentoVersion::class);
+        $this->clientFactoryMock = $this->createMock(ClientFactory::class);
 
         $this->process = new SearchEngine(
             $this->environmentMock,
             $this->loggerMock,
             $this->envWriterMock,
             $this->sharedWriterMock,
             $this->stageConfigMock,
-            $this->magentoVersionMock
+            $this->magentoVersionMock,
+            $this->clientFactoryMock
         );
     }
 
@@ -108,26 +119,63 @@ public function testExecute()
     public function magentoVersionTestDataProvider(): array
     {
         return [
-            [ 'newVersion' => true ],
-            [ 'newVersion' => false ],
+            ['newVersion' => true],
+            ['newVersion' => false],
         ];
     }
 
     /**
      * @param bool newVersion
-     * @dataProvider magentoVersionTestDataProvider
+     * @param string $version
+     * @param array $relationships
+     * @param array $expected
+     * @dataProvider executeWithElasticSearchDataProvider
      */
-    public function testExecuteWithElasticSearch(bool $newVersion)
-    {
-        $config['system']['default']['catalog']['search'] = [
-            'engine' => 'elasticsearch',
-            'elasticsearch_server_hostname' => 'localhost',
-            'elasticsearch_server_port' => 1234,
-        ];
+    public function testExecuteWithElasticSearch(
+        bool $newVersion,
+        string $version,
+        array $relationships,
+        array $expected
+    ) {
+        $config['system']['default']['catalog']['search'] = $expected;
+
+        $clientMock = $this->getMockBuilder(Client::class)
+            ->setMethods(['get'])
+            ->getMock();
+        $responseMock = $this->createMock(Response::class);
+        $streamMock = $this->getMockForAbstractClass(StreamInterface::class);
+
+        $clientMock->expects($this->once())
+            ->method('get')
+            ->with($relationships['host'] . ':' . $relationships['port'])
+            ->willReturn($responseMock);
+        $responseMock->expects($this->once())
+            ->method('getBody')
+            ->willReturn($streamMock);
+        $streamMock->expects($this->once())
+            ->method('getContents')
+            ->willReturn('{
+                "name" : "ZaIj9mo",
+                "cluster_name" : "elasticsearch",
+                "cluster_uuid" : "CIXBGIVdS6mwM_0lmVhF4g",
+                "version" : {
+                    "number" : "' . $version . '",
+                    "build_hash" : "c59ff00",
+                    "build_date" : "2018-03-13T10:06:29.741383Z",
+                    "build_snapshot" : false,
+                    "lucene_version" : "7.2.1",
+                    "minimum_wire_compatibility_version" : "5.6.0",
+                    "minimum_index_compatibility_version" : "5.0.0"
+                },
+                "tagline" : "You Know, for Search"
+            }
+        ');
 
+        $this->clientFactoryMock->expects($this->once())
+            ->method('create')
+            ->willReturn($clientMock);
         $this->magentoVersionMock->method('isGreaterOrEqual')
             ->willReturn($newVersion);
-        
         $this->stageConfigMock->expects($this->once())
             ->method('get')
             ->with(DeployInterface::VAR_SEARCH_CONFIGURATION)
@@ -137,10 +185,7 @@ public function testExecuteWithElasticSearch(bool $newVersion)
             ->willReturn(
                 [
                     'elasticsearch' => [
-                        [
-                            'host' => 'localhost',
-                            'port' => 1234,
-                        ],
+                        $relationships,
                     ],
                 ]
             );
@@ -157,8 +202,127 @@ public function testExecuteWithElasticSearch(bool $newVersion)
             ->method('info')
             ->withConsecutive(
                 ['Updating search engine configuration.'],
-                ['Set search engine to: elasticsearch']
+                ['Set search engine to: ' . $expected['engine']]
+            );
+
+        $this->process->execute();
+    }
+
+    /**
+     * @return array
+     */
+    public function executeWithElasticSearchDataProvider(): array
+    {
+        return [
+            [
+                'newVersion' => true,
+                'version' => '2.4',
+                'relationships' => [
+                    'host' => 'localhost',
+                    'port' => 1234,
+                ],
+                'expected' => [
+                    'engine' => 'elasticsearch',
+                    'elasticsearch_server_hostname' => 'localhost',
+                    'elasticsearch_server_port' => 1234,
+                ],
+            ],
+            [
+                'newVersion' => true,
+                'version' => '5',
+                'relationships' => [
+                    'host' => 'localhost',
+                    'port' => 1234,
+                ],
+                'expected' => [
+                    'engine' => 'elasticsearch5',
+                    'elasticsearch5_server_hostname' => 'localhost',
+                    'elasticsearch5_server_port' => 1234,
+                ],
+            ],
+            [
+                'newVersion' => false,
+                'version' => '5.1',
+                'relationships' => [
+                    'host' => 'localhost',
+                    'port' => 1234,
+                ],
+                'expected' => [
+                    'engine' => 'elasticsearch5',
+                    'elasticsearch5_server_hostname' => 'localhost',
+                    'elasticsearch5_server_port' => 1234,
+                ],
+            ],
+            [
+                'newVersion' => false,
+                'version' => '6.2',
+                'relationships' => [
+                    'host' => 'localhost',
+                    'port' => 1234,
+                ],
+                'expected' => [
+                    'engine' => 'elasticsearch5',
+                    'elasticsearch5_server_hostname' => 'localhost',
+                    'elasticsearch5_server_port' => 1234,
+                ],
+            ],
+        ];
+    }
+
+    public function testExecuteWithElasticSearchException()
+    {
+        $relationships = [
+            'host' => 'localhost',
+            'port' => 1234,
+        ];
+        $expected = [
+            'engine' => 'elasticsearch',
+            'elasticsearch_server_hostname' => 'localhost',
+            'elasticsearch_server_port' => 1234,
+        ];
+
+        $config['system']['default']['catalog']['search'] = $expected;
+
+        $clientMock = $this->getMockBuilder(Client::class)
+            ->setMethods(['get'])
+            ->getMock();
+
+        $clientMock->expects($this->once())
+            ->method('get')
+            ->with($relationships['host'] . ':' . $relationships['port'])
+            ->willThrowException(new \RuntimeException('ES is not available'));
+
+        $this->clientFactoryMock->expects($this->once())
+            ->method('create')
+            ->willReturn($clientMock);
+        $this->magentoVersionMock->method('isGreaterOrEqual')
+            ->willReturn(true);
+        $this->stageConfigMock->expects($this->once())
+            ->method('get')
+            ->with(DeployInterface::VAR_SEARCH_CONFIGURATION)
+            ->willReturn([]);
+        $this->environmentMock->expects($this->once())
+            ->method('getRelationships')
+            ->willReturn(
+                [
+                    'elasticsearch' => [
+                        $relationships,
+                    ],
+                ]
+            );
+        $this->envWriterMock->expects($this->once())
+            ->method('update')
+            ->with($config);
+
+        $this->loggerMock->expects($this->exactly(2))
+            ->method('info')
+            ->withConsecutive(
+                ['Updating search engine configuration.'],
+                ['Set search engine to: ' . $expected['engine']]
             );
+        $this->loggerMock->expects($this->once())
+            ->method('warning')
+            ->with('ES is not available');
 
         $this->process->execute();
     }
@@ -179,7 +343,7 @@ public function testExecuteWithElasticSolr(bool $newVersion)
 
         $this->magentoVersionMock->method('isGreaterOrEqual')
             ->willReturn($newVersion);
-        
+
         $this->stageConfigMock->expects($this->once())
             ->method('get')
             ->with(DeployInterface::VAR_SEARCH_CONFIGURATION)
@@ -231,7 +395,7 @@ public function testExecuteEnvironmentConfiguration(bool $newVersion)
 
         $this->magentoVersionMock->method('isGreaterOrEqual')
             ->willReturn($newVersion);
-        
+
         $this->stageConfigMock->expects($this->once())
             ->method('get')
             ->with(DeployInterface::VAR_SEARCH_CONFIGURATION)
diff --git a/tests/unit/.gitignore b/tests/unit/.gitignore
@@ -1 +1,2 @@
 tmp
+phpunit.xml
diff --git a/tests/unit/code-coverage.php b/tests/unit/code-coverage.php

Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ public function __construct(ContainerInterface $container)`
`33`	`33`	`* Creates a Client instance.`
`34`	`34`	`*`
`35`	`35`	`* @param array $config`
`36`		`- * @return ClientInterface`
	`36`	`+ * @return Client\|ClientInterface`
`37`	`37`	`*/`
`38`	`38`	`public function create(array $config = []): ClientInterface`
`39`	`39`	`{`