MC-5926: Conflict of simultaneous write in Redis cache

- create ignore list

Author: cpartica

dev/tests/integration/framework/Magento/TestFramework/Isolation/DeploymentConfig.php

@@ -28,6 +28,17 @@ class DeploymentConfig
      */
     private $config;
 
+    /**
+     * Ignore values in the config nested array, paths are separated by single slash "/".
+     *
+     * Example: compiled_config is not set in default mode, and once set it can't be unset
+     *
+     * @var array
+     */
+    private $ignoreValues = [
+        'cache_types/compiled_config',
+    ];
+
     /**
      * Memorizes the initial value of configuration reader and the configuration value
      *
@@ -57,11 +68,7 @@ public function startTestSuite()
      */
     public function endTest(\PHPUnit\Framework\TestCase $test)
     {
-        $config = $this->reader->load();
-        // ignore compiled_config setting because is not set in default mode
-        if (isset($config['cache_types']['compiled_config'])) {
-            unset($config['cache_types']['compiled_config']);
-        }
+        $config = $this->filterIgnoredConfigValues($this->reader->load());
         if ($this->config != $config) {
             $error = "\n\nERROR: deployment configuration is corrupted. The application state is no longer valid.\n"
                 . 'Further tests may fail.'
@@ -70,4 +77,27 @@ public function endTest(\PHPUnit\Framework\TestCase $test)
             $test->fail($error);
         }
     }
+
+    /**
+     * Filter ignored config values which are not set by default and appear when tests would change state.
+     *
+     * Example: compiled_config is not set in default mode, and once set it can't be unset
+     *
+     * @param array $config
+     * @param string $path
+     * @return array
+     */
+    private function filterIgnoredConfigValues(array $config, string $path = '') {
+        foreach ($config as $configKeyName => $configValue) {
+            $newPath = !empty($path) ?  $path . '/' . $configKeyName : $configKeyName;
+            if (is_array($configValue)) {
+                $config[$configKeyName] = $this->filterIgnoredConfigValues($configValue, $newPath);
+            } else {
+                if (array_key_exists($newPath, array_flip($this->ignoreValues))) {
+                    unset($config[$configKeyName]);
+                }
+            }
+        }
+        return $config;
+    }
 }