[FrameworkBundle] Define APP_ENV/APP_DEBUG from argv via Application::bootstrapEnv()

Author: Robin Chalas

CHANGELOG.md

@@ -15,10 +15,10 @@ CHANGELOG
  * Removed the `framework.messenger.encoder` and `framework.messenger.decoder` options. Use the `framework.messenger.serializer.id` option to replace the Messenger serializer. 
  * Deprecated the `ContainerAwareCommand` class in favor of `Symfony\Component\Console\Command\Command`
  * Made `debug:container` and `debug:autowiring` ignore backslashes in service ids
- * Deprecated the `--env` console option and its "-e" shortcut, set
-   the "APP_ENV" environment variable instead.
- * Deprecated the `--no-debug` console option, set the "APP_DEBUG" 
-   environment variable to "0" instead.
+ * Deprecated the `--env` console option and its "-e" shortcut, set the "APP_ENV" environment variable
+   or use `Application::bootstrapEnv()` instead.
+ * Deprecated the `--no-debug` console option, set the "APP_DEBUG" environment variable to "0"
+   or use `Application::bootstrapEnv()` instead.
  * Deprecated the `Templating\Helper\TranslatorHelper::transChoice()` method, use the `trans()` one instead with a `%count%` parameter
  * Deprecated `CacheCollectorPass`. Use `Symfony\Component\Cache\DependencyInjection\CacheCollectorPass` instead.
  * Deprecated `CachePoolClearerPass`. Use `Symfony\Component\Cache\DependencyInjection\CachePoolClearerPass` instead.

Console/Application.php

@@ -207,6 +207,35 @@ protected function registerCommands()
         }
     }
 
+    /**
+     * Defines the "APP_ENV" and "APP_DEBUG" environment variables by consuming --env and --no-debug from the command line arguments.
+     */
+    public static function bootstrapEnv(array &$argv)
+    {
+        for ($i = 0; $i < \count($argv) && '--' !== $v = $argv[$i]; ++$i) {
+            if ('--no-debug' === $v) {
+                putenv('APP_DEBUG='.$_SERVER['APP_DEBUG'] = $_ENV['APP_DEBUG'] = '0');
+                $argvUnset[$i] = true;
+                break;
+            }
+        }
+
+        for ($i = 0; $i < \count($argv) && '--' !== $v = $argv[$i]; ++$i) {
+            if (!$v || '-' !== $v[0] || !preg_match('/^-(?:-env(?:=|$)|e=?)(.*)$/D', $v, $v)) {
+                continue;
+            }
+            if (!empty($v[1]) || !empty($argv[1 + $i])) {
+                putenv('APP_ENV='.$_SERVER['APP_ENV'] = $_ENV['APP_ENV'] = empty($v[1]) ? $argv[1 + $i] : $v[1]);
+                $argvUnset[$i] = $argvUnset[$i + empty($v[1])] = true;
+            }
+            break;
+        }
+
+        if (!empty($argvUnset)) {
+            $argv = array_values(array_diff_key($argv, $argvUnset));
+        }
+    }
+
     private function renderRegistrationErrors(InputInterface $input, OutputInterface $output)
     {
         if ($output instanceof ConsoleOutputInterface) {

Tests/Console/ApplicationTest.php

@@ -283,6 +283,63 @@ private function createBundleMock(array $commands)
 
         return $bundle;
     }
+
+    public function testBootstrapEnv()
+    {
+        $argv = array('--no-debug', '--env=testBootstrapEnv', 'foo=bar');
+        Application::bootstrapEnv($argv);
+
+        $this->assertSame($_SERVER['APP_DEBUG'], '0');
+        $this->assertSame($_ENV['APP_DEBUG'], '0');
+        $this->assertSame('0', getenv('APP_DEBUG'));
+        $this->assertSame('testBootstrapEnv', $_SERVER['APP_ENV']);
+        $this->assertSame('testBootstrapEnv', $_ENV['APP_ENV']);
+        $this->assertSame('testBootstrapEnv', getenv('APP_ENV'));
+        $this->assertSame(array('foo=bar'), $argv);
+
+        unset($_SERVER['APP_ENV']);
+        unset($_ENV['APP_ENV']);
+        putenv('APP_ENV');
+        unset($_SERVER['APP_DEBUG']);
+        unset($_ENV['APP_DEBUG']);
+        putenv('APP_DEBUG');
+
+        $argv = array('--env', 'testBootstrapEnv', 'foo=bar');
+        Application::bootstrapEnv($argv);
+
+        $this->assertSame('testBootstrapEnv', $_SERVER['APP_ENV']);
+        $this->assertSame('testBootstrapEnv', $_ENV['APP_ENV']);
+        $this->assertSame('testBootstrapEnv', getenv('APP_ENV'));
+        $this->assertSame(array('foo=bar'), $argv);
+
+        unset($_SERVER['APP_ENV']);
+        unset($_ENV['APP_ENV']);
+        putenv('APP_ENV');
+
+        $argv = array('-e', 'testBootstrapEnv', 'foo=bar');
+        Application::bootstrapEnv($argv);
+
+        $this->assertSame('testBootstrapEnv', $_SERVER['APP_ENV']);
+        $this->assertSame('testBootstrapEnv', $_ENV['APP_ENV']);
+        $this->assertSame('testBootstrapEnv', getenv('APP_ENV'));
+        $this->assertSame(array('foo=bar'), $argv);
+
+        unset($_SERVER['APP_ENV']);
+        unset($_ENV['APP_ENV']);
+        putenv('APP_ENV');
+
+        $argv = array('-e=testBootstrapEnv', 'foo=bar');
+        Application::bootstrapEnv($argv);
+
+        $this->assertSame('testBootstrapEnv', $_SERVER['APP_ENV']);
+        $this->assertSame('testBootstrapEnv', $_ENV['APP_ENV']);
+        $this->assertSame('testBootstrapEnv', getenv('APP_ENV'));
+        $this->assertSame(array('foo=bar'), $argv);
+
+        unset($_SERVER['APP_ENV']);
+        unset($_ENV['APP_ENV']);
+        putenv('APP_ENV');
+    }
 }
 
 class ThrowingCommand extends Command