add basic tests on types and tools

pfilsx · pfilsx · commit 5a8382e73e1e · 2023-06-17T15:04:41.000+03:00
add ci
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -0,0 +1,42 @@
+name: CI
+on:
+  push:
+    branches: [ dev, master ]
+  pull_request:
+    branches: [ dev, master ]
+jobs:
+  tests:
+    runs-on: 'Ubuntu-20.04'
+    strategy:
+      fail-fast: false
+      matrix:
+        php: ['8.1', '8.2']
+
+    name: Tests PHP ${{ matrix.php }}
+    steps:
+      -   uses: actions/checkout@v2
+      -   uses: shivammathur/setup-php@v2
+          with:
+            php-version: '${{ matrix.php }}'
+            coverage: none
+            ini-values: 'memory_limit=-1'
+      -   uses: "ramsey/composer-install@v2"
+      -   name: Run Unit tests
+          run: vendor/bin/phpunit
+  style:
+    runs-on: 'Ubuntu-20.04'
+    strategy:
+      fail-fast: false
+      matrix:
+        php: [ '8.2' ]
+    name: Style PHP ${{ matrix.php }}
+    steps:
+      -   uses: actions/checkout@v2
+      -   uses: shivammathur/setup-php@v2
+          with:
+            php-version: '${{ matrix.php }}'
+            coverage: none
+            ini-values: 'memory_limit=-1'
+      -   uses: "ramsey/composer-install@v2"
+      -   name: Run Style checks
+          run: vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.php -v --dry-run --stop-on-violation
diff --git a/composer.json b/composer.json
@@ -39,6 +39,7 @@
         "doctrine/orm": "^2.13",
         "symfony/serializer": ">=5.4",
         "symfony/property-info": ">=5.4",
-        "phpunit/phpunit": "^10.0"
+        "phpunit/phpunit": "^10.0",
+        "symfony/property-access": ">=5.4"
     }
 }
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,14 +1,14 @@
 <?xml version="1.0"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" colors="true" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.0/phpunit.xsd">
-    <testsuites>
-        <testsuite name="PostgreSQLDoctrine">
-            <directory suffix="Test.php">./tests</directory>
-        </testsuite>
-    </testsuites>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" colors="true" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.2/phpunit.xsd">
+  <testsuites>
+    <testsuite name="PostgreSQLDoctrine">
+      <directory suffix="Test.php">./tests</directory>
+    </testsuite>
+  </testsuites>
 
-    <coverage>
-        <include>
-            <directory>./src</directory>
-        </include>
-    </coverage>
-</phpunit>
+  <source>
+    <include>
+      <directory>./src</directory>
+    </include>
+  </source>
+</phpunit>
diff --git a/src/DBAL/Platform/PostgreSQLPlatform.php b/src/DBAL/Platform/PostgreSQLPlatform.php
@@ -14,7 +14,7 @@
 use Pfilsx\PostgreSQLDoctrine\DBAL\Type\EnumType;
 use Pfilsx\PostgreSQLDoctrine\DBAL\Type\JsonModelType;
 
