Validate PSR12 codestyle with PHPCS #69 (#70)

szhajdu · web-flow · commit 06be16dcf4dd · 2024-05-16T22:12:18.000+02:00
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -3,7 +3,28 @@ name: CI
 on: [push, pull_request]
 
 jobs:
+  phpcs:
+    name: Code style
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.3'
+          tools: phpcs
+
+      - name: Check production code style
+        run: composer cs-prod
+
+      - name: Check test code style
+        run: composer cs-tests
+
   tests:
+    name: Unit tests
     runs-on: ubuntu-latest
 
     services:
@@ -53,7 +74,7 @@ jobs:
       run: /opt/mssql-tools/bin/sqlcmd -S localhost -U sa -P 'P@ssw0rd' -Q 'CREATE DATABASE codeception_test'
 
     - name: Checkout code
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
 
     - name: Setup PHP
       uses: shivammathur/setup-php@v2
diff --git a/composer.json b/composer.json
@@ -21,12 +21,26 @@
         "ext-pdo": "*",
         "codeception/codeception": "*@dev"
     },
+    "require-dev": {
+        "squizlabs/php_codesniffer": "*"
+    },
     "conflict": {
         "codeception/codeception": "<5.0"
     },
     "autoload":{
         "classmap": ["src/"]
     },
