Add dotenv (#321)

Co-authored-by: Pavel Karfik <[email protected]>
Co-authored-by: Markus Staab <[email protected]>

Author: 3 people

.env.dist

@@ -0,0 +1,6 @@
+DBA_HOST=mysql80.ab
+DBA_USER=testuser
+DBA_PASSWORD=test
+DBA_DATABASE=phpstan_dba
+DBA_MODE=recording
+DBA_REFLECTOR=mysqli

.gitignore

@@ -5,3 +5,5 @@ composer.lock
 
 mysqli.php
 pdo.php
+
+.env

bootstrap.php

@@ -1,11 +1,17 @@
 <?php
 
+use Dotenv\Dotenv;
 use staabm\PHPStanDba\QueryReflection\QueryReflection;
 use staabm\PHPStanDba\QueryReflection\RuntimeConfiguration;
 use staabm\PHPStanDba\Tests\ReflectorFactory;
 
 require_once __DIR__.'/vendor/autoload.php';
 
+if (false === getenv('GITHUB_ACTION')) {
+    $dotenv = Dotenv::createImmutable(__DIR__);
+    $dotenv->load();
+}
+
 $config = RuntimeConfiguration::create();
 $config->errorMode(RuntimeConfiguration::ERROR_MODE_EXCEPTION);
 // $config->debugMode(true);

composer.json

@@ -17,7 +17,8 @@
 		"phpstan/phpstan-phpunit": "^1.0",
 		"phpstan/phpstan-strict-rules": "^1.1",
 		"phpunit/phpunit": "^9",
-		"symplify/phpstan-extensions": "^10.0"
+		"symplify/phpstan-extensions": "^10.0",
+		"vlucas/phpdotenv": "^5.4"
 	},
 	"conflicts": {
 		"phpstan/phpstan": "1.4.0"

tests/ReflectorFactory.php

@@ -23,18 +23,19 @@ public static function create(string $cacheDir): QueryReflector
             $user = getenv('DBA_USER') ?: 'root';
             $password = getenv('DBA_PASSWORD') ?: 'root';
             $dbname = getenv('DBA_DATABASE') ?: 'phpstan_dba';
+            $mode = getenv('DBA_MODE') ?: 'recording';
+            $reflector = getenv('DBA_REFLECTOR') ?: 'mysqli';
         } else {
-            $host = getenv('DBA_HOST') ?: 'mysql80.ab';
-            $user = getenv('DBA_USER') ?: 'testuser';
-            $password = getenv('DBA_PASSWORD') ?: 'test';
-            $dbname = getenv('DBA_DATABASE') ?: 'phpstan_dba';
+            $host = getenv('DBA_HOST') ?: $_ENV['DBA_HOST'];
+            $user = getenv('DBA_USER') ?: $_ENV['DBA_USER'];
+            $password = getenv('DBA_PASSWORD') ?: $_ENV['DBA_PASSWORD'];
+            $dbname = getenv('DBA_DATABASE') ?: $_ENV['DBA_DATABASE'];
+            $mode = getenv('DBA_MODE') ?: $_ENV['DBA_MODE'];
+            $reflector = getenv('DBA_REFLECTOR') ?: $_ENV['DBA_REFLECTOR'];
         }
 
-        $mode = getenv('DBA_MODE') ?: 'recording';
-        $reflector = getenv('DBA_REFLECTOR') ?: 'mysqli';
-
         // make env vars available to tests, in case non are defined yet
-        putenv('DBA_REFLECTOR='.$reflector);
+        $_ENV['DBA_REFLECTOR'] = $reflector;
 
         // we need to record the reflection information in both, phpunit and phpstan since we are replaying it in both CI jobs.
         // in a regular application you will use phpstan-dba only within your phpstan CI job, therefore you only need 1 cache-file.

tests/default/config/bootstrap.php

@@ -1,11 +1,17 @@
 <?php
 
