MCLOUD-5542: Add mapping for Elastic 7 version validator in ece-tools (magento#716)

Author: shiftedreality

src/Config/Validator/Deploy/ElasticSearchVersion.php

@@ -7,6 +7,7 @@
 
 namespace Magento\MagentoCloud\Config\Validator\Deploy;
 
+use Composer\Semver\Comparator;
 use Composer\Semver\Semver;
 use Magento\MagentoCloud\Config\SearchEngine;
 use Magento\MagentoCloud\Config\Validator;
@@ -57,19 +58,24 @@ class ElasticSearchVersion implements ValidatorInterface
      */
     private static $versionsMap = [
         [
-            'packageVersion' => '~6.0',
-            'esVersion' => '~6.0',
-            'esVersionRaw' => '6.x',
+            'packageVersion' => '~2.0',
+            'esVersion' => '>= 1.0 < 3.0',
+            'esVersionRaw' => '1.x or 2.x',
         ],
         [
             'packageVersion' => '~5.0',
             'esVersion' => '~5.0',
             'esVersionRaw' => '5.x',
         ],
         [
-            'packageVersion' => '~2.0',
-            'esVersion' => '>= 1.0 < 3.0',
-            'esVersionRaw' => '1.x or 2.x',
+            'packageVersion' => '~6.0',
+            'esVersion' => '~6.0',
+            'esVersionRaw' => '6.x',
+        ],
+        [
+            'packageVersion' => '~7.0',
+            'esVersion' => '~7.0',
+            'esVersionRaw' => '7.x',
         ],
     ];
 
@@ -126,7 +132,7 @@ public function validate(): Validator\ResultInterface
                     return $this->generateError($esServiceVersion, $esPackageVersion, $versionInfo);
                 }
             }
-        } catch (\Exception $e) {
+        } catch (UndefinedPackageException $e) {
             $this->logger->warning('Can\'t validate version of elasticsearch: ' . $e->getMessage());
         }
 
@@ -164,10 +170,15 @@ private function generateError(
             $suggestion[] = '  Update the composer.json file for your Magento Cloud project to ' .
                 'require elasticsearch/elasticsearch module version ~2.0.';
         } else {
+            $mode = Comparator::greaterThan($esServiceVersion, $esPackageVersion)
+                ? 'downgrading'
+                : 'upgrading';
+
             $suggestion = [
                 sprintf(
-                    'You can fix this issue by upgrading the Elasticsearch service on your ' .
+                    'You can fix this issue by %s the Elasticsearch service on your ' .
                     'Magento Cloud infrastructure to version %s.',
+                    $mode,
                     $versionInfo['esVersionRaw']
                 )
             ];

src/Test/Unit/Config/Validator/Deploy/ElasticSearchVersionTest.php

@@ -15,6 +15,7 @@
 use Magento\MagentoCloud\Config\Validator\ResultFactory;
 use Magento\MagentoCloud\Package\MagentoVersion;
 use Magento\MagentoCloud\Package\Manager;
+use Magento\MagentoCloud\Package\UndefinedPackageException;
 use Magento\MagentoCloud\Service\ElasticSearch;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
@@ -63,7 +64,7 @@ class ElasticSearchVersionTest extends TestCase
     /**
      * @inheritdoc
      */
-    public function setUp()
+    public function setUp(): void
     {
         $this->resultFactoryMock = $this->createMock(ResultFactory::class);
         $this->managerMock = $this->createMock(Manager::class);
@@ -82,7 +83,7 @@ public function setUp()
         );
     }
 
-    public function testValidateElasticSearchServiceNotExists()
+    public function testValidateElasticSearchServiceNotExists(): void
     {
         $this->elasticSearchMock->expects($this->once())
             ->method('getVersion')
@@ -99,7 +100,7 @@ public function testValidateElasticSearchServiceNotExists()
         $this->assertInstanceOf(Success::class, $this->validator->validate());
     }
 
-    public function testValidatePackageNotExists()
+    public function testValidatePackageNotExists(): void
     {
         $this->searchEngineMock->expects($this->once())
             ->method('isESFamily')
@@ -110,7 +111,7 @@ public function testValidatePackageNotExists()
         $this->managerMock->expects($this->once())
             ->method('get')
             ->with('elasticsearch/elasticsearch')
-            ->willThrowException(new \Exception('package doesn\'t exist'));
+            ->willThrowException(new UndefinedPackageException('package doesn\'t exist'));
         $this->loggerMock->expects($this->once())
             ->method('warning')
             ->with('Can\'t validate version of elasticsearch: package doesn\'t exist');
@@ -120,7 +121,7 @@ public function testValidatePackageNotExists()
         $this->assertInstanceOf(Success::class, $this->validator->validate());
     }
 
-    public function testValidateElasticSearchServiceExistsAndNotConfigured()
+    public function testValidateElasticSearchServiceExistsAndNotConfigured(): void
     {
         $this->searchEngineMock->expects($this->once())
             ->method('isESFamily')
@@ -154,7 +155,7 @@ public function testValidate(
         string $magentoVersion = '2.2',
         string $errorMessage = '',
         string $errorSuggestion = ''
-    ) {
+    ): void {
         $this->magentoVersionMock->expects($this->any())
             ->method('getVersion')
             ->willReturn($magentoVersion);
@@ -186,6 +187,8 @@ public function testValidate(
 
     /**
      * @return array
+     *
+     * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
      */
     public function validateDataProvider(): array
     {
@@ -202,6 +205,8 @@ public function validateDataProvider(): array
             ['1.7', '2.9', Success::class],
             ['5.1', '5.0', Success::class],
             ['5.2', '5.1', Success::class],
+            ['7.0', '7.1', Success::class],
+            ['7.4', '7.2', Success::class],
             ['6.1', '2.0', Error::class],
             [
                 '6.2',
@@ -210,7 +215,7 @@ public function validateDataProvider(): array
                 '2.3.0',
                 'Elasticsearch service version 6.2 on infrastructure layer is not compatible with current version of ' .
                 'elasticsearch/elasticsearch module (5.0), used by your Magento application.',
-                'You can fix this issue by upgrading the Elasticsearch service on your ' .
+                'You can fix this issue by downgrading the Elasticsearch service on your ' .
                 'Magento Cloud infrastructure to version 5.x.'
             ],
             [
@@ -231,7 +236,7 @@ public function validateDataProvider(): array
                 '2.1.4',
                 'Elasticsearch service version 5.0 on infrastructure layer is not compatible with current version of ' .
                 'elasticsearch/elasticsearch module (2.0), used by your Magento application.',
-                'You can fix this issue by upgrading the Elasticsearch service on your ' .
+                'You can fix this issue by downgrading the Elasticsearch service on your ' .
                 'Magento Cloud infrastructure to version 1.x or 2.x.'
             ],
             [
@@ -280,6 +285,16 @@ public function validateDataProvider(): array
                 'You can fix this issue by upgrading the Elasticsearch service on your ' .
                 'Magento Cloud infrastructure to version 5.x.'
             ],
+            [
+                '7.4',
+                '6.2',
+                Error::class,
+                '2.4.0',
+                'Elasticsearch service version 7.4 on infrastructure layer is not compatible with current version of ' .
+                'elasticsearch/elasticsearch module (6.2), used by your Magento application.',
+                'You can fix this issue by downgrading the Elasticsearch service on your ' .
+                'Magento Cloud infrastructure to version 6.x.'
+            ],
         ];
     }
 }