PHPUnit 10 support (#33)

.github/workflows/build.yml

@@ -36,6 +36,7 @@ jobs:
           - '8.0'
           - '8.1'
           - '8.2'
+          - '8.3'
     services:
       mysql:
         image: "mysql:${{ matrix.db-version }}"
@@ -60,8 +61,11 @@ jobs:
         with:
           dependency-versions: locked
           composer-options: --no-ansi --no-interaction --no-progress
+      - name: Override config
+        run: cp ci/phpunit/phpunit.96.xml phpunit.xml.dist
+        if: ${{ matrix.php-versions == '7.4' || matrix.php-versions == '8.0' }}
       - name: Run PHPUnit
-        run: vendor/bin/phpunit --colors=always
+        run: vendor/bin/phpunit --colors=always --config phpunit.xml.dist
   coverage:
     name: Tests coverage
     runs-on: ubuntu-latest

.gitignore

@@ -1,6 +1,7 @@
 /.idea
 /.phpunit.result.cache
 /composer.lock
+/phpunit.xml
 /build
 /vendor
 /tools

phpunit.xml → ci/phpunit/phpunit.96.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.6/phpunit.xsd"
          bootstrap="tests/bootstrap.php"
          beStrictAboutCoversAnnotation="true"
          beStrictAboutOutputDuringTests="true"

composer.json

@@ -18,12 +18,14 @@
     "require": {
         "php": "^7.4 || ^8.0",
         "ext-pdo": "*",
-        "phpunit/phpunit": "^9.5",
+        "phpunit/phpunit": "^9.5 || ^10.2",
+        "symfony/polyfill-php80": "^1.27",
         "symfony/yaml": "^5.4 || ^6.0"
     },
     "require-dev": {
+        "phpstan/extension-installer": "^1.3",
         "phpstan/phpstan": "^1.10",
-        "symplify/easy-coding-standard": "^11.3"
+        "symplify/easy-coding-standard": "^12.0"
     },
     "autoload": {
         "psr-4": {
@@ -39,6 +41,9 @@
         ]
     },
     "config": {
-        "sort-packages": true
+        "sort-packages": true,
+        "allow-plugins": {
+            "phpstan/extension-installer": true
+        }
     }
 }

docker-compose.yml

@@ -2,7 +2,7 @@ version: 3.x
 
 services:
   mysql:
-    image: mysql:5.7
+    image: biarms/mysql:5.7
     environment:
       MYSQL_DATABASE: dbunit
       MYSQL_ALLOW_EMPTY_PASSWORD: yes

ecs.php

@@ -2,8 +2,6 @@
 
 declare(strict_types=1);
 
-use PhpCsFixer\Fixer\Comment\HeaderCommentFixer;
-use PhpCsFixer\Fixer\Operator\NotOperatorWithSuccessorSpaceFixer;
 use Symplify\EasyCodingStandard\Config\ECSConfig;
 use Symplify\EasyCodingStandard\ValueObject\Set\SetList;
 
@@ -24,12 +22,13 @@
 file that was distributed with this source code.
 EOF;
 
