class MenuUiTest in Drupal 9

Add a custom menu, add menu links to the custom menu and Tools menu, check their data, and delete them using the UI.

@group menu_ui

Hierarchy

• class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, FunctionalTestSetupTrait, TestSetupTrait, AssertLegacyTrait, BlockCreationTrait, ConfigTestTrait, ExtensionListTestTrait, ContentTypeCreationTrait, NodeCreationTrait, PhpUnitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings, UiHelperTrait, UserCreationTrait, XdebugRequestTrait
  • class \Drupal\Tests\menu_ui\Functional\MenuUiTest uses MenuUiTrait

File

core/modules/menu_ui/tests/src/Functional/MenuUiTest.php, line 23

Namespace

Drupal\Tests\menu_ui\Functional

class MenuUiTest extends BrowserTestBase {
  use MenuUiTrait;

  /**
   * Modules to enable.
   *
   * @var array
   */
  protected static $modules = [
    'block',
    'contextual',
    'help',
    'menu_link_content',
    'menu_ui',
    'node',
    'path',
    'test_page_test',
  ];

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';

  /**
   * A user with administration rights.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $adminUser;

  /**
   * An authenticated user.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $authenticatedUser;

  /**
   * Array of placed menu blocks keyed by block ID.
   *
   * @var array
   */
  protected $blockPlacements;

  /**
   * A test menu.
   *
   * @var \Drupal\system\Entity\Menu
   */
  protected $menu;

  /**
   * An array of test menu links.
   *
   * @var \Drupal\menu_link_content\MenuLinkContentInterface[]
   */
  protected $items;
  protected function setUp() : void {
    parent::setUp();
    $this
      ->drupalPlaceBlock('page_title_block');
    $this
      ->drupalPlaceBlock('system_menu_block:main');
    $this
      ->drupalCreateContentType([
      'type' => 'article',
      'name' => 'Article',
    ]);

    // Create users.
    $this->adminUser = $this
      ->drupalCreateUser([
      'access administration pages',
      'administer blocks',
      'administer menu',
      'create article content',
    ]);
    $this->authenticatedUser = $this
      ->drupalCreateUser([]);
  }

  /**
   * Tests menu functionality using the admin and user interfaces.
   */
  public function testMenu() {

    // Log in the user.
    $this
      ->drupalLogin($this->adminUser);
    $this->items = [];
    $this->menu = $this
      ->addCustomMenu();
    $this
      ->doMenuTests();
    $this
      ->doTestMenuBlock();
    $this
      ->addInvalidMenuLink();
    $this
      ->addCustomMenuCRUD();

    // Verify that the menu links rebuild is idempotent and leaves the same
    // number of links in the table.

    /** @var \Drupal\Core\Menu\MenuLinkManagerInterface $menu_link_manager */
    $menu_link_manager = \Drupal::service('plugin.manager.menu.link');
    $before_count = $menu_link_manager
      ->countMenuLinks(NULL);
    $menu_link_manager
      ->rebuild();
    $after_count = $menu_link_manager
      ->countMenuLinks(NULL);
    $this
      ->assertSame($before_count, $after_count, 'MenuLinkManager::rebuild() does not add more links');

    // Do standard user tests.
    // Log in the user.
    $this
      ->drupalLogin($this->authenticatedUser);
    $this
      ->verifyAccess(403);
    foreach ($this->items as $item) {

      // Menu link URIs are stored as 'internal:/node/$nid'.
      $node = Node::load(str_replace('internal:/node/', '', $item->link->uri));
      $this
        ->verifyMenuLink($item, $node);
    }

    // Log in the administrator.
    $this
      ->drupalLogin($this->adminUser);

    // Verify delete link exists and reset link does not exist.
    $this
      ->drupalGet('admin/structure/menu/manage/' . $this->menu
      ->id());
    $this
      ->assertSession()
      ->linkByHrefExists(Url::fromRoute('entity.menu_link_content.delete_form', [
      'menu_link_content' => $this->items[0]
        ->id(),
    ])
      ->toString());
    $this
      ->assertSession()
      ->linkByHrefNotExists(Url::fromRoute('menu_ui.link_reset', [
      'menu_link_plugin' => $this->items[0]
        ->getPluginId(),
    ])
      ->toString());

    // Check delete and reset access.
    $this
      ->drupalGet('admin/structure/menu/item/' . $this->items[0]
      ->id() . '/delete');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->drupalGet('admin/structure/menu/link/' . $this->items[0]
      ->getPluginId() . '/reset');
    $this
      ->assertSession()
      ->statusCodeEquals(403);

    // Delete menu links.
    foreach ($this->items as $item) {
      $this
        ->deleteMenuLink($item);
    }

    // Delete custom menu.
    $this
      ->deleteCustomMenu();

    // Modify and reset a standard menu link.
    $instance = $this
      ->getStandardMenuLink();
    $old_weight = $instance
      ->getWeight();

    // Edit the static menu link.
    $edit = [];
    $edit['weight'] = 10;
    $id = $instance
      ->getPluginId();
    $this
      ->drupalGet("admin/structure/menu/link/{$id}/edit");
    $this
      ->submitForm($edit, 'Save');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->pageTextContains('The menu link has been saved.');
    $menu_link_manager
      ->resetDefinitions();
    $instance = $menu_link_manager
      ->createInstance($instance
      ->getPluginId());
    $this
      ->assertEquals($edit['weight'], $instance
      ->getWeight(), 'Saving an existing link updates the weight.');
    $this
      ->resetMenuLink($instance, $old_weight);
  }

  /**
   * Adds a custom menu using CRUD functions.
   */
  public function addCustomMenuCRUD() {

    // Add a new custom menu.
    $menu_name = strtolower($this
      ->randomMachineName(MenuStorage::MAX_ID_LENGTH));
    $label = $this
      ->randomMachineName(16);
    $menu = Menu::create([
      'id' => $menu_name,
      'label' => $label,
      'description' => 'Description text',
    ]);
    $menu
      ->save();

    // Assert the new menu.
    $this
      ->drupalGet('admin/structure/menu/manage/' . $menu_name);
    $this
      ->assertSession()
      ->pageTextContains($label);

    // Edit the menu.
    $new_label = $this
      ->randomMachineName(16);
    $menu
      ->set('label', $new_label);
    $menu
      ->save();
    $this
      ->drupalGet('admin/structure/menu/manage/' . $menu_name);
    $this
      ->assertSession()
      ->pageTextContains($new_label);
  }

