class MigrateProcessErrorMessagesTest
Same name in other branches
- 10 core/modules/migrate/tests/src/Kernel/MigrateProcessErrorMessagesTest.php \Drupal\Tests\migrate\Kernel\MigrateProcessErrorMessagesTest
Tests the format of messages from process plugin exceptions.
@group migrate
Hierarchy
- class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements \Drupal\Core\DependencyInjection\ServiceProviderInterface uses \Drupal\KernelTests\AssertContentTrait, \Drupal\Tests\RandomGeneratorTrait, \Drupal\Tests\ConfigTestTrait, \Drupal\Tests\ExtensionListTestTrait, \Drupal\Tests\TestRequirementsTrait, \Drupal\Tests\PhpUnitCompatibilityTrait, \Prophecy\PhpUnit\ProphecyTrait, \Drupal\TestTools\Extension\DeprecationBridge\ExpectDeprecationTrait
- class \Drupal\Tests\migrate\Kernel\MigrateTestBase extends \Drupal\KernelTests\KernelTestBase implements \Drupal\migrate\MigrateMessageInterface
- class \Drupal\Tests\migrate\Kernel\MigrateProcessErrorMessagesTest extends \Drupal\Tests\migrate\Kernel\MigrateTestBase
- class \Drupal\Tests\migrate\Kernel\MigrateTestBase extends \Drupal\KernelTests\KernelTestBase implements \Drupal\migrate\MigrateMessageInterface
Expanded class hierarchy of MigrateProcessErrorMessagesTest
File
-
core/
modules/ migrate/ tests/ src/ Kernel/ MigrateProcessErrorMessagesTest.php, line 23
Namespace
Drupal\Tests\migrate\KernelView source
class MigrateProcessErrorMessagesTest extends MigrateTestBase {
/**
* {@inheritdoc}
*/
protected static $modules = [
'system',
'migrate_events_test',
'migrate',
];
/**
* A prophesized Process Plugin Manager.
*
* @var \Prophecy\Prophecy\ObjectProphecy
*/
protected ObjectProphecy $processPluginManager;
/**
* A prophesized ID Map Plugin Manager.
*
* @var \Prophecy\Prophecy\ObjectProphecy
*/
protected ObjectProphecy $idMapPluginManager;
/**
* A prophesized ID Map.
*
* @var \Prophecy\Prophecy\ObjectProphecy
*/
protected ObjectProphecy $idMap;
/**
* The default stub migration definition.
*
* @var array
*/
protected array $definition = [
'id' => 'process_errors_migration',
'idMap' => [
'plugin' => 'idmap_prophecy',
],
'source' => [
'plugin' => 'embedded_data',
'data_rows' => [
[
'id' => 1,
'my_property' => [
'subfield' => [
42,
],
],
],
],
'ids' => [
'id' => [
'type' => 'integer',
],
],
],
'process' => [
'id' => 'id',
],
'destination' => [
'plugin' => 'dummy',
],
'migration_dependencies' => [],
];
/**
* {@inheritdoc}
*/
protected function setUp() : void {
parent::setUp();
$this->processPluginManager = $this->prophesize(MigratePluginManagerInterface::class);
$this->idMapPluginManager = $this->prophesize(MigratePluginManagerInterface::class);
$this->idMap = $this->prophesize(MigrateIdMapInterface::class);
}
/**
* Tests format of map messages saved from plugin exceptions.
*/
public function testProcessErrorMessage() : void {
$this->definition['process']['error']['plugin'] = 'test_error';
$this->idMap
->saveMessage([
'id' => 1,
], "process_errors_migration:error:test_error: Process exception.", MigrationInterface::MESSAGE_ERROR)
->shouldBeCalled();
$this->setPluginManagers();
/** @var \Drupal\migrate\Plugin\MigrationInterface $migration */
$migration = \Drupal::service('plugin.manager.migration')->createStubMigration($this->definition);
$executable = new MigrateExecutable($migration, $this);
$executable->import();
}
/**
* Tests format of map messages saved from sub_process exceptions.
*
* This checks the format of messages that are thrown from normal process
* plugins while being executed inside a sub_process pipeline as they
* bubble up to the main migration.
*/
public function testSubProcessErrorMessage() : void {
$this->definition['process']['subprocess_error'] = [
'plugin' => 'sub_process',
'source' => 'my_property',
'process' => [
'subfield' => [
[
'plugin' => 'test_error',
'value' => 'subfield',
],
],
],
];
$this->processPluginManager
->createInstance('sub_process', Argument::cetera())
->will(fn($x) => new SubProcess($x[1], 'sub_process', [
'handle_multiples' => TRUE,
]));
$this->idMap
->saveMessage([
'id' => 1,
], "process_errors_migration:subprocess_error:sub_process: test_error: Process exception.", MigrationInterface::MESSAGE_ERROR)
->shouldBeCalled();
$this->setPluginManagers();
/** @var \Drupal\migrate\Plugin\MigrationInterface $migration */
$migration = \Drupal::service('plugin.manager.migration')->createStubMigration($this->definition);
$executable = new MigrateExecutable($migration, $this);
$executable->import();
}
/**
* Prepares and sets the prophesized plugin managers.
*/
protected function setPluginManagers() {
$error_plugin_prophecy = $this->prophesize(MigrateProcessInterface::class);
$error_plugin_prophecy->getPluginDefinition()
->willReturn([
'plugin_id' => 'test_error',
]);
$error_plugin_prophecy->getPluginId()
->willReturn('test_error');
$error_plugin_prophecy->reset()
->shouldBeCalled();
$error_plugin_prophecy->transform(Argument::cetera())
->willThrow(new MigrateException('Process exception.'));
$this->processPluginManager
->createInstance('get', Argument::cetera())
->will(fn($x) => new Get($x[1], 'get', [
'handle_multiples' => TRUE,
]));
$this->processPluginManager
->createInstance('test_error', Argument::cetera())
->willReturn($error_plugin_prophecy->reveal());
$this->idMap
->setMessage(Argument::any())
->willReturn();
$this->idMap
->getRowBySource(Argument::any())
->willReturn([]);
$this->idMap
->delete(Argument::cetera())
->willReturn();
$this->idMap
->saveIdMapping(Argument::cetera())
->willReturn();
$this->idMapPluginManager
->createInstance('idmap_prophecy', Argument::cetera())
->willReturn($this->idMap
->reveal());
$this->container
->set('plugin.manager.migrate.process', $this->processPluginManager
->reveal());
$this->container
->set('plugin.manager.migrate.id_map', $this->idMapPluginManager
->reveal());
}
}
Members
Title Sort descending | 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 | 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 | 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 | 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 | protected | function | Asserts that a field does not exist with the given name or ID. | ||
AssertContentTrait::assertNoFieldById | protected | function | Asserts that a field does not exist with the given ID and value. | ||
AssertContentTrait::assertNoFieldByName | protected | function | Asserts that a field does not exist with the given name and value. | ||
AssertContentTrait::assertNoFieldByXPath | protected | function | Asserts that a field does not exist or its value does not match, by XPath. | ||
AssertContentTrait::assertNoFieldChecked | 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 | protected | function | Passes if a link containing a given href (part) is not found. | ||
AssertContentTrait::assertNoLinkByHrefInMainRegion | protected | function | Passes if a link containing a given href is not found in the main region. | ||
AssertContentTrait::assertNoOption | protected | function | Asserts that a select option in the current page does not exist. | ||
AssertContentTrait::assertNoOptionSelected | 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 | 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 | protected | function | Asserts that a select option with the visible text exists. | ||
AssertContentTrait::assertOptionSelected | protected | function | Asserts that a select option in the current page is checked. | ||
AssertContentTrait::assertOptionSelectedWithDrupalSelector | 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 | 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 | protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | ||
AssertContentTrait::assertUniqueTextHelper | 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. | 1 | |
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 | 27 |
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. | 2 | |
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. | ||
MigrateProcessErrorMessagesTest::$definition | protected | property | The default stub migration definition. | ||
MigrateProcessErrorMessagesTest::$idMap | protected | property | A prophesized ID Map. | ||
MigrateProcessErrorMessagesTest::$idMapPluginManager | protected | property | A prophesized ID Map Plugin Manager. | ||
MigrateProcessErrorMessagesTest::$modules | protected static | property | Modules to install. | Overrides MigrateTestBase::$modules | |
MigrateProcessErrorMessagesTest::$processPluginManager | protected | property | A prophesized Process Plugin Manager. | ||
MigrateProcessErrorMessagesTest::setPluginManagers | protected | function | Prepares and sets the prophesized plugin managers. | ||
MigrateProcessErrorMessagesTest::setUp | protected | function | Overrides MigrateTestBase::setUp | ||
MigrateProcessErrorMessagesTest::testProcessErrorMessage | public | function | Tests format of map messages saved from plugin exceptions. | ||
MigrateProcessErrorMessagesTest::testSubProcessErrorMessage | public | function | Tests format of map messages saved from sub_process exceptions. | ||
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.