-    $ecsConfig->ruleWithConfiguration(HeaderCommentFixer::class, [
+    $ecsConfig->ruleWithConfiguration(PhpCsFixer\Fixer\Comment\HeaderCommentFixer::class, [
         'header' => $header,
     ]);
 
     $ecsConfig->skip([
-        NotOperatorWithSuccessorSpaceFixer::class,
+        PhpCsFixer\Fixer\Operator\NotOperatorWithSuccessorSpaceFixer::class,
+        PhpCsFixer\Fixer\StringNotation\ExplicitStringVariableFixer::class,
     ]);
 
     $ecsConfig->sets([
@@ -38,5 +37,7 @@
         SetList::CLEAN_CODE,
         SetList::ARRAY,
         SetList::PHPUNIT,
+        SetList::CONTROL_STRUCTURES,
+        SetList::NAMESPACES,
     ]);
 };

phpstan.neon

@@ -3,5 +3,4 @@ parameters:
   paths:
     - src
     - tests
-  editorUrl: '%%file%%:%%line%%'
   checkGenericClassInNonGenericObjectType: false

phpunit.xml.dist

@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
+         bootstrap="tests/bootstrap.php"
+         colors="true">
+
+    <testsuites>
+        <testsuite name="all">
+            <directory>tests/</directory>
+            <exclude>tests/_files/*</exclude>
+        </testsuite>
+        <testsuite name="unit">
+            <directory>tests/</directory>
+            <exclude>tests/_files/*</exclude>
+            <exclude>tests/Operation/OperationsMySQLTest.php</exclude>
+        </testsuite>
+    </testsuites>
+
+    <php>
+        <env name="MYSQL_DB_HOST" value="127.0.0.1"/>
+        <env name="MYSQL_DB_PORT" value="3406"/>
+        <env name="MYSQL_DB_NAME" value="dbunit"/>
+        <env name="MYSQL_DB_USER" value="root"/>
+        <env name="MYSQL_DB_PASSWORD" value=""/>
+    </php>
+
+    <source>
+        <include>
+            <directory>src</directory>
+        </include>
+    </source>
+</phpunit>

src/Constraint/DataSetIsEqual.php

@@ -23,7 +23,7 @@ class DataSetIsEqual extends Constraint
     /**
      * @var IDataSet
      */
-    protected $value;
+    protected IDataSet $value;
 
     /**
      * @param IDataSet $value
@@ -41,8 +41,8 @@ public function __construct(IDataSet $value)
     public function toString(): string
     {
         return sprintf(
-            'is equal to expected %s',
-            (string) $this->value
+            'is equal to expected dataset %s',
+            $this->value
         );
     }
 

src/Constraint/TableIsEqual.php

@@ -23,7 +23,7 @@ class TableIsEqual extends Constraint
     /**
      * @var ITable
      */
-    protected $value;
+    protected ITable $value;
 
     /**
      * @param ITable $value
@@ -42,7 +42,7 @@ public function toString(): string
     {
         return sprintf(
             'is equal to expected %s',
-            (string) $this->value
+            $this->value
         );
     }
 

src/DataSet/AbstractDataSet.php

@@ -20,15 +20,15 @@ abstract class AbstractDataSet implements IDataSet
 {
     public function __toString()
     {
+        /** @var ITable[] $iterator */
         $iterator = $this->getIterator();
 
-        $dataSetString = '';
-
+        $tables = [];
         foreach ($iterator as $table) {
-            $dataSetString .= $table;
+            $tables[] = $table->getTableMetadata()->getTableName();
         }
 
-        return $dataSetString;
+        return '[' . implode(',', $tables) . ']';
     }
 
     /**

src/DataSet/AbstractXmlDataSet.php

@@ -102,9 +102,9 @@ protected function createTables(array &$tableColumns, array &$tableValues): void
      * @param string $tableName
      * @param mixed $tableColumns
      *
-     * @return ITable
+     * @return DefaultTable
      */
