Drupal\Tests\mongodb\Kernel\MongoDbTestBase

Complexity

Total Complexity

4

Size/Duplication

Total Lines	116
Duplicated Lines	0 %

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getSettingsArray()	0	26	1
A	getTestDatabaseName()	0	2	1
A	tearDown()	0	7	1
A	setUp()	0	9	1

<?php

declare(strict_types=1);

namespace Drupal\Tests\mongodb\Kernel;

use Drupal\Core\Site\Settings;

The type Drupal\Core\Site\Settings was not found. Maybe you did not declare it correctly or list all dependencies?

use Drupal\KernelTests\KernelTestBase;

The type Drupal\KernelTests\KernelTestBase was not found. Maybe you did not declare it correctly or list all dependencies?

use Drupal\mongodb\ClientFactory;
use Drupal\mongodb\DatabaseFactory;
use Drupal\mongodb\MongoDb;

/**
 * Class MongoDbTestBase provides basic setUp()/tearDown() for MongoDB.
 *
 * @group MongoDB
 */
abstract class MongoDbTestBase extends KernelTestBase {

  const DEFAULT_URI = 'mongodb://localhost:27017';

  const CLIENT_BAD_ALIAS = 'bad';

  const CLIENT_TEST_ALIAS = 'test';

  const DB_BAD_CLIENT_ALIAS = 'bad';

  const DB_INVALID_ALIAS = 'invalid';

  const DB_DEFAULT_ALIAS = 'default';

  const DB_UNSET_ALIAS = 'unset';

  /**
   * Modules to enable.
   *
   * @var string[]
   */
  protected static $modules = [MongoDb::MODULE];

  /**
   * A test-specific instance of Settings.
   *
   * @var \Drupal\Core\Site\Settings
   */
  protected Settings $settings;

  /**
   * The MongoDB URI for a test server.
   *
   * @var string
   */
  protected string $uri;

  /**
   * Obtain the name of a per-test database.
   *
   * @param string $postfix
   *   The way for the caller to differentiate this database from others.
   *
   * @return string
   *   The name of the per-test database, like 'simpletest1234_foo'.
   */
  public function getTestDatabaseName($postfix) {
    return $this->getDatabasePrefix() . '_' . $postfix;
  }

  /**
   * Provide a sane set of default settings.
   *
   * @return array{clients: array<string, array{uri: string, uriOptions: array<string,mixed>, driverOptions: array<string,mixed>}>, databases: array<string,array{0:string,1:string}>>}

The doc comment array{clients: array<string, array{uri: string, uriOptions: array<string,mixed>, driverOptions: array<string,mixed>}>, databases: array<string,array{0:string,1:string}>>} at position 50 could not be parsed: Expected '}' at position 50, but found '>'.

   *   A settings array only containing MongoDB-related settings.
   */
  protected function getSettingsArray(): array {
    return [
      'clients' => [
        static::CLIENT_BAD_ALIAS => [
          'uri' => 'mongodb://localhost:80',
          'uriOptions' => [],
          'driverOptions' => [],
        ],
        static::CLIENT_TEST_ALIAS => [
          'uri' => $this->uri,
          'uriOptions' => [],
          'driverOptions' => [],
        ],
      ],
      'databases' => [
        static::DB_DEFAULT_ALIAS => [
          static::CLIENT_TEST_ALIAS,
          $this->getDatabasePrefix(),
        ],
        static::DB_INVALID_ALIAS => [
          static::CLIENT_TEST_ALIAS,
          '',
        ],
        static::DB_BAD_CLIENT_ALIAS => [
          static::CLIENT_BAD_ALIAS,
          $this->getDatabasePrefix(),
        ],
      ],
    ];
  }

  /**
   * {@inheritdoc}
   *
   * This setUp configures $this->settings and $this->>uri.
   */
  public function setUp(): void {
    parent::setUp();
    // $_ENV if it comes from phpunit.xml <env>
    // $_SERVER if it comes from the phpunit command line environment.
    $this->uri = $_ENV['MONGODB_URI']
      ?? $_SERVER['MONGODB_URI']
      ?? static::DEFAULT_URI;

    $this->settings = new Settings([MongoDb::MODULE => $this->getSettingsArray()]);
  }

  /**
   * {@inheritdoc}
   *
   * This tearDown drops the test database, so child classes do not need to
   * clean up behind them.
   */
  public function tearDown(): void {
    $clientFactory = new ClientFactory($this->settings);
    $databaseFactory = new DatabaseFactory($clientFactory, $this->settings);
    $databaseFactory->get(static::DB_DEFAULT_ALIAS)
      ->drop();

    parent::tearDown();
  }

}