abstract class MigrateSqlSourceTestCase in Zircon Profile 8

Base class for Migrate module source unit tests.

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \Drupal\Tests\PHPUnit_Framework_TestCase
  • class \Drupal\Tests\migrate\Unit\MigrateTestCase
    • class \Drupal\Tests\migrate\Unit\MigrateSqlSourceTestCase

65 files declare their use of MigrateSqlSourceTestCase

ActionTest.php in core/modules/action/tests/src/Unit/Plugin/migrate/source/d6/ActionTest.php

Contains \Drupal\Tests\action\Unit\Plugin\migrate\source\d6\ActionTest.

AggregatorFeedTest.php in core/modules/aggregator/tests/src/Unit/Plugin/migrate/source/d6/AggregatorFeedTest.php

Contains \Drupal\Tests\aggregator\Unit\Plugin\migrate\source\d6\AggregatorFeedTest.

AggregatorFeedTest.php in core/modules/aggregator/tests/src/Unit/Plugin/migrate/source/d7/AggregatorFeedTest.php

Contains \Drupal\Tests\aggregator\Unit\Plugin\migrate\source\d7\AggregatorFeedTest.

AggregatorItemTest.php in core/modules/aggregator/tests/src/Unit/Plugin/migrate/source/AggregatorItemTest.php

Contains \Drupal\Tests\aggregator\Unit\Plugin\migrate\source\AggregatorItemTest.

BlockCustomTest.php in core/modules/block_content/tests/src/Unit/Plugin/migrate/source/d7/BlockCustomTest.php

Contains \Drupal\Tests\block_content\Unit\Plugin\migrate\source\d7\BlockCustomTest.

... See full list

File

core/modules/migrate/tests/src/Unit/MigrateSqlSourceTestCase.php, line 15

Contains \Drupal\Tests\migrate\Unit\MigrateSqlSourceTestCase.

Namespace

Drupal\Tests\migrate\Unit

abstract class MigrateSqlSourceTestCase extends MigrateTestCase {

  /**
   * The tested source plugin.
   *
   * @var \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase.
   */
  protected $source;

  /**
   * The database contents.
   *
   * Database contents represents a mocked database. It should contain an
   * associative array with the table name as key, and as many nested arrays as
   * the number of mocked rows. Each of those faked rows must be another array
   * with the column name as the key and the value as the cell.
   *
   * @var array
   */
  protected $databaseContents = array();

  /**
   * The plugin class under test.
   *
   * The plugin system is not working during unit testing so the source plugin
   * class needs to be manually specified.
   *
   * @var string
   */
  const PLUGIN_CLASS = '';

  /**
   * The high water mark at the beginning of the import operation.
   *
   * Once the migration is run, we save a mark of the migrated sources, so the
   * migration can run again and update only new sources or changed sources.
   *
   * @var string
   */
  const ORIGINAL_HIGH_WATER = '';

  /**
   * Expected results after the source parsing.
   *
   * @var array
   */
  protected $expectedResults = array();

  /**
   * Expected count of source rows.
   *
   * @var int
   */
  protected $expectedCount = 0;

  /**
   * The source plugin instance under test.
   *
   * @var \Drupal\migrate\Plugin\MigrateSourceInterface
   */
  protected $plugin;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    $module_handler = $this
      ->getMock('Drupal\\Core\\Extension\\ModuleHandlerInterface');
    $state = $this
      ->getMock('Drupal\\Core\\State\\StateInterface');
    $entity_manager = $this
      ->getMock('Drupal\\Core\\Entity\\EntityManagerInterface');
    $migration = $this
      ->getMigration();
    $migration
      ->expects($this
      ->any())
      ->method('getHighWater')
      ->will($this
      ->returnValue(static::ORIGINAL_HIGH_WATER));

    // Setup the plugin.
    $plugin_class = static::PLUGIN_CLASS;
    $plugin = new $plugin_class($this->migrationConfiguration['source'], $this->migrationConfiguration['source']['plugin'], array(), $migration, $state, $entity_manager);

