Simplify test config

Author: theodorejb

.github/workflows/php.yml

@@ -38,17 +38,18 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php }}
-          tools: psalm
-          extensions: sqlsrv-5.10.1
 
       - name: Setup problem matchers for PHPUnit
         run: echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
 
+      - name: Validate composer.json and composer.lock
+        run: composer validate --strict
+
       - name: Install Composer dependencies
         run: composer install --no-progress
 
       - name: Run Psalm
-        run: psalm --output-format=github
+        run: composer analyze -- --output-format=github
         if: ${{ matrix.php == '8.3' }}
 
       - name: Run PHPUnit

.gitignore

@@ -4,4 +4,4 @@
 
 /vendor/
 /composer.lock
-/test/src/LocalConfig.php
+/test/config.php

CONTRIBUTING.md

@@ -11,8 +11,8 @@ From a console in the working directory, execute `composer test` to run all unit
 
 > [!NOTE]
 > By default, database tests will attempt to run on a database named `PeachySQL`.
-> To override connection settings, create a `LocalConfig.php` class in the `test/src`
-> directory which extends `Config` and overrides the desired methods.
+> To override connection settings, create a `test/config.php` file which returns
+> an instance of `Config` with the desired property values.
 
 ## Formatting and static analysis
 

psalm.xml

@@ -4,7 +4,7 @@
     resolveFromConfigFile="true"
     findUnusedBaselineEntry="true"
     findUnusedCode="true"
-    findUnusedPsalmSuppress="false"
+    findUnusedPsalmSuppress="true"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns="https://getpsalm.org/schema/config"
     xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"

test/MssqlDbTest.php

@@ -27,10 +27,10 @@ public static function dbProvider(): PeachySql
     {
         if (!self::$db) {
             $c = App::$config;
-            $server = $c->getMssqlServer();
+            $server = $c->mssqlServer;
             $connStr = getenv('MSSQL_CONNECTION_STRING');
-            $username = $c->getMssqlUsername();
-            $password = $c->getMssqlPassword();
+            $username = $c->mssqlUsername;
+            $password = $c->mssqlPassword;
 
             if ($connStr !== false) {
                 // running tests with GitHub Actions

test/MysqlDbTest.php

@@ -28,7 +28,7 @@ public static function dbProvider(): PeachySql
         if (!self::$db) {
             $c = App::$config;
 
-            $pdo = new PDO($c->getMysqlDsn(), $c->getMysqlUser(), $c->getMysqlPassword(), [
+            $pdo = new PDO($c->mysqlDsn, $c->mysqlUser, $c->mysqlPassword, [
                 PDO::ATTR_EMULATE_PREPARES => false,
             ]);
 

test/PgsqlDbTest.php

@@ -34,7 +34,7 @@ public static function dbProvider(): PeachySql
             $c = App::$config;
             $dbName = getenv('POSTGRES_HOST') !== false ? 'postgres' : 'PeachySQL';
 
-            $pdo = new PDO($c->getPgsqlDsn($dbName), $c->getPgsqlUser(), $c->getPgsqlPassword(), [
+            $pdo = new PDO($c->getPgsqlDsn($dbName), $c->pgsqlUser, $c->pgsqlPassword, [
                 PDO::ATTR_EMULATE_PREPARES => false,
             ]);
 

test/bootstrap.php

@@ -1,13 +1,19 @@
 <?php
 
-use DevTheorem\PeachySQL\Test\src\{App, Config, LocalConfig};
+use DevTheorem\PeachySQL\Test\src\{App, Config};
 
 require 'vendor/autoload.php';
 
-if (class_exists(LocalConfig::class)) {
-    // suppress error when LocalConfig doesn't exist
-    /** @psalm-suppress MixedAssignment */
-    App::$config = new LocalConfig();
+$configFile = __DIR__ . '/config.php';
+
+if (file_exists($configFile)) {
+    $config = require $configFile;
+
+    if (!$config instanceof Config) {
+        throw new Exception('Expected config file to return Config instance');
+    }
+
+    App::$config = $config;
 } else {
     App::$config = new Config();
 }

test/src/Config.php

@@ -2,53 +2,21 @@
 
 namespace DevTheorem\PeachySQL\Test\src;
 
-/**
- * Default test config. Values can be overridden with a LocalConfig child class.
- */
 class Config
 {
-    public function getMysqlDsn(): string
-    {
-        return "mysql:host=127.0.0.1;port=3306;dbname=PeachySQL";
-    }
+    public string $mssqlServer = '(local)\SQLEXPRESS';
+    public string $mssqlUsername = '';
+    public string $mssqlPassword = '';
 
-    public function getMysqlUser(): string
-    {
-        return 'root';
-    }
+    public string $mysqlDsn = 'mysql:host=127.0.0.1;port=3306;dbname=PeachySQL';
+    public string $mysqlUser = 'root';
+    public string $mysqlPassword = '';
 
-    public function getMysqlPassword(): string
-    {
-        return '';
-    }
+    public string $pgsqlUser = 'postgres';
+    public string $pgsqlPassword = 'postgres';
 
     public function getPgsqlDsn(string $database): string
     {
         return "pgsql:host=localhost;dbname=$database";
     }
-
-    public function getPgsqlUser(): string
-    {
-        return 'postgres';
-    }
-
-    public function getPgsqlPassword(): string
-    {
-        return 'postgres';
-    }
-
-    public function getMssqlServer(): string
-    {
-        return '(local)\SQLEXPRESS';
-    }
-
-    public function getMssqlUsername(): string
-    {
-        return '';
-    }
-
-    public function getMssqlPassword(): string
-    {
-        return '';
-    }
 }