class MenuLinkParentTest in Drupal 10
Same name and namespace in other branches
- 8 core/modules/migrate/tests/src/Unit/process/MenuLinkParentTest.php \Drupal\Tests\migrate\Unit\process\MenuLinkParentTest
- 9 core/modules/migrate/tests/src/Unit/process/MenuLinkParentTest.php \Drupal\Tests\migrate\Unit\process\MenuLinkParentTest
Tests the menu link parent process plugin.
@coversDefaultClass \Drupal\migrate\Plugin\migrate\process\MenuLinkParent @group migrate
Hierarchy
- class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, \Drupal\Tests\PhpUnitCompatibilityTrait, PhpUnitWarnings
- class \Drupal\Tests\migrate\Unit\MigrateTestCase
- class \Drupal\Tests\migrate\Unit\process\MigrateProcessTestCase
- class \Drupal\Tests\migrate\Unit\process\MenuLinkParentTest
- class \Drupal\Tests\migrate\Unit\process\MigrateProcessTestCase
- class \Drupal\Tests\migrate\Unit\MigrateTestCase
Expanded class hierarchy of MenuLinkParentTest
File
- core/
modules/ migrate/ tests/ src/ Unit/ process/ MenuLinkParentTest.php, line 24
Namespace
Drupal\Tests\migrate\Unit\processView source
class MenuLinkParentTest extends MigrateProcessTestCase {
/**
* A MigrationInterface prophecy.
*
* @var \Prophecy\Prophecy\ObjectProphecy
*/
protected $migration;
/**
* A MigrateLookupInterface prophecy.
*
* @var \Prophecy\Prophecy\ObjectProphecy
*/
protected $migrateLookup;
/**
* A Path validator prophecy.
*
* @var \Prophecy\Prophecy\ObjectProphecy
*/
protected $pathValidator;
/**
* The menu link entity storage handler.
*
* @var \Prophecy\Prophecy\ObjectProphecy
*/
protected $menuLinkStorage;
/**
* The menu link plugin manager.
*
* @var \Prophecy\Prophecy\ObjectProphecy
*/
protected $menuLinkManager;
/**
* {@inheritdoc}
*/
protected function setUp() : void {
parent::setUp();
$this->migration = $this
->prophesize(MigrationInterface::class);
$this->migrateLookup = $this
->prophesize(MigrateLookupInterface::class);
$this->menuLinkManager = $this
->prophesize(MenuLinkManagerInterface::class);
$this->menuLinkStorage = $this
->prophesize(EntityStorageInterface::class);
$container = new ContainerBuilder();
$container
->set('migrate.lookup', $this->migrateLookup
->reveal());
$this->pathValidator = $this
->prophesize(PathValidatorInterface::class);
$container
->set('path.validator', $this->pathValidator
->reveal());
\Drupal::setContainer($container);
}
/**
* Tests that an exception is thrown when the parent menu link is not found.
*
* @param string[] $source_value
* The source value(s) for the migration process plugin.
*
* @throws \Drupal\Component\Plugin\Exception\PluginException
* @throws \Drupal\migrate\MigrateException
* @throws \Drupal\migrate\MigrateSkipRowException
*
* @dataProvider providerTransformException
*/
public function testTransformException(array $source_value) {
[
$parent_id,
$menu_name,
] = $source_value;
$this->migrateLookup
->lookup(NULL, [
1,
])
->willReturn([]);
$plugin = new MenuLinkParent([], 'map', [], $this->migrateLookup
->reveal(), $this->menuLinkManager
->reveal(), $this->menuLinkStorage
->reveal(), $this->migration
->reveal());
$this
->expectException(MigrateSkipRowException::class);
$this
->expectExceptionMessage("No parent link found for plid '{$parent_id}' in menu '{$menu_name}'.");
$plugin
->transform($source_value, $this->migrateExecutable, $this->row, 'destination');
}
/**
* Provides data for testTransformException().
*/
public function providerTransformException() {
// The parent ID does not for the following tests.
return [
'parent link external and could not be loaded' => [
'source_value' => [
1,
'admin',
'http://drupal.org',
],
],
'parent link path/menu name not passed' => [
'source_value' => [
1,
NULL,
NULL,
],
],
'parent link is an internal URI that does not exist' => [
'source_value' => [
1,
NULL,
'admin/structure',
],
],
];
}
/**
* Tests the menu link content process plugin.
*
* @param string[] $source_value
* The source value(s) for the migration process plugin.
* @param string $lookup_result
* The ID value to be returned from migration_lookup.
* @param string $plugin_id
* The menu link plugin ID.
* @param string $route_name
* A route to create.
* @param string $expected_result
* The expected value(s) of the migration process plugin.
*
* @throws \Drupal\Component\Plugin\Exception\PluginException
* @throws \Drupal\migrate\MigrateException
* @throws \Drupal\migrate\MigrateSkipRowException
*
* @dataProvider providerMenuLinkParent
*/
public function testMenuLinkParent(array $source_value, $lookup_result, $plugin_id, $route_name, $expected_result) {
[
$parent_id,
$menu_name,
$parent_link_path,
] = $source_value;
$this->migrateLookup
->lookup(NULL, [
$parent_id,
])
->willReturn([
[
'id' => $lookup_result,
],
]);
if ($route_name) {
$plugin_definition = [
'menu_name' => $menu_name,
];
$static_override = $this
->prophesize(StaticMenuLinkOverridesInterface::class);
$static_override = $static_override
->reveal();
$menu_link = new MenuLinkDefault([], $plugin_id, $plugin_definition, $static_override);
$this->menuLinkManager
->loadLinksByRoute($route_name, [], 'admin')
->willReturn([
$plugin_id => $menu_link,
]);
$url = new Url($route_name, [], []);
$this->pathValidator
->getUrlIfValidWithoutAccessCheck($parent_link_path)
->willReturn($url);
}
$result = $this
->doTransform($source_value, $plugin_id);
$this
->assertSame($expected_result, $result);
}
/**
* Provides data for testMenuLinkParent().
*/
public function providerMenuLinkParent() {
return [
'menu link is route item' => [
'source_value' => [
0,
NULL,
NULL,
],
'lookup_result' => NULL,
'plugin_id' => NULL,
'route_name' => NULL,
'expected_result' => '',
],
'parent id exists' => [
'source_value' => [
1,
NULL,
NULL,
],
'lookup_result' => 1,
'plugin_id' => 'menu_link_content:abc',
'route_name' => NULL,
'expected_result' => 'menu_link_content:abc',
],
'no parent id internal route' => [
'source_value' => [
20,
'admin',
'admin/content',
],
'lookup_result' => NULL,
'plugin_id' => 'system.admin_structure',
'route_name' => 'system.admin_content',
'expected_result' => 'system.admin_structure',
],
'external' => [
'source_value' => [
9054,
'admin',
'http://example.com',
],
'lookup_result' => 9054,
'plugin_id' => 'menu_link_content:fe151460-dfa2-4133-8864-c1746f28ab27',
'route_name' => NULL,
'expected_result' => 'menu_link_content:fe151460-dfa2-4133-8864-c1746f28ab27',
],
];
}
/**
* Helper to finish setup and run the test.
*
* @param string[] $source_value
* The source value(s) for the migration process plugin.
* @param string $plugin_id
* The menu link plugin ID.
*
* @return string
* The transformed menu link.
*
* @throws \Drupal\migrate\MigrateSkipRowException
*/
public function doTransform(array $source_value, $plugin_id) {
[
$parent_id,
$menu_name,
$parent_link_path,
] = $source_value;
$menu_link_content = $this
->prophesize(MenuLinkContent::class);
$menu_link_content
->getPluginId()
->willReturn($plugin_id);
$this->menuLinkStorage
->load($parent_id)
->willReturn($menu_link_content);
$this->menuLinkStorage
->loadByProperties([
'menu_name' => $menu_name,
'link.uri' => $parent_link_path,
])
->willReturn([
$parent_id => $menu_link_content,
]);
$plugin = new MenuLinkParent([], 'menu_link', [], $this->migrateLookup
->reveal(), $this->menuLinkManager
->reveal(), $this->menuLinkStorage
->reveal(), $this->migration
->reveal());
return $plugin
->transform($source_value, $this->migrateExecutable, $this->row, 'destination');
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
MenuLinkParentTest:: |
protected | property | The menu link plugin manager. | |
MenuLinkParentTest:: |
protected | property | The menu link entity storage handler. | |
MenuLinkParentTest:: |
protected | property | A MigrateLookupInterface prophecy. | |
MenuLinkParentTest:: |
protected | property | A MigrationInterface prophecy. | |
MenuLinkParentTest:: |
protected | property | A Path validator prophecy. | |
MenuLinkParentTest:: |
public | function | Helper to finish setup and run the test. | |
MenuLinkParentTest:: |
public | function | Provides data for testMenuLinkParent(). | |
MenuLinkParentTest:: |
public | function | Provides data for testTransformException(). | |
MenuLinkParentTest:: |
protected | function |
Overrides MigrateProcessTestCase:: |
|
MenuLinkParentTest:: |
public | function | Tests the menu link content process plugin. | |
MenuLinkParentTest:: |
public | function | Tests that an exception is thrown when the parent menu link is not found. | |
MigrateProcessTestCase:: |
protected | property | ||
MigrateProcessTestCase:: |
protected | property | ||
MigrateProcessTestCase:: |
protected | property | ||
MigrateTestCase:: |
protected | property | The migration ID map. | |
MigrateTestCase:: |
protected | property | An array of migration configuration values. | 5 |
MigrateTestCase:: |
protected | property | Local store for mocking setStatus()/getStatus(). | |
MigrateTestCase:: |
protected | function | Generates a table schema from a row. | |
MigrateTestCase:: |
protected | function | Gets an SQLite database connection object for use in tests. | |
MigrateTestCase:: |
protected | function | Retrieves a mocked migration. | |
MigrateTestCase:: |
protected | function | Gets the value on a row for a given key. | |
MigrateTestCase:: |
public | function | Tests a query. | |
MigrateTestCase:: |
protected | function | Asserts tested values during test retrieval. | |
PhpUnitWarnings:: |
private static | property | Deprecation warnings from PHPUnit to raise with @trigger_error(). | |
PhpUnitWarnings:: |
public | function | Converts PHPUnit deprecation warnings to E_USER_DEPRECATED. | |
UnitTestCase:: |
protected | property | The random generator. | |
UnitTestCase:: |
protected | property | The app root. | 1 |
UnitTestCase:: |
protected | function | Returns a stub class resolver. | |
UnitTestCase:: |
public | function | Returns a stub config factory that behaves according to the passed array. | |
UnitTestCase:: |
public | function | Returns a stub config storage that returns the supplied configuration. | |
UnitTestCase:: |
protected | function | Sets up a container with a cache tags invalidator. | |
UnitTestCase:: |
protected | function | Gets the random generator for the utility methods. | |
UnitTestCase:: |
public | function | Returns a stub translation manager that just returns the passed string. | |
UnitTestCase:: |
public | function | Generates a unique random string containing letters and numbers. | |
UnitTestCase:: |
public static | function |