  /**
   * Creates a custom menu.
   *
   * @return \Drupal\system\Entity\Menu
   *   The custom menu that has been created.
   */
  public function addCustomMenu() {

    // Try adding a menu using a menu_name that is too long.
    $this
      ->drupalGet('admin/structure/menu/add');
    $menu_name = strtolower($this
      ->randomMachineName(MenuStorage::MAX_ID_LENGTH + 1));
    $label = $this
      ->randomMachineName(16);
    $edit = [
      'id' => $menu_name,
      'description' => '',
      'label' => $label,
    ];
    $this
      ->drupalGet('admin/structure/menu/add');
    $this
      ->submitForm($edit, 'Save');

    // Verify that using a menu_name that is too long results in a validation
    // message.
    $this
      ->assertSession()
      ->pageTextContains("Menu name cannot be longer than " . MenuStorage::MAX_ID_LENGTH . " characters but is currently " . mb_strlen($menu_name) . " characters long.");

    // Change the menu_name so it no longer exceeds the maximum length.
    $menu_name = strtolower($this
      ->randomMachineName(MenuStorage::MAX_ID_LENGTH));
    $edit['id'] = $menu_name;
    $this
      ->drupalGet('admin/structure/menu/add');
    $this
      ->submitForm($edit, 'Save');

    // Verify that no validation error is given for menu_name length.
    $this
      ->assertSession()
      ->pageTextNotContains("Menu name cannot be longer than " . MenuStorage::MAX_ID_LENGTH . " characters but is currently " . mb_strlen($menu_name) . " characters long.");

    // Verify that the confirmation message is displayed.
    $this
      ->assertSession()
      ->pageTextContains("Menu {$label} has been added.");
    $this
      ->drupalGet('admin/structure/menu');
    $this
      ->assertSession()
      ->pageTextContains($label);

    // Confirm that the custom menu block is available.
    $this
      ->drupalGet('admin/structure/block/list/' . $this
      ->config('system.theme')
      ->get('default'));
    $this
      ->clickLink('Place block');
    $this
      ->assertSession()
      ->pageTextContains($label);

    // Enable the block.
    $block = $this
      ->drupalPlaceBlock('system_menu_block:' . $menu_name);
    $this->blockPlacements[$menu_name] = $block
      ->id();
    return Menu::load($menu_name);
  }

  /**
   * Deletes the locally stored custom menu.
   *
   * This deletes the custom menu that is stored in $this->menu and performs
   * tests on the menu delete user interface.
   */
  public function deleteCustomMenu() {
    $menu_name = $this->menu
      ->id();
    $label = $this->menu
      ->label();

    // Delete custom menu.
    $this
      ->drupalGet("admin/structure/menu/manage/{$menu_name}/delete");
    $this
      ->submitForm([], 'Delete');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->pageTextContains("The menu {$label} has been deleted.");
    $this
      ->assertNull(Menu::load($menu_name), 'Custom menu was deleted');

    // Test if all menu links associated with the menu were removed from
    // database.
    $result = \Drupal::entityTypeManager()
      ->getStorage('menu_link_content')
      ->loadByProperties([
      'menu_name' => $menu_name,
    ]);
    $this
      ->assertEmpty($result, 'All menu links associated with the custom menu were deleted.');

    // Make sure there's no delete button on system menus.
    $this
      ->drupalGet('admin/structure/menu/manage/main');
    $this
      ->assertSession()
      ->responseNotContains('edit-delete');

    // Try to delete the main menu.
    $this
      ->drupalGet('admin/structure/menu/manage/main/delete');
    $this
      ->assertSession()
      ->pageTextContains('You are not authorized to access this page.');
  }

