Merge pull request #1798 from IrAlfred/refactor-test-db-config-env-based

feat(other): make database configuration for tests environment-based

Author: kroky

.env.test.example

@@ -0,0 +1,41 @@
+# Test Environment Configuration Template
+# 
+# REQUIRED: Copy this file to .env.test before running tests
+#   cp .env.test.example .env.test
+# 
+# Then edit .env.test with your database credentials.
+# The .env.test file is gitignored and safe for local credentials.
+#
+# Setup test database:
+#   php scripts/setup_database.php --env=.env.test
+#
+# Seed test data (required for tests to pass):
+#   For MySQL: mysql -u DB_USER -pDB_PASS DB_NAME < tests/phpunit/data/seed_mysql.sql
+#   For SQLite: sqlite3 DB_SOCKET < tests/phpunit/data/seed_sqlite.sql
+#   For PostgreSQL: PGPASSWORD=DB_PASS psql -h localhost -U DB_USER -d DB_NAME < tests/phpunit/data/seed_pgsql.sql
+#
+
+# Database Configuration for Tests
+DB_CONNECTION_TYPE=host
+DB_DRIVER=mysql
+DB_HOST=127.0.0.1
+DB_PORT=3306
+DB_NAME=cypht_test
+DB_USER=cypht_test
+DB_PASS=cypht_test
+DB_SOCKET=/var/lib/mysqld/mysqld.sock
+
+# Session Configuration for Tests
+SESSION_TYPE=PHP
+AUTH_TYPE=DB
+
+# User Configuration for Tests
+USER_CONFIG_TYPE=file
+USER_SETTINGS_DIR=tests/phpunit/data
+
+# Debug Mode
+DEBUG_LOG=true
+
+# Other test-specific settings
+DEFAULT_LANGUAGE=en
+ALLOW_SESSION_CACHE=false

.github/workflows/coveralls.yml

@@ -48,7 +48,7 @@ jobs:
         run: |
           FILE=/tmp/test.db
           cat tests/phpunit/data/schema_sqlite.sql | sqlite3 ${FILE}
-          cat tests/phpunit/data/seed.sql | sqlite3 ${FILE}
+          cat tests/phpunit/data/seed_sqlite.sql | sqlite3 ${FILE}
         env:
           DB_DRIVER: sqlite
           DB_NAME: cypht_test

.gitignore

@@ -10,6 +10,7 @@
 /.env
 /.env.*
 !.env.example
+!.env.test.example
 apigen4.sh
 testuser.txt
 website/docs

scripts/setup_database.php

@@ -9,8 +9,21 @@
 require VENDOR_PATH.'autoload.php';
 require APP_PATH.'lib/framework.php';
 
+// Allow specifying environment file via --env argument
+// Usage: php setup_database.php --env=.env.test
+$envFile = '.env';
+$options = getopt('', ['env:']);
+if (isset($options['env'])) {
+    $envFile = $options['env'];
+}
+
+if (!file_exists(APP_PATH . $envFile)) {
+    echo "Environment file {$envFile} not found. Please create it from the example file.\n";
+    exit(1);
+}
+
 $environment = Hm_Environment::getInstance();
-$environment->load();
+$environment->load($envFile);
 
 /* get config object */
 $config = new Hm_Site_Config_File();

tests/phpunit/bootstrap.php

@@ -53,7 +53,9 @@
 Hm_Tags_Wrapper::init($user_config, $session);
 
 $environment = Hm_Environment::getInstance();
-$environment->load('.env.example');
+// Load test environment configuration from .env.test
+// Create this file by copying .env.test.example: cp .env.test.example .env.test
+$environment->load('.env.test');
 /* set the default since and per_source values */
 $environment->define_default_constants($mock_config);
 

tests/phpunit/data/seed_pgsql.sql

