Remove deploy connection from doctrine dbal

Prior to this change, doctrine still had a deploy connection, just because the gateway_test schema needed to be created.
All other write interaction with the gateway_test was performed via PDO.
Also, the gateway_test is currently based on the current entity mapping. But because the middleware generated schema is not available in the pipeline, this cannot be changed.

This change removes the deploy connection from doctrine, and creates the schema by using PDO.

Resolves #402

Author: johanib

composer.lock

@@ -7,35 +7,33 @@ services:
   gateway.service.gateway_api_sms:
     class: Surfnet\StepupGateway\ApiBundle\Tests\TestDouble\Service\SmsService
 
+  Surfnet\StepupGateway\Behat\ValueObject\SmoketestPdoFactory:
+    class: Surfnet\StepupGateway\Behat\ValueObject\SmoketestPdoFactory
+    arguments:
+      - '%database_host%'
+      - 'gw_deploy_user'
+      - 'gw_deploy_secret'
+      - 'gateway_test'
+
   Surfnet\StepupGateway\Behat\Repository\SecondFactorRepository:
     class: Surfnet\StepupGateway\Behat\Repository\SecondFactorRepository
     arguments:
-      - '@Surfnet\StepupGateway\Behat\Repository\Connection'
+      - '@Surfnet\StepupGateway\Behat\ValueObject\SmoketestPdoFactory'
 
   Surfnet\StepupGateway\Behat\Repository\SamlEntityRepository:
     class: Surfnet\StepupGateway\Behat\Repository\SamlEntityRepository
     arguments:
-      - '@Surfnet\StepupGateway\Behat\Repository\Connection'
+      - '@Surfnet\StepupGateway\Behat\ValueObject\SmoketestPdoFactory'
 
   Surfnet\StepupGateway\Behat\Repository\WhitelistRepository:
     class: Surfnet\StepupGateway\Behat\Repository\WhitelistRepository
     arguments:
-      - '@Surfnet\StepupGateway\Behat\Repository\Connection'
+      - '@Surfnet\StepupGateway\Behat\ValueObject\SmoketestPdoFactory'
 
   Surfnet\StepupGateway\Behat\Repository\InstitutionConfigurationRepository:
     class: Surfnet\StepupGateway\Behat\Repository\InstitutionConfigurationRepository
     arguments:
-      - '@Surfnet\StepupGateway\Behat\Repository\Connection'
-
-  Surfnet\StepupGateway\Behat\Repository\Connection:
-    class: Surfnet\StepupGateway\Behat\Repository\Connection
-    arguments:
-      - '%env(APP_ENV)%'
-      - 'gw_deploy_user'
-      - 'gw_deploy_secret'
-      - 'gateway_test'
-      - '%database_host%'
-
+      - '@Surfnet\StepupGateway\Behat\ValueObject\SmoketestPdoFactory'
 
   Surfnet\StepupGateway\Behat\Controller\ServiceProviderController:
     class: Surfnet\StepupGateway\Behat\Controller\ServiceProviderController
@@ -69,6 +67,13 @@ services:
       - "@logger"
     public: false
 
+  Surfnet\StepupGateway\Behat\Service\DatabaseSchemaService:
+    class: Surfnet\StepupGateway\Behat\Service\DatabaseSchemaService
+    public: true
+    arguments:
+      - '@doctrine.orm.gateway_entity_manager'
+      - '@Surfnet\StepupGateway\Behat\ValueObject\SmoketestPdoFactory'
+
   Surfnet\StepupGateway\Behat\Service\FixtureService:
     class: Surfnet\StepupGateway\Behat\Service\FixtureService
     public: true
@@ -82,6 +87,7 @@ services:
     public: true
     arguments:
       $fixtureService: '@Surfnet\StepupGateway\Behat\Service\FixtureService'
+      $databaseSchemaService: '@Surfnet\StepupGateway\Behat\Service\DatabaseSchemaService'
       $logger: '@logger'
 
   Surfnet\StepupGateway\Behat\ServiceProviderContext:

config/services_test.yaml

@@ -28,6 +28,7 @@
 use RuntimeException;
 use SAML2\Compat\ContainerSingleton;
 use Surfnet\SamlBundle\Tests\TestSaml2Container;
+use Surfnet\StepupGateway\Behat\Service\DatabaseSchemaService;
 use Surfnet\StepupGateway\Behat\Service\FixtureService;
 
 class FeatureContext implements Context
@@ -37,6 +38,11 @@ class FeatureContext implements Context
      */
     private $fixtureService;
 
+    /**
+     * @var DatabaseSchemaService
+     */
+    private static $databaseSchemaService;
+
     private $whitelistedInstitutions = [];
 
     /**
@@ -66,9 +72,13 @@ class FeatureContext implements Context
      */
     private $cookieDomain;
 
