MAGECLOUD-3580: Env.php configs are not updated after deleting the ES service (#485)

oshmyheliuk · shiftedreality · commit b2896cc57424 · 2019-05-06T15:32:50.000-05:00
diff --git a/src/Config/Deploy/Writer.php b/src/Config/Deploy/Writer.php
@@ -58,6 +58,16 @@ public function create(array $config)
      * @inheritdoc
      */
     public function update(array $config)
+    {
+        $updatedConfig = array_replace($this->reader->read(), $config);
+
+        $this->create($updatedConfig);
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function updateRecursive(array $config)
     {
         $updatedConfig = array_replace_recursive($this->reader->read(), $config);
 
diff --git a/src/Config/Shared.php b/src/Config/Shared.php
@@ -79,7 +79,7 @@ public function all(): array
     public function update(array $config)
     {
         $this->reset();
-        $this->writer->update($config);
+        $this->writer->updateRecursive($config);
     }
 
     /**
diff --git a/src/Config/Shared/Writer.php b/src/Config/Shared/Writer.php
@@ -59,8 +59,18 @@ public function create(array $config)
      */
     public function update(array $config)
     {
-        $this->create(
-            array_replace_recursive($this->reader->read(), $config)
-        );
+        $updatedConfig = array_replace($this->reader->read(), $config);
+
+        $this->create($updatedConfig);
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function updateRecursive(array $config)
+    {
+        $updatedConfig = array_replace_recursive($this->reader->read(), $config);
+
+        $this->create($updatedConfig);
     }
 }
diff --git a/src/Config/State.php b/src/Config/State.php
@@ -85,7 +85,7 @@ public function isInstalled(): bool
             return true;
         }
 
-        $this->writer->update(['install' => ['date' => date('r')]]);
+        $this->writer->updateRecursive(['install' => ['date' => date('r')]]);
 
         return true;
     }
diff --git a/src/Filesystem/Writer/WriterInterface.php b/src/Filesystem/Writer/WriterInterface.php
@@ -29,4 +29,13 @@ public function create(array $config);
      * @throws FileSystemException
      */
     public function update(array $config);
+
+    /**
+     * Recursively updates existence configuration.
+     *
+     * @param array $config
+     * @return void
+     * @throws FileSystemException
+     */
+    public function updateRecursive(array $config);
 }
