HelpTest.php

<?php

/**
 * @file
 * Definition of Drupal\help\Tests\HelpTest.
 */
namespace Drupal\help\Tests;

use Drupal\simpletest\WebTestBase;

/**
 * Tests help display and user access for all modules implementing help.
 */
class HelpTest extends WebTestBase {

  /**
   * Modules to enable.
   *
   * @var array.
   */
  public static $modules = array(
    'poll',
  );

  // Tests help implementations of many arbitrary core modules.
  protected $profile = 'standard';

  /**
   * The admin user that will be created.
   */
  protected $adminUser;

  /**
   * The anonymous user that will be created.
   */
  protected $anyUser;
  public static function getInfo() {
    return array(
      'name' => 'Help functionality',
      'description' => 'Verify help display and user access to help based on permissions.',
      'group' => 'Help',
    );
  }
  public function setUp() {
    parent::setUp();
    $this
      ->getModuleList();

    // Create users.
    $this->adminUser = $this
      ->drupalCreateUser(array(
      'access administration pages',
      'view the administration theme',
      'administer permissions',
    ));
    $this->anyUser = $this
      ->drupalCreateUser(array());
  }

  /**
   * Logs in users, creates dblog events, and tests dblog functionality.
   */
  public function testHelp() {

    // Login the admin user.
    $this
      ->drupalLogin($this->adminUser);
    $this
      ->verifyHelp();

    // Login the regular user.
    $this
      ->drupalLogin($this->anyUser);
    $this
      ->verifyHelp(403);

    // Check for css on admin/help.
    $this
      ->drupalLogin($this->adminUser);
    $this
      ->drupalGet('admin/help');
    $this
      ->assertRaw(drupal_get_path('module', 'help') . '/help.css', 'The help.css file is present in the HTML.');

    // Verify that introductory help text exists, goes for 100% module coverage.
    $this
      ->assertRaw(t('For more information, refer to the specific topics listed in the next section or to the <a href="@drupal">online Drupal handbooks</a>.', array(
      '@drupal' => 'http://drupal.org/documentation',
    )), 'Help intro text correctly appears.');

    // Verify that help topics text appears.
    $this
      ->assertRaw('<h2>' . t('Help topics') . '</h2><p>' . t('Help is available on the following items:') . '</p>', 'Help topics text correctly appears.');

    // Make sure links are properly added for modules implementing hook_help().
    foreach ($this
      ->getModuleList() as $module => $name) {
      $this
        ->assertLink($name, 0, format_string('Link properly added to @name (admin/help/@module)', array(
        '@module' => $module,
        '@name' => $name,
      )));
    }
  }

  /**
   * Verifies the logged in user has access to the various help nodes.
   *
   * @param integer $response
   *   An HTTP response code.
   */
  protected function verifyHelp($response = 200) {
    foreach ($this
      ->getModuleList() as $module => $name) {

      // View module help node.
      $this
        ->drupalGet('admin/help/' . $module);
      $this
        ->assertResponse($response);
      if ($response == 200) {
        $this
          ->assertTitle($name . ' | Drupal', format_string('%module title was displayed', array(
          '%module' => $module,
        )));
        $this
          ->assertRaw('<h1 class="page-title">' . t($name) . '</h1>', format_string('%module heading was displayed', array(
          '%module' => $module,
        )));
      }
    }
  }

  /**
   * Gets the list of enabled modules that implement hook_help().
   *
   * @return array
   *   A list of enabled modules.
   */
  protected function getModuleList() {
    $modules = array();
    $module_data = system_rebuild_module_data();
    foreach (module_implements('help') as $module) {
      $modules[$module] = $module_data[$module]->info['name'];
    }
    return $modules;
  }

}