class MenuLinkTreeTest

Same name in this branch
  1. 11.x core/modules/system/tests/src/Unit/Menu/MenuLinkTreeTest.php \Drupal\Tests\system\Unit\Menu\MenuLinkTreeTest
Same name and namespace in other branches
  1. 9 core/modules/system/tests/src/Unit/Menu/MenuLinkTreeTest.php \Drupal\Tests\system\Unit\Menu\MenuLinkTreeTest
  2. 9 core/tests/Drupal/KernelTests/Core/Menu/MenuLinkTreeTest.php \Drupal\KernelTests\Core\Menu\MenuLinkTreeTest
  3. 8.9.x core/modules/system/tests/src/Unit/Menu/MenuLinkTreeTest.php \Drupal\Tests\system\Unit\Menu\MenuLinkTreeTest
  4. 8.9.x core/tests/Drupal/KernelTests/Core/Menu/MenuLinkTreeTest.php \Drupal\KernelTests\Core\Menu\MenuLinkTreeTest
  5. 10 core/modules/system/tests/src/Unit/Menu/MenuLinkTreeTest.php \Drupal\Tests\system\Unit\Menu\MenuLinkTreeTest
  6. 10 core/tests/Drupal/KernelTests/Core/Menu/MenuLinkTreeTest.php \Drupal\KernelTests\Core\Menu\MenuLinkTreeTest

Tests the menu link tree.

@group Menu

Hierarchy

Expanded class hierarchy of MenuLinkTreeTest

See also

\Drupal\Core\Menu\MenuLinkTree

File

core/tests/Drupal/KernelTests/Core/Menu/MenuLinkTreeTest.php, line 22

Namespace

Drupal\KernelTests\Core\Menu
View source
class MenuLinkTreeTest extends KernelTestBase {
    
    /**
     * The tested menu link tree.
     *
     * @var \Drupal\Core\Menu\MenuLinkTree
     */
    protected $linkTree;
    
    /**
     * The menu link plugin manager.
     *
     * @var \Drupal\Core\Menu\MenuLinkManagerInterface
     */
    protected $menuLinkManager;
    
    /**
     * Modules to enable.
     *
     * @var array
     */
    protected static $modules = [
        'system',
        'menu_test',
        'menu_link_content',
        'field',
        'link',
        'user',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->installEntitySchema('user');
        $this->installEntitySchema('menu_link_content');
        $this->linkTree = $this->container
            ->get('menu.link_tree');
        $this->menuLinkManager = $this->container
            ->get('plugin.manager.menu.link');
    }
    
    /**
     * Tests deleting all the links in a menu.
     */
    public function testDeleteLinksInMenu() : void {
        
        /** @var \Drupal\system\MenuStorage $storage */
        $storage = \Drupal::entityTypeManager()->getStorage('menu');
        $storage->create([
            'id' => 'menu1',
            'label' => 'Menu 1',
        ])
            ->save();
        $storage->create([
            'id' => 'menu2',
            'label' => 'Menu 2',
        ])
            ->save();
        \Drupal::entityTypeManager()->getStorage('menu_link_content')
            ->create([
            'link' => [
                'uri' => 'internal:/menu_name_test',
            ],
            'menu_name' => 'menu1',
            'bundle' => 'menu_link_content',
            'title' => 'Link test',
        ])
            ->save();
        \Drupal::entityTypeManager()->getStorage('menu_link_content')
            ->create([
            'link' => [
                'uri' => 'internal:/menu_name_test',
            ],
            'menu_name' => 'menu1',
            'bundle' => 'menu_link_content',
            'title' => 'Link test',
        ])
            ->save();
        \Drupal::entityTypeManager()->getStorage('menu_link_content')
            ->create([
            'link' => [
                'uri' => 'internal:/menu_name_test',
            ],
            'menu_name' => 'menu2',
            'bundle' => 'menu_link_content',
            'title' => 'Link test',
        ])
            ->save();
        $output = $this->linkTree
            ->load('menu1', new MenuTreeParameters());
        $this->assertCount(2, $output);
        $output = $this->linkTree
            ->load('menu2', new MenuTreeParameters());
        $this->assertCount(1, $output);
        $this->menuLinkManager
            ->deleteLinksInMenu('menu1');
        $output = $this->linkTree
            ->load('menu1', new MenuTreeParameters());
        $this->assertCount(0, $output);
        $output = $this->linkTree
            ->load('menu2', new MenuTreeParameters());
        $this->assertCount(1, $output);
    }
    
