basic tests

Author: pfilsx

.gitattributes

@@ -1,3 +1,7 @@
-*.md export-ignore
 .* export-ignore
+*.md export-ignore
+/tests export-ignore
+/phpunit.xml.dist export-ignore
+/.github export-ignore
+/.php-cs-fixer.php export-ignore
 /docs export-ignore

.gitignore

@@ -1,2 +1,3 @@
 /vendor
-/composer.lock
+/composer.lock
+.phpunit.result.cache

composer.json

@@ -29,10 +29,16 @@
             "Pfilsx\\PostgreSQLDoctrine\\": "src/"
         }
     },
+    "autoload-dev": {
+        "psr-4": {
+            "Pfilsx\\PostgreSQLDoctrine\\Tests\\": "tests/"
+        }
+    },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^3.13",
         "doctrine/orm": "^2.13",
         "symfony/serializer": ">=5.4",
-        "symfony/property-info": ">=5.4"
+        "symfony/property-info": ">=5.4",
+        "phpunit/phpunit": "^10.0"
     }
 }

phpunit.xml.dist

@@ -0,0 +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>
+
+    <coverage>
+        <include>
+            <directory>./src</directory>
+        </include>
+    </coverage>
+</phpunit>

tests/Fixtures/Enum/TestEnumInterfaceEnum.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Pfilsx\PostgreSQLDoctrine\Tests\Fixtures\Enum;
+
+use Pfilsx\PostgreSQLDoctrine\DBAL\Contract\EnumInterface;
+
+final class TestEnumInterfaceEnum implements EnumInterface
+{
+    public const CASE1 = 'Case1';
+
+    public const CASE2 = 'Case2';
+
+    public const CASE3 = 'Case3';
+
+    public static function cases(): array
+    {
+        return [self::CASE1, self::CASE2, self::CASE3];
+    }
+}

tests/Fixtures/Enum/TestIntBackedEnum.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Pfilsx\PostgreSQLDoctrine\Tests\Fixtures\Enum;
+
+enum TestIntBackedEnum: int
+{
+    case Case1 = 1;
+    case Case2 = 2;
+    case Case3 = 3;
+}

tests/Fixtures/Enum/TestStringBackedEnum.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Pfilsx\PostgreSQLDoctrine\Tests\Fixtures\Enum;
+
+enum TestStringBackedEnum: string
+{
+    case Case1 = 'Case1';
+    case Case2 = 'Case2';
+    case Case3 = 'Case3';
+}

tests/Fixtures/Enum/TestUnitEnum.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Pfilsx\PostgreSQLDoctrine\Tests\Fixtures\Enum;
+
+enum TestUnitEnum
+{
+    case Case1;
+    case Case2;
+    case Case3;
+}

tests/Unit/Tools/EnumToolTest.php

@@ -0,0 +1,68 @@
+<?php
+
+namespace Pfilsx\PostgreSQLDoctrine\Tests\Unit\Tools;
+
+use Doctrine\DBAL\Exception\InvalidArgumentException;
+use Pfilsx\PostgreSQLDoctrine\Tests\Fixtures\Enum\TestEnumInterfaceEnum;
+use Pfilsx\PostgreSQLDoctrine\Tests\Fixtures\Enum\TestIntBackedEnum;
+use Pfilsx\PostgreSQLDoctrine\Tests\Fixtures\Enum\TestStringBackedEnum;
+use Pfilsx\PostgreSQLDoctrine\Tests\Fixtures\Enum\TestUnitEnum;
+use Pfilsx\PostgreSQLDoctrine\Tools\EnumTool;
+use PHPUnit\Framework\TestCase;
+
+final class EnumToolTest extends TestCase
+{
+    /**
+     * @dataProvider providerTestGetEnumTypeNameFromClassName
+     * @see EnumTool::getEnumTypeNameFromClassName()
+     */
+    public function testGetEnumTypeNameFromClassName(string $className, ?string $expectedName): void
+    {
+        if ($expectedName === null) {
+            self::expectException(InvalidArgumentException::class);
+        }
+
+        self::assertSame($expectedName, EnumTool::getEnumTypeNameFromClassName($className));
+    }
+
+    public static function providerTestGetEnumTypeNameFromClassName(): array
+    {
+        return [
+            'string enum' => [TestStringBackedEnum::class, 'test_string_backed_enum_type'],
+            'unit enum' => [TestUnitEnum::class, 'test_unit_enum_type'],
+            'enum interface' => [TestEnumInterfaceEnum::class, 'test_enum_interface_enum_type'],
+            'int enum' => [TestIntBackedEnum::class, null],
+            'other class' => [\stdClass::class, null],
+            'random string' => ['test', null],
+        ];
+    }
+
+    /**
+     * @dataProvider providerTestGetEnumLabelsByClassName
+     * @see EnumTool::getEnumLabelsByClassName()
+     */
+    public function testGetEnumLabelsByClassName(string $className, bool $expectException): void
+    {
+        if ($expectException) {
+            self::expectException(InvalidArgumentException::class);
+        }
+
+        self::assertSame([
+            'Case1',
+            'Case2',
+            'Case3',
+        ], EnumTool::getEnumLabelsByClassName($className));
+    }
+
+    public static function providerTestGetEnumLabelsByClassName(): array
+    {
+        return [
+            'string enum' => [TestStringBackedEnum::class, false],
+            'unit enum' => [TestUnitEnum::class, false],
+            'enum interface' => [TestEnumInterfaceEnum::class, false],
+            'int enum' => [TestIntBackedEnum::class, true],
+            'other class' => [\stdClass::class, true],
+            'random string' => ['test', true],
+        ];
+    }
+}