admin_toolbar-8.x-2.x-dev/tests/src/Functional/AdminToolbarSettingsFormTest.php

<?php

namespace Drupal\Tests\admin_toolbar\Functional;

use Drupal\Tests\BrowserTestBase;

/**
 * Test the Admin Toolbar settings form.
 *
 * @group admin_toolbar
 */
class AdminToolbarSettingsFormTest extends BrowserTestBase {

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

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'admin_toolbar',
  ];

  /**
   * A user with access to the Admin Toolbar settings form permission.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $adminUser;

  /**
   * {@inheritdoc}
   */
  protected function setUp(): void {
    parent::setUp();

    $permissions = [
      'access toolbar',
      'access administration pages',
      'administer site configuration',
      // This permission is needed to display the user admin links to be tested.
      'administer account settings',
    ];
    $this->adminUser = $this->drupalCreateUser($permissions);
  }

  /**
   * Test backend admin toolbar settings form fields and submission.
   *
   * Login as an admin user, go to the 'Admin Toolbar settings' form, change
   * all the values, submit the form and check the expected values are applied.
   */
  public function testAdminToolbarSettingsForm(): void {
    /** @var \Drupal\Tests\WebAssert $assert */
    $assert = $this->assertSession();

    // Log in as an admin user to test admin pages.
    $this->drupalLogin($this->adminUser);

    // Assert the account settings link under config, has the expected classes.
    $assert->responseContains('class="toolbar-icon toolbar-icon-user-admin-index"');

    // Test the 'Admin Toolbar settings' page form submission and fields.
    $this->drupalGet('admin/config/user-interface/admin-toolbar');

    // Change the hoverIntent settings values.
    $hoverintent_settings_expected_js_value = '"hoverIntentTimeout":750';
    $edit = [
      'hoverintent_behavior[timeout]' => 750,
    ];
    $this->submitForm($edit, 'Save configuration');
    $assert->pageTextContains('The configuration options have been saved.');

    /* Test default values to compare with the ones after the changes. */

    // Test 'Menu depth' for the Admin Toolbar settings form, under:
    // Configuration > User interface > Admin Toolbar.
    // Default value '4': the menu should be displayed as level 3.
    $assert->elementExists('xpath', '//div[@class="toolbar-menu-administration"]//ul[contains(@class, "toolbar-menu")]//li[contains(@class, "menu-item")]//ul[@class="toolbar-menu"]//li[contains(@class, "menu-item")]//ul[@class="toolbar-menu"]//li[@class="menu-item"]//a[contains(@href, "/admin/config/user-interface/admin-toolbar") and contains(.,"Admin Toolbar")]');

    // Test the toggle toolbar shortcut library is *not* loaded by default.
    $toggle_shortcut_js = 'js/admin_toolbar.toggle_shortcut.js';
    $toggle_shortcut_css = 'css/admin_toolbar.toggle_shortcut.css';
    $assert->responseNotContains($toggle_shortcut_js);
    $assert->responseNotContains($toggle_shortcut_css);

    // Test hoverintent and Sticky behavior.
    $hover_js = 'js/admin_toolbar.hover.js';
    $hoverintent_js = 'js/admin_toolbar.hoverintent.js';
    // Path to the libraries CSS files for sticky behavior, to be tested.
    $disable_sticky_css = 'css/admin_toolbar.disable_sticky.css';
    $sticky_behavior_css = 'css/admin_toolbar.sticky_behavior.css';

    // Check the default hoverintent library is not loaded.
    $assert->responseNotContains($hover_js);
    // Check the hoverIntent functionality is enabled.
    $assert->responseContains($hoverintent_js);
    // Check the hoverIntent drupalSettings values are loaded as expected.
    $assert->responseContains($hoverintent_settings_expected_js_value);
    // Check sticky behavior is disabled and its CSS is *not* loaded.
    $assert->responseNotContains($disable_sticky_css);
    $assert->responseNotContains($sticky_behavior_css);

    /* Change all the values of the settings form. */

    // Set the 'Menu depth' to '2', disable sticky, hoverIntent and save.
    $edit = [
      'enable_toggle_shortcut' => TRUE,
      'menu_depth' => '2',
      'sticky_behavior' => 'disabled',
      'hoverintent_behavior[enabled]' => FALSE,
    ];
    $this->submitForm($edit, 'Save configuration');
    $assert->pageTextContains('The configuration options have been saved.');

    /* Test updated values. */

    // Check the menu item 'Admin Toolbar' is not displayed.
    $assert->elementNotExists('xpath', '//div[@class="toolbar-menu-administration"]//ul[contains(@class, "toolbar-menu")]//li[contains(@class, "menu-item")]//ul[@class="toolbar-menu"]//li[contains(@class, "menu-item")]//ul[@class="toolbar-menu"]//li[@class="menu-item"]//a[contains(@href, "/admin/config/user-interface/admin-toolbar") and contains(.,"Admin Toolbar")]');
    // Check the menu item 'User interface' does not have a child 'ul'.
    $assert->elementNotExists('xpath', '//div[@class="toolbar-menu-administration"]//ul[contains(@class, "toolbar-menu")]//li[contains(@class, "menu-item")]//ul[@class="toolbar-menu"]//li[contains(@class, "menu-item")]//ul');
    // Check the menu item 'User interface' has a single child 'a' link tag.
    $assert->elementExists('xpath', '//div[@class="toolbar-menu-administration"]//ul[contains(@class, "toolbar-menu")]//li[contains(@class, "menu-item")]//ul[@class="toolbar-menu"]//li[contains(@class, "menu-item") and count(child::*)=1 and child::*=a]');

    // Check toggle shortcut is enabled.
    $assert->responseContains($toggle_shortcut_js);
    $assert->responseContains($toggle_shortcut_css);
    // Check the default hoverintent library is loaded.
    $assert->responseContains($hover_js);
    // Check the hoverIntent functionality is not enabled.
    $assert->responseNotContains($hoverintent_js);
    // Check the hoverIntent drupalSettings values are not loaded.
    $assert->responseNotContains('hoverIntentTimeout');
    // Check sticky behavior is disabled, but its CSS is loaded, since it is
    // required by the toggle shortcut library.
    $assert->responseContains($disable_sticky_css);
    $assert->responseContains($sticky_behavior_css);

    // Set the sticky behavior to 'Hide on scroll down' and save the form.
    $edit = [
      'enable_toggle_shortcut' => FALSE,
      'sticky_behavior' => 'hide_on_scroll_down',
    ];
    $this->submitForm($edit, 'Save configuration');
    $assert->pageTextContains('The configuration options have been saved.');

    // Check toggle shortcut is disabled.
    $assert->responseNotContains($toggle_shortcut_js);
    $assert->responseNotContains($toggle_shortcut_css);
    // Check sticky behavior 'hide_on_scroll_down' is displayed.
    $assert->responseNotContains($disable_sticky_css);
    $assert->responseContains($sticky_behavior_css);
    $assert->responseContains('js/admin_toolbar.sticky_behavior.js');

  }

}