+    "autoload-dev": {
+        "classmap": ["tests/"]
+    },
+    "scripts": {
+        "cs-prod": "phpcs src/",
+        "cs-tests": "phpcs tests/ --standard=tests/phpcs.xml"
+    },
+    "scripts-descriptions": {
+        "cs-prod": "Check production code style",
+        "cs-tests": "Check test code style"
+    },
     "config": {
         "classmap-authoritative": true,
         "sort-packages": true
diff --git a/docker-compose.amd64.yml b/docker-compose.amd64.yml
@@ -1,5 +1,3 @@
-version: '3.9'
-
 services:
   php:
     platform: linux/amd64
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -1,5 +1,3 @@
-version: "3.9"
-
 services:
   php:
     container_name: codeception-module-db
diff --git a/phpcs.xml b/phpcs.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0"?>
+<ruleset name="Codeception">
+    <description>Codeception code standard</description>
+    <rule ref="PSR12">
+        <exclude name="Generic.Files.LineLength.TooLong"/>
+        <exclude name="PSR2.Methods.MethodDeclaration.Underscore"/>
+    </rule>
+</ruleset>
diff --git a/src/Codeception/Lib/DbPopulator.php b/src/Codeception/Lib/DbPopulator.php
@@ -74,7 +74,7 @@ protected function buildCommand(string $command, string $dumpFile = null): strin
 
         foreach ($vars as $key => $value) {
             if (!is_array($value)) {
-                $vars['$'.$key] = $value;
+                $vars['$' . $key] = $value;
             }
 
             unset($vars[$key]);
diff --git a/src/Codeception/Lib/Driver/MySql.php b/src/Codeception/Lib/Driver/MySql.php
@@ -43,7 +43,7 @@ public function getPrimaryKey(string $tableName): array
             $columns = $stmt->fetchAll(PDO::FETCH_ASSOC);
 
             foreach ($columns as $column) {
-                $primaryKey []= $column['Column_name'];
+                $primaryKey[] = $column['Column_name'];
             }
             $this->primaryKeys[$tableName] = $primaryKey;
         }
diff --git a/src/Codeception/Lib/Driver/Oci.php b/src/Codeception/Lib/Driver/Oci.php
@@ -104,7 +104,7 @@ public function getPrimaryKey(string $tableName): array
             $columns = $stmt->fetchAll(\PDO::FETCH_ASSOC);
 
             foreach ($columns as $column) {
-                $primaryKey []= $column['COLUMN_NAME'];
+                $primaryKey[] = $column['COLUMN_NAME'];
             }
 
             $this->primaryKeys[$tableName] = $primaryKey;
diff --git a/src/Codeception/Lib/Driver/PostgreSql.php b/src/Codeception/Lib/Driver/PostgreSql.php
@@ -169,7 +169,7 @@ public function getPrimaryKey(string $tableName): array
             $stmt = $this->executeQuery($query, []);
             $columns = $stmt->fetchAll(PDO::FETCH_ASSOC);
             foreach ($columns as $column) {
-                $primaryKey []= $column['attname'];
+                $primaryKey[] = $column['attname'];
             }
 
             $this->primaryKeys[$tableName] = $primaryKey;
diff --git a/src/Codeception/Lib/Driver/SqlSrv.php b/src/Codeception/Lib/Driver/SqlSrv.php
@@ -77,7 +77,7 @@ public function getPrimaryKey(string $tableName): array
             $columns = $stmt->fetchAll(PDO::FETCH_ASSOC);
 
             foreach ($columns as $column) {
-                $primaryKey []= $column['Column_Name'];
+                $primaryKey[] = $column['Column_Name'];
             }
 
             $this->primaryKeys[$tableName] = $primaryKey;
diff --git a/src/Codeception/Lib/Driver/Sqlite.php b/src/Codeception/Lib/Driver/Sqlite.php
@@ -11,7 +11,7 @@
 class Sqlite extends Db
 {
     protected bool $hasSnapshot = false;
-    
+
     protected string $filename = '';
 
     public function __construct(string $dsn, string $user = null, string $password = null, array $options = null)
@@ -47,7 +47,7 @@ public function load(array $sql): void
             if (file_exists($this->filename . '_snapshot')) {
                 unlink($this->filename . '_snapshot');
             }
-            
+
             parent::load($sql);
             copy($this->filename, $this->filename . '_snapshot');
             $this->hasSnapshot = true;
@@ -71,7 +71,7 @@ public function getPrimaryKey(string $tableName): array
 
             foreach ($columns as $column) {
                 if ($column['pk'] !== '0' && $column['pk'] !== 0) {
-                    $primaryKey []= $column['name'];
+                    $primaryKey[] = $column['name'];
                 }
             }
 
diff --git a/src/Codeception/Module/Db.php b/src/Codeception/Module/Db.php
@@ -565,38 +565,43 @@ private function connect($databaseKey, $databaseConfig): void
 
         $options = [];
 
-        if (array_key_exists('ssl_key', $databaseConfig)
+        if (
+            array_key_exists('ssl_key', $databaseConfig)
             && !empty($databaseConfig['ssl_key'])
             && defined(PDO::class . '::MYSQL_ATTR_SSL_KEY')
         ) {
             $options[PDO::MYSQL_ATTR_SSL_KEY] = (string) $databaseConfig['ssl_key'];
         }
 
-        if (array_key_exists('ssl_cert', $databaseConfig)
+        if (
+            array_key_exists('ssl_cert', $databaseConfig)
             && !empty($databaseConfig['ssl_cert'])
             && defined(PDO::class . '::MYSQL_ATTR_SSL_CERT')
         ) {
             $options[PDO::MYSQL_ATTR_SSL_CERT] = (string) $databaseConfig['ssl_cert'];
         }
 
-        if (array_key_exists('ssl_ca', $databaseConfig)
+        if (
+            array_key_exists('ssl_ca', $databaseConfig)
             && !empty($databaseConfig['ssl_ca'])
             && defined(PDO::class . '::MYSQL_ATTR_SSL_CA')
         ) {
             $options[PDO::MYSQL_ATTR_SSL_CA] = (string) $databaseConfig['ssl_ca'];
         }
 
-        if (array_key_exists('ssl_cipher', $databaseConfig)
+        if (
+            array_key_exists('ssl_cipher', $databaseConfig)
             && !empty($databaseConfig['ssl_cipher'])
             && defined(PDO::class . '::MYSQL_ATTR_SSL_CIPHER')
         ) {
             $options[PDO::MYSQL_ATTR_SSL_CIPHER] = (string) $databaseConfig['ssl_cipher'];
         }
 
-        if (array_key_exists('ssl_verify_server_cert', $databaseConfig)
+        if (
+            array_key_exists('ssl_verify_server_cert', $databaseConfig)
             && defined(PDO::class . '::MYSQL_ATTR_SSL_VERIFY_SERVER_CERT')
         ) {
-            $options[PDO::MYSQL_ATTR_SSL_VERIFY_SERVER_CERT] = (boolean) $databaseConfig[ 'ssl_verify_server_cert' ];
+            $options[PDO::MYSQL_ATTR_SSL_VERIFY_SERVER_CERT] = (bool) $databaseConfig[ 'ssl_verify_server_cert' ];
         }
 
         try {
@@ -672,7 +677,7 @@ protected function removeInserted($databaseKey = null): void
             try {
                 $this->_getDriver()->deleteQueryByCriteria($row['table'], $row['primary']);
             } catch (Exception $e) {
-                $this->debug("Couldn't delete record " . json_encode($row['primary'], JSON_THROW_ON_ERROR) ." from {$row['table']}");
+                $this->debug("Couldn't delete record " . json_encode($row['primary'], JSON_THROW_ON_ERROR) . " from {$row['table']}");
             }
         }
 
diff --git a/tests/phpcs.xml b/tests/phpcs.xml
@@ -0,0 +1,9 @@
+<?xml version="1.0"?>
+<ruleset name="Codeception">
+    <description>Codeception code standard</description>
+    <rule ref="PSR12">
+        <exclude name="Generic.Files.LineLength.TooLong"/>
+        <exclude name="PSR1.Classes.ClassDeclaration.MissingNamespace"/>
+        <exclude name="PSR2.Methods.MethodDeclaration.Underscore"/>
+    </rule>
+</ruleset>
diff --git a/tests/support/UnitTester.php b/tests/support/UnitTester.php
@@ -1,6 +1,5 @@
 <?php
 
-
 /**
  * Inherited Methods
  * @method void wantToTest($text)
@@ -15,12 +14,12 @@
  * @method void pause()
  *
  * @SuppressWarnings(PHPMD)
-*/
+ */
 class UnitTester extends \Codeception\Actor
 {
     use _generated\UnitTesterActions;
 
-   /**
-    * Define custom actions here
-    */
+    /**
+     * Define custom actions here
+     */
 }
diff --git a/tests/unit/Codeception/Lib/Driver/DbTest.php b/tests/unit/Codeception/Lib/Driver/DbTest.php
@@ -6,33 +6,29 @@
 use Codeception\Test\Unit;
 use Codeception\Util\ReflectionHelper;
 
-/**
- * @group appveyor
- * @group db
- */
 final class DbTest extends Unit
 {
     /**
      * @dataProvider getWhereCriteria
      */
     public function testGenerateWhereClause(array $criteria, string $expectedResult)
     {
-        $db = new Db('sqlite:tests/data/sqlite.db','root','');
+        $db = new Db('sqlite:tests/data/sqlite.db', 'root', '');
         $result = ReflectionHelper::invokePrivateMethod($db, 'generateWhereClause', [&$criteria]);
         $this->assertSame($expectedResult, $result);
     }
 
     public function getWhereCriteria(): array
     {
         return [
-            'like'        => [['email like' => 'mail.ua'], 'WHERE "email" LIKE ? '],
-            '<='          => [['id <=' => '5'],            'WHERE "id" <= ? '],
-            '<'           => [['id <' => '5'],             'WHERE "id" < ? '],
-            '>='          => [['id >=' => '5'],            'WHERE "id" >= ? '],
-            '>'           => [['id >' => '5'],             'WHERE "id" > ? '],
-            '!='          => [['id !=' => '5'],            'WHERE "id" != ? '],
-            'is null'     => [['id' => null],              'WHERE "id" IS NULL '],
-            'is not null' => [['id !=' => null],           'WHERE "id" IS NOT NULL '],
+            'like' => [['email like' => 'mail.ua'], 'WHERE "email" LIKE ? '],
+            '<=' => [['id <=' => '5'], 'WHERE "id" <= ? '],
+            '<' => [['id <' => '5'], 'WHERE "id" < ? '],
+            '>=' => [['id >=' => '5'], 'WHERE "id" >= ? '],
+            '>' => [['id >' => '5'], 'WHERE "id" > ? '],
+            '!=' => [['id !=' => '5'], 'WHERE "id" != ? '],
+            'is null' => [['id' => null], 'WHERE "id" IS NULL '],
+            'is not null' => [['id !=' => null], 'WHERE "id" IS NOT NULL '],
         ];
     }
 }
diff --git a/tests/unit/Codeception/Lib/Driver/MysqlTest.php b/tests/unit/Codeception/Lib/Driver/MysqlTest.php
@@ -7,10 +7,6 @@
 use Codeception\Lib\Driver\MySql;
 use Codeception\Test\Unit;
 
-/**
- * @group appveyor
- * @group db
- */
 final class MysqlTest extends Unit
 {
     protected static array $config = [
@@ -69,9 +65,6 @@ public function testCleanupDatabase()
         $this->assertEmpty($this->mysql->getDbh()->query("SHOW TABLES")->fetchAll());
     }
 
-    /**
-     * @group appveyor
-     */
     public function testLoadDump()
     {
         $res = $this->mysql->getDbh()->query("select * from users where name = 'davert'");
@@ -108,7 +101,7 @@ public function testInsertIntoBitField()
     {
         $res = $this->mysql->executeQuery(
             "insert into `users`(`id`,`name`,`email`,`is_active`,`created_at`) values (?,?,?,?,?)",
-            [5,'insert.test','insert.test@mail.ua',false,'2012-02-01 21:17:47']
+            [5, 'insert.test', 'insert.test@mail.ua', false, '2012-02-01 21:17:47']
         );
         $this->assertSame(1, $res->rowCount());
     }
@@ -123,7 +116,7 @@ public function testLoadThrowsExceptionWhenDumpFileContainsSyntaxError()
             'check the manual that corresponds to your MySQL server version for the right syntax to use near ' .
             "'VALS('')' at line 1\nSQL query being executed: \n" . $sql;
         $this->expectException(ModuleException::class);
-        $this->expectExceptionMessage( $expectedMessage);
+        $this->expectExceptionMessage($expectedMessage);
         $this->mysql->load([$sql]);
     }
 }
diff --git a/tests/unit/Codeception/Lib/Driver/PostgresTest.php b/tests/unit/Codeception/Lib/Driver/PostgresTest.php
@@ -6,10 +6,6 @@
 use Codeception\Lib\Driver\PostgreSql;
 use Codeception\Test\Unit;
 
-/**
- * @group appveyor
- * @group db
- */
 final class PostgresTest extends Unit
 {
     protected static array $config = [
@@ -141,7 +137,7 @@ public function testGetEmptyArrayIfTableHasNoPrimaryKey()
 
     public function testLastInsertIdReturnsSequenceValueWhenNonStandardSequenceNameIsUsed()
     {
-        $this->postgres->executeQuery('INSERT INTO seqnames(name) VALUES(?)',['test']);
+        $this->postgres->executeQuery('INSERT INTO seqnames(name) VALUES(?)', ['test']);
         $this->assertSame('1', $this->postgres->lastInsertId('seqnames'));
     }
 
diff --git a/tests/unit/Codeception/Lib/Driver/SqliteTest.php b/tests/unit/Codeception/Lib/Driver/SqliteTest.php
@@ -7,10 +7,6 @@
 use Codeception\Lib\Driver\Sqlite;
 use Codeception\Test\Unit;
 
-/**
- * @group db
- * Class SqliteTest
- */
 final class SqliteTest extends Unit
 {
     /**
diff --git a/tests/unit/Codeception/Module/Db/MssqlDblibDbTest.php b/tests/unit/Codeception/Module/Db/MssqlDblibDbTest.php
@@ -2,13 +2,6 @@
 
 declare(strict_types=1);
 
-use Codeception\Configuration;
-
-require_once Configuration::testsDir() . 'unit/Codeception/Module/Db/AbstractDbTest.php';
-
-/**
- * @group db
- */
 final class MssqlDblibDbTest extends AbstractDbTest
 {
     public function getPopulator(): string
diff --git a/tests/unit/Codeception/Module/Db/MssqlSqlSrvDbTest.php b/tests/unit/Codeception/Module/Db/MssqlSqlSrvDbTest.php
@@ -2,13 +2,6 @@
 
 declare(strict_types=1);
 
-use Codeception\Configuration;
-
-require_once Configuration::testsDir() . 'unit/Codeception/Module/Db/AbstractDbTest.php';
-
-/**
- * @group db
- */
 final class MssqlSqlSrvDbTest extends AbstractDbTest
 {
     public function getPopulator(): string
diff --git a/tests/unit/Codeception/Module/Db/MySqlDbTest.php b/tests/unit/Codeception/Module/Db/MySqlDbTest.php
diff --git a/tests/unit/Codeception/Module/Db/Populator/DbPopulatorTest.php b/tests/unit/Codeception/Module/Db/Populator/DbPopulatorTest.php
diff --git a/tests/unit/Codeception/Module/Db/PostgreSqlDbTest.php b/tests/unit/Codeception/Module/Db/PostgreSqlDbTest.php
diff --git a/tests/unit/Codeception/Module/Db/SqliteDbTest.php b/tests/unit/Codeception/Module/Db/SqliteDbTest.php

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-version: '3.9'`
`2`		`-`
`3`	`1`	`services:`
`4`	`2`	`php:`
`5`	`3`	`platform: linux/amd64`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-version: "3.9"`
`2`		`-`
`3`	`1`	`services:`
`4`	`2`	`php:`
`5`	`3`	`container_name: codeception-module-db`
Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,7 @@ protected function buildCommand(string $command, string $dumpFile = null): strin`
`74`	`74`
`75`	`75`	`foreach ($vars as $key => $value) {`
`76`	`76`	`if (!is_array($value)) {`
`77`		`- $vars['$'.$key] = $value;`
	`77`	`+ $vars['$' . $key] = $value;`
`78`	`78`	`}`
`79`	`79`
`80`	`80`	`unset($vars[$key]);`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ public function getPrimaryKey(string $tableName): array`
`43`	`43`	`$columns = $stmt->fetchAll(PDO::FETCH_ASSOC);`
`44`	`44`
`45`	`45`	`foreach ($columns as $column) {`
`46`		`- $primaryKey []= $column['Column_name'];`
	`46`	`+ $primaryKey[] = $column['Column_name'];`
`47`	`47`	`}`
`48`	`48`	`$this->primaryKeys[$tableName] = $primaryKey;`
`49`	`49`	`}`
Original file line number	Diff line number	Diff line change
`@@ -104,7 +104,7 @@ public function getPrimaryKey(string $tableName): array`
`104`	`104`	`$columns = $stmt->fetchAll(\PDO::FETCH_ASSOC);`
`105`	`105`
`106`	`106`	`foreach ($columns as $column) {`
`107`		`- $primaryKey []= $column['COLUMN_NAME'];`
	`107`	`+ $primaryKey[] = $column['COLUMN_NAME'];`
`108`	`108`	`}`
`109`	`109`
`110`	`110`	`$this->primaryKeys[$tableName] = $primaryKey;`
Original file line number	Diff line number	Diff line change
`@@ -169,7 +169,7 @@ public function getPrimaryKey(string $tableName): array`
`169`	`169`	`$stmt = $this->executeQuery($query, []);`
`170`	`170`	`$columns = $stmt->fetchAll(PDO::FETCH_ASSOC);`
`171`	`171`	`foreach ($columns as $column) {`
`172`		`- $primaryKey []= $column['attname'];`
	`172`	`+ $primaryKey[] = $column['attname'];`
`173`	`173`	`}`
`174`	`174`
`175`	`175`	`$this->primaryKeys[$tableName] = $primaryKey;`
Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,7 @@ public function getPrimaryKey(string $tableName): array`
`77`	`77`	`$columns = $stmt->fetchAll(PDO::FETCH_ASSOC);`
`78`	`78`
`79`	`79`	`foreach ($columns as $column) {`
`80`		`- $primaryKey []= $column['Column_Name'];`
	`80`	`+ $primaryKey[] = $column['Column_Name'];`
`81`	`81`	`}`
`82`	`82`
`83`	`83`	`$this->primaryKeys[$tableName] = $primaryKey;`