-final class PostgreSQLPlatform extends BasePlatform
+class PostgreSQLPlatform extends BasePlatform
 {
     public function createSchemaManager(Connection $connection): PostgreSQLSchemaManager
     {
diff --git a/src/DBAL/Schema/EnumTypeUsageAsset.php b/src/DBAL/Schema/EnumTypeUsageAsset.php
@@ -12,7 +12,7 @@ final class EnumTypeUsageAsset
 
     private ?string $default;
 
-    public function __construct(string $table, string $column, ?string $default = null)
+    public function __construct(string $table, string $column, string $default = null)
     {
         $this->table = $table;
         $this->column = $column;
diff --git a/src/DBAL/Schema/PostgreSQLSchemaManager.php b/src/DBAL/Schema/PostgreSQLSchemaManager.php
@@ -61,7 +61,7 @@ public function createComparator(): Comparator
         return new Comparator($this->_platform);
     }
 
-    protected function selectTableColumns(string $databaseName, ?string $tableName = null): Result
+    protected function selectTableColumns(string $databaseName, string $tableName = null): Result
     {
         $sql = 'SELECT';
 
diff --git a/src/DBAL/Schema/Schema.php b/src/DBAL/Schema/Schema.php
@@ -18,7 +18,7 @@ final class Schema extends BaseSchema
     public function __construct(
         array $tables = [],
         array $sequences = [],
-        ?SchemaConfig $schemaConfig = null,
+        SchemaConfig $schemaConfig = null,
         array $namespaces = [],
         array $types = []
     ) {
diff --git a/src/DBAL/Schema/SchemaDiff.php b/src/DBAL/Schema/SchemaDiff.php
@@ -22,7 +22,7 @@ public function __construct(
         array $createdTables = [],
         array $alteredTables = [],
         array $droppedTables = [],
-        ?Schema $fromSchema = null,
+        Schema $fromSchema = null,
         array $createdSchemas = [],
         array $droppedSchemas = [],
         array $createdSequences = [],
diff --git a/src/DBAL/Schema/Table.php b/src/DBAL/Schema/Table.php
@@ -27,7 +27,7 @@ public function addColumn($name, $typeName, array $options = []): Column
      *
      * @return self
      */
-    public function modifyColumn($name, array $options, ?string $enumClass = null): self
+    public function modifyColumn($name, array $options, string $enumClass = null): self
     {
         $column = $this->getColumn($name);
         $column->setOptions($options);
diff --git a/src/DBAL/Type/JsonModelType.php b/src/DBAL/Type/JsonModelType.php
@@ -32,7 +32,7 @@ public function convertToDatabaseValue(mixed $value, AbstractPlatform $platform)
             return null;
         }
 
-        if (!\is_object($value)) {
+        if (!\is_object($value) || get_class($value) !== static::getModelClass()) {
             throw ConversionException::conversionFailed($value, $this->getName());
         }
 
diff --git a/src/Tools/ArrayTypeTool.php b/src/Tools/ArrayTypeTool.php
@@ -45,7 +45,7 @@ final class ArrayTypeTool
      *
      * @return string
      */
-    public static function convertPHPArrayToDatabaseArrayString(array $array, ArrayTypeEnum $type, ?AbstractPlatform $platform = null): string
+    public static function convertPHPArrayToDatabaseArrayString(array $array, ArrayTypeEnum $type, AbstractPlatform $platform = null): string
     {
         if ($array === []) {
             return '{}';
@@ -55,7 +55,7 @@ public static function convertPHPArrayToDatabaseArrayString(array $array, ArrayT
             ArrayTypeEnum::SmallIntArray, ArrayTypeEnum::IntArray, ArrayTypeEnum::BigIntArray => self::convertIntPHPArrayToDatabaseArray($array, $type),
             ArrayTypeEnum::TextArray => self::convertStringPHPArrayToDatabaseArray($array),
             ArrayTypeEnum::BooleanArray => self::convertBooleanPHPArrayToDatabaseArray($array, $platform),
-            ArrayTypeEnum::JsonArray => array_map(static fn ($row) => '"' . json_encode($row) . '"', $array),
+            ArrayTypeEnum::JsonArray => array_map(static fn ($row) => '"' . addcslashes(json_encode($row), '"') . '"', $array),
         };
 
         return '{' . implode(',', $preparedArray) . '}';
@@ -70,7 +70,7 @@ public static function convertPHPArrayToDatabaseArrayString(array $array, ArrayT
      *
      * @return bool[]|int[]|string[]
      */
-    public static function convertDatabaseArrayStringToPHPArray(string $value, ArrayTypeEnum $type, ?AbstractPlatform $platform = null): array
+    public static function convertDatabaseArrayStringToPHPArray(string $value, ArrayTypeEnum $type, AbstractPlatform $platform = null): array
     {
         if ($value === '{}') {
             return [];
@@ -153,7 +153,7 @@ private static function convertBooleanPHPArrayToDatabaseArray(array $array, ?Abs
                 continue;
             }
 
-            throw new \InvalidArgumentException(\sprintf('Item at key %s has invalid type. Expected boolean, 0, 1 or boolean string literal, "%s" provided.', $key, \var_export($value, true)));
+            throw new \InvalidArgumentException(\sprintf('Item at key %s has invalid type. Expected boolean, 0, 1 or boolean string literal, %s provided.', $key, \var_export($value, true)));
         }
 
         return $array;
@@ -193,10 +193,10 @@ private static function convertDatabaseArrayStringToStringPHPArray(string $value
         $array = \str_getcsv(\trim($value, '{}'));
 
         foreach ($array as $key => $item) {
-            if ($item === null) {
-                unset($array[$key]);
+            if ($item === 'null') {
+                $array[$key] = null;
 
-                break;
+                continue;
             }
 
             $array[$key] = \stripslashes($item);
diff --git a/src/Tools/SchemaTool.php b/src/Tools/SchemaTool.php
@@ -294,11 +294,11 @@ private function processingNotRequired(
         ClassMetadata $class,
         array $processedClasses
     ): bool {
-        return isset($processedClasses[$class->name]) ||
-            $class->isMappedSuperclass ||
-            $class->isEmbeddedClass ||
-            ($class->isInheritanceTypeSingleTable() && $class->name !== $class->rootEntityName) ||
-            in_array($class->name, $this->em->getConfiguration()->getSchemaIgnoreClasses());
+        return isset($processedClasses[$class->name])
+            || $class->isMappedSuperclass
+            || $class->isEmbeddedClass
+            || ($class->isInheritanceTypeSingleTable() && $class->name !== $class->rootEntityName)
+            || in_array($class->name, $this->em->getConfiguration()->getSchemaIgnoreClasses());
     }
 
     private function gatherColumns(ClassMetadata $class, Table $table): void
@@ -673,8 +673,8 @@ private function addDiscriminatorColumnDefinition(ClassMetadata $class, Table $t
         $discrColumn = $class->discriminatorColumn;
 
         if (
-            !isset($discrColumn['type']) ||
-            (strtolower($discrColumn['type']) === 'string' && !isset($discrColumn['length']))
+            !isset($discrColumn['type'])
+            || (strtolower($discrColumn['type']) === 'string' && !isset($discrColumn['length']))
         ) {
             $discrColumn['type'] = 'string';
             $discrColumn['length'] = 255;
diff --git a/tests/Fixtures/Model/TestModel.php b/tests/Fixtures/Model/TestModel.php
@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pfilsx\PostgreSQLDoctrine\Tests\Fixtures\Model;
+
+
+final class TestModel
+{
+    public int $id;
+
+    private string $text;
+
+    public function getText(): string
+    {
+        return $this->text;
+    }
+
+    public function setText(string $text): self
+    {
+        $this->text = $text;
+        return $this;
+    }
+}
diff --git a/tests/Fixtures/Type/TestJsonModelType.php b/tests/Fixtures/Type/TestJsonModelType.php
@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pfilsx\PostgreSQLDoctrine\Tests\Fixtures\Type;
+
+
+use Pfilsx\PostgreSQLDoctrine\DBAL\Type\JsonModelType;
+use Pfilsx\PostgreSQLDoctrine\Tests\Fixtures\Model\TestModel;
+
+final class TestJsonModelType extends JsonModelType
+{
+    public static function getTypeName(): string
+    {
+        return 'test_json_model_type';
+    }
+
+    protected static function getModelClass(): string
+    {
+        return TestModel::class;
+    }
+}
diff --git a/tests/Unit/DBAL/Type/ArrayTypesTest.php b/tests/Unit/DBAL/Type/ArrayTypesTest.php
@@ -0,0 +1,91 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pfilsx\PostgreSQLDoctrine\Tests\Unit\DBAL\Type;
+
+
+use Pfilsx\PostgreSQLDoctrine\DBAL\Platform\PostgreSQLPlatform;
+use Pfilsx\PostgreSQLDoctrine\DBAL\Type\BigIntArrayType;
+use Pfilsx\PostgreSQLDoctrine\DBAL\Type\BooleanArrayType;
+use Pfilsx\PostgreSQLDoctrine\DBAL\Type\IntegerArrayType;
+use Pfilsx\PostgreSQLDoctrine\DBAL\Type\JsonArrayType;
+use Pfilsx\PostgreSQLDoctrine\DBAL\Type\SmallIntArrayType;
+use Pfilsx\PostgreSQLDoctrine\DBAL\Type\TextArrayType;
+use PHPUnit\Framework\TestCase;
+
+final class ArrayTypesTest extends TestCase
+{
+    private PostgreSQLPlatform $platform;
+
+    public function setUp(): void
+    {
+        $this->platform = $this->createMock(PostgreSQLPlatform::class);
+    }
+
+    /**
+     * @see SmallIntArrayType
+     */
+    public function testSmallIntArrayType(): void
+    {
+        $type = new SmallIntArrayType();
+        self::assertSame('smallint[]', $type->getName());
+        self::assertSame('{-32768,0,32767}', $type->convertToDatabaseValue([-32768, 0, 32767], $this->platform));
+        self::assertSame([-32768, 0, 32767], $type->convertToPHPValue('{-32768,0,32767}', $this->platform));
+    }
+
+    /**
+     * @see IntegerArrayType
+     */
+    public function testIntArrayType(): void
+    {
+        $type = new IntegerArrayType();
+        self::assertSame('integer[]', $type->getName());
+        self::assertSame('{-2147483648,0,2147483647}', $type->convertToDatabaseValue([-2147483648, 0, 2147483647], $this->platform));
+        self::assertSame([-2147483648, 0, 2147483647], $type->convertToPHPValue('{-2147483648,0,2147483647}', $this->platform));
+    }
+
+    /**
+     * @see BigIntArrayType
+     */
+    public function testBigIntArrayType(): void
+    {
+        $type = new BigIntArrayType();
+        self::assertSame('bigint[]', $type->getName());
+        self::assertSame('{-9223372036854775807,0,9223372036854775807}', $type->convertToDatabaseValue([-9223372036854775807, 0, 9223372036854775807], $this->platform));
+        self::assertSame([-9223372036854775807, 0, 9223372036854775807], $type->convertToPHPValue('{-9223372036854775807,0,9223372036854775807}', $this->platform));
+    }
+
+    /**
+     * @see BooleanArrayType
+     */
+    public function testBooleanArrayType(): void
+    {
+        $type = new BooleanArrayType();
+        self::assertSame('bool[]', $type->getName());
+        self::assertSame('{true,false,true,false}', $type->convertToDatabaseValue([1, false, 'yes', 'off'], $this->platform));
+        self::assertSame([true, false], $type->convertToPHPValue('{true,false}', $this->platform));
+    }
+
+    /**
+     * @see TextArrayType
+     */
+    public function testTextArrayType(): void
+    {
+        $type = new TextArrayType();
+        self::assertSame('text[]', $type->getName());
+        self::assertSame('{1,"text"}', $type->convertToDatabaseValue(['1', 'text'], $this->platform));
+        self::assertSame(['1', 'text'], $type->convertToPHPValue('{1,"text"}', $this->platform));
+    }
+
+    /**
+     * @see JsonArrayType
+     */
+    public function testJsonArrayType(): void
+    {
+        $type = new JsonArrayType();
+        self::assertSame('json[]', $type->getName());
+        self::assertSame('{"{\"key\":1}","{\"key\":2}"}', $type->convertToDatabaseValue([['key' => 1], ['key' => 2]], $this->platform));
+        self::assertSame([['key' => 1], ['key' => 2]], $type->convertToPHPValue('{"{\"key\":1}","{\"key\":2}"}', $this->platform));
+    }
+}
diff --git a/tests/Unit/DBAL/Type/EnumTypeTest.php b/tests/Unit/DBAL/Type/EnumTypeTest.php
diff --git a/tests/Unit/DBAL/Type/JsonModelTypeTest.php b/tests/Unit/DBAL/Type/JsonModelTypeTest.php
diff --git a/tests/Unit/Tools/ArrayTypeToolTest.php b/tests/Unit/Tools/ArrayTypeToolTest.php
diff --git a/tests/Unit/Tools/EnumToolTest.php b/tests/Unit/Tools/EnumToolTest.php

Original file line number	Diff line number	Diff line change
`@@ -39,6 +39,7 @@`
`39`	`39`	`"doctrine/orm": "^2.13",`
`40`	`40`	`"symfony/serializer": ">=5.4",`
`41`	`41`	`"symfony/property-info": ">=5.4",`
`42`		`- "phpunit/phpunit": "^10.0"`
	`42`	`+ "phpunit/phpunit": "^10.0",`
	`43`	`+ "symfony/property-access": ">=5.4"`
`43`	`44`	`}`
`44`	`45`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@`
`14`	`14`	`use Pfilsx\PostgreSQLDoctrine\DBAL\Type\EnumType;`
`15`	`15`	`use Pfilsx\PostgreSQLDoctrine\DBAL\Type\JsonModelType;`
`16`	`16`
`17`		`-final class PostgreSQLPlatform extends BasePlatform`
	`17`	`+class PostgreSQLPlatform extends BasePlatform`
`18`	`18`	`{`
`19`	`19`	`public function createSchemaManager(Connection $connection): PostgreSQLSchemaManager`
`20`	`20`	`{`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ final class EnumTypeUsageAsset`
`12`	`12`
`13`	`13`	`private ?string $default;`
`14`	`14`
`15`		`- public function __construct(string $table, string $column, ?string $default = null)`
	`15`	`+ public function __construct(string $table, string $column, string $default = null)`
`16`	`16`	`{`
`17`	`17`	`$this->table = $table;`
`18`	`18`	`$this->column = $column;`
Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ public function createComparator(): Comparator`
`61`	`61`	`return new Comparator($this->_platform);`
`62`	`62`	`}`
`63`	`63`
`64`		`- protected function selectTableColumns(string $databaseName, ?string $tableName = null): Result`
	`64`	`+ protected function selectTableColumns(string $databaseName, string $tableName = null): Result`
`65`	`65`	`{`
`66`	`66`	`$sql = 'SELECT';`
`67`	`67`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ public function addColumn($name, $typeName, array $options = []): Column`
`27`	`27`	`*`
`28`	`28`	`* @return self`
`29`	`29`	`*/`
`30`		`- public function modifyColumn($name, array $options, ?string $enumClass = null): self`
	`30`	`+ public function modifyColumn($name, array $options, string $enumClass = null): self`
`31`	`31`	`{`
`32`	`32`	`$column = $this->getColumn($name);`
`33`	`33`	`$column->setOptions($options);`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ public function convertToDatabaseValue(mixed $value, AbstractPlatform $platform)`
`32`	`32`	`return null;`
`33`	`33`	`}`
`34`	`34`
`35`		`- if (!\is_object($value)) {`
	`35`	`+ if (!\is_object($value) \|\| get_class($value) !== static::getModelClass()) {`
`36`	`36`	`throw ConversionException::conversionFailed($value, $this->getName());`
`37`	`37`	`}`
`38`	`38`