diff --git a/src/Process/Deploy/DisableCron.php b/src/Process/Deploy/DisableCron.php
@@ -53,7 +53,7 @@ public function __construct(
     public function execute()
     {
         $this->logger->info('Disable cron');
-        $this->writer->update(['cron' => ['enabled' => 0]]);
+        $this->writer->updateRecursive(['cron' => ['enabled' => 0]]);
 
         $this->cronProcessKill->execute();
     }
diff --git a/src/Process/Deploy/InstallUpdate/ConfigUpdate/DocumentRoot.php b/src/Process/Deploy/InstallUpdate/ConfigUpdate/DocumentRoot.php
@@ -42,6 +42,6 @@ public function __construct(
     public function execute()
     {
         $this->logger->info('The value of the property \'directories/document_root_is_pub\' set as \'true\'');
-        $this->configWriter->update(['directories' => ['document_root_is_pub' => true]]);
+        $this->configWriter->updateRecursive(['directories' => ['document_root_is_pub' => true]]);
     }
 }
diff --git a/src/Process/Deploy/InstallUpdate/Update/SetAdminUrl.php b/src/Process/Deploy/InstallUpdate/Update/SetAdminUrl.php
@@ -64,7 +64,7 @@ public function execute()
         $config['backend']['frontName'] = $adminUrl;
 
         try {
-            $this->configWriter->update($config);
+            $this->configWriter->updateRecursive($config);
         } catch (FileSystemException $exception) {
             throw new ProcessException($exception->getMessage(), $exception->getCode(), $exception);
         }
diff --git a/src/Process/Deploy/SetCryptKey.php b/src/Process/Deploy/SetCryptKey.php
@@ -79,7 +79,7 @@ public function execute()
         $config['crypt']['key'] = $key;
 
         try {
-            $this->configWriter->update($config);
+            $this->configWriter->updateRecursive($config);
         } catch (FileSystemException $exception) {
             throw new ProcessException($exception->getMessage(), $exception->getCode(), $exception);
         }
diff --git a/src/Test/Unit/Config/Deploy/WriterTest.php b/src/Test/Unit/Config/Deploy/WriterTest.php
@@ -96,7 +96,69 @@ public function createDataProvider()
      * @param array $config
      * @param array $currentConfig
      * @param string $updatedConfig
-     * @dataProvider readDataProvider
+     * @dataProvider getUpdateRecursiveDataProvider
+     */
+    public function testUpdateRecursive(array $config, array $currentConfig, $updatedConfig)
+    {
+        $filePath = '/path/to/file';
+        $this->fileListMock->expects($this->once())
+            ->method('getEnv')
+            ->willReturn($filePath);
+        $this->readerMock->expects($this->once())
+            ->method('read')
+            ->willReturn($currentConfig);
+        $this->fileMock->expects($this->once())
+            ->method('filePutContents')
+            ->with($filePath, $updatedConfig);
+
+        $this->writer->updateRecursive($config);
+    }
+
+    /**
+     * @return array
+     */
+    public function getUpdateRecursiveDataProvider()
+    {
+        return [
+            [
+                [],
+                [],
+                "<?php\nreturn array (\n);",
+            ],
+            [
+                ['key' => 'value'],
+                ['key1' => 'value1'],
+                "<?php\nreturn array (\n  'key1' => 'value1',\n  'key' => 'value',\n);",
+            ],
+            [
+                ['key1' => 'value1', 'key2' => 'value2'],
+                ['key1' => 'value0', 'key3' => 'value3'],
+                "<?php\nreturn array (\n  'key1' => 'value1',\n  'key3' => 'value3',\n  'key2' => 'value2',\n);",
+            ],
+            [
+                [
+                    'key1' => [
+                        'key12' => 'value2new',
+                        'key13' => 'value3new',
+                    ]
+                ],
+                [
+                    'key1' => [
+                        'key11' => 'value1',
+                        'key12' => 'value2',
+                    ]
+                ],
+                "<?php\nreturn array (\n  'key1' => \n  array (\n    'key11' => 'value1',\n" .
+                "    'key12' => 'value2new',\n    'key13' => 'value3new',\n  ),\n);"
+            ],
+        ];
+    }
+
+    /**
+     * @param array $config
+     * @param array $currentConfig
+     * @param string $updatedConfig
+     * @dataProvider getUpdateDataProvider
      */
     public function testUpdate(array $config, array $currentConfig, $updatedConfig)
     {
@@ -117,7 +179,7 @@ public function testUpdate(array $config, array $currentConfig, $updatedConfig)
     /**
      * @return array
      */
-    public function readDataProvider()
+    public function getUpdateDataProvider()
     {
         return [
             [
@@ -135,6 +197,22 @@ public function readDataProvider()
                 ['key1' => 'value0', 'key3' => 'value3'],
                 "<?php\nreturn array (\n  'key1' => 'value1',\n  'key3' => 'value3',\n  'key2' => 'value2',\n);",
             ],
+            [
+                [
+                    'key1' => [
+                        'key12' => 'value2new',
+                        'key13' => 'value3new',
+                    ]
+                ],
+                [
+                    'key1' => [
+                        'key11' => 'value1',
+                        'key12' => 'value2',
+                    ]
+                ],
+                "<?php\nreturn array (\n  'key1' => \n  array (\n" .
+                "    'key12' => 'value2new',\n    'key13' => 'value3new',\n  ),\n);"
+            ]
         ];
     }
 }
diff --git a/src/Test/Unit/Config/Shared/WriterTest.php b/src/Test/Unit/Config/Shared/WriterTest.php
@@ -96,7 +96,69 @@ public function createDataProvider(): array
      * @param array $config
      * @param array $currentConfig
      * @param string $updatedConfig
-     * @dataProvider updateDataProvider
+     * @dataProvider updateRecursiveDataProvider
+     */
+    public function testUpdateRecursive(array $config, array $currentConfig, $updatedConfig)
+    {
+        $filePath = '/path/to/file';
+        $this->fileListMock->expects($this->once())
+            ->method('getConfig')
+            ->willReturn($filePath);
+        $this->readerMock->expects($this->once())
+            ->method('read')
+            ->willReturn($currentConfig);
+        $this->fileMock->expects($this->once())
+            ->method('filePutContents')
+            ->with($filePath, $updatedConfig);
+
+        $this->writer->updateRecursive($config);
+    }
+
+    /**
+     * @return array
+     */
+    public function updateRecursiveDataProvider(): array
+    {
+        return [
+            [
+                [],
+                [],
+                "<?php\nreturn array (\n);",
+            ],
+            [
+                ['key' => 'value'],
+                ['key1' => 'value1'],
+                "<?php\nreturn array (\n  'key1' => 'value1',\n  'key' => 'value',\n);",
+            ],
+            [
+                ['key1' => 'value1', 'key2' => 'value2'],
+                ['key1' => 'value0', 'key3' => 'value3'],
+                "<?php\nreturn array (\n  'key1' => 'value1',\n  'key3' => 'value3',\n  'key2' => 'value2',\n);",
+            ],
+            [
+                [
+                    'key1' => [
+                        'key12' => 'value2new',
+                        'key13' => 'value3new',
+                    ]
+                ],
+                [
+                    'key1' => [
+                        'key11' => 'value1',
+                        'key12' => 'value2',
+                    ]
+                ],
+                "<?php\nreturn array (\n  'key1' => \n  array (\n    'key11' => 'value1',\n" .
+                "    'key12' => 'value2new',\n    'key13' => 'value3new',\n  ),\n);"
+            ],
+        ];
+    }
+
+    /**
+     * @param array $config
+     * @param array $currentConfig
+     * @param string $updatedConfig
+     * @dataProvider getUpdateDataProvider
      */
     public function testUpdate(array $config, array $currentConfig, $updatedConfig)
     {
@@ -117,7 +179,7 @@ public function testUpdate(array $config, array $currentConfig, $updatedConfig)
     /**
      * @return array
      */
-    public function updateDataProvider(): array
+    public function getUpdateDataProvider()
     {
         return [
             [
@@ -135,6 +197,22 @@ public function updateDataProvider(): array
                 ['key1' => 'value0', 'key3' => 'value3'],
                 "<?php\nreturn array (\n  'key1' => 'value1',\n  'key3' => 'value3',\n  'key2' => 'value2',\n);",
             ],
+            [
+                [
+                    'key1' => [
+                        'key12' => 'value2new',
+                        'key13' => 'value3new',
+                    ]
+                ],
+                [
+                    'key1' => [
+                        'key11' => 'value1',
+                        'key12' => 'value2',
+                    ]
+                ],
+                "<?php\nreturn array (\n  'key1' => \n  array (\n" .
+                "    'key12' => 'value2new',\n    'key13' => 'value3new',\n  ),\n);"
+            ]
         ];
     }
 }
diff --git a/src/Test/Unit/Config/SharedTest.php b/src/Test/Unit/Config/SharedTest.php
@@ -129,7 +129,7 @@ public function testReset()
     public function testUpdate()
     {
         $this->writerMock->expects($this->once())
-            ->method('update')
+            ->method('updateRecursive')
             ->with(['some' => 'config']);
 
         $this->shared->update(['some' => 'config']);
diff --git a/src/Test/Unit/Config/StateTest.php b/src/Test/Unit/Config/StateTest.php
@@ -78,7 +78,7 @@ public function testIsInstalledTablesCount($tables)
             ->method('listTables')
             ->willReturn($tables);
         $this->writerMock->expects($this->never())
-            ->method('update');
+            ->method('updateRecursive');
 
         $this->assertFalse($this->state->isInstalled());
     }
@@ -105,7 +105,7 @@ public function testIsInstalledTablesWithException($tables)
             ->method('listTables')
             ->willReturn($tables);
         $this->writerMock->expects($this->never())
-            ->method('update');
+            ->method('updateRecursive');
 
         $this->state->isInstalled();
     }
