Add support for ES scheme and full host path (#78)

Author: shiftedreality

src/Config/SearchEngine.php

@@ -14,6 +14,7 @@
 use Magento\MagentoCloud\Service\ElasticSearch;
 use Magento\MagentoCloud\Service\OpenSearch;
 use Magento\MagentoCloud\Service\ServiceException;
+use Magento\MagentoCloud\Service\Search\AbstractService as AbstractSearchService;
 
 /**
  * Returns search configuration.
@@ -154,20 +155,12 @@ public function isESFamily(): bool
      */
     private function getSearchConfig(): array
     {
-        if ($osConfig = $this->openSearch->getConfiguration()) {
-            return $this->getElasticSearchFamilyConfiguration(
-                $this->openSearch->getFullEngineName(),
-                $osConfig,
-                $this->openSearch->isAuthEnabled()
-            );
+        if ($this->openSearch->getConfiguration()) {
+            return $this->getElasticSearchFamilyConfiguration($this->openSearch);
         }
 
-        if ($esConfig = $this->elasticSearch->getConfiguration()) {
-            return $this->getElasticSearchFamilyConfiguration(
-                $this->elasticSearch->getFullEngineName(),
-                $esConfig,
-                $this->elasticSearch->isAuthEnabled()
-            );
+        if ($this->elasticSearch->getConfiguration()) {
+            return $this->getElasticSearchFamilyConfiguration($this->elasticSearch);
         }
 
         $solrConfig = $this->environment->getRelationship('solr');
@@ -199,22 +192,23 @@ private function getSolrConfiguration(array $config): array
     /**
      * Returns ElasticSearch configuration
      *
-     * @param string $engine Engine name
-     * @param array $config ElasticSearch/OpenSearch connection configuration
-     * @param bool $isAuthEnabled
+     * @param AbstractSearchService $searchService
      * @return array
      *
      * @throws ServiceException
      */
-    private function getElasticSearchFamilyConfiguration(string $engine, array $config, bool $isAuthEnabled): array
+    private function getElasticSearchFamilyConfiguration(AbstractSearchService $searchService): array
     {
+        $engine = $searchService->getFullEngineName();
+        $config = $searchService->getConfiguration();
+
         $elasticSearchConfig = [
             'engine' => $engine,
-            "{$engine}_server_hostname" => $config['host'],
+            "{$engine}_server_hostname" => $searchService->getHost(),
             "{$engine}_server_port" => $config['port'],
         ];
 
-        if ($isAuthEnabled) {
+        if ($searchService->isAuthEnabled()) {
             $elasticSearchConfig["{$engine}_enable_auth"] = 1;
             $elasticSearchConfig["{$engine}_username"] = $config['username'];
             $elasticSearchConfig["{$engine}_password"] = $config['password'];

src/Service/Search/AbstractService.php

@@ -132,6 +132,10 @@ public function getHost(): string
             throw new ServiceException(static::ENGINE_SHORT_NAME . ' service is not installed');
         }
 
+        if (!empty($this->getConfiguration()['scheme'])) {
+            return $this->getConfiguration()['scheme'] . '://' . $this->getConfiguration()['host'];
+        }
+
         return (string)$this->getConfiguration()['host'];
     }
 
@@ -204,7 +208,7 @@ public function getTemplate(): array
         try {
             $templates = $this->call(sprintf(
                 '%s:%s/_template/platformsh_index_settings',
-                $config['host'],
+                $this->getHost(),
                 $config['port']
             ));
 

src/Test/Unit/Config/SearchEngineTest.php

@@ -136,12 +136,15 @@ public function testGetWithElasticSearch(
             ->method('get')
             ->with(DeployInterface::VAR_SEARCH_CONFIGURATION)
             ->willReturn($customSearchConfig);
-        $this->elasticSearchMock->expects($this->once())
+        $this->elasticSearchMock->expects($this->exactly(2))
             ->method('getConfiguration')
             ->willReturn($esServiceConfig);
         $this->openSearchMock->expects($this->once())
             ->method('getConfiguration')
             ->willReturn([]);
+        $this->elasticSearchMock->expects($this->once())
+            ->method('getHost')
+            ->willReturn('localhost');
         $this->elasticSearchMock->expects($this->once())
             ->method('isAuthEnabled')
             ->willReturn($authEnabled);
@@ -152,6 +155,8 @@ public function testGetWithElasticSearch(
             ->willReturn('elasticsearch');
         $this->openSearchMock->expects($this->never())
             ->method('getFullEngineName');
+        $this->elasticSearchMock->method('getHost')
+            ->willReturn($esServiceConfig['host']);
 
         $expected = ['system' => ['default' => ['catalog' => ['search' => $expected]]]];
 
@@ -292,7 +297,7 @@ public function testGetWithOpenSearch(
             ->method('isAuthEnabled');
         $this->elasticSearchMock->expects($this->never())
             ->method('getFullEngineName');
-        $this->openSearchMock->expects($this->once())
+        $this->openSearchMock->expects($this->exactly(2))
             ->method('getConfiguration')
             ->willReturn($osServiceConfig);
         $this->openSearchMock->expects($this->once())
@@ -301,6 +306,8 @@ public function testGetWithOpenSearch(
         $this->openSearchMock->expects($this->once())
             ->method('getFullEngineName')
             ->willReturn('opensearch');
+        $this->openSearchMock->method('getHost')
+            ->willReturn($osServiceConfig['host']);
 
         $expected = ['system' => ['default' => ['catalog' => ['search' => $expected]]]];
 
@@ -432,7 +439,7 @@ public function testGetWithElasticSuite(
             ->method('get')
             ->with(DeployInterface::VAR_SEARCH_CONFIGURATION)
             ->willReturn($customSearchConfig);
-        $this->elasticSearchMock->expects($this->once())
+        $this->elasticSearchMock->expects($this->exactly(2))
             ->method('getConfiguration')
             ->willReturn($esServiceConfig);
         $this->openSearchMock->expects($this->once())
@@ -449,6 +456,8 @@ public function testGetWithElasticSuite(
         $this->elasticSearchMock->expects($this->once())
             ->method('getFullEngineName')
             ->willReturn('elasticsearch');
+        $this->elasticSearchMock->method('getHost')
+            ->willReturn($esServiceConfig['host']);
 
         $expected = ['system' => ['default' => $expected]];