class MigrateStubTest

Same name in this branch
  1. 11.x core/modules/migrate/tests/src/Unit/MigrateStubTest.php \Drupal\Tests\migrate\Unit\MigrateStubTest
Same name in other branches
  1. 9 core/modules/migrate/tests/src/Unit/MigrateStubTest.php \Drupal\Tests\migrate\Unit\MigrateStubTest
  2. 9 core/modules/migrate/tests/src/Kernel/MigrateStubTest.php \Drupal\Tests\migrate\Kernel\MigrateStubTest
  3. 8.9.x core/modules/migrate/tests/src/Unit/MigrateStubTest.php \Drupal\Tests\migrate\Unit\MigrateStubTest
  4. 8.9.x core/modules/migrate/tests/src/Kernel/MigrateStubTest.php \Drupal\Tests\migrate\Kernel\MigrateStubTest
  5. 10 core/modules/migrate/tests/src/Unit/MigrateStubTest.php \Drupal\Tests\migrate\Unit\MigrateStubTest
  6. 10 core/modules/migrate/tests/src/Kernel/MigrateStubTest.php \Drupal\Tests\migrate\Kernel\MigrateStubTest

Tests the migrate.stub Service.

@group migrate

Hierarchy

Expanded class hierarchy of MigrateStubTest

File

core/modules/migrate/tests/src/Kernel/MigrateStubTest.php, line 15

Namespace

Drupal\Tests\migrate\Kernel
View source
class MigrateStubTest extends MigrateTestBase {
    use ContentTypeCreationTrait;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'system',
        'node',
        'field',
        'user',
        'text',
        'filter',
        'migrate_stub_test',
    ];
    
    /**
     * The migrate stub service.
     *
     * @var \Drupal\migrate\MigrateStubInterface
     */
    protected $migrateStub;
    
    /**
     * The migration lookup service.
     *
     * @var \Drupal\migrate\MigrateLookupInterface
     */
    protected $migrateLookup;
    
    /**
     * The migration plugin manager.
     *
     * @var \Drupal\migrate\Plugin\MigrationPluginManagerInterface
     */
    protected $migrationPluginManager;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->setTestLogger();
        $this->migrateStub = $this->container
            ->get('migrate.stub');
        $this->migrateLookup = $this->container
            ->get('migrate.lookup');
        $this->migrationPluginManager = $this->container
            ->get('plugin.manager.migration');
        $this->installEntitySchema('node');
        $this->installEntitySchema('user');
        $this->installSchema('node', 'node_access');
        $this->installConfig([
            'node',
            'user',
        ]);
        $this->createContentType([
            'type' => 'node_lookup',
        ]);
    }
    
    /**
     * Tests stub creation.
     */
    public function testCreateStub() : void {
        $this->assertSame([], $this->migrateLookup
            ->lookup('sample_stubbing_migration', [
            17,
        ]));
        $ids = $this->migrateStub
            ->createStub('sample_stubbing_migration', [
            17,
        ]);
        $this->assertSame([
            $ids,
        ], $this->migrateLookup
            ->lookup('sample_stubbing_migration', [
            17,
        ]));
        $this->assertNotNull(\Drupal::entityTypeManager()->getStorage('node')
            ->load($ids['nid']));
    }
    
    /**
     * Tests raw stub creation.
     */
    public function testCreateStubRawReturn() : void {
        $this->assertSame([], $this->migrateLookup
            ->lookup('sample_stubbing_migration', [
            17,
        ]));
        $ids = $this->migrateStub
            ->createStub('sample_stubbing_migration', [
            17,
        ], [], FALSE);
        $this->assertSame($ids, [
            $this->migrateLookup
                ->lookup('sample_stubbing_migration', [
                17,
            ])[0]['nid'],
        ]);
        $this->assertNotNull(\Drupal::entityTypeManager()->getStorage('node')
            ->load($ids[0]));
    }
    
    /**
     * Tests stub creation with default values.
     */
    public function testStubWithDefaultValues() : void {
        $this->assertSame([], $this->migrateLookup
            ->lookup('sample_stubbing_migration', [
            17,
        ]));
        $ids = $this->migrateStub
            ->createStub('sample_stubbing_migration', [
            17,
        ], [
            'title' => "Placeholder for source id 17",
        ]);
        $this->assertSame([
            $ids,
        ], $this->migrateLookup
            ->lookup('sample_stubbing_migration', [
            17,
        ]));
        $node = \Drupal::entityTypeManager()->getStorage('node')
            ->load($ids['nid']);
        $this->assertNotNull($node);
        // Test that our default value was set as the node title.
        $this->assertSame("Placeholder for source id 17", $node->label());
        // Test that running the migration replaces the node title.
        $this->executeMigration('sample_stubbing_migration');
        $node = \Drupal::entityTypeManager()->getStorage('node')
            ->loadUnchanged($ids['nid']);
        $this->assertSame("Sample 1", $node->label());
    }
    
    /**
     * Tests stub creation with bundle fields.
     */
    public function testStubWithBundleFields() : void {
        $this->createContentType([
            'type' => 'node_stub',
        ]);
        // Make "Body" field required to make stubbing populate field value.
        $body_field = FieldConfig::loadByName('node', 'node_stub', 'body');
        $body_field->setRequired(TRUE)
            ->save();
        $this->assertSame([], $this->migrateLookup
            ->lookup('sample_stubbing_migration', [
            33,
        ]));
        $ids = $this->migrateStub
            ->createStub('sample_stubbing_migration', [
            33,
        ], []);
        $this->assertSame([
            $ids,
        ], $this->migrateLookup
            ->lookup('sample_stubbing_migration', [
            33,
        ]));
        $node = \Drupal::entityTypeManager()->getStorage('node')
            ->load($ids['nid']);
        $this->assertNotNull($node);
        // Make sure the "Body" field value was populated.
        $this->assertNotEmpty($node->get('body')->value);
    }
    
    /**
     * Tests invalid source id count.
     */
    public function testInvalidSourceIdCount() : void {
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionMessage('Expected and provided source id counts do not match.');
        $this->migrateStub
            ->createStub('sample_stubbing_migration_with_multiple_source_ids', [
            17,
        ]);
    }
    
    /**
     * Tests invalid source ids keys.
     */
    public function testInvalidSourceIdKeys() : void {
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionMessage("'version_id' is defined as a source ID but has no value.");
        $this->migrateStub
            ->createStub('sample_stubbing_migration_with_multiple_source_ids', [
            'id' => 17,
            'not_a_key' => 17,
        ]);
    }

}

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.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. 1
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.
MigrateStubTest::$migrateLookup protected property The migration lookup service.
MigrateStubTest::$migrateStub protected property The migrate stub service.
MigrateStubTest::$migrationPluginManager protected property The migration plugin manager.
MigrateStubTest::$modules protected static property Modules to install. Overrides MigrateTestBase::$modules
MigrateStubTest::setUp protected function Overrides MigrateTestBase::setUp
MigrateStubTest::testCreateStub public function Tests stub creation.
MigrateStubTest::testCreateStubRawReturn public function Tests raw stub creation.
MigrateStubTest::testInvalidSourceIdCount public function Tests invalid source id count.
MigrateStubTest::testInvalidSourceIdKeys public function Tests invalid source ids keys.
MigrateStubTest::testStubWithBundleFields public function Tests stub creation with bundle fields.
MigrateStubTest::testStubWithDefaultValues public function Tests stub creation with default values.
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::$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::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.