real database connection using the following parameters * of the $GLOBALS array: * * 'db_driver' : The name of the Doctrine DBAL database driver to use. * 'db_user' : The username to use for connecting. * 'db_password' : The password to use for connecting. * 'db_host' : The hostname of the database to connect to. * 'db_server' : The server name of the database to connect to * (optional, some vendors allow multiple server instances with different names on the same host). * 'db_dbname' : The name of the database to connect to. * 'db_port' : The port of the database to connect to. * * These variables of the $GLOBALS array are filled by PHPUnit based on an XML configuration file. * * IMPORTANT: * 1) Each invocation of this method returns a NEW database connection. * 2) The database is dropped and recreated to ensure it's clean. */ public static function getConnection(): DbalExtensions\Connection { if (! self::$initialized) { self::initializeDatabase(); self::$initialized = true; } $connectionParameters = self::getTestConnectionParameters(); $configuration = new Configuration(); if (in_array($connectionParameters['driver'], ['pdo_sqlite', 'sqlite3'], true) && class_exists(EnableForeignKeys::class)) { $configuration->setMiddlewares([new EnableForeignKeys()]); } $connection = DriverManager::getConnection($connectionParameters, $configuration); assert($connection instanceof DbalExtensions\Connection); self::addDbEventSubscribers($connection); return $connection; } public static function getPrivilegedConnection(): DbalExtensions\Connection { $connection = DriverManager::getConnection(self::getPrivilegedConnectionParameters()); assert($connection instanceof DbalExtensions\Connection); return $connection; } public static function configureProxies(Configuration $configuration): void { $configuration->setProxyDir(__DIR__ . '/Proxies'); $configuration->setProxyNamespace('Doctrine\Tests\Proxies'); $proxyImplementation = getenv('ORM_PROXY_IMPLEMENTATION') ?: (trait_exists(LazyGhostTrait::class) ? 'lazy-ghost' : 'common'); switch ($proxyImplementation) { case 'lazy-ghost': $configuration->setLazyGhostObjectEnabled(true); return; case 'common': $configuration->setLazyGhostObjectEnabled(false); return; } throw new LogicException(sprintf('Unknown proxy implementation: %s.', $proxyImplementation)); } private static function initializeDatabase(): void { $testConnParams = self::getTestConnectionParameters(); $privConnParams = self::getPrivilegedConnectionParameters(); $testConn = DriverManager::getConnection($testConnParams); // Note, writes direct to STDERR to prevent phpunit detecting output - otherwise this would cause either an // "unexpected output" warning or a failure on the first test case to call this method. fwrite(STDERR, sprintf("\nUsing DB driver %s\n", get_debug_type($testConn->getDriver()))); // Connect as a privileged user to create and drop the test database. $privConn = DriverManager::getConnection($privConnParams); $platform = $privConn->getDatabasePlatform(); if ($platform instanceof SqlitePlatform) { $method = method_exists(AbstractSchemaManager::class, 'introspectSchema') ? 'introspectSchema' : 'createSchema'; $schema = self::createSchemaManager($testConn)->$method(); $stmts = $schema->toDropSql($testConn->getDatabasePlatform()); foreach ($stmts as $stmt) { $testConn->executeStatement($stmt); } } else { $dbname = $testConnParams['dbname'] ?? $testConn->getDatabase(); $testConn->close(); if ($dbname !== null) { $schemaManager = self::createSchemaManager($privConn); try { $schemaManager->dropDatabase($dbname); } catch (DriverException $e) { } $schemaManager->createDatabase($dbname); $privConn->close(); } } } private static function createSchemaManager(Connection $connection): AbstractSchemaManager { return method_exists(Connection::class, 'createSchemaManager') ? $connection->createSchemaManager() : $connection->getSchemaManager(); } private static function addDbEventSubscribers(Connection $conn): void { if (! isset($GLOBALS['db_event_subscribers'])) { return; } $evm = $conn->getEventManager(); /** @var class-string $subscriberClass */ foreach (explode(',', $GLOBALS['db_event_subscribers']) as $subscriberClass) { $subscriberInstance = new $subscriberClass(); $evm->addEventSubscriber($subscriberInstance); } } /** @return array */ private static function getPrivilegedConnectionParameters(): array { if (isset($GLOBALS['privileged_db_driver'])) { return self::mapConnectionParameters($GLOBALS, 'privileged_db_'); } $parameters = self::mapConnectionParameters($GLOBALS, 'db_'); unset($parameters['dbname']); return $parameters; } /** @psalm-return array */ private static function getTestConnectionParameters(): array { if (! isset($GLOBALS['db_driver'])) { throw new UnexpectedValueException( 'You must provide database connection params including a db_driver value. See phpunit.xml.dist for details' ); } return self::mapConnectionParameters($GLOBALS, 'db_'); } /** * @param array $configuration * * @return array */ private static function mapConnectionParameters(array $configuration, string $prefix): array { $parameters = []; foreach ( [ 'driver', 'user', 'password', 'host', 'dbname', 'port', 'server', 'memory', 'path', 'ssl_key', 'ssl_cert', 'ssl_ca', 'ssl_capath', 'ssl_cipher', 'unix_socket', ] as $parameter ) { if (! isset($configuration[$prefix . $parameter])) { continue; } $parameters[$parameter] = $configuration[$prefix . $parameter]; } foreach ($configuration as $param => $value) { if (! str_starts_with($param, $prefix . 'driver_option_')) { continue; } $parameters['driverOptions'][substr($param, strlen($prefix . 'driver_option_'))] = $value; } $parameters['wrapperClass'] = DbalExtensions\Connection::class; return $parameters; } }