Allow configure Magento with env

 - add coverage by unit test

Author: kandy

lib/internal/Magento/Framework/App/DeploymentConfig.php

@@ -20,7 +20,8 @@
 class DeploymentConfig
 {
     private const MAGENTO_ENV_PREFIX = 'MAGENTO_DC_';
-    private const ENV_NAME_PATTERN = '~^%env\(\s*(?<name>\w+)\s*(,\s*"(?<default>[^"]+)")?\)%$~';
+    private const ENV_NAME_PATTERN = '~^#env\(\s*(?<name>\w+)\s*(,\s*"(?<default>[^"]+)")?\)$~';
+    private const OVERRIDE_KEY = self::MAGENTO_ENV_PREFIX . '_OVERRIDE';
 
     /**
      * Configuration reader
@@ -151,7 +152,7 @@ public function isDbAvailable()
      */
     private function getEnvOverride() : array
     {
-        $env = getenv(self::MAGENTO_ENV_PREFIX . '_OVERRIDE');
+        $env = getenv(self::OVERRIDE_KEY);
         return !empty($env) ? (json_decode($env, true) ?? []) : [];
     }
 
@@ -172,6 +173,19 @@ private function load()
             );
             // flatten data for config retrieval using get()
             $this->flatData = $this->flattenParams($this->data);
+
+            // allow reading values from env variables by convention
+            // MAGENTO_DC_{path}, like db/connection/default/host =>
+            // can be overwritten by MAGENTO_DC_DB__CONNECTION__DEFAULT__HOST
+            foreach (getenv() as $key => $value) {
+                if (false !== \strpos($key, self::MAGENTO_ENV_PREFIX)
+                    && $key !== self::OVERRIDE_KEY
+                ) {
+                    // convert MAGENTO_DC_DB__CONNECTION__DEFAULT__HOST into db/connection/default/host
+                    $flatKey = strtolower(str_replace([self::MAGENTO_ENV_PREFIX, '__'], ['', '/'], $key));
+                    $this->flatData[$flatKey] = $value;
+                }
+            }
         }
     }
 
@@ -210,17 +224,11 @@ private function flattenParams(array $params, $path = null, array &$flattenResul
             } else  {
                 // allow reading values from env variables
                 // value need to be specified in %env(NAME, "default value")% format
-                // like %env(DB_PASSWORD)%, %env(DB_NAME, "test")%
+                // like #env(DB_PASSWORD), #env(DB_NAME, "test")
                 if (preg_match(self::ENV_NAME_PATTERN, $param, $matches)) {
                     $param = getenv($matches['name']) ?: ($matches['default'] ?? null);
                 }
 
-                // allow reading values from env variables by convention
-                // MAGENTO_DC_{path}, like db/connection/default/host =>
-                // can be overwritten by MAGENTO_DC_DB__CONNECTION__DEFAULT__HOST
-                $envName = self::MAGENTO_ENV_PREFIX . strtoupper(str_replace(['/'], ['__'], $newPath));
-                $param = getenv($envName) ?: $param;
-
                 $flattenResult[$newPath] = $param;
             }
         }

lib/internal/Magento/Framework/App/Test/Unit/DeploymentConfigTest.php

@@ -147,6 +147,16 @@ public function testKeyCollision(array $data): void
         $object->get();
     }
 
+    protected function tearDown(): void
+    {
+        foreach (array_keys(getenv()) as $key) {
+            if (false !== \strpos($key, 'MAGENTO_DC')) {
+                putenv($key);
+            }
+        }
+        parent::tearDown();
+    }
+
     /**
      * @return array
      */
@@ -178,4 +188,44 @@ public function testIsDbAvailable(): void
         $this->_deploymentConfig->resetData();
         $this->assertTrue($this->_deploymentConfig->isDbAvailable());
     }
+
+    public function testNoEnvVariables()
+    {
+        $this->reader->expects($this->once())->method('load')->willReturn(['a'=>'b']);
+        $this->assertSame('b', $this->_deploymentConfig->get('a'));
+    }
+
+    public function testEnvVariables()
+    {
+        $this->reader->expects($this->once())->method('load')->willReturn([]);
+        putenv('MAGENTO_DC__OVERRIDE={"a": "c"}');
+        $this->assertSame('c', $this->_deploymentConfig->get('a'));
+    }
+
+    public function testEnvVariablesWithNoBaseConfig()
+    {
+        $this->reader->expects($this->once())->method('load')->willReturn(['a'=>'b']);
+        putenv('MAGENTO_DC_A=c');
+        putenv('MAGENTO_DC_B__B__B=D');
+        $this->assertSame('c', $this->_deploymentConfig->get('a'));
+        $this->assertSame('D', $this->_deploymentConfig->get('b/b/b'));
+    }
+
+    public function testEnvVariablesSubstitution()
+    {
+        $this->reader->expects($this->once())
+            ->method('load')
+            ->willReturn(
+                [
+                    'a'=>'#env(MAGENTO_DC____A)',
+                    'b'=>'#env(MAGENTO_DC____B, "test")',
+                    'c'=>'#env(MAGENTO_DC____D, "e$%^&")'
+                ]
+            );
+        putenv('MAGENTO_DC____A=c');
+        putenv('MAGENTO_DC____B=D');
+        $this->assertSame('c', $this->_deploymentConfig->get('a'));
+        $this->assertSame('D', $this->_deploymentConfig->get('b'), 'return value from env');
+        $this->assertSame('e$%^&', $this->_deploymentConfig->get('c'), 'return default value');
+    }
 }