-    public function __construct(FixtureService $fixtureService, LoggerInterface $logger)
-    {
+    public function __construct(
+        FixtureService $fixtureService,
+        DatabaseSchemaService $databaseSchemaService,
+        LoggerInterface $logger
+    ) {
         $this->fixtureService = $fixtureService;
+        self::$databaseSchemaService = $databaseSchemaService;
         $this->sso2faCookieName = 'stepup-gateway_sso-on-second-factor-authentication';
         $this->sessCookieName = 'MOCKSESSID';
         $this->cookieDomain = '.gateway.dev.openconext.local';
@@ -80,10 +90,7 @@ public function __construct(FixtureService $fixtureService, LoggerInterface $log
     #[\Behat\Hook\BeforeFeature]
     public static function setupDatabase(BeforeFeatureScope $scope): void
     {
-        // Generate test databases
-        echo "Preparing test schemas\n";
-        shell_exec("/var/www/html/bin/console doctrine:schema:drop --env=smoketest --force");
-        shell_exec("/var/www/html/bin/console doctrine:schema:create --env=smoketest");
+        self::$databaseSchemaService->resetSchema();
     }
 
     #[\Behat\Hook\BeforeScenario]

tests/features/bootstrap/FeatureContext.php

@@ -19,22 +19,20 @@
 namespace Surfnet\StepupGateway\Behat\Repository;
 
 use Exception;
+use PDO;
+use Surfnet\StepupGateway\Behat\ValueObject\SmoketestPdoFactory;
 use function error_get_last;
 
 /**
  * A poor-mans repository, a pdo connection to the test database is established in the constructor
  */
 class InstitutionConfigurationRepository
 {
+    private readonly PDO $connection;
 
-    /**
-     * @var Connection
-     */
-    private $connection;
-
-    public function __construct(Connection $connection)
+    public function __construct(SmoketestPdoFactory $factory)
     {
-        $this->connection = $connection;
+        $this->connection = $factory->createConnection();
     }
 
     public function configure(string $institution, string $option, bool $value)

tests/src/Repository/Connection.php

@@ -21,6 +21,7 @@
 use Exception;
 use PDO;
 use Ramsey\Uuid\Uuid;
+use Surfnet\StepupGateway\Behat\ValueObject\SmoketestPdoFactory;
 
 /**
  * A poor mans repository, a pdo connection to the test database is established in the constructor
@@ -31,14 +32,11 @@ class SamlEntityRepository
 
     const SP_ADFS_SSO_LOCATION = 'https://gateway.dev.openconext.local/test/authentication/adfs/sso';
 
-    /**
-     * @var Connection
-     */
-    private $connection;
+    private readonly PDO $connection;
 
-    public function __construct(Connection $connection)
+    public function __construct(SmoketestPdoFactory $factory)
     {
-        $this->connection = $connection;
+        $this->connection = $factory->createConnection();
     }
 
     public function createSpIfNotExists($entityId, $certificate, $sfoEnabled = false)

tests/src/Repository/InstitutionConfigurationRepository.php

@@ -22,20 +22,18 @@
 use PDO;
 use Ramsey\Uuid\Uuid;
 use Surfnet\StepupBundle\Value\VettingType;
+use Surfnet\StepupGateway\Behat\ValueObject\SmoketestPdoFactory;
 
 /**
  * A poor mans repository, a pdo connection to the test database is established in the constructor
  */
 class SecondFactorRepository
 {
-    /**
-     * @var Connection
-     */
-    private $connection;
+    private readonly PDO $connection;
 
-    public function __construct(Connection $connection)
+    public function __construct(SmoketestPdoFactory $factory)
     {
-        $this->connection = $connection;
+        $this->connection = $factory->createConnection();
     }
 
     public function create($nameId, $tokenType, $institution, bool $selfAsserted = false, $identifier = null)

tests/src/Repository/SamlEntityRepository.php

@@ -20,20 +20,18 @@
 
 use Exception;
 use PDO;
+use Surfnet\StepupGateway\Behat\ValueObject\SmoketestPdoFactory;
 
 /**
  * A poor mans repository, a pdo connection to the test database is established in the constructor
  */
 class WhitelistRepository
 {
-    /**
-     * @var Connection
-     */
-    private $connection;
+    private readonly PDO $connection;
 
-    public function __construct(Connection $connection)
+    public function __construct(SmoketestPdoFactory $factory)
     {
-        $this->connection = $connection;
+        $this->connection = $factory->createConnection();
     }
 
     /**

tests/src/Repository/SecondFactorRepository.php

@@ -0,0 +1,75 @@
+<?php declare(strict_types=1);
+
+/**
+ * Copyright 2025 SURFnet bv
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace Surfnet\StepupGateway\Behat\Service;
+
+use Doctrine\ORM\EntityManagerInterface;
+use Doctrine\ORM\Tools\SchemaTool;
+use PDO;
+use Surfnet\StepupGateway\Behat\ValueObject\SmoketestPdoFactory;
+
+/**
+ * Manages the database schema for smoketests.
+ * Uses Doctrine's schema tools to generate SQL from entity mappings,
+ * but executes via PDO with elevated privileges (deploy user).
+ */
+class DatabaseSchemaService
+{
+    private readonly PDO $connection;
+
+    public function __construct(
+        private readonly EntityManagerInterface $entityManager,
+        SmoketestPdoFactory $pdoFactory,
+    ) {
+        $this->connection = $pdoFactory->createConnection();
+    }
+
+    public function dropSchema(): void
+    {
+        $this->connection->exec('SET FOREIGN_KEY_CHECKS = 0');
+
+        $stmt = $this->connection->query('SHOW TABLES');
+        $tables = $stmt->fetchAll(PDO::FETCH_COLUMN);
+
+        foreach ($tables as $table) {
+            $this->connection->exec("DROP TABLE IF EXISTS `$table`");
+        }
+
+        $this->connection->exec('SET FOREIGN_KEY_CHECKS = 1');
+    }
+
+    public function createSchema(): void
+    {
+        $schemaTool = new SchemaTool($this->entityManager);
+        $metadata = $this->entityManager->getMetadataFactory()->getAllMetadata();
+
+        $createSql = $schemaTool->getCreateSchemaSql($metadata);
+
+        foreach ($createSql as $sql) {
+            $this->connection->exec($sql);
+        }
+    }
+
+    public function resetSchema(): void
+    {
+        echo "Preparing test schemas\n";
+        $this->dropSchema();
+        $this->createSchema();
+    }
+}
+