MCLOUD-8405: Change OS validator (#80)

BaDos · web-flow · commit c5fe5aff8c48 · 2022-01-25T15:43:51.000-06:00
diff --git a/.gitignore b/.gitignore
@@ -9,3 +9,4 @@
 /codeception.yml
 /_workdir
 /*.code-workspace
+**/.phpunit.result.cache
diff --git a/composer.json b/composer.json
@@ -91,7 +91,10 @@
     ]
   },
   "config": {
-    "sort-packages": true
+    "sort-packages": true,
+    "allow-plugins": {
+      "funkjedi/composer-include-files": true
+    }
   },
   "prefer-stable": true,
   "extra": {
diff --git a/config/schema.error.yaml b/config/schema.error.yaml
@@ -651,3 +651,9 @@
     stage: deploy
     step: validate-config
     type: warning
+!php/const Magento\MagentoCloud\App\Error::DEPLOY_MAGENTO_VERSION_DOES_NOT_SUPPORT_OS:
+    step: validate-config
+    title: 'Incorrect search engine'
+    suggestion: 'This Magento version does not support Opensearch. You must use versions 2.3.7-p3, 2.4.3-p2, or higher'
+    stage: deploy
+    type: critical
diff --git a/scenario/deploy.xml b/scenario/deploy.xml
@@ -101,6 +101,7 @@
                 <item name="remote-storage" xsi:type="object" priority="1000">Magento\MagentoCloud\Step\Deploy\RemoteStorage</item>
                 <!-- Config update end -->
                 <item name="set-admin-url" xsi:type="object" priority="1000">Magento\MagentoCloud\Step\Deploy\InstallUpdate\Update\SetAdminUrl</item>
+                <item name="clean-cache" xsi:type="object" priority="1050">CleanCache.Deploy</item>
                 <item name="setup" xsi:type="object" priority="1100">Magento\MagentoCloud\Step\Deploy\InstallUpdate\Update\Setup</item>
                 <item name="split-db" xsi:type="object" priority="1200">Magento\MagentoCloud\Step\Deploy\SplitDbConnection</item>
                 <item name="cache-type" xsi:type="object" priority="1300">Magento\MagentoCloud\Step\Deploy\InstallUpdate\ConfigUpdate\CacheType</item>
diff --git a/src/App/Error.php b/src/App/Error.php
@@ -78,6 +78,7 @@ class Error
     public const DEPLOY_REMOVED_SPLIT_DB = 136;
     public const DEPLOY_OS_CANNOT_CONNECT = 137;
     public const DEPLOY_OS_SERVICE_NOT_INSTALLED = 138;
+    public const DEPLOY_MAGENTO_VERSION_DOES_NOT_SUPPORT_OS = 139;
 
     public const PD_DEPLOY_IS_FAILED = 201;
     public const PD_ENV_PHP_IS_NOT_WRITABLE = 202;
diff --git a/src/Config/Validator/Deploy/ElasticSearchIntegrity.php b/src/Config/Validator/Deploy/ElasticSearchIntegrity.php
@@ -66,7 +66,7 @@ public function __construct(
     public function validate(): Validator\ResultInterface
     {
         try {
-            if ($this->magentoVersion->isGreaterOrEqual('2.4.4') && $this->openSearch->isInstalled()) {
+            if ($this->magentoVersion->satisfies('>=2.4.3-p2') && $this->openSearch->isInstalled()) {
                 return $this->resultFactory->success();
             }
 
diff --git a/src/Config/Validator/Deploy/OpenSearchIntegrity.php b/src/Config/Validator/Deploy/OpenSearchIntegrity.php
@@ -71,7 +71,13 @@ public function validate(): Validator\ResultInterface
                 return $this->resultFactory->success();
             }
 
-            if ($this->magentoVersion->isGreaterOrEqual('2.4.4')
+            if (!$this->magentoVersion->satisfies('>=2.3.7-p3 <2.4.0 || >=2.4.3-p2')
+                && $this->openSearch->isInstalled()
+            ) {
+                return $this->resultFactory->errorByCode(Error::DEPLOY_MAGENTO_VERSION_DOES_NOT_SUPPORT_OS);
+            }
+
+            if ($this->magentoVersion->isGreaterOrEqual('2.4.3-p2')
                 && !$this->openSearch->isInstalled()
             ) {
                 return $this->resultFactory->errorByCode(Error::DEPLOY_OS_SERVICE_NOT_INSTALLED);
diff --git a/src/Config/Validator/Deploy/ServiceVersion.php b/src/Config/Validator/Deploy/ServiceVersion.php
@@ -82,6 +82,7 @@ public function validate(): Validator\ResultInterface
                 ServiceInterface::NAME_REDIS,
                 ServiceInterface::NAME_REDIS_SESSION,
                 ServiceInterface::NAME_ELASTICSEARCH,
+                ServiceInterface::NAME_OPENSEARCH,
                 $this->databaseType->getServiceName()
             ];
 
diff --git a/src/Service/Validator.php b/src/Service/Validator.php
@@ -71,6 +71,9 @@ class Validator
             '>=2.4.0 <2.4.2' => '~7.5.0 || ~7.6.0 || ~7.7.0',
             '>=2.4.2' => '~7.5.0 || ~7.6.0 || ~7.7.0 || ~7.9.0',
         ],
+        ServiceInterface::NAME_OPENSEARCH => [
+            '>=2.3.7-p3 <2.4.0 || >=2.4.3-p2' => '~1.1 || ~1.2.1',
+        ],
         ServiceInterface::NAME_RABBITMQ => [
             '<2.3.0' => '~3.5.0',
             '>=2.3.0' => '~3.5.0 || ~3.7.0 || ~3.8.0',
@@ -186,7 +189,8 @@ private function getSupportedVersions(): array
                         break;
                     }
                 }
-                if (!isset($this->supportedVersionList[$serviceName])) {
+                if (!isset($this->supportedVersionList[$serviceName])
+                    && $serviceName !== ServiceInterface::NAME_OPENSEARCH) {
                     throw new ServiceMismatchException(sprintf(
                         'Service "%s" does not have defined configurations for "%s" Magento version',
                         $serviceName,
diff --git a/src/Step/Deploy/InstallUpdate/Install/Setup/InstallCommandFactory.php b/src/Step/Deploy/InstallUpdate/Install/Setup/InstallCommandFactory.php
@@ -246,7 +246,9 @@ private function getEsOptions(): array
                 );
             }
 
-            if ($this->openSearch->isInstalled() && $this->magentoVersion->isGreaterOrEqual('2.4.4')) {
+            if ($this->openSearch->isInstalled()
+                && $this->magentoVersion->satisfies('>=2.3.7-p3 <2.4.0 || >=2.4.3-p2')
+            ) {
                 $engine = $this->openSearch->getFullEngineName();
                 $host = $this->openSearch->getHost();
                 $port = $this->openSearch->getPort();
diff --git a/src/Test/Unit/Config/Validator/Deploy/ElasticsearchIntegrityTest.php b/src/Test/Unit/Config/Validator/Deploy/ElasticsearchIntegrityTest.php
@@ -70,9 +70,13 @@ protected function setUp(): void
      */
     public function testValidate(): void
     {
-        $this->magentoVersionMock->expects($this->exactly(2))
+        $this->magentoVersionMock->expects($this->once())
+            ->method('satisfies')
+            ->with('>=2.4.3-p2')
+            ->willReturn(false);
+        $this->magentoVersionMock->expects($this->once())
             ->method('isGreaterOrEqual')
-            ->withConsecutive(['2.4.4'], ['2.4.0'])
+            ->with('2.4.0')
             ->willReturn(false);
         $this->openSearchMock->expects($this->never())
             ->method('isInstalled');
@@ -87,9 +91,13 @@ public function testValidate(): void
      */
     public function testValidateNoElasticSearchAndNoOpenSearchMagentoGreater244(): void
     {
-        $this->magentoVersionMock->expects($this->exactly(2))
+        $this->magentoVersionMock->expects($this->once())
+            ->method('satisfies')
+            ->with('>=2.4.3-p2')
+            ->willReturn(true);
+        $this->magentoVersionMock->expects($this->once())
             ->method('isGreaterOrEqual')
-            ->withConsecutive(['2.4.4'], ['2.4.0'])
+            ->with('2.4.0')
             ->willReturn(true);
         $this->openSearchMock->expects($this->once())
             ->method('isInstalled')
@@ -109,10 +117,14 @@ public function testValidateNoElasticSearchAndNoOpenSearchMagentoGreater244(): v
      */
     public function testValidateWithElasticSearchNoOrWithOpenSearch240(): void
     {
-        $this->magentoVersionMock->expects($this->exactly(2))
+        $this->magentoVersionMock->expects($this->once())
+            ->method('satisfies')
+            ->with('>=2.4.3-p2')
+            ->willReturn(false);
+        $this->magentoVersionMock->expects($this->once())
             ->method('isGreaterOrEqual')
-            ->withConsecutive(['2.4.4'], ['2.4.0'])
-            ->willReturnOnConsecutiveCalls(false, true);
+            ->with('2.4.0')
+            ->willReturn(true);
         $this->openSearchMock->expects($this->never())
             ->method('isInstalled');
         $this->elasticSearchMock->expects($this->once())
@@ -129,10 +141,13 @@ public function testValidateWithElasticSearchNoOrWithOpenSearch240(): void
      */
     public function testValidateWithElasticSearchNoOpenSearch244(): void
     {
-        $this->magentoVersionMock->expects($this->exactly(2))
+        $this->magentoVersionMock->expects($this->once())
+            ->method('satisfies')
+            ->with('>=2.4.3-p2')
+            ->willReturn(true);
+        $this->magentoVersionMock->expects($this->once())
             ->method('isGreaterOrEqual')
-            ->withConsecutive(['2.4.4'], ['2.4.0'])
-            ->willReturnOnConsecutiveCalls(true, true);
+            ->willReturn(true);
         $this->openSearchMock->expects($this->once())
             ->method('isInstalled')
             ->willReturn(false);
@@ -151,9 +166,11 @@ public function testValidateWithElasticSearchNoOpenSearch244(): void
     public function testValidateWithOrNoElasticSearchWithOpenSearch244(): void
     {
         $this->magentoVersionMock->expects($this->once())
-            ->method('isGreaterOrEqual')
-            ->with('2.4.4')
+            ->method('satisfies')
+            ->with('>=2.4.3-p2')
             ->willReturn(true);
+        $this->magentoVersionMock->expects($this->never())
+            ->method('isGreaterOrEqual');
         $this->openSearchMock->expects($this->once())
             ->method('isInstalled')
             ->willReturn(true);
@@ -170,10 +187,14 @@ public function testValidateWithOrNoElasticSearchWithOpenSearch244(): void
      */
     public function testValidateNoElasticSearchWithOpenSearch240(): void
     {
-        $this->magentoVersionMock->expects($this->exactly(2))
+        $this->magentoVersionMock->expects($this->once())
+            ->method('satisfies')
+            ->with('>=2.4.3-p2')
+            ->willReturn(false);
+        $this->magentoVersionMock->expects($this->once())
             ->method('isGreaterOrEqual')
-            ->withConsecutive(['2.4.4'], ['2.4.0'])
-            ->willReturnOnConsecutiveCalls(false, true);
+            ->with('2.4.0')
+            ->willReturn(true);
         $this->openSearchMock->expects($this->never())
             ->method('isInstalled');
         $this->elasticSearchMock->expects($this->once())
diff --git a/src/Test/Unit/Config/Validator/Deploy/ServiceVersionTest.php b/src/Test/Unit/Config/Validator/Deploy/ServiceVersionTest.php
@@ -99,34 +99,41 @@ public function testValidate(): void
         $serviceES->expects($this->once())
             ->method('getVersion')
             ->willReturn('7.7');
+        $serviceOS = $this->createMock(ServiceInterface::class);
+        $serviceOS->expects($this->once())
+            ->method('getVersion')
+            ->willReturn('1.2');
         $serviceMariaDB = $this->createMock(ServiceInterface::class);
         $serviceMariaDB->expects($this->once())
             ->method('getVersion')
             ->willReturn('10.2');
-        $this->serviceFactory->expects($this->exactly(5))
+        $this->serviceFactory->expects($this->exactly(6))
             ->method('create')
             ->willReturnOnConsecutiveCalls(
                 $serviceRmq,
                 $serviceRedis,
                 $serviceRedisSession,
                 $serviceES,
+                $serviceOS,
                 $serviceMariaDB
             );
-        $this->loggerMock->expects($this->exactly(5))
+        $this->loggerMock->expects($this->exactly(6))
             ->method('info')
             ->withConsecutive(
                 ['Version of service \'rabbitmq\' is not detected', []],
                 ['Version of service \'redis\' is 3.2', []],
                 ['Version of service \'redis-session\' is 3.2', []],
                 ['Version of service \'elasticsearch\' is 7.7', []],
+                ['Version of service \'opensearch\' is 1.2', []],
                 ['Version of service \'mariadb\' is 10.2', []]
             );
-        $this->serviceVersionValidatorMock->expects($this->exactly(4))
+        $this->serviceVersionValidatorMock->expects($this->exactly(5))
             ->method('validateService')
             ->withConsecutive(
                 [ServiceInterface::NAME_REDIS, '3.2'],
                 [ServiceInterface::NAME_REDIS_SESSION, '3.2'],
                 [ServiceInterface::NAME_ELASTICSEARCH, '7.7'],
+                [ServiceInterface::NAME_OPENSEARCH, '1.2'],
                 [ServiceInterface::NAME_DB_MARIA, '10.2']
             )
             ->willReturn('');
@@ -142,7 +149,12 @@ public function testValidateWithErrors(): void
             ->method('getServiceName')
             ->willReturn(ServiceInterface::NAME_DB_MYSQL);
         $errorMessages = [
-            'error message 1', 'error message 2', 'error message 3', 'error message 4', 'error message 5'
+            'error message 1',
+            'error message 2',
+            'error message 3',
+            'error message 4',
+            'error message 5',
+            'error message 6'
         ];
         $service1 = $this->createMock(ServiceInterface::class);
         $service1->expects($this->once())
@@ -162,18 +174,23 @@ public function testValidateWithErrors(): void
             ->willReturn('7.7');
         $service5 = $this->createMock(ServiceInterface::class);
         $service5->expects($this->once())
+            ->method('getVersion')
+            ->willReturn('1.2');
+        $service6 = $this->createMock(ServiceInterface::class);
+        $service6->expects($this->once())
             ->method('getVersion')
             ->willReturn('5.7');
-        $this->serviceFactory->expects($this->exactly(5))
+        $this->serviceFactory->expects($this->exactly(6))
             ->method('create')
-            ->willReturnOnConsecutiveCalls($service1, $service2, $service3, $service4, $service5);
-        $this->serviceVersionValidatorMock->expects($this->exactly(5))
+            ->willReturnOnConsecutiveCalls($service1, $service2, $service3, $service4, $service5, $service6);
+        $this->serviceVersionValidatorMock->expects($this->exactly(6))
             ->method('validateService')
             ->withConsecutive(
                 [ServiceInterface::NAME_RABBITMQ, '1.5'],
                 [ServiceInterface::NAME_REDIS, '2.2'],
                 [ServiceInterface::NAME_REDIS_SESSION, '2.2'],
                 [ServiceInterface::NAME_ELASTICSEARCH, '7.7'],
+                [ServiceInterface::NAME_OPENSEARCH, '1.2'],
                 [ServiceInterface::NAME_DB_MYSQL, '5.7']
             )
             ->willReturnOnConsecutiveCalls(...$errorMessages);
diff --git a/src/Test/Unit/Service/ValidatorTest.php b/src/Test/Unit/Service/ValidatorTest.php
@@ -280,6 +280,55 @@ public function validateVersionsDataProvider(): array
                 ],
                 4
             ],
+            [
+                '2.3.7',
+                [
+                    ServiceInterface::NAME_OPENSEARCH => '1.1' //wrong
+                ],
+                1
+            ],
+            [
+                '2.3.7-p2',
+                [
+                    ServiceInterface::NAME_OPENSEARCH => '1.2' //wrong
+                ],
+                1
+            ],
+            [
+                '2.3.7-p3',
+                [
+                    ServiceInterface::NAME_OPENSEARCH => '1.1'
+                ],
+                0
+            ],
+            [
+                '2.3.7-p3',
+                [
+                    ServiceInterface::NAME_OPENSEARCH => '1.2.2'
+                ],
+                0
+            ],
+            [
+                '2.4.0',
+                [
+                    ServiceInterface::NAME_OPENSEARCH => '1.2.2' //wrong
+                ],
+                1
+            ],
+            [
+                '2.4.3-p2',
+                [
+                    ServiceInterface::NAME_OPENSEARCH => '1.2.2'
+                ],
+                0
+            ],
+            [
+                '2.4.4',
+                [
+                    ServiceInterface::NAME_OPENSEARCH => '1.2.2'
+                ],
+                0
+            ],
         ];
     }
 }
diff --git a/src/Test/Unit/Step/Deploy/InstallUpdate/Install/Setup/InstallCommandFactoryTest.php b/src/Test/Unit/Step/Deploy/InstallUpdate/Install/Setup/InstallCommandFactoryTest.php
@@ -487,6 +487,10 @@ public function testExecuteWithOSauthOptions(): void
                 ['2.4.2', true],
                 ['2.4.4', true],
             ]);
+        $this->magentoVersionMock->expects($this->once())
+            ->method('satisfies')
+            ->with('>=2.3.7-p3 <2.4.0 || >=2.4.3-p2')
+            ->willReturn(true);
         $this->openSearchMock->expects($this->once())
             ->method('isInstalled')
             ->willReturn(true);

Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ public function __construct(`
`66`	`66`	`public function validate(): Validator\ResultInterface`
`67`	`67`	`{`
`68`	`68`	`try {`
`69`		`- if ($this->magentoVersion->isGreaterOrEqual('2.4.4') && $this->openSearch->isInstalled()) {`
	`69`	`+ if ($this->magentoVersion->satisfies('>=2.4.3-p2') && $this->openSearch->isInstalled()) {`
`70`	`70`	`return $this->resultFactory->success();`
`71`	`71`	`}`
`72`	`72`