  /**
   * Tests menu functionality.
   */
  public function doMenuTests() {
    $menu_name = $this->menu
      ->id();

    // Test the 'Add link' local action.
    $this
      ->drupalGet(Url::fromRoute('entity.menu.edit_form', [
      'menu' => $menu_name,
    ]));
    $this
      ->clickLink('Add link');
    $link_title = $this
      ->randomString();
    $this
      ->submitForm([
      'link[0][uri]' => '/',
      'title[0][value]' => $link_title,
    ], 'Save');
    $this
      ->assertSession()
      ->addressEquals(Url::fromRoute('entity.menu.edit_form', [
      'menu' => $menu_name,
    ]));

    // Test the 'Edit' operation.
    $this
      ->clickLink('Edit');
    $this
      ->assertSession()
      ->fieldValueEquals('title[0][value]', $link_title);
    $link_title = $this
      ->randomString();
    $this
      ->submitForm([
      'title[0][value]' => $link_title,
    ], 'Save');
    $this
      ->assertSession()
      ->addressEquals(Url::fromRoute('entity.menu.edit_form', [
      'menu' => $menu_name,
    ]));

    // Test the 'Delete' operation.
    $this
      ->clickLink('Delete');
    $this
      ->assertSession()
      ->pageTextContains("Are you sure you want to delete the custom menu link {$link_title}?");
    $this
      ->submitForm([], 'Delete');
    $this
      ->assertSession()
      ->addressEquals(Url::fromRoute('entity.menu.edit_form', [
      'menu' => $menu_name,
    ]));

    // Add nodes to use as links for menu links.
    $node1 = $this
      ->drupalCreateNode([
      'type' => 'article',
    ]);
    $node2 = $this
      ->drupalCreateNode([
      'type' => 'article',
    ]);
    $node3 = $this
      ->drupalCreateNode([
      'type' => 'article',
    ]);
    $node4 = $this
      ->drupalCreateNode([
      'type' => 'article',
    ]);

    // Create a node with an alias.
    $node5 = $this
      ->drupalCreateNode([
      'type' => 'article',
      'path' => [
        'alias' => '/node5',
      ],
    ]);

    // Verify add link button.
    $this
      ->drupalGet('admin/structure/menu');
    $this
      ->assertSession()
      ->linkByHrefExists('admin/structure/menu/manage/' . $menu_name . '/add', 0, "The add menu link button URL is correct");

    // Verify form defaults.
    $this
      ->doMenuLinkFormDefaultsTest();

    // Add menu links.
    $item1 = $this
      ->addMenuLink('', '/node/' . $node1
      ->id(), $menu_name, TRUE);
    $item2 = $this
      ->addMenuLink($item1
      ->getPluginId(), '/node/' . $node2
      ->id(), $menu_name, FALSE);
    $item3 = $this
      ->addMenuLink($item2
      ->getPluginId(), '/node/' . $node3
      ->id(), $menu_name);

    // Hierarchy
    // <$menu_name>
    // - item1
    // -- item2
    // --- item3
    $this
      ->assertMenuLink([
      'children' => [
        $item2
          ->getPluginId(),
        $item3
          ->getPluginId(),
      ],
      'parents' => [
        $item1
          ->getPluginId(),
      ],
      // We assert the language code here to make sure that the language
      // selection element degrades gracefully without the Language module.
      'langcode' => 'en',
    ], $item1
      ->getPluginId());
    $this
      ->assertMenuLink([
      'children' => [
        $item3
          ->getPluginId(),
      ],
      'parents' => [
        $item2
          ->getPluginId(),
        $item1
          ->getPluginId(),
      ],
      // See above.
      'langcode' => 'en',
    ], $item2
      ->getPluginId());
    $this
      ->assertMenuLink([
      'children' => [],
      'parents' => [
        $item3
          ->getPluginId(),
        $item2
          ->getPluginId(),
        $item1
          ->getPluginId(),
      ],
      // See above.
      'langcode' => 'en',
    ], $item3
      ->getPluginId());

    // Verify menu links.
    $this
      ->verifyMenuLink($item1, $node1);
    $this
      ->verifyMenuLink($item2, $node2, $item1, $node1);
    $this
      ->verifyMenuLink($item3, $node3, $item2, $node2);

    // Add more menu links.
    $item4 = $this
      ->addMenuLink('', '/node/' . $node4
      ->id(), $menu_name);
    $item5 = $this
      ->addMenuLink($item4
      ->getPluginId(), '/node/' . $node5
      ->id(), $menu_name);

    // Create a menu link pointing to an alias.
    $item6 = $this
      ->addMenuLink($item4
      ->getPluginId(), '/node5', $menu_name, TRUE, '0');

    // Hierarchy
    // <$menu_name>
    // - item1
    // -- item2
    // --- item3
    // - item4
    // -- item5
    // -- item6
    $this
      ->assertMenuLink([
      'children' => [
        $item5
          ->getPluginId(),
        $item6
          ->getPluginId(),
      ],
      'parents' => [
        $item4
          ->getPluginId(),
      ],
      // See above.
      'langcode' => 'en',
    ], $item4
      ->getPluginId());
    $this
      ->assertMenuLink([
      'children' => [],
      'parents' => [
        $item5
          ->getPluginId(),
        $item4
          ->getPluginId(),
      ],
      'langcode' => 'en',
    ], $item5
      ->getPluginId());
    $this
      ->assertMenuLink([
      'children' => [],
      'parents' => [
        $item6
          ->getPluginId(),
        $item4
          ->getPluginId(),
      ],
      'route_name' => 'entity.node.canonical',
      'route_parameters' => [
        'node' => $node5
          ->id(),
      ],
      'url' => '',
      // See above.
      'langcode' => 'en',
    ], $item6
      ->getPluginId());

    // Modify menu links.
    $this
      ->modifyMenuLink($item1);
    $this
      ->modifyMenuLink($item2);

    // Toggle menu links.
    $this
      ->toggleMenuLink($item1);
    $this
      ->toggleMenuLink($item2);

    // Move link and verify that descendants are updated.
    $this
      ->moveMenuLink($item2, $item5
      ->getPluginId(), $menu_name);

    // Hierarchy
    // <$menu_name>
    // - item1
    // - item4
    // -- item5
    // --- item2
    // ---- item3
    // -- item6
    $this
      ->assertMenuLink([
      'children' => [],
      'parents' => [
        $item1
          ->getPluginId(),
      ],
      // See above.
      'langcode' => 'en',
    ], $item1
      ->getPluginId());
    $this
      ->assertMenuLink([
      'children' => [
        $item5
          ->getPluginId(),
        $item6
          ->getPluginId(),
        $item2
          ->getPluginId(),
        $item3
          ->getPluginId(),
      ],
      'parents' => [
        $item4
          ->getPluginId(),
      ],
      // See above.
      'langcode' => 'en',
    ], $item4
      ->getPluginId());
    $this
      ->assertMenuLink([
      'children' => [
        $item2
          ->getPluginId(),
        $item3
          ->getPluginId(),
      ],
      'parents' => [
        $item5
          ->getPluginId(),
        $item4
          ->getPluginId(),
      ],
      // See above.
      'langcode' => 'en',
    ], $item5
      ->getPluginId());
    $this
      ->assertMenuLink([
      'children' => [
        $item3
          ->getPluginId(),
      ],
      'parents' => [
        $item2
          ->getPluginId(),
        $item5
          ->getPluginId(),
        $item4
          ->getPluginId(),
      ],
      // See above.
      'langcode' => 'en',
    ], $item2
      ->getPluginId());
    $this
      ->assertMenuLink([
      'children' => [],
      'parents' => [
        $item3
          ->getPluginId(),
        $item2
          ->getPluginId(),
        $item5
          ->getPluginId(),
        $item4
          ->getPluginId(),
      ],
      // See above.
      'langcode' => 'en',
    ], $item3
      ->getPluginId());

    // Add 102 menu links with increasing weights, then make sure the last-added
    // item's weight doesn't get changed because of the old hardcoded delta=50.
    $items = [];
    for ($i = -50; $i <= 51; $i++) {
      $items[$i] = $this
        ->addMenuLink('', '/node/' . $node1
        ->id(), $menu_name, TRUE, strval($i));
    }
    $this
      ->assertMenuLink([
      'weight' => '51',
    ], $items[51]
      ->getPluginId());

    // Disable a link and then re-enable the link via the overview form.
    $this
      ->disableMenuLink($item1);
    $edit = [];
    $edit['links[menu_plugin_id:' . $item1
      ->getPluginId() . '][enabled]'] = TRUE;
    $this
      ->drupalGet('admin/structure/menu/manage/' . $item1
      ->getMenuName());
    $this
      ->submitForm($edit, 'Save');

    // Mark item2, item4 and item5 as expanded.
    // This is done in order to show them on the frontpage.
    $item2->expanded->value = 1;
    $item2
      ->save();
    $item4->expanded->value = 1;
    $item4
      ->save();
    $item5->expanded->value = 1;
    $item5
      ->save();

    // Verify in the database.
    $this
      ->assertMenuLink([
      'enabled' => 1,
    ], $item1
      ->getPluginId());

    // Add an external link.
    $item7 = $this
      ->addMenuLink('', 'https://www.drupal.org', $menu_name);
    $this
      ->assertMenuLink([
      'url' => 'https://www.drupal.org',
    ], $item7
      ->getPluginId());

    // Add <front> menu item.
    $item8 = $this
      ->addMenuLink('', '/', $menu_name);
    $this
      ->assertMenuLink([
      'route_name' => '<front>',
    ], $item8
      ->getPluginId());
    $this
      ->drupalGet('');
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // Make sure we get routed correctly.
    $this
      ->clickLink($item8
      ->getTitle());
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // Check invalid menu link parents.
    $this
      ->checkInvalidParentMenuLinks();

    // Save menu links for later tests.
    $this->items[] = $item1;
    $this->items[] = $item2;
  }

  /**
   * Test logout link isn't displayed when the user is logged out.
   */
  public function testLogoutLinkVisibility() {
    $adminUserWithLinkAnyPage = $this
      ->drupalCreateUser([
      'access administration pages',
      'administer blocks',
      'administer menu',
      'create article content',
      'link to any page',
    ]);
    $this
      ->drupalLogin($adminUserWithLinkAnyPage);
    $this
      ->addMenuLink('', '/user/logout', 'main');
    $assert = $this
      ->assertSession();

    // Verify that any link with logout URL is displayed.
    $assert
      ->linkByHrefExists('user/logout');

    // Verify that any link with logout URL is not displayed.
    $this
      ->drupalLogout();
    $assert
      ->linkByHrefNotExists('user/logout');
  }

  /**
   * Ensures that the proper default values are set when adding a menu link.
   */
  protected function doMenuLinkFormDefaultsTest() {
    $this
      ->drupalGet("admin/structure/menu/manage/tools/add");
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->fieldValueEquals('title[0][value]', '');
    $this
      ->assertSession()
      ->fieldValueEquals('link[0][uri]', '');
    $this
      ->assertSession()
      ->checkboxNotChecked('edit-expanded-value');
    $this
      ->assertSession()
      ->checkboxChecked('edit-enabled-value');
    $this
      ->assertSession()
      ->fieldValueEquals('description[0][value]', '');
    $this
      ->assertSession()
      ->fieldValueEquals('weight[0][value]', 0);
  }

