MCLOUD-5706: Add support of new ES option to ECE-Tools

Author: shiftedreality

config/services.xml

@@ -35,6 +35,7 @@
         <service id="Magento\MagentoCloud\Scenario\Exception\ValidationException" autowire="false" />
         <service id="Magento\MagentoCloud\Service\ServiceMismatchException" autowire="false" />
         <service id="Magento\MagentoCloud\Config\ValidatorException" autowire="false" />
+        <service id="Magento\MagentoCloud\Service\ServiceException" autowire="false" />
         <service id="Magento\MagentoCloud\Shell\Process" autowire="false" />
         <service id="Magento\MagentoCloud\Shell\ProcessException" autowire="false" />
         <service id="Magento\MagentoCloud\Step\Build\BackupData" autowire="false" />

src/Config/SearchEngine.php

@@ -179,12 +179,7 @@ private function getSolrConfiguration(array $config): array
      */
     private function getElasticSearchConfiguration(array $config): array
     {
-        $engine = ElasticSearch::ENGINE_NAME;
-
-        $esVersion = $this->elasticSearch->getVersion();
-        if (Semver::satisfies($esVersion, '>= 5')) {
-            $engine .= (int)$esVersion;
-        }
+        $engine = $this->elasticSearch->getFullVersion();
 
         $elasticSearchConfig = [
             'engine' => $engine,

src/Config/SearchEngine/ElasticSuite.php

@@ -73,6 +73,14 @@ public function get(): array
         return $this->configMerger->merge($this->getConfig(), $envConfig);
     }
 
+    /**
+     * @return string
+     */
+    public function getServers(): string
+    {
+        return $this->get()['es_client']['servers'] ?? '';
+    }
+
     /**
      * Checks if both ElasticSearch and ElasticSuite are installed.
      *

src/Service/ElasticSearch.php

@@ -7,17 +7,19 @@
 
 namespace Magento\MagentoCloud\Service;
 
+use Composer\Semver\Semver;
 use Magento\MagentoCloud\Config\Environment;
 use Magento\MagentoCloud\Http\ClientFactory;
 use Psr\Log\LoggerInterface;
+use Throwable;
 
 /**
  * Returns ElasticSearch service configurations.
  */
 class ElasticSearch implements ServiceInterface
 {
-    const RELATIONSHIP_KEY = 'elasticsearch';
-    const ENGINE_NAME = 'elasticsearch';
+    private const RELATIONSHIP_KEY = 'elasticsearch';
+    public const ENGINE_NAME = 'elasticsearch';
 
     /**
      * @var ClientFactory
@@ -80,33 +82,79 @@ public function getConfiguration(): array
      *   elasticsearch doesn't exist in relationships.
      *
      * @return string
+     *
+     * @throws ServiceException
      */
     public function getVersion(): string
     {
-        if ($this->version === null) {
-            $this->version = '0';
-
-            $config = $this->getConfiguration();
-            if (!$config) {
-                return $this->version;
-            }
+        if (!$this->isInstalled()) {
+            throw new ServiceException('ES service is not installed');
+        }
 
+        if ($this->version === null) {
             try {
                 $esConfiguration = $this->call(sprintf(
                     '%s:%s',
-                    $config['host'],
-                    $config['port']
+                    $this->getHost(),
+                    $this->getPort()
                 ));
 
                 $this->version = $esConfiguration['version']['number'];
-            } catch (\Exception $exception) {
-                $this->logger->warning('Can\'t get version of elasticsearch: ' . $exception->getMessage());
+            } catch (Throwable $exception) {
+                throw new ServiceException('Can\'t get version of elasticsearch: ' . $exception->getMessage());
             }
         }
 
         return $this->version;
     }
 
+    /**
+     * Retrieve host.
+     *
+     * @return string
+     * @throws ServiceException
+     */
+    public function getHost(): string
+    {
+        if (!$this->isInstalled()) {
+            throw new ServiceException('ES service is not installed');
+        }
+
+        return (string)$this->getConfiguration()['host'];
+    }
+
+    /**
+     * Retrieve port.
+     *
+     * @return string
+     * @throws ServiceException
+     */
+    public function getPort(): string
+    {
+        if (!$this->isInstalled()) {
+            throw new ServiceException('ES service is not installed');
+        }
+
+        return (string)$this->getConfiguration()['port'];
+    }
+
+    /**
+     * Return full version with engine name.
+     *
+     * @return string
+     * @throws ServiceException
+     */
+    public function getFullVersion(): string
+    {
+        $version = $this->getVersion();
+
+        if (Semver::satisfies($version, '>= 5')) {
+            return self::ENGINE_NAME . (int)$version;
+        }
+
+        return self::ENGINE_NAME;
+    }
+
     /**
      * Retrieves default template configuration.
      * May contain configuration for replicas and shards.

src/Service/ServiceException.php

@@ -0,0 +1,17 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\MagentoCloud\Service;
+
+use Magento\MagentoCloud\App\GenericException;
+
+/**
+ * Generic service exception.
+ */
+class ServiceException extends GenericException
+{
+}