    // Do some reflection to set the database and moduleHandler.
    $plugin_reflection = new \ReflectionClass($plugin);
    $database_property = $plugin_reflection
      ->getProperty('database');
    $database_property
      ->setAccessible(TRUE);
    $module_handler_property = $plugin_reflection
      ->getProperty('moduleHandler');
    $module_handler_property
      ->setAccessible(TRUE);

    // Set the database and the module handler onto our plugin.
    $database_property
      ->setValue($plugin, $this
      ->getDatabase($this->databaseContents + array(
      'test_map' => array(),
    )));
    $module_handler_property
      ->setValue($plugin, $module_handler);
    $plugin
      ->setStringTranslation($this
      ->getStringTranslationStub());
    $migration
      ->expects($this
      ->any())
      ->method('getSourcePlugin')
      ->will($this
      ->returnValue($plugin));
    $this->source = $plugin;
    $this->expectedCount = count($this->expectedResults);
  }

  /**
   * Test the source returns the same rows as expected.
   */
  public function testRetrieval() {
    $this
      ->assertInstanceOf(SelectInterface::class, $this->source
      ->query());
    $this
      ->queryResultTest($this->source, $this->expectedResults);
  }

  /**
   * Test the source returns the row count expected.
   */
  public function testSourceCount() {
    $count = $this->source
      ->count();
    $this
      ->assertTrue(is_numeric($count));
    $this
      ->assertEquals($count, $this->expectedCount);
  }

  /**
   * Test the source defines a valid ID.
   */
  public function testSourceId() {
    $this
      ->assertNotEmpty($this->source
      ->getIds());
  }

  /**
   * @param \Drupal\migrate\Row $row
   * @param string $key
   * @return mixed
   */
  protected function getValue($row, $key) {
    return $row
      ->getSourceProperty($key);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
MigrateSqlSourceTestCase::$databaseContents	protected	property	The database contents.	5
MigrateSqlSourceTestCase::$expectedCount	protected	property	Expected count of source rows.
MigrateSqlSourceTestCase::$expectedResults	protected	property	Expected results after the source parsing.	66
MigrateSqlSourceTestCase::$plugin	protected	property	The source plugin instance under test.
MigrateSqlSourceTestCase::$source	protected	property	The tested source plugin.
MigrateSqlSourceTestCase::getValue	protected	function	Overrides MigrateTestCase::getValue
MigrateSqlSourceTestCase::ORIGINAL_HIGH_WATER		constant	The high water mark at the beginning of the import operation.	1
MigrateSqlSourceTestCase::PLUGIN_CLASS		constant	The plugin class under test.	66
MigrateSqlSourceTestCase::setUp	protected	function	Overrides UnitTestCase::setUp	61
MigrateSqlSourceTestCase::testRetrieval	public	function	Test the source returns the same rows as expected.
MigrateSqlSourceTestCase::testSourceCount	public	function	Test the source returns the row count expected.
MigrateSqlSourceTestCase::testSourceId	public	function	Test the source defines a valid ID.
MigrateTestCase::$idMap	protected	property
MigrateTestCase::$migrationConfiguration	protected	property		74
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	Get an SQLite database connection object for use in tests.
MigrateTestCase::getMigration	protected	function	Retrieve a mocked migration.
MigrateTestCase::queryResultTest	public	function	Tests a query
MigrateTestCase::retrievalAssertHelper	protected	function	Asserts tested values during test retrieval.
UnitTestCase::$randomGenerator	protected	property	The random generator.
UnitTestCase::$root	protected	property	The app root.
UnitTestCase::assertArrayEquals	protected	function	Asserts if two arrays are equal by sorting them first.
UnitTestCase::getBlockMockWithMachineName	protected	function	Mocks a block with a block plugin.
UnitTestCase::getClassResolverStub	protected	function	Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub	public	function	Returns a stub config factory that behaves according to the passed in 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.