MCLOUD-7722: Fix Custom Cache Config Validation and Clean Cache (#47)

Author: NadiyaS

src/Step/Deploy/PreDeploy/ConfigUpdate/Cache.php

@@ -156,15 +156,32 @@ private function checkBackendModel(string $backend): void
      */
     private function testRedisConnection(array $backendOptions): bool
     {
-        if (!isset($backendOptions['server'], $backendOptions['port'])) {
-            throw new StepException('Missing required Redis configuration!', Error::DEPLOY_WRONG_CACHE_CONFIGURATION);
+        if (empty($backendOptions['server'])) {
+            throw new StepException(
+                'Missing required Redis configuration \'server\'!',
+                Error::DEPLOY_WRONG_CACHE_CONFIGURATION
+            );
+        }
+        $address = $backendOptions['server'];
+        if (!isset($backendOptions['port'])) {
+            preg_match('#^(.{1,4}://)?([^:]+)(:([0-9]+))?#', $address, $matches);
+            if (!isset($matches[4])) {
+                throw new StepException(
+                    'Missing required Redis configuration \'port\'!',
+                    Error::DEPLOY_WRONG_CACHE_CONFIGURATION
+                );
+            }
+            $address = $matches[2];
+            $port = $matches[4];
+        } else {
+            $port = $backendOptions['port'];
         }
 
         $sock = socket_create(AF_INET, SOCK_STREAM, SOL_TCP);
         $connected = @socket_connect(
             $sock,
-            (string)$backendOptions['server'],
-            (int)$backendOptions['port']
+            (string)$address,
+            (int)$port
         );
         socket_close($sock);
 

src/Test/Unit/Step/Deploy/PreDeploy/ConfigUpdate/CacheTest.php

@@ -107,9 +107,13 @@ protected function setUp()
 
     /**
      * @param array $config
+     * @param bool $isGreaterOrEqual
+     * @param string $address
+     * @param int $port
+     * @throws StepException
      * @dataProvider executeDataProvider
      */
-    public function testExecute(array $config, bool $isGreaterOrEqual)
+    public function testExecute(array $config, bool $isGreaterOrEqual, $address, $port)
     {
         $this->magentoVersion->expects($this->any())
             ->method('isGreaterOrEqual')
@@ -128,10 +132,15 @@ public function testExecute(array $config, bool $isGreaterOrEqual)
             ->method('info')
             ->with('Updating cache configuration.');
 
-        $this->socketCreateMock->expects($this->once());
+        $sock = socket_create(AF_INET, SOCK_STREAM, SOL_TCP);
+        $this->socketCreateMock->expects($this->once())
+            ->willReturn($sock);
         $this->socketConnectMock->expects($this->once())
+            ->with($sock, $address, $port)
             ->willReturn(true);
-        $this->socketCloseMock->expects($this->once());
+        $this->socketCloseMock->expects($this->once())
+            ->with($sock);
+        socket_close($sock);
 
         $this->step->execute();
     }
@@ -152,6 +161,8 @@ public function executeDataProvider(): array
                     ],
                 ],
                 'isGreaterOrEqual' => false,
+                'address' => 'localhost',
+                'port' => 6370
             ],
             'backend model with remote_backend_options' => [
                 'config' => [
@@ -168,6 +179,42 @@ public function executeDataProvider(): array
                     ],
                 ],
                 'isGreaterOrEqual' => true,
+                'address' => 'localhost',
+                'port' => 6370
+            ],
+            'Server contains port data' => [
+                'config' => [
+                    'frontend' => [
+                        'frontName' => [
+                            'backend' => CacheFactory::REDIS_BACKEND_REMOTE_SYNCHRONIZED_CACHE,
+                            'backend_options' => [
+                                'remote_backend_options' => [
+                                    'server' => '127.0.0.1:6371',
+                                ],
+                            ],
+                        ],
+                    ],
+                ],
+                'isGreaterOrEqual' => true,
+                'address' => '127.0.0.1',
+                'port' => 6371
+            ],
+            'Server contains protocol and port data' => [
+                'config' => [
+                    'frontend' => [
+                        'frontName' => [
+                            'backend' => CacheFactory::REDIS_BACKEND_REMOTE_SYNCHRONIZED_CACHE,
+                            'backend_options' => [
+                                'remote_backend_options' => [
+                                    'server' => 'tcp://localhost:6379',
+                                ],
+                            ],
+                        ],
+                    ],
+                ],
+                'isGreaterOrEqual' => true,
+                'address' => 'localhost',
+                'port' => 6379
             ],
         ];
     }
@@ -300,13 +347,17 @@ public function testExecuteMixedBackends()
     }
 
     /**
+     * @param $options
+     * @param $errorMessage
      * @throws StepException
+     *
+     * @dataProvider dataProviderExecuteWithWrongConfiguration
      */
-    public function testExecuteWithWrongConfiguration()
+    public function testExecuteWithWrongConfiguration($options, $errorMessage)
     {
         $this->expectExceptionCode(Error::DEPLOY_WRONG_CACHE_CONFIGURATION);
         $this->expectException(StepException::class);
-        $this->expectExceptionMessage('Missing required Redis configuration!');
+        $this->expectExceptionMessage($errorMessage);
 
         $this->configReaderMock->expects($this->once())
             ->method('read')
@@ -316,13 +367,31 @@ public function testExecuteWithWrongConfiguration()
             ->willReturn([
                 'frontend' => ['frontName' => [
                     'backend' => 'Cm_Cache_Backend_Redis',
-                    'backend_options' => ['server' => 'redis.server'],
+                    'backend_options' => $options,
                 ]],
             ]);
 
         $this->step->execute();
     }
 
+    public function dataProviderExecuteWithWrongConfiguration()
+    {
+        return [
+            [
+                ['server' => 'redis.server'],
+                'Missing required Redis configuration \'port\'!'
+            ],
+            [
+                ['server' => '', 'port' => '6379'],
+                'Missing required Redis configuration \'server\'!'
+            ],
+            [
+                ['port' => '6379'],
+                'Missing required Redis configuration \'server\'!'
+            ],
+        ];
+    }
+
     /**
      * @throws StepException
      */