You are here

Home » API reference » Drupal 9 » DrupalSqlBaseTest.php

class DrupalSqlBaseTest in Drupal 9

Same name and namespace in other branches
  1. 8 core/modules/migrate_drupal/tests/src/Unit/source/DrupalSqlBaseTest.php \Drupal\Tests\migrate_drupal\Unit\source\DrupalSqlBaseTest

@coversDefaultClass \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase @group migrate_drupal

Hierarchy

Expanded class hierarchy of DrupalSqlBaseTest

File

core/modules/migrate_drupal/tests/src/Unit/source/DrupalSqlBaseTest.php, line 14

Namespace

Drupal\Tests\migrate_drupal\Unit\source
View source 
class DrupalSqlBaseTest extends MigrateTestCase {

  /**
   * Define bare minimum migration configuration.
   */
  protected $migrationConfiguration = [
    'id' => 'DrupalSqlBase',
  ];

  /**
   * @var \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase
   */
  protected $base;

  /**
   * The plugin definition.
   *
   * @var array
   */
  protected $pluginDefinition = [];

  /**
   * Mock StateInterface.
   *
   * @var \PHPUnit\Framework\MockObject\MockObject
   */
  protected $state;

  /**
   * Mock entity type manager.
   *
   * @var \PHPUnit\Framework\MockObject\MockObject
   */
  protected $entityTypeManager;

  /**
   * Minimum database contents needed to test DrupalSqlBase.
   */
  protected $databaseContents = [
    'system' => [
      [
        'filename' => 'sites/all/modules/module1',
        'name' => 'module1',
        'type' => 'module',
        'status' => 0,
        'schema_version' => -1,
      ],
    ],
  ];

  /**
   * {@inheritdoc}
   */
  public function setUp() : void {
    parent::setUp();
    $this->pluginDefinition['requirements_met'] = TRUE;
    $this->pluginDefinition['source_module'] = 'module1';
    $this->state = $this
      ->createMock('Drupal\\Core\\State\\StateInterface');
    $this->entityTypeManager = $this
      ->createMock('Drupal\\Core\\Entity\\EntityTypeManagerInterface');
  }

  /**
   * @covers ::checkRequirements
   */
  public function testSourceProviderNotActive() {
    $plugin = new TestDrupalSqlBase([], 'placeholder_id', $this->pluginDefinition, $this
      ->getMigration(), $this->state, $this->entityTypeManager);
    $plugin
      ->setDatabase($this
      ->getDatabase($this->databaseContents));
    $this
      ->expectException(RequirementsException::class);
    $this
      ->expectExceptionMessage('The module module1 is not enabled in the source site.');
    try {
      $plugin
        ->checkRequirements();
    } catch (RequirementsException $e) {

      // Ensure requirements are set on the exception.
      $this
        ->assertEquals([
        'source_module' => 'module1',
      ], $e
        ->getRequirements());

      // Re-throw so PHPUnit can assert the exception.
      throw $e;
    }
  }

  /**
   * @covers ::checkRequirements
   */
  public function testSourceDatabaseError() {
    $plugin = new TestDrupalSqlBase([], 'test', $this->pluginDefinition, $this
      ->getMigration(), $this->state, $this->entityTypeManager);
    $this
      ->expectException(RequirementsException::class);
    $this
      ->expectExceptionMessage('No database connection configured for source plugin test');
    $plugin
      ->checkRequirements();
  }

  /**
   * @covers ::checkRequirements
   *
   * @param bool $success
   *   True if this test will not throw an exception.
   * @param null|string $minimum_version
   *   The minimum version declared in the configuration of a source plugin.
   * @param string $schema_version
   *   The schema version for the source module declared in a source plugin.
   *
   * @dataProvider providerMinimumVersion
   */
  public function testMinimumVersion($success, $minimum_version, $schema_version) {
    $this->pluginDefinition['minimum_version'] = $minimum_version;
    $this->databaseContents['system'][0]['status'] = 1;
    $this->databaseContents['system'][0]['schema_version'] = $schema_version;
    $plugin = new TestDrupalSqlBase([], 'test', $this->pluginDefinition, $this
      ->getMigration(), $this->state, $this->entityTypeManager);
    $plugin
      ->setDatabase($this
      ->getDatabase($this->databaseContents));
    if (!$success) {
      $this
        ->expectException(RequirementsException::class);
      $this
        ->expectExceptionMessage("Required minimum version {$minimum_version}");
    }
    $plugin
      ->checkRequirements();
  }

  /**
   * Provides data for testMinimumVersion.
   */
  public function providerMinimumVersion() {
    return [
      'minimum less than schema' => [
        TRUE,
        '7000',
        '7001',
      ],
      'same version' => [
        TRUE,
        '7001',
        '7001',
      ],
      'minimum greater than schema' => [
        FALSE,
        '7005',
        '7001',
      ],
      'schema version 0' => [
        FALSE,
        '7000',
        '0',
      ],
      'schema version -1' => [
        FALSE,
        '7000',
        '-1',
      ],
      'minimum not set' => [
        TRUE,
        NULL,
        '-1',
      ],
    ];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DrupalSqlBaseTest::$base protected property
DrupalSqlBaseTest::$databaseContents protected property Minimum database contents needed to test DrupalSqlBase.
DrupalSqlBaseTest::$entityTypeManager protected property Mock entity type manager.
DrupalSqlBaseTest::$migrationConfiguration protected property Define bare minimum migration configuration. Overrides MigrateTestCase::$migrationConfiguration
DrupalSqlBaseTest::$pluginDefinition protected property The plugin definition.
DrupalSqlBaseTest::$state protected property Mock StateInterface.
DrupalSqlBaseTest::providerMinimumVersion public function Provides data for testMinimumVersion.
DrupalSqlBaseTest::setUp public function Overrides UnitTestCase::setUp
DrupalSqlBaseTest::testMinimumVersion public function @covers ::checkRequirements
DrupalSqlBaseTest::testSourceDatabaseError public function @covers ::checkRequirements
DrupalSqlBaseTest::testSourceProviderNotActive public function @covers ::checkRequirements
MigrateTestCase::$idMap protected property The migration ID map.
MigrateTestCase::$migrationStatus protected property Local store for mocking setStatus()/getStatus().
MigrateTestCase::createSchemaFromRow protected function Generates a table schema from a row.
MigrateTestCase::getDatabase protected function Gets an SQLite database connection object for use in tests.
MigrateTestCase::getMigration protected function Retrieves a mocked migration.
MigrateTestCase::getValue protected function Gets the value on a row for a given key.
MigrateTestCase::queryResultTest public function Tests a query.
MigrateTestCase::retrievalAssertHelper protected function Asserts tested values during test retrieval.
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
UnitTestCase::$randomGenerator protected property The random generator.
UnitTestCase::$root protected property The app root. 1
UnitTestCase::assertArrayEquals Deprecated protected function Asserts if two arrays are equal by sorting them first.
UnitTestCase::getClassResolverStub protected function Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub public function Returns a stub config factory that behaves according to the passed array.
UnitTestCase::getConfigStorageStub public function Returns a stub config storage that returns the supplied configuration.
UnitTestCase::getContainerWithCacheTagsInvalidator protected function Sets up a container with a cache tags invalidator.
UnitTestCase::getRandomGenerator protected function Gets the random generator for the utility methods.
UnitTestCase::getStringTranslationStub public function Returns a stub translation manager that just returns the passed string.
UnitTestCase::randomMachineName public function Generates a unique random string containing letters and numbers.
UnitTestCase::setUpBeforeClass public static function