  /**
   * Adds and removes a menu link with a query string and fragment.
   */
  public function testMenuQueryAndFragment() {
    $this
      ->drupalLogin($this->adminUser);

    // Make a path with query and fragment on.
    $path = '/test-page?arg1=value1&arg2=value2';
    $item = $this
      ->addMenuLink('', $path);

    // Check that the path has both the query and fragment.
    $this
      ->drupalGet('admin/structure/menu/item/' . $item
      ->id() . '/edit');
    $this
      ->assertSession()
      ->fieldValueEquals('link[0][uri]', $path);

    // Now change the path to something without query and fragment.
    $path = '/test-page';
    $this
      ->drupalGet('admin/structure/menu/item/' . $item
      ->id() . '/edit');
    $this
      ->submitForm([
      'link[0][uri]' => $path,
    ], 'Save');
    $this
      ->drupalGet('admin/structure/menu/item/' . $item
      ->id() . '/edit');
    $this
      ->assertSession()
      ->fieldValueEquals('link[0][uri]', $path);

    // Use <front>#fragment and ensure that saving it does not lose its content.
    $path = '<front>?arg1=value#fragment';
    $item = $this
      ->addMenuLink('', $path);
    $this
      ->drupalGet('admin/structure/menu/item/' . $item
      ->id() . '/edit');
    $this
      ->assertSession()
      ->fieldValueEquals('link[0][uri]', $path);
    $this
      ->drupalGet('admin/structure/menu/item/' . $item
      ->id() . '/edit');
    $this
      ->submitForm([], 'Save');
    $this
      ->drupalGet('admin/structure/menu/item/' . $item
      ->id() . '/edit');
    $this
      ->assertSession()
      ->fieldValueEquals('link[0][uri]', $path);
  }

  /**
   * Tests renaming the built-in menu.
   */
  public function testSystemMenuRename() {
    $this
      ->drupalLogin($this->adminUser);
    $edit = [
      'label' => $this
        ->randomMachineName(16),
    ];
    $this
      ->drupalGet('admin/structure/menu/manage/main');
    $this
      ->submitForm($edit, 'Save');

    // Make sure menu shows up with new name in block addition.
    $default_theme = $this
      ->config('system.theme')
      ->get('default');
    $this
      ->drupalget('admin/structure/block/list/' . $default_theme);
    $this
      ->clickLink('Place block');
    $this
      ->assertSession()
      ->pageTextContains($edit['label']);
  }

  /**
   * Tests that menu items pointing to unpublished nodes are editable.
   */
  public function testUnpublishedNodeMenuItem() {
    $this
      ->drupalLogin($this
      ->drupalCreateUser([
      'access administration pages',
      'administer blocks',
      'administer menu',
      'create article content',
      'bypass node access',
    ]));

    // Create an unpublished node.
    $node = $this
      ->drupalCreateNode([
      'type' => 'article',
      'status' => NodeInterface::NOT_PUBLISHED,
    ]);
    $item = $this
      ->addMenuLink('', '/node/' . $node
      ->id());
    $this
      ->modifyMenuLink($item);

    // Test that a user with 'administer menu' but without 'bypass node access'
    // cannot see the menu item.
    $this
      ->drupalLogout();
    $this
      ->drupalLogin($this->adminUser);
    $this
      ->drupalGet('admin/structure/menu/manage/' . $item
      ->getMenuName());
    $this
      ->assertSession()
      ->pageTextNotContains($item
      ->getTitle());

    // The cache contexts associated with the (in)accessible menu links are
    // bubbled. See DefaultMenuLinkTreeManipulators::menuLinkCheckAccess().
    $this
      ->assertSession()
      ->responseHeaderContains('X-Drupal-Cache-Contexts', 'user.permissions');
  }

  /**
   * Adds a menu link using the UI.
   *
   * @param string $parent
   *   Optional parent menu link id.
   * @param string $path
   *   The path to enter on the form. Defaults to the front page.
   * @param string $menu_name
   *   Menu name. Defaults to 'tools'.
   * @param bool $expanded
   *   Whether or not this menu link is expanded. Setting this to TRUE should
   *   test whether it works when we do the authenticatedUser tests. Defaults
   *   to FALSE.
   * @param string $weight
   *   Menu weight. Defaults to 0.
   *
   * @return \Drupal\menu_link_content\Entity\MenuLinkContent
   *   A menu link entity.
   */
  public function addMenuLink($parent = '', $path = '/', $menu_name = 'tools', $expanded = FALSE, $weight = '0') {

    // View add menu link page.
    $this
      ->drupalGet("admin/structure/menu/manage/{$menu_name}/add");
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $title = '!link_' . $this
      ->randomMachineName(16);
    $edit = [
      'link[0][uri]' => $path,
      'title[0][value]' => $title,
      'description[0][value]' => '',
      'enabled[value]' => 1,
      'expanded[value]' => $expanded,
      'menu_parent' => $menu_name . ':' . $parent,
      'weight[0][value]' => $weight,
    ];

    // Add menu link.
    $this
      ->submitForm($edit, 'Save');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->pageTextContains('The menu link has been saved.');
    $menu_links = \Drupal::entityTypeManager()
      ->getStorage('menu_link_content')
      ->loadByProperties([
      'title' => $title,
    ]);
    $menu_link = reset($menu_links);
    $this
      ->assertInstanceOf(MenuLinkContent::class, $menu_link);
    $this
      ->assertMenuLink([
      'menu_name' => $menu_name,
      'children' => [],
      'parent' => $parent,
    ], $menu_link
      ->getPluginId());
    return $menu_link;
  }

  /**
   * Attempts to add menu link with invalid path or no access permission.
   */
  public function addInvalidMenuLink() {
    foreach ([
      'access' => '/admin/people/permissions',
    ] as $type => $link_path) {
      $edit = [
        'link[0][uri]' => $link_path,
        'title[0][value]' => 'title',
      ];
      $this
        ->drupalGet("admin/structure/menu/manage/{$this->menu->id()}/add");
      $this
        ->submitForm($edit, 'Save');
      $this
        ->assertSession()
        ->pageTextContains("The path '{$link_path}' is inaccessible.");
    }
  }

  /**
   * Tests that parent options are limited by depth when adding menu links.
   */
  public function checkInvalidParentMenuLinks() {
    $last_link = NULL;
    $created_links = [];

    // Get the max depth of the tree.
    $menu_link_tree = \Drupal::service('menu.link_tree');
    $max_depth = $menu_link_tree
      ->maxDepth();

    // Create a maximum number of menu links, each a child of the previous.
    for ($i = 0; $i <= $max_depth - 1; $i++) {
      $parent = $last_link ? 'tools:' . $last_link
        ->getPluginId() : 'tools:';
      $title = 'title' . $i;
      $edit = [
        'link[0][uri]' => '/',
        'title[0][value]' => $title,
        'menu_parent' => $parent,
        'description[0][value]' => '',
        'enabled[value]' => 1,
        'expanded[value]' => FALSE,
        'weight[0][value]' => '0',
      ];
      $this
        ->drupalGet("admin/structure/menu/manage/{$this->menu->id()}/add");
      $this
        ->submitForm($edit, 'Save');
      $menu_links = \Drupal::entityTypeManager()
        ->getStorage('menu_link_content')
        ->loadByProperties([
        'title' => $title,
      ]);
      $last_link = reset($menu_links);
      $created_links[] = 'tools:' . $last_link
        ->getPluginId();
    }

    // The last link cannot be a parent in the new menu link form.
    $this
      ->drupalGet('admin/structure/menu/manage/admin/add');
    $value = 'tools:' . $last_link
      ->getPluginId();
    $this
      ->assertSession()
      ->optionNotExists('edit-menu-parent', $value);

    // All but the last link can be parents in the new menu link form.
    array_pop($created_links);
    foreach ($created_links as $key => $link) {
      $this
        ->assertSession()
        ->optionExists('edit-menu-parent', $link);
    }
  }

