BreadcrumbTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\system\Functional\Menu;

use Drupal\block\Entity\Block;
use Drupal\Core\Url;
use Drupal\node\Entity\NodeType;
use Drupal\Tests\BrowserTestBase;
use Drupal\user\RoleInterface;
use PHPUnit\Framework\ExpectationFailedException;

/**
 * Tests breadcrumbs functionality.
 *
 * @group Menu
 */
class BreadcrumbTest extends BrowserTestBase {
    use AssertBreadcrumbTrait;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'block',
        'dblog',
        'field_ui',
        'filter_test',
        'menu_test',
        'olivero_test',
    ];
    
    /**
     * An administrative user.
     *
     * @var \Drupal\user\UserInterface
     */
    protected $adminUser;
    
    /**
     * A regular user.
     *
     * @var \Drupal\user\UserInterface
     */
    protected $webUser;
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'olivero';
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // Install 'claro' and configure it as administrative theme.
        $this->container
            ->get('theme_installer')
            ->install([
            'claro',
        ]);
        $this->config('system.theme')
            ->set('admin', 'claro')
            ->save();
        $this->config('system.site')
            ->set('page.front', '/node')
            ->save();
        $perms = array_keys(\Drupal::service('user.permissions')->getPermissions());
        $this->adminUser = $this->drupalCreateUser($perms);
        $this->drupalLogin($this->adminUser);
        // This test puts menu links in the Tools menu and then tests for their
        // presence on the page, so we need to ensure that the Tools block will be
        // displayed in the admin theme and olivero.
        $this->drupalPlaceBlock('system_menu_block:tools', [
            'region' => 'content',
            'theme' => $this->config('system.theme')
                ->get('admin'),
        ]);
        $this->drupalPlaceBlock('system_menu_block:tools', [
            'region' => 'content',
            'theme' => 'olivero',
        ]);
    }
    
    /**
     * Tests breadcrumbs on node and administrative paths.
     */
    public function testBreadCrumbs() : void {
        // Prepare common base breadcrumb elements.
        $home = [
            '' => 'Home',
        ];
        $admin = $home + [
            'admin' => 'Administration',
        ];
        $config = $admin + [
            'admin/config' => 'Configuration',
        ];
        $type = 'article';
        // Verify Taxonomy administration breadcrumbs.
        $trail = $admin + [
            'admin/structure' => 'Structure',
        ];
        $this->assertBreadcrumb('admin/structure/taxonomy', $trail);
        $trail += [
            'admin/structure/taxonomy' => 'Taxonomy',
        ];
        $this->assertBreadcrumb('admin/structure/taxonomy/manage/tags', $trail);
        $trail += [
            'admin/structure/taxonomy/manage/tags' => 'Edit Tags',
        ];
        $this->assertBreadcrumb('admin/structure/taxonomy/manage/tags/overview', $trail);
        $this->assertBreadcrumb('admin/structure/taxonomy/manage/tags/add', $trail);
        // Verify Menu administration breadcrumbs.
        $trail = $admin + [
            'admin/structure' => 'Structure',
        ];
        $this->assertBreadcrumb('admin/structure/menu', $trail);
        $trail += [
            'admin/structure/menu' => 'Menus',
        ];
        $this->assertBreadcrumb('admin/structure/menu/manage/tools', $trail);
        $trail += [
            'admin/structure/menu/manage/tools' => 'Tools',
        ];
        $this->assertBreadcrumb("admin/structure/menu/link/node.add_page/edit", $trail);
        $this->assertBreadcrumb('admin/structure/menu/manage/tools/add', $trail);
        // Verify Node administration breadcrumbs.
        $trail = $admin + [
            'admin/structure' => 'Structure',
            'admin/structure/types' => 'Content types',
        ];
        $this->assertBreadcrumb('admin/structure/types/add', $trail);
        $this->assertBreadcrumb("admin/structure/types/manage/{$type}", $trail);
        $trail += [
            "admin/structure/types/manage/{$type}" => 'Article',
        ];
        $this->assertBreadcrumb("admin/structure/types/manage/{$type}/fields", $trail);
        $this->assertBreadcrumb("admin/structure/types/manage/{$type}/display", $trail);
        $trail_teaser = $trail + [
            "admin/structure/types/manage/{$type}/display" => 'Manage display',
        ];
        $this->assertBreadcrumb("admin/structure/types/manage/{$type}/display/teaser", $trail_teaser);
        $this->assertBreadcrumb("admin/structure/types/manage/{$type}/delete", $trail);
        $trail += [
            "admin/structure/types/manage/{$type}/fields" => 'Manage fields',
        ];
        $this->assertBreadcrumb("admin/structure/types/manage/{$type}/fields/node.{$type}.body", $trail);
        // Verify Filter text format administration breadcrumbs.
        $filter_formats = filter_formats();
        $format = reset($filter_formats);
        $format_id = $format->id();
        $trail = $config + [
            'admin/config/content' => 'Content authoring',
        ];
        $this->assertBreadcrumb('admin/config/content/formats', $trail);
        $trail += [
            'admin/config/content/formats' => 'Text formats and editors',
        ];
        $this->assertBreadcrumb('admin/config/content/formats/add', $trail);
        $this->assertBreadcrumb("admin/config/content/formats/manage/{$format_id}", $trail);
        // @todo Remove this part once we have a _title_callback, see
        //   https://www.drupal.org/node/2076085.
        $trail += [
            "admin/config/content/formats/manage/{$format_id}" => $format->label(),
        ];
        $this->assertBreadcrumb("admin/config/content/formats/manage/{$format_id}/disable", $trail);
        // Verify node breadcrumbs (without menu link).
        $node1 = $this->drupalCreateNode([
            'type' => $type,
        ]);
        $nid1 = $node1->id();
        $trail = $home;
        $this->assertBreadcrumb("node/{$nid1}", $trail);
        // Also verify that the node does not appear elsewhere (e.g., menu trees).
        $this->assertSession()
            ->linkNotExists($node1->getTitle());
        $trail += [
            "node/{$nid1}" => $node1->getTitle(),
        ];
        $this->assertBreadcrumb("node/{$nid1}/edit", $trail);
        // Verify that breadcrumb on node listing page contains "Home" only.
        $trail = [];
        $this->assertBreadcrumb('node', $trail);
        // Verify node breadcrumbs (in menu).
        // Do this separately for Main menu and Tools menu, since only the
        // latter is a preferred menu by default.
        // @todo Also test all themes? Manually testing led to the suspicion that
        //   breadcrumbs may differ, possibly due to theme overrides.
        $menus = [
            'main',
            'tools',
        ];
        // Alter node type menu settings.
        $node_type = NodeType::load($type);
        $node_type->setThirdPartySetting('menu_ui', 'available_menus', $menus);
        $node_type->setThirdPartySetting('menu_ui', 'parent', 'tools:');
        $node_type->save();
        foreach ($menus as $menu) {
            // Create a parent node in the current menu.
            $title = $this->randomMachineName();
            $node2 = $this->drupalCreateNode([
                'type' => $type,
                'title' => $title,
                'menu' => [
                    'enabled' => 1,
                    'title' => 'Parent ' . $title,
                    'description' => '',
                    'menu_name' => $menu,
                    'parent' => '',
                ],
            ]);
            if ($menu == 'tools') {
                $parent = $node2;
            }
        }
        // Create a Tools menu link for 'node', move the last parent node menu
        // link below it, and verify a full breadcrumb for the last child node.
        $menu = 'tools';
        $edit = [
            'title[0][value]' => 'Root',
            'link[0][uri]' => '/node',
        ];
        $this->drupalGet("admin/structure/menu/manage/{$menu}/add");
        $this->submitForm($edit, 'Save');
        $menu_links = \Drupal::entityTypeManager()->getStorage('menu_link_content')
            ->loadByProperties([
            'title' => 'Root',
        ]);
        $link = reset($menu_links);
        $edit = [
            'menu[menu_parent]' => $link->getMenuName() . ':' . $link->getPluginId(),
        ];
        $this->drupalGet('node/' . $parent->id() . '/edit');
        $this->submitForm($edit, 'Save');
        // Add a taxonomy term/tag to last node, and add a link for that term to the
        // Tools menu.
        $tags = [
            'Drupal' => [],
            'Breadcrumbs' => [],
        ];
        $edit = [
            'field_tags[target_id]' => implode(',', array_keys($tags)),
        ];
        $this->drupalGet('node/' . $parent->id() . '/edit');
        $this->submitForm($edit, 'Save');
        // Put both terms into a hierarchy Drupal » Breadcrumbs. Required for both
        // the menu links and the terms itself, since taxonomy_term_page() resets
        // the breadcrumb based on taxonomy term hierarchy.
        $parent_tid = 0;
        foreach ($tags as $name => $null) {
            $terms = \Drupal::entityTypeManager()->getStorage('taxonomy_term')
                ->loadByProperties([
                'name' => $name,
            ]);
            $term = reset($terms);
            $tags[$name]['term'] = $term;
            if ($parent_tid) {
                $edit = [
                    'parent[]' => [
                        $parent_tid,
                    ],
                ];
                $this->drupalGet("taxonomy/term/{$term->id()}/edit");
                $this->submitForm($edit, 'Save');
            }
            $parent_tid = $term->id();
        }
        $parent_menu_link_id = '';
        foreach ($tags as $name => $data) {
            $term = $data['term'];
            $edit = [
                'title[0][value]' => "{$name} link",
                'link[0][uri]' => "/taxonomy/term/{$term->id()}",
                'menu_parent' => "{$menu}:{$parent_menu_link_id}",
                'enabled[value]' => 1,
            ];
            $this->drupalGet("admin/structure/menu/manage/{$menu}/add");
            $this->submitForm($edit, 'Save');
            $menu_links = \Drupal::entityTypeManager()->getStorage('menu_link_content')
                ->loadByProperties([
                'title' => $edit['title[0][value]'],
                'link.uri' => 'internal:/taxonomy/term/' . $term->id(),
            ]);
            $tags[$name]['link'] = reset($menu_links);
            $parent_menu_link_id = $tags[$name]['link']->getPluginId();
        }
        // Verify expected breadcrumbs for menu links.
        $trail = $home;
        $tree = [];
        // Logout the user because we want to check the active class as well, which
        // is just rendered as anonymous user.
        $this->drupalLogout();
        foreach ($tags as $name => $data) {
            $term = $data['term'];
            
            /** @var \Drupal\menu_link_content\MenuLinkContentInterface $link */
            $link = $data['link'];
            $link_path = $link->getUrlObject()
                ->getInternalPath();
            $tree += [
                $link_path => $link->getTitle(),
            ];
            $this->assertBreadcrumb($link_path, $trail, $term->getName(), $tree, TRUE, 'menu__item--active-trail');
            // Ensure that the tagged node is found.
            $this->assertSession()
                ->assertEscaped($parent->getTitle());
            // Additionally make sure that this link appears only once; i.e., the
            // untranslated menu links automatically generated from menu router items
            // ('taxonomy/term/%') should never be translated and appear in any menu
            // other than the breadcrumb trail.
            $this->assertSession()
                ->elementsCount('xpath', '//nav[contains(@class, "menu--tools")]/descendant::a[@href="' . Url::fromUri('base:' . $link_path)->toString() . '"]', 1);
            // Next iteration should expect this tag as parent link.
            // Note: Term name, not link name, due to taxonomy_term_page().
            $trail += [
                $link_path => $term->getName(),
            ];
        }
        // Verify breadcrumbs on user and user/%.
        // We need to log back in and out below, and cannot simply grant the
        // 'administer users' permission, since user_page() makes your head explode.
        user_role_grant_permissions(RoleInterface::ANONYMOUS_ID, [
            'access user profiles',
        ]);
        // Verify breadcrumb on front page.
        $this->assertBreadcrumb('<front>', []);
        // Verify breadcrumb on user pages (without menu link) for anonymous user.
        $trail = $home;
        $this->assertBreadcrumb('user', $trail, 'Log in');
        $this->assertBreadcrumb('user/' . $this->adminUser
            ->id(), $trail, $this->adminUser
            ->getAccountName());
        // Verify breadcrumb on user pages (without menu link) for registered users.
        $this->drupalLogin($this->adminUser);
        $trail = $home;
        $this->assertBreadcrumb('user', $trail, $this->adminUser
            ->getAccountName());
        $this->assertBreadcrumb('user/' . $this->adminUser
            ->id(), $trail, $this->adminUser
            ->getAccountName());
        $trail += [
            'user/' . $this->adminUser
                ->id() => $this->adminUser
                ->getAccountName(),
        ];
        $this->assertBreadcrumb('user/' . $this->adminUser
            ->id() . '/edit', $trail, $this->adminUser
            ->getAccountName());
        // Create a second user to verify breadcrumb on user pages again.
        $this->webUser = $this->drupalCreateUser([
            'administer users',
            'access user profiles',
        ]);
        $this->drupalLogin($this->webUser);
        // Verify correct breadcrumb and page title on another user's account pages.
        $trail = $home;
        $this->assertBreadcrumb('user/' . $this->adminUser
            ->id(), $trail, $this->adminUser
            ->getAccountName());
        $trail += [
            'user/' . $this->adminUser
                ->id() => $this->adminUser
                ->getAccountName(),
        ];
        $this->assertBreadcrumb('user/' . $this->adminUser
            ->id() . '/edit', $trail, $this->adminUser
            ->getAccountName());
        // Verify correct breadcrumb and page title when viewing own user account.
        $trail = $home;
        $this->assertBreadcrumb('user/' . $this->webUser
            ->id(), $trail, $this->webUser
            ->getAccountName());
        $trail += [
            'user/' . $this->webUser
                ->id() => $this->webUser
                ->getAccountName(),
        ];
        $this->assertBreadcrumb('user/' . $this->webUser
            ->id() . '/edit', $trail, $this->webUser
            ->getAccountName());
        // Create an only slightly privileged user being able to access site reports
        // but not administration pages.
        $this->webUser = $this->drupalCreateUser([
            'access site reports',
        ]);
        $this->drupalLogin($this->webUser);
        // Verify that we can access recent log entries, there is a corresponding
        // page title, and that the breadcrumb is just the Home link (because the
        // user is not able to access "Administer".
        $trail = $home;
        $this->assertBreadcrumb('admin', $trail, 'Access denied');
        $this->assertSession()
            ->statusCodeEquals(403);
        // Since the 'admin' path is not accessible, we still expect only the Home
        // link.
        $this->assertBreadcrumb('admin/reports', $trail, 'Reports');
        $this->assertSession()
            ->statusCodeNotEquals(403);
        // Since the Reports page is accessible, that will show.
        $trail += [
            'admin/reports' => 'Reports',
        ];
        $this->assertBreadcrumb('admin/reports/dblog', $trail, 'Recent log messages');
        $this->assertSession()
            ->statusCodeNotEquals(403);
        // Ensure that the breadcrumb is safe against XSS.
        $this->drupalGet('menu-test/breadcrumb1/breadcrumb2/breadcrumb3');
        $this->assertSession()
            ->responseContains('<script>alert(12);</script>');
        $this->assertSession()
            ->assertEscaped('<script>alert(123);</script>');
    }
    
    /**
     * Tests AssertBreadcrumbTrait works as expected.
     */
    public function testAssertBreadcrumbTrait() : void {
        // Ensure the test trait works as expected using menu_test routes.
        $home = [
            '' => 'Home',
        ];
        $trail = $home + [
            'menu-test' => 'Menu test root',
        ];
        // Test a passing assertion.
        $this->assertBreadcrumb('menu-test/breadcrumb1', $trail);
        // If there is no trail, this assert should fail.
        $message = 'Breadcrumb assertion should fail with empty trail.';
        try {
            $this->assertBreadcrumb('menu-test/breadcrumb1', []);
            $this->fail($message);
        } catch (ExpectationFailedException $e) {
            $this->assertTrue(TRUE, $message);
        }
        // If the trail is incorrect, this assert should fail.
        $message = 'Breadcrumb assertion should fail with incorrect trail.';
        try {
            $this->assertBreadcrumb('menu-test/breadcrumb1', $home);
            $this->fail($message);
        } catch (ExpectationFailedException $e) {
            $this->assertTrue(TRUE, $message);
        }
        // Remove the breadcrumb block to test the trait when breadcrumbs are not
        // shown.
        Block::load('olivero_breadcrumbs')->delete();
        // If there is no trail, this should pass as there is no breadcrumb.
        $this->assertBreadcrumb('menu-test/breadcrumb1', []);
        // If there is a trail, this should fail as there is no breadcrumb.
        $message = 'Breadcrumb assertion should fail when breadcrumb block deleted and there is a trail.';
        try {
            $this->assertBreadcrumb('menu-test/breadcrumb1', $trail);
            $this->fail($message);
        } catch (ExpectationFailedException $e) {
            $this->assertTrue(TRUE, $message);
        }
    }

}