@@ -137,7 +137,7 @@ public function testIsInstalledConfigFileIsNotExistsOrEmpty()
             ->method('read')
             ->willReturn([]);
         $this->writerMock->expects($this->once())
-            ->method('update')
+            ->method('updateRecursive')
             ->with($config);
 
         $dateMock = $this->getFunctionMock('Magento\MagentoCloud\Config', 'date');
@@ -166,7 +166,7 @@ public function testIsInstalledConfigFileWithDate()
             ->method('read')
             ->willReturn($config);
         $this->writerMock->expects($this->never())
-            ->method('update');
+            ->method('updateRecursive');
 
         $this->assertTrue($this->state->isInstalled());
     }
diff --git a/src/Test/Unit/Process/Deploy/DisableCronTest.php b/src/Test/Unit/Process/Deploy/DisableCronTest.php
@@ -60,7 +60,7 @@ public function testExecute()
             ->method('info')
             ->with('Disable cron');
         $this->writerMock->expects($this->once())
-            ->method('update')
+            ->method('updateRecursive')
             ->with($config);
         $this->cronProcessKillMock->expects($this->once())
             ->method('execute');
diff --git a/src/Test/Unit/Process/Deploy/InstallUpdate/ConfigUpdate/DocumentRootTest.php b/src/Test/Unit/Process/Deploy/InstallUpdate/ConfigUpdate/DocumentRootTest.php
@@ -54,7 +54,7 @@ public function testExecute()
             ->method('info')
             ->with('The value of the property \'directories/document_root_is_pub\' set as \'true\'');
         $this->configWriterMock->expects($this->once())
