Merge pull request #7 from jakzal/putenv

Add support for putenv()

Author: jakzal

README.md

@@ -8,9 +8,11 @@ Supported annotations:
 
  * `@env` for `$_ENV`
  * `@server` for `$_SERVER` 
+ * `@putenv` for [`putenv()`](http://php.net/putenv)
 
 Global variables are set before each test case is executed,
 and brought to the original state after each test case has finished.
+The same applies to `putenv()`/`getenv()` calls.
 
 ## Installation
 
@@ -73,6 +75,7 @@ class ExampleTest extends TestCase
      * @env APP_DEBUG=0
      * @server APP_ENV=bar
      * @server APP_DEBUG=1
+     * @putenv APP_HOST=localhost
      */
     public function test_global_variables()
     {
@@ -81,6 +84,7 @@ class ExampleTest extends TestCase
         $this->assertSame('0', $_ENV['APP_DEBUG']);
         $this->assertSame('bar', $_SERVER['APP_ENV']);
         $this->assertSame('1', $_SERVER['APP_DEBUG']);
+        $this->assertSame('localhost', \getenv('APP_HOST'));
     }
 }
 ```

src/AnnotationListener.php

@@ -14,6 +14,7 @@ class AnnotationListener implements TestListener
 
     private $server;
     private $env;
+    private $getenv;
 
     public function startTest(Test $test): void
     {
@@ -33,12 +34,20 @@ private function backupGlobals(): void
     {
         $this->server = $_SERVER;
         $this->env = $_ENV;
+        $this->getenv = \getenv();
     }
 
     private function restoreGlobals(): void
     {
         $_SERVER = $this->server;
         $_ENV = $this->env;
+
+        foreach (\array_diff_assoc($this->getenv, \getenv()) as $name => $value) {
+            \putenv(\sprintf('%s=%s', $name, $value));
+        }
+        foreach (\array_diff_assoc(\getenv(), $this->getenv) as $name => $value) {
+            \putenv($name);
+        }
     }
 
     private function readGlobalAnnotations(TestCase $test)
@@ -51,6 +60,9 @@ private function readGlobalAnnotations(TestCase $test)
         foreach ($globalVars['server'] as $name => $value) {
             $_SERVER[$name] = $value;
         }
+        foreach ($globalVars['putenv'] as $name => $value) {
+            \putenv(\sprintf('%s=%s', $name, $value));
+        }
     }
 
     private function parseGlobalAnnotations(TestCase $test): array
@@ -70,9 +82,9 @@ private function findGlobalVarAnnotations(TestCase $test): array
         $annotations = $test->getAnnotations();
 
         return \array_filter(
-            \array_merge_recursive(['env' => [], 'server' => []], $annotations['class'], $annotations['method']),
+            \array_merge_recursive(['env' => [], 'server' => [], 'putenv' => []], $annotations['class'], $annotations['method']),
             function (string $annotationName) {
-                return \in_array($annotationName, ['env', 'server']);
+                return \in_array($annotationName, ['env', 'server', 'putenv']);
             },
             ARRAY_FILTER_USE_KEY
         );

tests/AnnotationListenerTest.php

@@ -11,6 +11,7 @@
 /**
  * @env APP_ENV=test
  * @server APP_DEBUG=0
+ * @putenv APP_HOST=localhost
  */
 class AnnotationListenerTest extends TestCase
 {
@@ -22,51 +23,62 @@ public function test_it_is_a_test_listener()
     /**
      * @env APP_ENV=test_foo
      * @server APP_DEBUG=1
+     * @putenv APP_HOST=dev
      */
     public function test_it_reads_global_variables_from_method_annotations()
     {
         $this->assertArraySubset(['APP_ENV' => 'test_foo'], $_ENV);
         $this->assertArraySubset(['APP_DEBUG' => '1'], $_SERVER);
+        $this->assertArraySubset(['APP_HOST' => 'dev'], \getenv());
     }
 
     public function test_it_reads_global_variables_from_class_annotations()
     {
         $this->assertArraySubset(['APP_ENV' => 'test'], $_ENV);
         $this->assertArraySubset(['APP_DEBUG' => '0'], $_SERVER);
+        $this->assertArraySubset(['APP_HOST' => 'localhost'], \getenv());
     }
 
     /**
      * @env FOO=foo
      * @server BAR=bar
+     * @putenv BAZ=baz
      */
     public function test_it_reads_additional_global_variables_from_methods()
     {
         $this->assertArraySubset(['APP_ENV' => 'test'], $_ENV);
         $this->assertArraySubset(['APP_DEBUG' => '0'], $_SERVER);
+        $this->assertArraySubset(['APP_HOST' => 'localhost'], \getenv());
         $this->assertArraySubset(['FOO' => 'foo'], $_ENV);
         $this->assertArraySubset(['BAR' => 'bar'], $_SERVER);
+        $this->assertArraySubset(['BAZ' => 'baz'], \getenv());
     }
 
     /**
      * @env APP_ENV=test_foo
      * @env APP_ENV=test_foo_bar
      * @server APP_DEBUG=1
      * @server APP_DEBUG=2
+     * @putenv APP_HOST=host1
+     * @putenv APP_HOST=host2
      */
     public function test_it_reads_the_latest_var_defined()
     {
         $this->assertArraySubset(['APP_ENV' => 'test_foo_bar'], $_ENV);
         $this->assertArraySubset(['APP_DEBUG' => '2'], $_SERVER);
+        $this->assertArraySubset(['APP_HOST' => 'host2'], \getenv());
     }
 
     /**
      * @env APP_ENV
      * @server APP_DEBUG
+     * @putenv APP_HOST
      */
     public function test_it_reads_empty_vars()
     {
         $this->assertArraySubset(['APP_ENV' => ''], $_ENV);
         $this->assertArraySubset(['APP_DEBUG' => ''], $_SERVER);
+        $this->assertArraySubset(['APP_HOST' => ''], \getenv());
     }
 
     public function test_it_backups_the_state()
@@ -75,9 +87,13 @@ public function test_it_backups_the_state()
 
         $_ENV['FOO'] = 'env_foo';
         $_SERVER['BAR'] = 'server_bar';
+        \putenv('FOO=putenv_foo');
+        \putenv('USER=foobar');
 
         $this->assertArrayHasKey('FOO', $_ENV);
         $this->assertArrayHasKey('BAR', $_SERVER);
+        $this->assertSame('putenv_foo', \getenv('FOO'));
+        $this->assertSame('foobar', \getenv('USER'));
     }
 
     /**
@@ -87,6 +103,9 @@ public function test_it_cleans_up_after_itself()
     {
         $this->assertArrayNotHasKey('FOO', $_ENV);
         $this->assertArrayNotHasKey('BAR', $_SERVER);
+        $this->assertFalse(\getenv('FOO'), 'It removes environment variables initialised in a test.');
+        $this->assertNotSame('foobar', \getenv('USER'), 'It restores environment variables changed in a test.');
+        $this->assertNotFalse(\getenv('USER'), 'It restores environment variables changed in a test.');
     }
 
     public function test_it_ignores_non_standard_test_cases()