-    protected function getOrCreateTable($tableName, $tableColumns): ITable
+    protected function getOrCreateTable(string $tableName, $tableColumns): DefaultTable
     {
         if (empty($this->tables[$tableName])) {
             $tableMetaData = new DefaultTableMetadata($tableName, $tableColumns);

src/DataSet/DefaultDataSet.php

@@ -19,9 +19,9 @@ class DefaultDataSet extends AbstractDataSet
     /**
      * An array of ITable objects.
      *
-     * @var array
+     * @var ITable[]
      */
-    protected $tables;
+    protected array $tables;
 
     /**
      * @param array $tables

src/DataSet/DefaultTableMetadata.php

@@ -25,7 +25,7 @@ class DefaultTableMetadata extends AbstractTableMetadata
      * @param array $columns
      * @param array $primaryKeys
      */
-    public function __construct($tableName, array $columns, array $primaryKeys = [])
+    public function __construct(string $tableName, array $columns, array $primaryKeys = [])
     {
         $this->tableName = $tableName;
         $this->columns = $columns;

src/DataSet/IDataSet.php

@@ -14,7 +14,7 @@
 /**
  * Provides a basic interface for creating and reading data from data sets.
  */
-interface IDataSet extends \IteratorAggregate
+interface IDataSet extends \IteratorAggregate, \Stringable
 {
     /**
      * Returns an array of table names contained in the dataset.

src/DataSet/ITable.php

@@ -14,7 +14,7 @@
 /**
  * Provides a basic interface for creating and reading data from data sets.
  */
-interface ITable
+interface ITable extends \Stringable
 {
     /**
      * Returns the table's meta data.

src/DataSet/ReplacementDataSet.php

@@ -51,9 +51,9 @@ public function __construct(IDataSet $dataSet, array $fullReplacements = [], arr
      * Full replacements will only replace values if the FULL value is a match
      *
      * @param string $value
-     * @param string $replacement
+     * @param string|null $replacement
      */
-    public function addFullReplacement($value, $replacement): void
+    public function addFullReplacement(string $value, ?string $replacement): void
     {
         $this->fullReplacements[$value] = $replacement;
     }

src/DataSet/ReplacementTable.php

@@ -82,9 +82,9 @@ public function __toString()
      * Full replacements will only replace values if the FULL value is a match
      *
      * @param string $value
-     * @param string $replacement
+     * @param string|null $replacement
      */
-    public function addFullReplacement($value, $replacement): void
+    public function addFullReplacement(string $value, ?string $replacement): void
     {
         $this->fullReplacements[$value] = $replacement;
     }

src/Database/DataSet.php

@@ -38,6 +38,16 @@ class DataSet extends AbstractDataSet
      */
     protected $databaseConnection;
 
+    /**
+     * Creates a new dataset using the given database connection.
+     *
+     * @param Connection $databaseConnection
+     */
+    public function __construct(Connection $databaseConnection)
+    {
+        $this->databaseConnection = $databaseConnection;
+    }
+
     /**
      * Creates the query necessary to pull all of the data from a table.
      *
@@ -83,16 +93,6 @@ public static function buildTableSelect(ITableMetadata $tableMetaData, Connectio
         return "SELECT {$columnList} FROM {$tableName} {$orderBy}";
     }
 
-    /**
-     * Creates a new dataset using the given database connection.
-     *
-     * @param Connection $databaseConnection
-     */
-    public function __construct(Connection $databaseConnection)
-    {
-        $this->databaseConnection = $databaseConnection;
-    }
-
     /**
      * Returns a table object for the given table.
      *

src/Database/Metadata/AbstractMetadata.php

@@ -56,6 +56,19 @@ abstract class AbstractMetadata implements Metadata
      */
     protected $truncateCommand = 'TRUNCATE';
 
+    /**
+     * Creates a new database meta data object using the given pdo connection
+     * and schema name.
+     *
+     * @param PDO    $pdo
+     * @param string $schema
+     */
+    final public function __construct(PDO $pdo, $schema = '')
+    {
+        $this->pdo = $pdo;
+        $this->schema = $schema;
+    }
+
     /**
      * Creates a meta data object based on the driver of given $pdo object and
      * $schema name.
@@ -110,19 +123,6 @@ public static function registerClassWithDriver($className, $pdoDriver)
         throw new RuntimeException("Specified class for {$pdoDriver} driver ({$className}) does not extend PHPUnit_Extensions_Database_DB_MetaData.");
     }
 
-    /**
-     * Creates a new database meta data object using the given pdo connection
-     * and schema name.
-     *
-     * @param PDO    $pdo
-     * @param string $schema
-     */
-    final public function __construct(PDO $pdo, $schema = '')
-    {
-        $this->pdo = $pdo;
-        $this->schema = $schema;
-    }
-
     /**
      * Returns the schema for the connection.
      *
@@ -165,7 +165,9 @@ public function quoteSchemaObject($object)
      */
     public function splitTableName($fullTableName)
     {
-        if (($dot = strpos($fullTableName, '.')) !== false) {
+        $dot = strpos($fullTableName, '.');
+
+        if ($dot !== false) {
             return [
                 'schema' => substr($fullTableName, 0, $dot),
                 'table' => substr($fullTableName, $dot + 1),