-            ->method('update')
+            ->method('updateRecursive')
             ->with(['directories' => ['document_root_is_pub' => true]]);
 
         $this->process->execute();
diff --git a/src/Test/Unit/Process/Deploy/InstallUpdate/Update/SetAdminUrlTest.php b/src/Test/Unit/Process/Deploy/InstallUpdate/Update/SetAdminUrlTest.php
@@ -66,7 +66,7 @@ public function testExecute()
             ->method('getAdminUrl')
             ->willReturn($frontName);
         $this->configWriterMock->expects($this->once())
-            ->method('update')
+            ->method('updateRecursive')
             ->with(['backend' => ['frontName' => $frontName]]);
 
         $this->setAdminUrl->execute();
@@ -84,7 +84,7 @@ public function testExecuteNoChange()
             ->method('info')
             ->with('Not updating env.php backend front name. (ADMIN_URL not set)');
         $this->configWriterMock->expects($this->never())
-            ->method('update');
+            ->method('updateRecursive');
 
         $this->setAdminUrl->execute();
     }
diff --git a/src/Test/Unit/Process/Deploy/SetCryptKeyTest.php b/src/Test/Unit/Process/Deploy/SetCryptKeyTest.php

Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,7 @@ public function all(): array`
`79`	`79`	`public function update(array $config)`
`80`	`80`	`{`
`81`	`81`	`$this->reset();`
`82`		`- $this->writer->update($config);`
	`82`	`+ $this->writer->updateRecursive($config);`
`83`	`83`	`}`
`84`	`84`
`85`	`85`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -85,7 +85,7 @@ public function isInstalled(): bool`
`85`	`85`	`return true;`
`86`	`86`	`}`
`87`	`87`
`88`		`- $this->writer->update(['install' => ['date' => date('r')]]);`
	`88`	`+ $this->writer->updateRecursive(['install' => ['date' => date('r')]]);`
`89`	`89`
`90`	`90`	`return true;`
`91`	`91`	`}`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ public function __construct(`
`53`	`53`	`public function execute()`
`54`	`54`	`{`
`55`	`55`	`$this->logger->info('Disable cron');`
`56`		`- $this->writer->update(['cron' => ['enabled' => 0]]);`
	`56`	`+ $this->writer->updateRecursive(['cron' => ['enabled' => 0]]);`
`57`	`57`
`58`	`58`	`$this->cronProcessKill->execute();`
`59`	`59`	`}`
Original file line number	Diff line number	Diff line change
`@@ -42,6 +42,6 @@ public function __construct(`
`42`	`42`	`public function execute()`
`43`	`43`	`{`
`44`	`44`	`$this->logger->info('The value of the property \'directories/document_root_is_pub\' set as \'true\'');`
`45`		`- $this->configWriter->update(['directories' => ['document_root_is_pub' => true]]);`
	`45`	`+ $this->configWriter->updateRecursive(['directories' => ['document_root_is_pub' => true]]);`
`46`	`46`	`}`
`47`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,7 @@ public function execute()`
`64`	`64`	`$config['backend']['frontName'] = $adminUrl;`
`65`	`65`
`66`	`66`	`try {`
`67`		`- $this->configWriter->update($config);`
	`67`	`+ $this->configWriter->updateRecursive($config);`
`68`	`68`	`} catch (FileSystemException $exception) {`
`69`	`69`	`throw new ProcessException($exception->getMessage(), $exception->getCode(), $exception);`
`70`	`70`	`}`
Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,7 @@ public function execute()`
`79`	`79`	`$config['crypt']['key'] = $key;`
`80`	`80`
`81`	`81`	`try {`
`82`		`- $this->configWriter->update($config);`
	`82`	`+ $this->configWriter->updateRecursive($config);`
`83`	`83`	`} catch (FileSystemException $exception) {`
`84`	`84`	`throw new ProcessException($exception->getMessage(), $exception->getCode(), $exception);`
`85`	`85`	`}`