+use Dotenv\Dotenv;
 use staabm\PHPStanDba\QueryReflection\QueryReflection;
 use staabm\PHPStanDba\QueryReflection\RuntimeConfiguration;
 use staabm\PHPStanDba\Tests\ReflectorFactory;
 
 require_once __DIR__.'/../../../vendor/autoload.php';
 
+if (false === getenv('GITHUB_ACTION')) {
+    $dotenv = Dotenv::createImmutable(__DIR__.'/../../..');
+    $dotenv->load();
+}
+
 $config = RuntimeConfiguration::create();
 $config->errorMode(RuntimeConfiguration::ERROR_MODE_EXCEPTION);
 // $config->debugMode(true);

tests/defaultFetchAssoc/config/bootstrap.php

@@ -1,12 +1,18 @@
 <?php
 
+use Dotenv\Dotenv;
 use staabm\PHPStanDba\QueryReflection\QueryReflection;
 use staabm\PHPStanDba\QueryReflection\QueryReflector;
 use staabm\PHPStanDba\QueryReflection\RuntimeConfiguration;
 use staabm\PHPStanDba\Tests\ReflectorFactory;
 
 require_once __DIR__.'/../../../vendor/autoload.php';
 
+if (false === getenv('GITHUB_ACTION')) {
+    $dotenv = Dotenv::createImmutable(__DIR__.'/../../..');
+    $dotenv->load();
+}
+
 $config = RuntimeConfiguration::create();
 $config->errorMode(RuntimeConfiguration::ERROR_MODE_EXCEPTION);
 $config->defaultFetchMode(QueryReflector::FETCH_TYPE_ASSOC);

tests/defaultFetchNumeric/config/bootstrap.php

@@ -1,12 +1,18 @@
 <?php
 
+use Dotenv\Dotenv;
 use staabm\PHPStanDba\QueryReflection\QueryReflection;
 use staabm\PHPStanDba\QueryReflection\QueryReflector;
 use staabm\PHPStanDba\QueryReflection\RuntimeConfiguration;
 use staabm\PHPStanDba\Tests\ReflectorFactory;
 
 require_once __DIR__.'/../../../vendor/autoload.php';
 
+if (false === getenv('GITHUB_ACTION')) {
+    $dotenv = Dotenv::createImmutable(__DIR__.'/../../..');
+    $dotenv->load();
+}
+
 $config = RuntimeConfiguration::create();
 $config->errorMode(RuntimeConfiguration::ERROR_MODE_EXCEPTION);
 $config->defaultFetchMode(QueryReflector::FETCH_TYPE_NUMERIC);

tests/rules/config/bootstrap.php

@@ -1,11 +1,17 @@
 <?php
 
+use Dotenv\Dotenv;
 use staabm\PHPStanDba\QueryReflection\QueryReflection;
 use staabm\PHPStanDba\QueryReflection\RuntimeConfiguration;
 use staabm\PHPStanDba\Tests\ReflectorFactory;
 
 require_once __DIR__.'/../../../vendor/autoload.php';
 
+if (false === getenv('GITHUB_ACTION')) {
+    $dotenv = Dotenv::createImmutable(__DIR__.'/../../..');
+    $dotenv->load();
+}
+
 $config = RuntimeConfiguration::create();
 $config->errorMode(RuntimeConfiguration::ERROR_MODE_EXCEPTION);
 // $config->debugMode(true);

tests/stringify/config/bootstrap.php

@@ -1,11 +1,17 @@
 <?php
 
+use Dotenv\Dotenv;
 use staabm\PHPStanDba\QueryReflection\QueryReflection;
 use staabm\PHPStanDba\QueryReflection\RuntimeConfiguration;
 use staabm\PHPStanDba\Tests\ReflectorFactory;
 
 require_once __DIR__.'/../../../vendor/autoload.php';
 
+if (false === getenv('GITHUB_ACTION')) {
+    $dotenv = Dotenv::createImmutable(__DIR__.'/../../..');
+    $dotenv->load();
+}
+
 $config = RuntimeConfiguration::create();
 $config->errorMode(RuntimeConfiguration::ERROR_MODE_EXCEPTION);
 $config->stringifyTypes(true);