[Runtime] Support extra dot-env files

natepage · fabpot · commit 22d505a53ada · 2025-04-06T18:01:50.000+02:00
diff --git a/src/Symfony/Component/Runtime/SymfonyRuntime.php b/src/Symfony/Component/Runtime/SymfonyRuntime.php
@@ -41,6 +41,7 @@ class_exists(MissingDotenv::class, false) || class_exists(Dotenv::class) || clas
  *  - "test_envs" to define the names of the test envs - defaults to ["test"];
  *  - "use_putenv" to tell Dotenv to set env vars using putenv() (NOT RECOMMENDED.)
  *  - "dotenv_overload" to tell Dotenv to override existing vars
+ *  - "dotenv_extra_paths" to define a list of additional dot-env files
  *
  * When the "debug" / "env" options are not defined, they will fallback to the
  * "APP_DEBUG" / "APP_ENV" environment variables, and to the "--env|-e" / "--no-debug"
@@ -86,6 +87,7 @@ class SymfonyRuntime extends GenericRuntime
      *   env_var_name?: string,
      *   debug_var_name?: string,
      *   dotenv_overload?: ?bool,
+     *   dotenv_extra_paths?: ?string[],
      * } $options
      */
     public function __construct(array $options = [])
@@ -107,12 +109,22 @@ public function __construct(array $options = [])
         }
 
         if (!($options['disable_dotenv'] ?? false) && isset($options['project_dir']) && !class_exists(MissingDotenv::class, false)) {
-            (new Dotenv($envKey, $debugKey))
+            $overrideExistingVars = $options['dotenv_overload'] ?? false;
+            $dotenv = (new Dotenv($envKey, $debugKey))
                 ->setProdEnvs((array) ($options['prod_envs'] ?? ['prod']))
-                ->usePutenv($options['use_putenv'] ?? false)
-                ->bootEnv($options['project_dir'].'/'.($options['dotenv_path'] ?? '.env'), 'dev', (array) ($options['test_envs'] ?? ['test']), $options['dotenv_overload'] ?? false);
+                ->usePutenv($options['use_putenv'] ?? false);
 
-            if (isset($this->input) && ($options['dotenv_overload'] ?? false)) {
+            $dotenv->bootEnv($options['project_dir'].'/'.($options['dotenv_path'] ?? '.env'), 'dev', (array) ($options['test_envs'] ?? ['test']), $overrideExistingVars);
+
+            if (\is_array($options['dotenv_extra_paths'] ?? null) && $options['dotenv_extra_paths']) {
+                $options['dotenv_extra_paths'] = array_map(fn (string $path) => $options['project_dir'].'/'.$path, $options['dotenv_extra_paths']);
+
+                $overrideExistingVars
+                    ? $dotenv->overload(...$options['dotenv_extra_paths'])
+                    : $dotenv->load(...$options['dotenv_extra_paths']);
+            }
+
+            if (isset($this->input) && $overrideExistingVars) {
                 if ($this->input->getParameterOption(['--env', '-e'], $_SERVER[$envKey], true) !== $_SERVER[$envKey]) {
                     throw new \LogicException(\sprintf('Cannot use "--env" or "-e" when the "%s" file defines "%s" and the "dotenv_overload" runtime option is true.', $options['dotenv_path'] ?? '.env', $envKey));
                 }
diff --git a/src/Symfony/Component/Runtime/Tests/phpt/.env.extra b/src/Symfony/Component/Runtime/Tests/phpt/.env.extra
@@ -0,0 +1 @@
+SOME_VAR=foo_bar_extra
diff --git a/src/Symfony/Component/Runtime/Tests/phpt/dotenv_extra_load.php b/src/Symfony/Component/Runtime/Tests/phpt/dotenv_extra_load.php
@@ -0,0 +1,25 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+
+$_SERVER['SOME_VAR'] = 'ccc';
+$_SERVER['APP_RUNTIME_OPTIONS'] = [
+    'dotenv_extra_paths' => [
+        '.env.extra',
+    ],
+    'dotenv_overload' => false,
+];
+
+require __DIR__.'/autoload.php';
+
+return fn (Request $request, array $context) => new Response('OK Request '.$context['SOME_VAR']);
diff --git a/src/Symfony/Component/Runtime/Tests/phpt/dotenv_extra_load.phpt b/src/Symfony/Component/Runtime/Tests/phpt/dotenv_extra_load.phpt
@@ -0,0 +1,12 @@
+--TEST--
+Test Dotenv extra paths load
+--INI--
+display_errors=1
+--FILE--
+<?php
+
+require $_SERVER['SCRIPT_FILENAME'] = __DIR__.'/dotenv_extra_load.php';
+
+?>
+--EXPECTF--
+OK Request ccc
diff --git a/src/Symfony/Component/Runtime/Tests/phpt/dotenv_extra_overload.php b/src/Symfony/Component/Runtime/Tests/phpt/dotenv_extra_overload.php
@@ -0,0 +1,25 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+
+$_SERVER['SOME_VAR'] = 'ccc';
+$_SERVER['APP_RUNTIME_OPTIONS'] = [
+    'dotenv_extra_paths' => [
+        '.env.extra',
+    ],
+    'dotenv_overload' => true,
+];
+
+require __DIR__.'/autoload.php';
+
+return fn (Request $request, array $context) => new Response('OK Request '.$context['SOME_VAR']);
diff --git a/src/Symfony/Component/Runtime/Tests/phpt/dotenv_extra_overload.phpt b/src/Symfony/Component/Runtime/Tests/phpt/dotenv_extra_overload.phpt
@@ -0,0 +1,12 @@
+--TEST--
+Test Dotenv extra paths overload
+--INI--
+display_errors=1
+--FILE--
+<?php
+
+require $_SERVER['SCRIPT_FILENAME'] = __DIR__.'/dotenv_extra_overload.php';
+
+?>
+--EXPECTF--
+OK Request foo_bar_extra