  /**
   * Verifies a menu link using the UI.
   *
   * @param \Drupal\menu_link_content\Entity\MenuLinkContent $item
   *   Menu link.
   * @param object $item_node
   *   Menu link content node.
   * @param \Drupal\menu_link_content\Entity\MenuLinkContent $parent
   *   Parent menu link.
   * @param object $parent_node
   *   Parent menu link content node.
   */
  public function verifyMenuLink(MenuLinkContent $item, $item_node, MenuLinkContent $parent = NULL, $parent_node = NULL) {

    // View home page.
    $this
      ->drupalGet('');
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // Verify parent menu link.
    if (isset($parent)) {

      // Verify menu link.
      $title = $parent
        ->getTitle();
      $this
        ->assertSession()
        ->linkExists($title, 0, 'Parent menu link was displayed');

      // Verify menu link link.
      $this
        ->clickLink($title);
      $title = $parent_node
        ->label();
      $this
        ->assertSession()
        ->titleEquals("{$title} | Drupal");
    }

    // Verify menu link.
    $title = $item
      ->getTitle();
    $this
      ->assertSession()
      ->linkExists($title, 0, 'Menu link was displayed');

    // Verify menu link link.
    $this
      ->clickLink($title);
    $title = $item_node
      ->label();
    $this
      ->assertSession()
      ->titleEquals("{$title} | Drupal");
  }

  /**
   * Changes the parent of a menu link using the UI.
   *
   * @param \Drupal\menu_link_content\MenuLinkContent $item
   *   The menu link item to move.
   * @param int $parent
   *   The id of the new parent.
   * @param string $menu_name
   *   The menu the menu link will be moved to.
   */
  public function moveMenuLink(MenuLinkContent $item, $parent, $menu_name) {
    $mlid = $item
      ->id();
    $edit = [
      'menu_parent' => $menu_name . ':' . $parent,
    ];
    $this
      ->drupalGet("admin/structure/menu/item/{$mlid}/edit");
    $this
      ->submitForm($edit, 'Save');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
  }

  /**
   * Modifies a menu link using the UI.
   *
   * @param \Drupal\menu_link_content\Entity\MenuLinkContent $item
   *   Menu link entity.
   */
  public function modifyMenuLink(MenuLinkContent $item) {
    $item->title->value = $this
      ->randomMachineName(16);
    $mlid = $item
      ->id();
    $title = $item
      ->getTitle();

    // Edit menu link.
    $edit = [];
    $edit['title[0][value]'] = $title;
    $this
      ->drupalGet("admin/structure/menu/item/{$mlid}/edit");
    $this
      ->submitForm($edit, 'Save');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->pageTextContains('The menu link has been saved.');

    // Verify menu link.
    $this
      ->drupalGet('admin/structure/menu/manage/' . $item
      ->getMenuName());
    $this
      ->assertSession()
      ->pageTextContains($title);
  }

  /**
   * Resets a standard menu link using the UI.
   *
   * @param \Drupal\Core\Menu\MenuLinkInterface $menu_link
   *   The Menu link.
   * @param int $old_weight
   *   Original title for menu link.
   */
  public function resetMenuLink(MenuLinkInterface $menu_link, $old_weight) {

    // Reset menu link.
    $this
      ->drupalGet("admin/structure/menu/link/{$menu_link->getPluginId()}/reset");
    $this
      ->submitForm([], 'Reset');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->pageTextContains('The menu link was reset to its default settings.');

    // Verify menu link.
    $instance = \Drupal::service('plugin.manager.menu.link')
      ->createInstance($menu_link
      ->getPluginId());
    $this
      ->assertEquals($old_weight, $instance
      ->getWeight(), 'Resets to the old weight.');
  }

  /**
   * Deletes a menu link using the UI.
   *
   * @param \Drupal\menu_link_content\Entity\MenuLinkContent $item
   *   Menu link.
   */
  public function deleteMenuLink(MenuLinkContent $item) {
    $mlid = $item
      ->id();
    $title = $item
      ->getTitle();

    // Delete menu link.
    $this
      ->drupalGet("admin/structure/menu/item/{$mlid}/delete");
    $this
      ->submitForm([], 'Delete');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->pageTextContains("The menu link {$title} has been deleted.");

    // Verify deletion.
    $this
      ->drupalGet('');
    $this
      ->assertSession()
      ->pageTextNotContains($title);
  }

  /**
   * Alternately disables and enables a menu link.
   *
   * @param \Drupal\menu_link_content\Entity\MenuLinkContent $item
   *   Menu link.
   */
  public function toggleMenuLink(MenuLinkContent $item) {
    $this
      ->disableMenuLink($item);

    // Verify menu link is absent.
    $this
      ->drupalGet('');
    $this
      ->assertSession()
      ->pageTextNotContains($item
      ->getTitle());
    $this
      ->enableMenuLink($item);

    // Verify menu link is displayed.
    $this
      ->drupalGet('');
    $this
      ->assertSession()
      ->pageTextContains($item
      ->getTitle());
  }

  /**
   * Disables a menu link.
   *
   * @param \Drupal\menu_link_content\Entity\MenuLinkContent $item
   *   Menu link.
   */
  public function disableMenuLink(MenuLinkContent $item) {
    $mlid = $item
      ->id();
    $edit['enabled[value]'] = FALSE;
    $this
      ->drupalGet("admin/structure/menu/item/{$mlid}/edit");
    $this
      ->submitForm($edit, 'Save');

    // Unlike most other modules, there is no confirmation message displayed.
    // Verify in the database.
    $this
      ->assertMenuLink([
      'enabled' => 0,
    ], $item
      ->getPluginId());
  }

  /**
   * Enables a menu link.
   *
   * @param \Drupal\menu_link_content\Entity\MenuLinkContent $item
   *   Menu link.
   */
  public function enableMenuLink(MenuLinkContent $item) {
    $mlid = $item
      ->id();
    $edit['enabled[value]'] = TRUE;
    $this
      ->drupalGet("admin/structure/menu/item/{$mlid}/edit");
    $this
      ->submitForm($edit, 'Save');

    // Verify in the database.
    $this
      ->assertMenuLink([
      'enabled' => 1,
    ], $item
      ->getPluginId());
  }

  /**
   * Tests if admin users, other than UID1, can access parents AJAX callback.
   */
  public function testMenuParentsJsAccess() {
    $this
      ->drupalLogin($this
      ->drupalCreateUser([
      'administer menu',
    ]));

    // Just check access to the callback overall, the POST data is irrelevant.
    $this
      ->drupalGet('admin/structure/menu/parents', [
      'query' => [
        MainContentViewSubscriber::WRAPPER_FORMAT => 'drupal_ajax',
      ],
    ], [
      'X-Requested-With: XMLHttpRequest',
    ]);
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // Log in as authenticated user.
    $this
      ->drupalLogin($this
      ->drupalCreateUser());

    // Check that a simple user is not able to access the menu.
    $this
      ->drupalGet('admin/structure/menu/parents', [
      'query' => [
        MainContentViewSubscriber::WRAPPER_FORMAT => 'drupal_ajax',
      ],
    ], [
      'X-Requested-With: XMLHttpRequest',
    ]);
    $this
      ->assertSession()
      ->statusCodeEquals(403);
  }

