Ease local testing (#367)

Author: arogachev

.github/workflows/build.yml

@@ -93,6 +93,12 @@ jobs:
 
       - name: Run tests with phpunit with code coverage.
         run: vendor/bin/phpunit --coverage-clover=coverage.xml --colors=always
+        env:
+          YII_PGSQL_DATABASE: yiitest
+          YII_PGSQL_HOST: 127.0.0.1
+          YII_PGSQL_PORT: 5432
+          YII_PGSQL_USER: root
+          YII_PGSQL_PASSWORD: root
 
       - name: Upload coverage to Codecov.
         uses: codecov/codecov-action@v3

.github/workflows/mutation.yml

@@ -79,3 +79,8 @@ jobs:
           vendor/bin/roave-infection-static-analysis-plugin --threads=2 --ignore-msi-with-no-mutations --only-covered
         env:
           STRYKER_DASHBOARD_API_KEY: ${{ secrets.STRYKER_DASHBOARD_API_KEY }}
+          YII_PGSQL_DATABASE: yiitest
+          YII_PGSQL_HOST: 127.0.0.1
+          YII_PGSQL_PORT: 5432
+          YII_PGSQL_USER: root
+          YII_PGSQL_PASSWORD: root

.gitignore

@@ -36,10 +36,6 @@ phpunit.phar
 /phpunit.xml
 /.phpunit.result.cache
 
-# NPM packages
-/node_modules
-.env
-
 #codeception
 /tests/_output
 c3.php

composer.json

@@ -45,14 +45,16 @@
         "roave/infection-static-analysis-plugin": "^1.16",
         "spatie/phpunit-watcher": "^1.23",
         "vimeo/psalm": "^5.25",
+        "vlucas/phpdotenv": "^5.6",
         "yiisoft/aliases": "^2.0",
         "yiisoft/cache-file": "^3.1",
         "yiisoft/var-dumper": "^1.5"
     },
     "autoload": {
         "psr-4": {
             "Yiisoft\\Db\\Pgsql\\": "src"
-        }
+        },
+        "files": ["tests/bootstrap.php"]
     },
     "autoload-dev": {
         "psr-4": {

tests/.env

@@ -0,0 +1,6 @@
+ENVIRONMENT=local
+YII_PGSQL_DATABASE=yii
+YII_PGSQL_HOST=postgres
+YII_PGSQL_PORT=5432
+YII_PGSQL_USER=postgres
+YII_PGSQL_PASSWORD=postgres

tests/CommandTest.php

@@ -9,13 +9,9 @@
 use Yiisoft\Db\Exception\Exception;
 use Yiisoft\Db\Exception\InvalidConfigException;
 use Yiisoft\Db\Exception\NotSupportedException;
-use Yiisoft\Db\Pgsql\Connection;
-use Yiisoft\Db\Pgsql\Dsn;
-use Yiisoft\Db\Pgsql\Driver;
 use Yiisoft\Db\Pgsql\Tests\Provider\CommandProvider;
 use Yiisoft\Db\Pgsql\Tests\Support\TestTrait;
 use Yiisoft\Db\Tests\Common\CommonCommandTest;
-use Yiisoft\Db\Tests\Support\DbHelper;
 
 use function serialize;
 
@@ -279,13 +275,7 @@ public function testinsertWithReturningPksUuid(): void
 
     public function testShowDatabases(): void
     {
-        $dsn = new Dsn('pgsql', '127.0.0.1');
-        $db = new Connection(new Driver($dsn->asString(), 'root', 'root'), DbHelper::getSchemaCache());
-
-        $command = $db->createCommand();
-
-        $this->assertSame('pgsql:host=127.0.0.1;dbname=postgres;port=5432', $db->getDriver()->getDsn());
-        $this->assertSame(['yiitest'], $command->showDatabases());
+        $this->assertSame([self::getDatabaseName()], self::getDb()->createCommand()->showDatabases());
     }
 
     #[DataProviderExternal(CommandProvider::class, 'createIndex')]

tests/PDODriverTest.php

@@ -8,7 +8,6 @@
 use PHPUnit\Framework\TestCase;
 use Yiisoft\Db\Exception\Exception;
 use Yiisoft\Db\Exception\InvalidConfigException;
-use Yiisoft\Db\Pgsql\Driver;
 use Yiisoft\Db\Pgsql\Tests\Support\TestTrait;
 
 /**
@@ -33,7 +32,7 @@ public function testConnectionCharset(): void
 
         $this->assertEqualsIgnoringCase('UTF8', array_values($charset)[0]);
 
-        $pdoDriver = new Driver('pgsql:host=127.0.0.1;dbname=yiitest;port=5432', 'root', 'root');
+        $pdoDriver = $this->getDriver();
         $pdoDriver->charset('latin1');
         $pdo = $pdoDriver->createConnection();
         $charset = $pdo->query('SHOW client_encoding', PDO::FETCH_ASSOC)->fetch();

tests/Support/TestTrait.php

@@ -5,6 +5,7 @@
 namespace Yiisoft\Db\Pgsql\Tests\Support;
 
 use Yiisoft\Db\Driver\Pdo\PdoConnectionInterface;
+use Yiisoft\Db\Driver\Pdo\PdoDriverInterface;
 use Yiisoft\Db\Exception\Exception;
 use Yiisoft\Db\Exception\InvalidConfigException;
 use Yiisoft\Db\Pgsql\Connection;
@@ -23,9 +24,7 @@ trait TestTrait
      */
     protected function getConnection(bool $fixture = false): PdoConnectionInterface
     {
-        $pdoDriver = new Driver($this->getDsn(), 'root', 'root');
-        $pdoDriver->charset('utf8');
-        $db = new Connection($pdoDriver, DbHelper::getSchemaCache());
+        $db = new Connection($this->getDriver(), DbHelper::getSchemaCache());
 
         if ($fixture) {
             DbHelper::loadFixture($db, __DIR__ . "/Fixture/$this->fixture");
@@ -36,15 +35,25 @@ protected function getConnection(bool $fixture = false): PdoConnectionInterface
 
     protected static function getDb(): PdoConnectionInterface
     {
-        $dsn = (new Dsn(databaseName: 'yiitest'))->asString();
-
-        return new Connection(new Driver($dsn, 'root', 'root'), DbHelper::getSchemaCache());
+        $dsn = (new Dsn(
+            host: self::getHost(),
+            databaseName: self::getDatabaseName(),
+            port: self::getPort(),
+        ))->asString();
+        $driver = new Driver($dsn, self::getUsername(), self::getPassword());
+        $driver->charset('utf8');
+
+        return new Connection($driver, DbHelper::getSchemaCache());
     }
 
     protected function getDsn(): string
     {
         if ($this->dsn === '') {
-            $this->dsn = (new Dsn(databaseName: 'yiitest'))->asString();
+            $this->dsn = (new Dsn(
+                host: self::getHost(),
+                databaseName: self::getDatabaseName(),
+                port: self::getPort(),
+            ))->asString();
         }
 
         return $this->dsn;
@@ -73,4 +82,37 @@ public static function setUpBeforeClass(): void
 
         $db->close();
     }
+
+    private function getDriver(): PdoDriverInterface
+    {
+        $driver = new Driver($this->getDsn(), self::getUsername(), self::getPassword());
+        $driver->charset('utf8');
+
+        return $driver;
+    }
+
+    private static function getDatabaseName(): string
+    {
+        return getenv('YII_PGSQL_DATABASE') ?: '';
+    }
+
+    private static function getHost(): string
+    {
+        return getenv('YII_PGSQL_HOST') ?: '';
+    }
+
+    private static function getPort(): string
+    {
+        return getenv('YII_PGSQL_PORT') ?: '';
+    }
+
+    private static function getUsername(): string
+    {
+        return getenv('YII_PGSQL_USER') ?: '';
+    }
+
+    private static function getPassword(): string
+    {
+        return getenv('YII_PGSQL_PASSWORD') ?: '';
+    }
 }

tests/bootstrap.php

@@ -0,0 +1,8 @@
+<?php
+
+declare(strict_types=1);
+
+if (getenv('ENVIRONMENT', local_only: true) === 'local') {
+    $dotenv = Dotenv\Dotenv::createUnsafeImmutable(__DIR__);
+    $dotenv->load();
+}