@@ -0,0 +1,12 @@
+-- Test Data Seed for PHPUnit Tests (PostgreSQL)
+-- Password for 'unittestuser' is 'unittestpass'
+-- Password for 'testuser' is hashed with argon2id
+
+INSERT INTO hm_user (username, hash) VALUES 
+('unittestuser', 'sha512:86000:xfEgf7NIUQ2XkeU5tnIcA+HsN8pUllMVdzpJxCSwmbsZAE8Hze3Zs+MeIqepwocYteJ92vhq7pjOfrVThg/p1voELkDdPenU8i2PgG9UTI0IJTGhMN7rsUILgT6XlMAKLp/u2OD13sukUFcQNTdZNFqMsuTVTYw/Me2tAnFwgO4=:rfyUhYsWBCknx6EmbeswN0fy0hAC0N3puXzwWyDRquA='),
+('testuser', '$argon2id$v=19$m=65536,t=2,p=1$dw4pTU24zRKHCEkLcloU/A$9NJm6ALQhVpB2HTHmVHjOai912VhURUDAPsut5lrEa0')
+ON CONFLICT (username) DO UPDATE SET hash = EXCLUDED.hash;
+
+INSERT INTO hm_user_settings (username, settings) VALUES 
+('testuser', 'sFpVPU/hPvmfeiEKUBs4w1EizmbW/Ze2BALZf6kdJrIU3KVZrsqIhKaWTNNFRm3p51ssRAH2mpbxBMhsdpOAqIZMXFHjLttRu9t5WZWOkN7qwEh2LRq6imbkMkfqXg//K294QDLyWjE0Lsc/HSGqnguBF0YUVLVmWmdeqq7/OrXUo4HNbU88i4s2gkukKobJA2hjcOEq/rLOXr3t4LnLlcISnUbt4ptalSbeRrOnx4ehZV8hweQf1E+ID7s/a+8HHx1Qo713JDzReoLEKUsxRQ==')
+ON CONFLICT (username) DO UPDATE SET settings = EXCLUDED.settings;

tests/phpunit/data/seed.sql tests/phpunit/data/seed_sqlite.sqltests/phpunit/data/seed.sql renamed to tests/phpunit/data/seed_sqlite.sql

@@ -18,11 +18,12 @@ public function setUp(): void {
     public function test_build_dsn() {
         setup_db($this->config);
         $this->assertEquals('object', gettype(Hm_DB::connect($this->config)));
+        $db_name = $this->config->get('db_name', 'cypht_test');
         if ($this->config->data['db_driver'] == 'mysql') {
-            $this->assertEquals('mysql:host=127.0.0.1;dbname=cypht_test', Hm_DB::build_dsn());
+            $this->assertEquals('mysql:host=127.0.0.1;dbname='.$db_name, Hm_DB::build_dsn());
         }
         if ($this->config->data['db_driver'] == 'pgsql') {
-            $this->assertEquals('pgsql:host=127.0.0.1;dbname=cypht_test', Hm_DB::build_dsn());
+            $this->assertEquals('pgsql:host=127.0.0.1;dbname='.$db_name, Hm_DB::build_dsn());
         }
         $this->config->data['db_driver'] = 'sqlite';
         $this->config->data['db_socket'] = '/tmp/test.db';
@@ -33,7 +34,7 @@ public function test_build_dsn() {
         $this->config->data['db_connection_type'] = 'socket';
         $this->config->data['db_socket'] = '/test';
         $this->assertEquals('boolean', gettype(Hm_DB::connect($this->config)));
-        $this->assertEquals('mysql:unix_socket=/test;dbname=cypht_test', Hm_DB::build_dsn());
+        $this->assertEquals('mysql:unix_socket=/test;dbname='.$db_name, Hm_DB::build_dsn());
     }
     /**
      * @preserveGlobalState disabled

tests/phpunit/db.php

@@ -5,6 +5,16 @@
 set -e
 
 SCRIPT_DIR=$(dirname $(realpath "$0"))
+PROJECT_ROOT=$(dirname $(dirname "$SCRIPT_DIR"))
+
+# Change to project root to ensure correct paths work
+cd "$PROJECT_ROOT"
+
+# Create .env.test if it doesn't exist (for CI environments)
+if [ ! -f .env.test ]; then
+    echo "Creating .env.test from .env.test.example"
+    cp .env.test.example .env.test
+fi
 
 DB="${DB:-sqlite}"
 
@@ -21,7 +31,7 @@ if [ "$DB" = "sqlite" ]; then
     export DB_SOCKET=${FILE}
 
     cat ${SCRIPT_DIR}/data/schema_sqlite.sql | sqlite3 ${FILE}
-    cat ${SCRIPT_DIR}/data/seed.sql | sqlite3 ${FILE}
+    cat ${SCRIPT_DIR}/data/seed_sqlite.sql | sqlite3 ${FILE}
 
 elif [ "$DB" = "mysql" ]; then
     # Load schema.sql
@@ -42,4 +52,4 @@ else
     exit 1
 fi
 
-phpunit --configuration ${SCRIPT_DIR}/phpunit.xml --testdox $@
+${PROJECT_ROOT}/vendor/bin/phpunit --configuration ${SCRIPT_DIR}/phpunit.xml --testdox $@