  /**
   * Tests the "expand all items" feature.
   */
  public function testExpandAllItems() {
    $this
      ->drupalLogin($this->adminUser);
    $menu = $this
      ->addCustomMenu();
    $node = $this
      ->drupalCreateNode([
      'type' => 'article',
    ]);

    // Create three menu items, none of which are expanded.
    $parent = $this
      ->addMenuLink('', $node
      ->toUrl()
      ->toString(), $menu
      ->id(), FALSE);
    $child_1 = $this
      ->addMenuLink($parent
      ->getPluginId(), $node
      ->toUrl()
      ->toString(), $menu
      ->id(), FALSE);
    $child_2 = $this
      ->addMenuLink($parent
      ->getPluginId(), $node
      ->toUrl()
      ->toString(), $menu
      ->id(), FALSE);

    // The menu will not automatically show all levels of depth.
    $this
      ->drupalGet('<front>');
    $this
      ->assertSession()
      ->linkExists($parent
      ->getTitle());
    $this
      ->assertSession()
      ->linkNotExists($child_1
      ->getTitle());
    $this
      ->assertSession()
      ->linkNotExists($child_2
      ->getTitle());

    // Update the menu block to show all levels of depth as expanded.
    $block_id = $this->blockPlacements[$menu
      ->id()];
    $this
      ->drupalGet('admin/structure/block/manage/' . $block_id);
    $this
      ->assertSession()
      ->checkboxNotChecked('settings[expand_all_items]');
    $this
      ->submitForm([
      'settings[depth]' => 2,
      'settings[level]' => 1,
      'settings[expand_all_items]' => 1,
    ], 'Save block');

    // Ensure the setting is persisted.
    $this
      ->drupalGet('admin/structure/block/manage/' . $block_id);
    $this
      ->assertSession()
      ->checkboxChecked('settings[expand_all_items]');

    // Ensure all three links are shown, including the children which would
    // usually be hidden without the "expand all items" setting.
    $this
      ->drupalGet('<front>');
    $this
      ->assertSession()
      ->linkExists($parent
      ->getTitle());
    $this
      ->assertSession()
      ->linkExists($child_1
      ->getTitle());
    $this
      ->assertSession()
      ->linkExists($child_2
      ->getTitle());
  }

  /**
   * Returns standard menu link.
   *
   * @return \Drupal\Core\Menu\MenuLinkInterface
   *   A menu link plugin.
   */
  private function getStandardMenuLink() {

    // Retrieve menu link id of the Log out menu link, which will always be on
    // the front page.

    /** @var \Drupal\Core\Menu\MenuLinkManagerInterface $menu_link_manager */
    $menu_link_manager = \Drupal::service('plugin.manager.menu.link');
    $instance = $menu_link_manager
      ->getInstance([
      'id' => 'user.logout',
    ]);
    $this
      ->assertTrue((bool) $instance, 'Standard menu link was loaded');
    return $instance;
  }

  /**
   * Verifies the logged in user has the desired access to various menu pages.
   *
   * @param int $response
   *   (optional) The expected HTTP response code. Defaults to 200.
   */
  private function verifyAccess($response = 200) {

    // View menu help page.
    $this
      ->drupalGet('admin/help/menu');
    $this
      ->assertSession()
      ->statusCodeEquals($response);
    if ($response == 200) {
      $this
        ->assertSession()
        ->pageTextContains('Menu', 'Menu help was displayed');
    }

    // View menu build overview page.
    $this
      ->drupalGet('admin/structure/menu');
    $this
      ->assertSession()
      ->statusCodeEquals($response);
    if ($response == 200) {
      $this
        ->assertSession()
        ->pageTextContains('Menus', 'Menu build overview page was displayed');
    }

    // View tools menu customization page.
    $this
      ->drupalGet('admin/structure/menu/manage/' . $this->menu
      ->id());
    $this
      ->assertSession()
      ->statusCodeEquals($response);
    if ($response == 200) {
      $this
        ->assertSession()
        ->pageTextContains('Tools', 'Tools menu page was displayed');
    }

    // View menu edit page for a static link.
    $item = $this
      ->getStandardMenuLink();
    $this
      ->drupalGet('admin/structure/menu/link/' . $item
      ->getPluginId() . '/edit');
    $this
      ->assertSession()
      ->statusCodeEquals($response);
    if ($response == 200) {
      $this
        ->assertSession()
        ->pageTextContains('Edit menu item', 'Menu edit page was displayed');
    }

    // View add menu page.
    $this
      ->drupalGet('admin/structure/menu/add');
    $this
      ->assertSession()
      ->statusCodeEquals($response);
    if ($response == 200) {
      $this
        ->assertSession()
        ->pageTextContains('Menus', 'Add menu page was displayed');
    }
  }

  /**
   * Tests menu block settings.
   */
  protected function doTestMenuBlock() {
    $menu_id = $this->menu
      ->id();
    $block_id = $this->blockPlacements[$menu_id];
    $this
      ->drupalGet('admin/structure/block/manage/' . $block_id);
    $this
      ->submitForm([
      'settings[depth]' => 3,
      'settings[level]' => 2,
    ], 'Save block');
    $block = Block::load($block_id);
    $settings = $block
      ->getPlugin()
      ->getConfiguration();
    $this
      ->assertEquals(3, $settings['depth']);
    $this
      ->assertEquals(2, $settings['level']);

    // Reset settings.
    $block
      ->getPlugin()
      ->setConfigurationValue('depth', 0);
    $block
      ->getPlugin()
      ->setConfigurationValue('level', 1);
    $block
      ->save();
  }

