function HelpTest::testHelp

Logs in users, tests help pages.

File

core/modules/help/tests/src/Functional/HelpTest.php, line 69

Class

HelpTest

Verify help display and user access to help based on permissions.

Namespace

Code

public function testHelp() : void {
  // Log in the root user to ensure as many admin links appear as possible on
  // the module overview pages.
  $this->drupalLogin($this->drupalCreateUser([
    'access help pages',
    'access administration pages',
  ]));
  $this->verifyHelp();
  // Log in the regular user.
  $this->drupalLogin($this->anyUser);
  $this->verifyHelp(403);
  // Verify that introductory help text exists, goes for 100% module coverage.
  $this->drupalLogin($this->adminUser);
  $this->drupalGet('admin/help');
  $this->assertSession()
    ->responseContains('For more information, refer to the help listed on this page or to the <a href="https://www.drupal.org/documentation">online documentation</a> and <a href="https://www.drupal.org/support">support</a> pages at <a href="https://www.drupal.org">drupal.org</a>.');
  // Verify that hook_help() section title and description appear.
  $this->assertSession()
    ->responseContains('<h2>Module overviews</h2>');
  $this->assertSession()
    ->responseContains('<p>Module overviews are provided by modules. Overviews available for your installed modules:</p>');
  // Verify that an empty section is handled correctly.
  $this->assertSession()
    ->responseContains('<h2>Empty section</h2>');
  $this->assertSession()
    ->responseContains('<p>This description should appear.</p>');
  $this->assertSession()
    ->pageTextContains('There is currently nothing in this section.');
  // Make sure links are properly added for modules implementing hook_help().
  foreach ($this->getModuleList() as $module => $name) {
    $this->assertSession()
      ->linkExists($name, 0, new FormattableMarkup('Link properly added to @name (admin/help/@module)', [
      '@module' => $module,
      '@name' => $name,
    ]));
  }
  // Ensure a module which does not provide a module overview page is handled
  // correctly.
  $module_name = \Drupal::service('extension.list.module')->getName('help_test');
  $this->clickLink($module_name);
  $this->assertSession()
    ->pageTextContains('No help is available for module ' . $module_name);
  // Verify that the order of topics is alphabetical by displayed module
  // name, by checking the order of some modules, including some that would
  // have a different order if it was done by machine name instead.
  $this->drupalGet('admin/help');
  $page_text = $this->getTextContent();
  $start = strpos($page_text, 'Module overviews');
  $pos = $start;
  $list = [
    'Block',
    'Block Content',
    'Breakpoint',
    'History',
    'Text Editor',
  ];
  foreach ($list as $name) {
    $this->assertSession()
      ->linkExists($name);
    $new_pos = strpos($page_text, $name, $start);
    $this->assertGreaterThan($pos, $new_pos, "Order of {$name} is not correct on page");
    $pos = $new_pos;
  }
}