Feature/amp postgres (#9)

* Add declare strict types

* Add support for amphp/postgres

* Check for interface, not class

Author: cspray

.gitignore

@@ -2,4 +2,5 @@
 ..
 /vendor
 .phpunit.cache
-.phpunit.result.cache
+.phpunit.result.cache
+composer.lock

CHANGELOG.md

@@ -0,0 +1,28 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased Changes
+
+### Added
+
+- Introduces a `Cspray\DatabaseTestCase\AbstractConnectionAdapter` for implementing functionality common across all `Cspray\DatabaseTestCase\ConnectionAdapter` implementations.
+- Provides the `Cspray\DatabaseTestCase\AmpPostgresConnectionAdapter` for working with the amphp/postgres library.
+
+### Changed
+
+- The `Cspray\DatabaseTestCase\PdoConnectionAdapter` now extends the new `AbstractConnectionAdapter` and has been simplified.
+- Added `declare(strict_types=1)` in all files it was missing.
+
+## [0.1.0](https://github.com/cspray/database-test-case/releases/tag/0.1.0) - 2023-03-02
+
+### Added
+
+- Adds a `Cspray\DatabaseTestCase\DatabaseTestCase` that allows for testing database interactions.
+- Adds a `Cspray\DatabaseTestCase\ConnectionAdapter` interface that is responsible for actual calls to an underlying connection.
+- Provides a `Cspray\DatabaseTestCase\PdoConnectionAdapter` with support for PostgreSQL databases.
+- Provides a mechanism for loading fixtures per test, using the Attribute `#[LoadFixture]` and providing an implementation of `Cspray\DatabaseTestCase\Fixture`.
+- Provides a mechanism for retrieving the state of a database table at a given point in time with `Cspray\DatabaseTestCase\DatabaseRepresentation\Table`.

composer.json

@@ -7,13 +7,16 @@
     "database"
   ],
   "license": ["MIT"],
+  "minimum-stability": "beta",
+  "prefer-stable": true,
   "require": {
     "php": "^8.2",
     "phpunit/phpunit": "^10.0"
   },
   "require-dev": {
     "ext-pdo": "*",
     "ext-pdo_pgsql": "*",
+    "amphp/postgres": "^v2.0.0-beta.2",
     "roave/security-advisories": "dev-latest"
   },
   "autoload": {
@@ -27,6 +30,7 @@
     }
   },
   "suggest": {
-    "ext-pdo": "To enable the PdoConnectionAdapter"
+    "ext-pdo": "To enable the PdoConnectionAdapter",
+    "amphp/postgres": "To enable the AmpPostgresConnectionAdapter"
   }
 }

docker/php/Dockerfile

@@ -4,7 +4,7 @@ RUN apt-get update -y \
     && apt-get upgrade -y
 
 RUN apt-get install git libsodium-dev libzip-dev libpq-dev -y
-RUN docker-php-ext-install sodium zip pdo pdo_pgsql
+RUN docker-php-ext-install sodium zip pdo pdo_pgsql pgsql
 
 RUN mv "$PHP_INI_DIR/php.ini-development" "$PHP_INI_DIR/php.ini"
 

src/AbstractConnectionAdapter.php

@@ -0,0 +1,67 @@
+<?php declare(strict_types=1);
+
+namespace Cspray\DatabaseTestCase;
+
+use Cspray\DatabaseTestCase\DatabaseRepresentation\Row;
+use Cspray\DatabaseTestCase\DatabaseRepresentation\Table;
+use Cspray\DatabaseTestCase\Exception\UnableToGetTable;
+use Throwable;
+
+abstract class AbstractConnectionAdapter implements ConnectionAdapter {
+
+    final public function loadFixture(Fixture $fixture, Fixture ...$additionalFixture) : void {
+        /** @var Fixture $f */
+        foreach ([$fixture, ...$additionalFixture] as $f) {
+            foreach ($f->getFixtureRecords() as $fixtureRecord) {
+                $sql = $this->generateInsertSqlForParameters($fixtureRecord);
+                $parameters = $fixtureRecord->parameters;
+                $this->executeInsertSql($sql, $parameters);
+            }
+        }
+    }
+
+    final public function getTable(string $name) : Table {
+        try {
+            $table = Table::forName($name);
+            foreach ($this->executeSelectAllSql($name) as $row) {
+                $r = null;
+                foreach ($row as $col => $val) {
+                    $r = $r === null ? Row::forValue($col, $val) : $r->withValue($col, $val);
+                }
+                $table = $table->withRow($r);
+            }
+            return $table;
+        } catch (Throwable $throwable) {
+            throw new UnableToGetTable(
+                message: sprintf('Unable to fetch table "%s", please check previous Exception for more details.', $name),
+                previous: $throwable
+            );
+        }
+    }
+
+    protected function generateInsertSqlForParameters(FixtureRecord $fixtureRecord) : string {
+        $table = $fixtureRecord->table;
+        $parameters = $fixtureRecord->parameters;
+        $colsString = implode(
+            ', ',
+            array_keys($parameters)
+        );
+        $paramString = implode(
+            ', ',
+            array_map(static fn(string $col) => ':' . $col, array_keys($parameters))
+        );
+        return <<<SQL
+INSERT INTO $table ($colsString)
+VALUES ($paramString)
+SQL;
+    }
+
+    abstract protected function executeInsertSql(string $sql, array $parameters) : void;
+
+    /**
+     * @return list<array<string, mixed>>
+     * @throws Throwable
+     */
+    abstract protected function executeSelectAllSql(string $table) : array;
+
+}

