Merge pull request #5 from 77web/feat/add-tests

add tests

Author: 77web

compose.yml

@@ -0,0 +1,12 @@
+version: "3.9"
+services:
+  postgres:
+    image: postgres:15.0-alpine
+    environment:
+      TZ: Asia/Tokyo
+      POSTGRES_DB: test
+      POSTGRES_USER: test
+      POSTGRES_PASSWORD: password
+      POSTGRES_INITDB_ARGS: --encoding=UTF-8 --locale=C
+    ports:
+      - "5432:5432"

composer.json

@@ -9,14 +9,20 @@
     "require-dev": {
         "phpunit/phpunit": "^10.0",
         "friendsofphp/php-cs-fixer": "^3.15",
-        "phpstan/phpstan": "^1.10"
+        "phpstan/phpstan": "^1.10",
+        "symfony/cache": "^7.1"
     },
     "license": "MIT",
     "autoload": {
         "psr-4": {
             "Linkage\\DoctrineRowLevelSecurity\\": "src/"
         }
     },
+    "autoload-dev": {
+        "psr-4": {
+            "Linkage\\DoctrineRowLevelSecurity\\Tests\\": "tests/"
+        }
+    },
     "authors": [
         {
             "name": "Hiromi Hishida",

phpunit.xml

@@ -4,7 +4,7 @@
          bootstrap="vendor/autoload.php"
          cacheDirectory=".phpunit.cache"
          executionOrder="depends,defects"
-         requireCoverageMetadata="true"
+         requireCoverageMetadata="false"
          beStrictAboutCoverageMetadata="true"
          beStrictAboutOutputDuringTests="true"
          failOnRisky="true"

tests/Entity/Dog.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Linkage\DoctrineRowLevelSecurity\Tests\Entity;
+
+use Doctrine\ORM\Mapping as ORM;
+use Linkage\DoctrineRowLevelSecurity\RowLevelSecurity;
+
+#[ORM\Table]
+#[ORM\Entity]
+#[RowLevelSecurity(name: 'dog_policy', role: 'dog_owner', using: 'owner_id = current_user::uuid')]
+class Dog
+{
+    #[ORM\Id]
+    #[ORM\Column(type: 'guid')]
+    public string $id;
+
+    #[ORM\ManyToOne(targetEntity: DogOwner::class)]
+    public DogOwner $owner;
+
+    #[ORM\Column(type: 'string')]
+    public string $name;
+}

tests/Entity/DogOwner.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Linkage\DoctrineRowLevelSecurity\Tests\Entity;
+
+use Doctrine\ORM\Mapping as ORM;
+
+#[ORM\Entity]
+#[ORM\Table]
+class DogOwner
+{
+    #[ORM\Id]
+    #[ORM\Column(type: 'guid')]
+    public string $id;
+
+    #[ORM\Column(type: 'string')]
+    public string $name;
+}

tests/Functional/RowLevelSecurityUsageTest.php

@@ -0,0 +1,77 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Linkage\DoctrineRowLevelSecurity\Tests\Functional;
+
+use Doctrine\Common\EventManager;
+use Doctrine\DBAL\Connection;
+use Doctrine\DBAL\DriverManager;
+use Doctrine\ORM\EntityManager;
+use Doctrine\ORM\Mapping\ClassMetadataFactory;
+use Doctrine\ORM\ORMSetup;
+use Doctrine\ORM\Tools\SchemaTool;
+use Linkage\DoctrineRowLevelSecurity\RowLevelSecurityAwarePostgreSqlConnection;
+use Linkage\DoctrineRowLevelSecurity\RowLevelSecurityListener;
+use Linkage\DoctrineRowLevelSecurity\Tests\Entity\Dog;
+use Linkage\DoctrineRowLevelSecurity\Tests\Entity\DogOwner;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Cache\Adapter\ArrayAdapter;
+
+class RowLevelSecurityUsageTest extends TestCase
+{
+    private Connection $conn;
+
+    protected function setUp(): void
+    {
+        $connectionParams = [
+            'dbname' => 'test',
+            'user' => 'test',
+            'password' => 'password',
+            'host' => 'localhost',
+            'driver' => 'pdo_pgsql',
+            'wrapperClass' => RowLevelSecurityAwarePostgreSqlConnection::class,
+        ];
+        $conn = DriverManager::getConnection($connectionParams);
+        foreach (explode(';', (string) file_get_contents(__DIR__ . '/drop_table.sql')) as $dropSql) {
+            if (trim($dropSql) === '') {
+                continue;
+            }
+            $conn->executeQuery($dropSql);
+        }
+        foreach (explode(';', (string) file_get_contents(__DIR__ . '/create_table.sql')) as $createSql) {
+            if (trim($createSql) === '') {
+                continue;
+            }
+            $conn->executeQuery($createSql);
+        }
+
+        $configuration = ORMSetup::createAttributeMetadataConfiguration(
+            paths: [__DIR__."/../Entity"],
+            isDevMode: true,
+            cache: new ArrayAdapter(),
+        );
+        $this->em = new EntityManager(
+            $conn,
+            $configuration,
+            new EventManager(),
+        );
+        $this->em->getEventManager()->addEventSubscriber(new RowLevelSecurityListener());
+    }
+
+    public function testCreateSchema(): void
+    {
+        $schemaTool = new SchemaTool($this->em);
+        $this->em->getConnection()->getDatabasePlatform()->setEventManager($this->em->getEventManager());
+        $classMetadataFactory = new ClassMetadataFactory();
+        $classMetadataFactory->setEntityManager($this->em);
+        $sql = $schemaTool->getCreateSchemaSql([
+            $classMetadataFactory->getMetadataFor(DogOwner::class),
+            $classMetadataFactory->getMetadataFor(Dog::class),
+        ]);
+
+        $this->assertContains('CREATE POLICY dog_policy ON Dog TO dog_owner USING (owner_id = current_user::uuid)', $sql);
+        $this->assertContains('GRANT ALL ON TABLE Dog TO dog_owner', $sql);
+        $this->assertContains('ALTER TABLE Dog ENABLE ROW LEVEL SECURITY', $sql);
+    }
+}

tests/Functional/create_table.sql

@@ -0,0 +1,12 @@
+CREATE TABLE dog_owner
+(
+    id uuid primary key,
+    name varchar(255) not null
+);
+CREATE TABLE dog
+(
+    id uuid primary key,
+    owner_id uuid not null,
+    name varchar(255) not null
+);
+ALTER TABLE dog ADD CONSTRAINT user_id_fk FOREIGN KEY (owner_id) REFERENCES dog_owner (id);

tests/Functional/drop_table.sql

@@ -0,0 +1,2 @@
+drop table if exists dog;
+drop table if exists dog_owner;