    /**
     * Tests creating links with an expected tree structure.
     */
    public function testCreateLinksInMenu() : void {
        // This creates a tree with the following structure:
        // - 1
        // - 2
        //   - 3
        //     - 4
        // - 5
        //   - 7
        // - 6
        // - 8
        // With link 6 being the only external link.
        $links = [
            1 => MenuLinkMock::create([
                'id' => 'test.example1',
                'route_name' => 'example1',
                'title' => 'foo',
                'parent' => '',
            ]),
            2 => MenuLinkMock::create([
                'id' => 'test.example2',
                'route_name' => 'example2',
                'title' => 'bar',
                'parent' => 'test.example1',
                'route_parameters' => [
                    'foo' => 'bar',
                ],
            ]),
            3 => MenuLinkMock::create([
                'id' => 'test.example3',
                'route_name' => 'example3',
                'title' => 'baz',
                'parent' => 'test.example2',
                'route_parameters' => [
                    'baz' => 'qux',
                ],
            ]),
            4 => MenuLinkMock::create([
                'id' => 'test.example4',
                'route_name' => 'example4',
                'title' => 'qux',
                'parent' => 'test.example3',
            ]),
            5 => MenuLinkMock::create([
                'id' => 'test.example5',
                'route_name' => 'example5',
                'title' => 'title5',
                'parent' => '',
            ]),
            6 => MenuLinkMock::create([
                'id' => 'test.example6',
                'route_name' => '',
                'url' => 'https://www.drupal.org/',
                'title' => 'barbar',
                'parent' => '',
            ]),
            7 => MenuLinkMock::create([
                'id' => 'test.example7',
                'route_name' => 'example7',
                'title' => 'title7',
                'parent' => '',
            ]),
            8 => MenuLinkMock::create([
                'id' => 'test.example8',
                'route_name' => 'example8',
                'title' => 'title8',
                'parent' => '',
            ]),
        ];
        foreach ($links as $instance) {
            $this->menuLinkManager
                ->addDefinition($instance->getPluginId(), $instance->getPluginDefinition());
        }
        $parameters = new MenuTreeParameters();
        $tree = $this->linkTree
            ->load('mock', $parameters);
        $count = function (array $tree) {
            $sum = function ($carry, MenuLinkTreeElement $item) {
                return $carry + $item->count();
            };
            return array_reduce($tree, $sum);
        };
        $this->assertEquals(8, $count($tree));
        $parameters = new MenuTreeParameters();
        $parameters->setRoot('test.example2');
        $tree = $this->linkTree
            ->load($instance->getMenuName(), $parameters);
        $top_link = reset($tree);
        $this->assertCount(1, $top_link->subtree);
        $child = reset($top_link->subtree);
        $this->assertEquals($links[3]->getPluginId(), $child->link
            ->getPluginId());
        $height = $this->linkTree
            ->getSubtreeHeight('test.example2');
        $this->assertEquals(3, $height);
    }
    
    /**
     * Tests user/login and user/logout links.
     */
    public function testUserLoginAndUserLogoutLinks() : void {
        $account_switcher = $this->container
            ->get('account_switcher');
        $login_menu_link = MenuLinkMock::create([
            'id' => 'user_login_example',
            'route_name' => 'user.login',
        ]);
        $logout_menu_link = MenuLinkMock::create([
            'id' => 'user_logout_example',
            'route_name' => 'user.logout',
        ]);
        $this->menuLinkManager
            ->addDefinition($login_menu_link->getPluginId(), $login_menu_link->getPluginDefinition());
        $this->menuLinkManager
            ->addDefinition($logout_menu_link->getPluginId(), $logout_menu_link->getPluginDefinition());
        // Returns the accessible links from transformed 'mock' menu tree.
        $get_accessible_links = function () {
            $parameters = new MenuTreeParameters();
            $manipulators = [
                [
                    'callable' => 'menu.default_tree_manipulators:checkAccess',
                ],
            ];
            $tree = $this->linkTree
                ->load('mock', $parameters);
            $this->linkTree
                ->transform($tree, $manipulators);
            return array_keys(array_filter($tree, function (MenuLinkTreeElement $element) {
                return !$element->link instanceof InaccessibleMenuLink;
            }));
        };
        // Check that anonymous can only access the login link.
        $account_switcher->switchTo(new AnonymousUserSession());
        $this->assertSame([
            'user_login_example',
        ], $get_accessible_links());
        // Ensure that also user 1 does not see the login link.
        $account_switcher->switchTo(new UserSession([
            'uid' => 1,
        ]));
        $this->assertSame([
            'user_logout_example',
        ], $get_accessible_links());
    }

}

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. 3
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. 8
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 enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable 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::tearDown protected function 7
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.
MenuLinkTreeTest::$linkTree protected property The tested menu link tree.
MenuLinkTreeTest::$menuLinkManager protected property The menu link plugin manager.
MenuLinkTreeTest::$modules protected static property Modules to enable. Overrides KernelTestBase::$modules
MenuLinkTreeTest::setUp protected function Overrides KernelTestBase::setUp
MenuLinkTreeTest::testCreateLinksInMenu public function Tests creating links with an expected tree structure.
MenuLinkTreeTest::testDeleteLinksInMenu public function Tests deleting all the links in a menu.
MenuLinkTreeTest::testUserLoginAndUserLogoutLinks public function Tests user/login and user/logout links.
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.