class MigrateTestBase

Same name in other branches
  1. 9 core/modules/migrate/tests/src/Kernel/MigrateTestBase.php \Drupal\Tests\migrate\Kernel\MigrateTestBase
  2. 8.9.x core/modules/migrate/tests/src/Kernel/MigrateTestBase.php \Drupal\Tests\migrate\Kernel\MigrateTestBase
  3. 10 core/modules/migrate/tests/src/Kernel/MigrateTestBase.php \Drupal\Tests\migrate\Kernel\MigrateTestBase

Creates abstract base class for migration tests.

Hierarchy

Expanded class hierarchy of MigrateTestBase

6 files declare their use of MigrateTestBase
EntityRevisionTest.php in core/modules/migrate/tests/src/Kernel/Plugin/EntityRevisionTest.php
MigrateDrupalTestBase.php in core/modules/migrate_drupal/tests/src/Kernel/MigrateDrupalTestBase.php
MigrateUserAdminPassTest.php in core/modules/user/tests/src/Kernel/Migrate/MigrateUserAdminPassTest.php
MigrationSourceCacheTest.php in core/modules/migrate/tests/src/Kernel/Plugin/source/MigrationSourceCacheTest.php
NodeMigrationTypePluginAlterTest.php in core/modules/migrate_drupal/tests/src/Kernel/NodeMigrationTypePluginAlterTest.php

... See full list

File

core/modules/migrate/tests/src/Kernel/MigrateTestBase.php, line 19

Namespace

Drupal\Tests\migrate\Kernel
View source
abstract class MigrateTestBase extends KernelTestBase implements MigrateMessageInterface {
    
    /**
     * TRUE to collect messages instead of displaying them.
     *
     * @var bool
     */
    protected $collectMessages = FALSE;
    
    /**
     * A two dimensional array of messages.
     *
     * The first key is the type of message, the second is just numeric. Values
     * are the messages.
     *
     * @var array
     */
    protected $migrateMessages;
    
    /**
     * The primary migration being tested.
     *
     * @var \Drupal\migrate\Plugin\MigrationInterface
     */
    protected $migration;
    
    /**
     * The source database connection.
     *
     * @var \Drupal\Core\Database\Connection
     */
    protected $sourceDatabase;
    