src/AmpPostgresConnectionAdapter.php

@@ -0,0 +1,65 @@
+<?php declare(strict_types=1);
+
+namespace Cspray\DatabaseTestCase;
+
+use Amp\Postgres\PostgresConfig;
+use Amp\Postgres\PostgresLink;
+use Cspray\DatabaseTestCase\Exception\MissingRequiredComposerPackage;
+use function Amp\Postgres\connect;
+
+if (! interface_exists(PostgresLink::class)) {
+    throw new MissingRequiredComposerPackage('You must install amphp/postgres to use ' . AmpPostgresConnectionAdapter::class);
+}
+
+class AmpPostgresConnectionAdapter extends AbstractConnectionAdapter {
+
+    private ?PostgresLink $connection = null;
+
+    public function __construct(
+        private readonly ConnectionAdapterConfig $adapterConfig
+    ) {}
+
+    public function establishConnection() : void {
+        $this->connection = connect(
+            PostgresConfig::fromString(sprintf(
+                'db=%s host=%s port=%d user=%s pass=%s',
+                $this->adapterConfig->database,
+                $this->adapterConfig->host,
+                $this->adapterConfig->port,
+                $this->adapterConfig->user,
+                $this->adapterConfig->password
+            ))
+        );
+    }
+
+    public function onTestStart() : void {
+        $this->connection->query('START TRANSACTION');
+    }
+
+    public function onTestStop() : void {
+        $this->connection->query('ROLLBACK');
+    }
+
+    public function closeConnection() : void {
+        $this->connection->close();
+        $this->connection = null;
+    }
+
+    public function getUnderlyingConnection() : PostgresLink {
+        return $this->connection;
+    }
+
+    protected function executeInsertSql(string $sql, array $parameters) : void {
+        $statement = $this->connection->prepare($sql);
+        $statement->execute($parameters);
+    }
+
+    protected function executeSelectAllSql(string $table) : array {
+        $result = $this->connection->query(sprintf('SELECT * FROM %s', $table));
+        $rows = [];
+        while ($row = $result->fetchRow()) {
+            $rows[] = $row;
+        }
+        return $rows;
+    }
+}

src/ConnectionAdapter.php

@@ -1,4 +1,4 @@
-<?php
+<?php declare(strict_types=1);
 
 namespace Cspray\DatabaseTestCase;
 

src/ConnectionAdapterConfig.php

@@ -1,4 +1,4 @@
-<?php
+<?php declare(strict_types=1);
 
 namespace Cspray\DatabaseTestCase;
 

src/DatabaseRepresentation/Row.php

@@ -1,4 +1,4 @@
-<?php
+<?php declare(strict_types=1);
 
 namespace Cspray\DatabaseTestCase\DatabaseRepresentation;
 

src/DatabaseTestCase.php

@@ -1,4 +1,4 @@
-<?php
+<?php declare(strict_types=1);
 
 namespace Cspray\DatabaseTestCase;
 
@@ -7,9 +7,6 @@
 use PHPUnit\Framework\TestCase;
 use ReflectionMethod;
 
-/**
- *
- */
 abstract class DatabaseTestCase extends TestCase {
 
     private static ?ConnectionAdapter $connectionAdapter;