  /**
   * Tests that menu links with pending revisions can not be re-parented.
   */
  public function testMenuUiWithPendingRevisions() {
    $this
      ->drupalLogin($this->adminUser);
    $assert_session = $this
      ->assertSession();

    // Add four menu links in two separate menus.
    $menu_1 = $this
      ->addCustomMenu();
    $root_1 = $this
      ->addMenuLink('', '/', $menu_1
      ->id());
    $this
      ->addMenuLink($root_1
      ->getPluginId(), '/', $menu_1
      ->id());
    $menu_2 = $this
      ->addCustomMenu();
    $root_2 = $this
      ->addMenuLink('', '/', $menu_2
      ->id());
    $child_2 = $this
      ->addMenuLink($root_2
      ->getPluginId(), '/', $menu_2
      ->id());
    $this
      ->drupalGet('admin/structure/menu/manage/' . $menu_2
      ->id());
    $assert_session
      ->pageTextNotContains($menu_2
      ->label() . ' contains 1 menu link with pending revisions. Manipulation of a menu tree having links with pending revisions is not supported, but you can re-enable manipulation by getting each menu link to a published state.');
    $this
      ->drupalGet('admin/structure/menu/manage/' . $menu_1
      ->id());
    $assert_session
      ->pageTextNotContains($menu_1
      ->label() . ' contains 1 menu link with pending revisions. Manipulation of a menu tree having links with pending revisions is not supported, but you can re-enable manipulation by getting each menu link to a published state.');

    // Create a pending revision for one of the menu links and check that it can
    // no longer be re-parented in the UI. We can not create pending revisions
    // through the UI yet so we have to use API calls.
    \Drupal::entityTypeManager()
      ->getStorage('menu_link_content')
      ->createRevision($child_2, FALSE)
      ->save();
    $this
      ->drupalGet('admin/structure/menu/manage/' . $menu_2
      ->id());
    $assert_session
      ->pageTextContains($menu_2
      ->label() . ' contains 1 menu link with pending revisions. Manipulation of a menu tree having links with pending revisions is not supported, but you can re-enable manipulation by getting each menu link to a published state.');

    // Check that the 'Enabled' checkbox is hidden for a pending revision.
    $this
      ->assertNotEmpty($this
      ->cssSelect('input[name="links[menu_plugin_id:' . $root_2
      ->getPluginId() . '][enabled]"]'), 'The publishing status of a default revision can be changed.');
    $this
      ->assertEmpty($this
      ->cssSelect('input[name="links[menu_plugin_id:' . $child_2
      ->getPluginId() . '][enabled]"]'), 'The publishing status of a pending revision can not be changed.');
    $this
      ->drupalGet('admin/structure/menu/manage/' . $menu_1
      ->id());
    $assert_session
      ->pageTextNotContains($menu_1
      ->label() . ' contains 1 menu link with pending revisions. Manipulation of a menu tree having links with pending revisions is not supported, but you can re-enable manipulation by getting each menu link to a published state.');

    // Check that the menu overview form can be saved without errors when there
    // are pending revisions.
    $this
      ->drupalGet('admin/structure/menu/manage/' . $menu_2
      ->id());
    $this
      ->submitForm([], 'Save');
    $this
      ->assertSession()
      ->elementNotExists('xpath', '//div[contains(@class, "messages--error")]');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AssertLegacyTrait::assert Deprecated	protected	function
AssertLegacyTrait::assertCacheTag Deprecated	protected	function	Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent Deprecated	protected	function	Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent Deprecated	protected	function	Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual Deprecated	protected	function
AssertLegacyTrait::assertEscaped Deprecated	protected	function	Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField Deprecated	protected	function	Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById Deprecated	protected	function	Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName Deprecated	protected	function	Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath Deprecated	protected	function	Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked Deprecated	protected	function	Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue Deprecated	protected	function	Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader Deprecated	protected	function	Checks that current response header equals value.
AssertLegacyTrait::assertIdentical Deprecated	protected	function
AssertLegacyTrait::assertIdenticalObject Deprecated	protected	function
AssertLegacyTrait::assertLink Deprecated	protected	function	Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref Deprecated	protected	function	Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag Deprecated	protected	function	Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped Deprecated	protected	function	Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField Deprecated	protected	function	Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById Deprecated	protected	function	Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName Deprecated	protected	function	Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath Deprecated	protected	function	Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked Deprecated	protected	function	Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink Deprecated	protected	function	Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref Deprecated	protected	function	Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption Deprecated	protected	function	Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern Deprecated	protected	function	Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw Deprecated	protected	function	Passes if the raw text IS not found on the loaded page, fail otherwise.
AssertLegacyTrait::assertNotEqual Deprecated	protected	function
AssertLegacyTrait::assertNoText Deprecated	protected	function	Passes if the page (with HTML stripped) does not contains the text.
AssertLegacyTrait::assertNotIdentical Deprecated	protected	function
AssertLegacyTrait::assertNoUniqueText Deprecated	protected	function	Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption Deprecated	protected	function	Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText Deprecated	protected	function	Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected Deprecated	protected	function	Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern Deprecated	protected	function	Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw Deprecated	protected	function	Passes if the raw text IS found on the loaded page, fail otherwise.
AssertLegacyTrait::assertResponse Deprecated	protected	function	Asserts the page responds with the specified response code.
AssertLegacyTrait::assertText Deprecated	protected	function	Passes if the page (with HTML stripped) contains the text.
AssertLegacyTrait::assertTextHelper Deprecated	protected	function	Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle Deprecated	protected	function	Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText Deprecated	protected	function	Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl Deprecated	protected	function	Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery Deprecated	protected	function	Builds an XPath query.
AssertLegacyTrait::constructFieldXpath Deprecated	protected	function	Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions Deprecated	protected	function	Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent Deprecated	protected	function	Gets the current raw content.
AssertLegacyTrait::pass Deprecated	protected	function
AssertLegacyTrait::verbose Deprecated	protected	function
BlockCreationTrait::placeBlock	protected	function	Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl	protected	property	The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName	protected	property	Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter	protected	property	Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage	protected	property	Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory	protected	property	Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled	protected	property	HTML output output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile	protected	property	The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId	protected	property	HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders	protected	function	Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders	protected	function	Returns headers in HTML output format.	1
BrowserHtmlDebugTrait::getResponseLogHandler	protected	function	Provides a Guzzle middleware handler to log every response received.
BrowserHtmlDebugTrait::htmlOutput	protected	function	Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile	protected	function	Creates the directory to store browser output.
BrowserTestBase::$baseUrl	protected	property	The base URL.
BrowserTestBase::$configImporter	protected	property	The config importer that can be used in a test.
BrowserTestBase::$customTranslations	protected	property	An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix	protected	property	The database prefix of this test run.
BrowserTestBase::$mink	protected	property	Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs	protected	property	Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass	protected	property	Mink class for the default driver to use.	1
BrowserTestBase::$originalContainer	protected	property	The original container.
BrowserTestBase::$originalShutdownCallbacks	protected	property	The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState	protected	property
BrowserTestBase::$profile	protected	property	The profile to install as a basis for testing.	39
BrowserTestBase::$root	protected	property	The app root.
BrowserTestBase::$runTestInSeparateProcess	protected	property	Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests.
BrowserTestBase::$timeLimit	protected	property	Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory	protected	property	The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment	protected	function	Clean up the Simpletest environment.
BrowserTestBase::config	protected	function	Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::drupalGetHeader Deprecated	protected	function	Gets the value of an HTTP response header.
BrowserTestBase::filePreDeleteCallback	public static	function	Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance	protected	function	Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings	protected	function	Gets the JavaScript drupalSettings variable for the currently-loaded page.	1
BrowserTestBase::getHttpClient	protected	function	Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs	protected	function	Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests.	1
BrowserTestBase::getOptions	protected	function	Helper function to get the options of select field.
BrowserTestBase::getSession	public	function	Returns Mink session.
BrowserTestBase::getSessionCookies	protected	function	Get session cookies from current session.
BrowserTestBase::getTestMethodCaller	protected	function	Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage	protected	function	Visits the front page when initializing Mink.	3
BrowserTestBase::initMink	protected	function	Initializes Mink sessions.	1
BrowserTestBase::installDrupal	public	function	Installs Drupal into the Simpletest site.	1
BrowserTestBase::registerSessions	protected	function	Registers additional Mink sessions.
BrowserTestBase::setUpAppRoot	protected	function	Sets up the root application path.
BrowserTestBase::setUpBeforeClass	public static	function		1
BrowserTestBase::tearDown	protected	function		3
BrowserTestBase::translatePostValues	protected	function	Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath	protected	function	Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__sleep	public	function	Prevents serializing any properties.
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. Aliased as: drupalCreateContentType	1
ExtensionListTestTrait::getModulePath	protected	function	Gets the path for the specified module.
ExtensionListTestTrait::getThemePath	protected	function	Gets the path for the specified theme.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix	protected	property	The flag to set 'apcu_ensure_unique_prefix' setting.	1
FunctionalTestSetupTrait::$classLoader	protected	property	The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser	protected	property	The "#1" admin user.
FunctionalTestSetupTrait::doInstall	protected	function	Execute the non-interactive installer.	1
FunctionalTestSetupTrait::getDatabaseTypes	protected	function	Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig	protected	function	Initialize various configurations post-installation.	1
FunctionalTestSetupTrait::initKernel	protected	function	Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings	protected	function	Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession	protected	function	Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty	protected	function	Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installModulesFromClassProperty	protected	function	Install modules defined by `static::$modules`.	1
FunctionalTestSetupTrait::installParameters	protected	function	Returns the parameters that will be used when Simpletest installs Drupal.	9
FunctionalTestSetupTrait::prepareEnvironment	protected	function	Prepares the current environment for running the test.	20
FunctionalTestSetupTrait::prepareRequestForGenerator	protected	function	Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings	protected	function	Prepares site settings and services before installation.	2
FunctionalTestSetupTrait::rebuildAll	protected	function	Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer	protected	function	Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll	protected	function	Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter	protected	function	Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl	protected	function	Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings	protected	function	Rewrites the settings.php file of the test site.	1
MenuUiTest::$adminUser	protected	property	A user with administration rights.
MenuUiTest::$authenticatedUser	protected	property	An authenticated user.
MenuUiTest::$blockPlacements	protected	property	Array of placed menu blocks keyed by block ID.
MenuUiTest::$defaultTheme	protected	property	The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
MenuUiTest::$items	protected	property	An array of test menu links.
MenuUiTest::$menu	protected	property	A test menu.
MenuUiTest::$modules	protected static	property	Modules to enable. Overrides BrowserTestBase::$modules
MenuUiTest::addCustomMenu	public	function	Creates a custom menu.
MenuUiTest::addCustomMenuCRUD	public	function	Adds a custom menu using CRUD functions.
MenuUiTest::addInvalidMenuLink	public	function	Attempts to add menu link with invalid path or no access permission.
MenuUiTest::addMenuLink	public	function	Adds a menu link using the UI.
MenuUiTest::checkInvalidParentMenuLinks	public	function	Tests that parent options are limited by depth when adding menu links.
MenuUiTest::deleteCustomMenu	public	function	Deletes the locally stored custom menu.
MenuUiTest::deleteMenuLink	public	function	Deletes a menu link using the UI.
MenuUiTest::disableMenuLink	public	function	Disables a menu link.
MenuUiTest::doMenuLinkFormDefaultsTest	protected	function	Ensures that the proper default values are set when adding a menu link.
MenuUiTest::doMenuTests	public	function	Tests menu functionality.
MenuUiTest::doTestMenuBlock	protected	function	Tests menu block settings.
MenuUiTest::enableMenuLink	public	function	Enables a menu link.
MenuUiTest::getStandardMenuLink	private	function	Returns standard menu link.
MenuUiTest::modifyMenuLink	public	function	Modifies a menu link using the UI.
MenuUiTest::moveMenuLink	public	function	Changes the parent of a menu link using the UI.
MenuUiTest::resetMenuLink	public	function	Resets a standard menu link using the UI.
MenuUiTest::setUp	protected	function	Overrides BrowserTestBase::setUp
MenuUiTest::testExpandAllItems	public	function	Tests the "expand all items" feature.
MenuUiTest::testLogoutLinkVisibility	public	function	Test logout link isn't displayed when the user is logged out.
MenuUiTest::testMenu	public	function	Tests menu functionality using the admin and user interfaces.
MenuUiTest::testMenuParentsJsAccess	public	function	Tests if admin users, other than UID1, can access parents AJAX callback.
MenuUiTest::testMenuQueryAndFragment	public	function	Adds and removes a menu link with a query string and fragment.
MenuUiTest::testMenuUiWithPendingRevisions	public	function	Tests that menu links with pending revisions can not be re-parented.
MenuUiTest::testSystemMenuRename	public	function	Tests renaming the built-in menu.
MenuUiTest::testUnpublishedNodeMenuItem	public	function	Tests that menu items pointing to unpublished nodes are editable.
MenuUiTest::toggleMenuLink	public	function	Alternately disables and enables a menu link.
MenuUiTest::verifyAccess	private	function	Verifies the logged in user has the desired access to various menu pages.
MenuUiTest::verifyMenuLink	public	function	Verifies a menu link using the UI.
MenuUiTrait::assertMenuLink	protected	function	Asserts that a menu fetched from the database matches an expected one.
NodeCreationTrait::createNode	protected	function	Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle	public	function	Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
PhpUnitWarnings::$deprecationWarnings	private static	property	Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning	public	function	Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RandomGeneratorTrait::$randomGenerator	protected	property	The random generator.
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.	1
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.
RandomGeneratorTrait::randomStringValidate	public	function	Callback for random string validation.
RefreshVariablesTrait::refreshVariables	protected	function	Refreshes in-memory configuration and state information.	1
SessionTestTrait::$sessionName	protected	property	The name of the session cookie.
SessionTestTrait::generateSessionName	protected	function	Generates a session cookie name.
SessionTestTrait::getSessionName	protected	function	Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents	protected static	function	Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements	private	function	Checks missing module requirements.
TestRequirementsTrait::checkRequirements	protected	function	Check module requirements for the Drupal use case.	1
TestRequirementsTrait::getDrupalRoot	protected static	function	Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions	protected static	property	An array of config object names that are excluded from schema checking.
TestSetupTrait::$container	protected	property	The dependency injection container used in the test.
TestSetupTrait::$kernel	protected	property	The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite	protected	property	The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory	protected	property	The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory	protected	property	The public file directory for the test environment.
TestSetupTrait::$siteDirectory	protected	property	The site directory of this test run.
TestSetupTrait::$strictConfigSchema	protected	property	Set to TRUE to strict check all configuration saved.	1
TestSetupTrait::$tempFilesDirectory	protected	property	The temporary file directory for the test environment.
TestSetupTrait::$testId	protected	property	The test run ID.
TestSetupTrait::changeDatabasePrefix	protected	function	Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions	protected	function	Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection	public static	function	Returns the database connection to the site running Simpletest.
TestSetupTrait::prepareDatabasePrefix	protected	function	Generates a database prefix for running tests.	1
UiHelperTrait::$loggedInUser	protected	property	The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount	protected	property	The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount	protected	property	The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession	public	function	Returns WebAssert object.	1
UiHelperTrait::buildUrl	protected	function	Builds an absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh	protected	function	Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click	protected	function	Clicks the element with the given CSS selector.
UiHelperTrait::clickLink	protected	function	Follows a link by complete name.
UiHelperTrait::cssSelect	protected	function	Searches elements using a CSS selector in the raw content.
UiHelperTrait::cssSelectToXpath	protected	function	Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet	protected	function	Retrieves a Drupal path or an absolute path.	2
UiHelperTrait::drupalLogin	protected	function	Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout	protected	function	Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm Deprecated	protected	function	Executes a form submission.
UiHelperTrait::drupalUserIsLoggedIn	protected	function	Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl	protected	function	Takes a path and returns an absolute path.
UiHelperTrait::getTextContent	protected	function	Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl	protected	function	Get the current URL from the browser.
UiHelperTrait::isTestUsingGuzzleClient	protected	function	Determines if test is using DrupalTestBrowser.
UiHelperTrait::prepareRequest	protected	function	Prepare for a request to testing site.	1
UiHelperTrait::submitForm	protected	function	Fills and submits a form.
UserCreationTrait::checkPermissions	protected	function	Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole	protected	function	Creates an administrative role.
UserCreationTrait::createRole	protected	function	Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser	protected	function	Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions	protected	function	Grant permissions to a user role.
UserCreationTrait::setCurrentUser	protected	function	Switch the current logged in user.
UserCreationTrait::setUpCurrentUser	protected	function	Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest	protected	function	Adds xdebug cookies, from request setup.