    /**
     * A logger prophecy object.
     *
     * Using ::setTestLogger(), this prophecy will be configured and injected into
     * the container. Using $this->logger->function(args)->shouldHaveBeenCalled()
     * you can assert that the logger was called.
     *
     * @var \Prophecy\Prophecy\ObjectProphecy
     */
    protected $logger;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'migrate',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->createMigrationConnection();
        $this->sourceDatabase = Database::getConnection('default', 'migrate');
        // Attach the original test prefix as a database, for SQLite to attach its
        // database file.
        $this->sourceDatabase
            ->attachDatabase(substr($this->sourceDatabase
            ->getConnectionOptions()['prefix'], 0, -1));
    }
    
    /**
     * Changes the database connection to the prefixed one.
     *
     * @todo Remove when we don't use global. https://www.drupal.org/node/2552791
     */
    private function createMigrationConnection() {
        // If the backup already exists, something went terribly wrong.
        // This case is possible, because database connection info is a static
        // global state construct on the Database class, which at least persists
        // for all test methods executed in one PHP process.
        if (Database::getConnectionInfo('simpletest_original_migrate')) {
            throw new \RuntimeException("Bad Database connection state: 'simpletest_original_migrate' connection key already exists. Broken test?");
        }
        // Clone the current connection and replace the current prefix.
        $connection_info = Database::getConnectionInfo('migrate');
        if ($connection_info) {
            Database::renameConnection('migrate', 'simpletest_original_migrate');
        }
        $connection_info = Database::getConnectionInfo('default');
        foreach ($connection_info as $target => $value) {
            $prefix = $value['prefix'];
            // Tests use 7 character prefixes at most so this can't cause collisions.
            $connection_info[$target]['prefix'] = $prefix . '0';
        }
        Database::addConnectionInfo('migrate', 'default', $connection_info['default']);
    }
    
    /**
     * {@inheritdoc}
     */
    protected function tearDown() : void {
        $this->cleanupMigrateConnection();
        parent::tearDown();
        $this->collectMessages = FALSE;
        unset($this->migration, $this->migrateMessages);
    }
    
    /**
     * Cleans up the test migrate connection.
     *
     * @todo Remove when we don't use global. https://www.drupal.org/node/2552791
     */
    private function cleanupMigrateConnection() {
        Database::removeConnection('migrate');
        $original_connection_info = Database::getConnectionInfo('simpletest_original_migrate');
        if ($original_connection_info) {
            Database::renameConnection('simpletest_original_migrate', 'migrate');
        }
    }
    
    /**
     * Prepare any dependent migrations.
     *
     * @param array $id_mappings
     *   A list of ID mappings keyed by migration IDs. Each ID mapping is a list
     *   of two arrays, the first are source IDs and the second are destination
     *   IDs.
     */
    protected function prepareMigrations(array $id_mappings) {
        $manager = $this->container
            ->get('plugin.manager.migration');
        foreach ($id_mappings as $migration_id => $data) {
            foreach ($manager->createInstances($migration_id) as $migration) {
                $id_map = $migration->getIdMap();
                $id_map->setMessage($this);
                $source_ids = $migration->getSourcePlugin()
                    ->getIds();
                foreach ($data as $id_mapping) {
                    $row = new Row(array_combine(array_keys($source_ids), $id_mapping[0]), $source_ids);
                    $id_map->saveIdMapping($row, $id_mapping[1]);
                }
            }
        }
    }
    
    /**
     * Modify a migration's configuration before executing it.
     *
     * @param \Drupal\migrate\Plugin\MigrationInterface $migration
     *   The migration to execute.
     */
    protected function prepareMigration(MigrationInterface $migration) {
        // Default implementation for test classes not requiring modification.
    }
    
    /**
     * Executes a single migration.
     *
     * @param string|\Drupal\migrate\Plugin\MigrationInterface $migration
     *   The migration to execute, or its ID.
     */
    protected function executeMigration($migration) {
        if (is_string($migration)) {
            $this->migration = $this->getMigration($migration);
        }
        else {
            $this->migration = $migration;
        }
        if ($this instanceof MigrateDumpAlterInterface) {
            static::migrateDumpAlter($this);
        }
        $this->prepareMigration($this->migration);
        (new MigrateExecutable($this->migration, $this))
            ->import();
    }
    
    /**
     * Executes a set of migrations in dependency order.
     *
     * @param string[] $ids
     *   Array of migration IDs, in any order. If any of these migrations use a
     *   deriver, the derivatives will be made before execution.
     */
    protected function executeMigrations(array $ids) {
        $manager = $this->container
            ->get('plugin.manager.migration');
        $instances = $manager->createInstances($ids);
        array_walk($instances, [
            $this,
            'executeMigration',
        ]);
    }
    
    /**
     * {@inheritdoc}
     */
    public function display($message, $type = 'status') {
        if ($this->collectMessages) {
            $this->migrateMessages[$type][] = $message;
        }
        else {
            $this->assertEquals('status', $type, $message);
        }
    }
    
    /**
     * Start collecting messages and erase previous messages.
     */
    public function startCollectingMessages() {
        $this->collectMessages = TRUE;
        $this->migrateMessages = [];
    }
    
    /**
     * Stop collecting messages.
     */
    public function stopCollectingMessages() {
        $this->collectMessages = FALSE;
    }
    
    /**
     * Records a failure in the map table of a specific migration.
     *
     * This is done in order to test scenarios which require a failed row.
     *
     * @param string|\Drupal\migrate\Plugin\MigrationInterface $migration
     *   The migration entity, or its ID.
     * @param array $row
     *   The raw source row which "failed".
     * @param int $status
     *   (optional) The failure status. Should be one of the
     *   MigrateIdMapInterface::STATUS_* constants. Defaults to
     *   MigrateIdMapInterface::STATUS_FAILED.
     */
    protected function mockFailure($migration, array $row, $status = MigrateIdMapInterface::STATUS_FAILED) {
        if (is_string($migration)) {
            $migration = $this->getMigration($migration);
        }
        
        /** @var \Drupal\migrate\Plugin\MigrationInterface $migration */
        $destination = array_map(function () {
            return NULL;
        }, $migration->getDestinationPlugin()
            ->getIds());
        $row = new Row($row, $migration->getSourcePlugin()
            ->getIds());
        $migration->getIdMap()
            ->saveIdMapping($row, $destination, $status);
    }
    
    /**
     * Gets the migration plugin.
     *
     * @param string $plugin_id
     *   The plugin ID of the migration to get.
     *
     * @return \Drupal\migrate\Plugin\Migration
     *   The migration plugin.
     */
    protected function getMigration($plugin_id) {
        return $this->container
            ->get('plugin.manager.migration')
            ->createInstance($plugin_id);
    }
    
    /**
     * Injects the test logger into the container.
     */
    protected function setTestLogger() {
        $this->logger = $this->prophesize(LoggerChannelInterface::class);
        $this->container
            ->set('logger.channel.migrate', $this->logger
            ->reveal());
        \Drupal::setContainer($this->container);
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById Deprecated protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds Deprecated protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if raw text IS NOT found escaped on loaded page, fail otherwise.
AssertContentTrait::assertNoField Deprecated protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById Deprecated protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName Deprecated protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath Deprecated protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref Deprecated protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion Deprecated protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption Deprecated protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected Deprecated protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText Deprecated protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText Deprecated protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected Deprecated protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector Deprecated protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern Deprecated protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText Deprecated protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper Deprecated protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
ExpectDeprecationTrait::getCallableName private static function Returns a callable as a string suitable for inclusion in a message.
ExpectDeprecationTrait::setUpErrorHandler public function Sets up the test error handler.
ExpectDeprecationTrait::tearDownErrorHandler public function Tears down the test error handler.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 6
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 4
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$root protected property The app root.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 9
KernelTestBase::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 3
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel protected function Bootstraps a kernel for a test. 1
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test. 2
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 2
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to install.
KernelTestBase::getModulesToEnable private static function Returns the modules to install for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 28
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 3
KernelTestBase::tearDownCloseDatabaseConnection public function Additional tear down method to close the connection at the end.
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__construct public function
KernelTestBase::__sleep public function Prevents serializing any properties.
MigrateTestBase::$collectMessages protected property TRUE to collect messages instead of displaying them.
MigrateTestBase::$logger protected property A logger prophecy object. 2
MigrateTestBase::$migrateMessages protected property A two dimensional array of messages.
MigrateTestBase::$migration protected property The primary migration being tested. 1
MigrateTestBase::$modules protected static property Modules to install. Overrides KernelTestBase::$modules 17
MigrateTestBase::$sourceDatabase protected property The source database connection.
MigrateTestBase::cleanupMigrateConnection private function Cleans up the test migrate connection.
MigrateTestBase::createMigrationConnection private function Changes the database connection to the prefixed one.
MigrateTestBase::display public function Displays a migrate message. Overrides MigrateMessageInterface::display
MigrateTestBase::executeMigration protected function Executes a single migration.
MigrateTestBase::executeMigrations protected function Executes a set of migrations in dependency order.
MigrateTestBase::getMigration protected function Gets the migration plugin.
MigrateTestBase::mockFailure protected function Records a failure in the map table of a specific migration.
MigrateTestBase::prepareMigration protected function Modify a migration's configuration before executing it.
MigrateTestBase::prepareMigrations protected function Prepare any dependent migrations.
MigrateTestBase::setTestLogger protected function Injects the test logger into the container.
MigrateTestBase::setUp protected function Overrides KernelTestBase::setUp 18
MigrateTestBase::startCollectingMessages public function Start collecting messages and erase previous messages.
MigrateTestBase::stopCollectingMessages public function Stop collecting messages.
MigrateTestBase::tearDown protected function Overrides KernelTestBase::tearDown
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers.
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.