comparison core/modules/tour/tests/src/Functional/TourHelpPageTest.php @ 0:4c8ae668cc8c

Initial import (non-working)

+<?php
+
+namespace Drupal\Tests\tour\Functional;
+
+use Drupal\Tests\BrowserTestBase;
+
+/**
+ * Verifies help page display of tours.
+ *
+ * @group help
+ */
+class TourHelpPageTest extends BrowserTestBase {
+
+  /**
+   * Modules to enable, including some providing tours.
+   *
+   * @var array
+   */
+  public static $modules = ['help', 'tour', 'locale', 'language'];
+
+  /**
+   * User that can access tours and help.
+   *
+   * @var \Drupal\user\UserInterface
+   */
+  protected $tourUser;
+
+  /**
+   * A user who can access help but not tours.
+   *
+   * @var \Drupal\user\UserInterface
+   */
+  protected $noTourUser;
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function setUp() {
+    parent::setUp();
+
+    // Create users. For the Tour user, include permissions for the language
+    // tours' parent pages, but not the translation tour's parent page. See
+    // self:getTourList().
+    $this->tourUser = $this->drupalCreateUser(['access administration pages', 'access tour', 'administer languages']);
+    $this->noTourUser = $this->drupalCreateUser(['access administration pages']);
+  }
+
+  /**
+   * Logs in users, tests help pages.
+   */
+  public function testHelp() {
+    $this->drupalLogin($this->tourUser);
+    $this->verifyHelp();
+
+    $this->drupalLogin($this->noTourUser);
+    $this->verifyHelp(FALSE);
+  }
+
+  /**
+   * Verifies the logged in user has access to the help properly.
+   *
+   * @param bool $tours_ok
+   *   (optional) TRUE (default) if the user should see tours, FALSE if not.
+   */
+  protected function verifyHelp($tours_ok = TRUE) {
+    $this->drupalGet('admin/help');
+
+    // All users should be able to see the module section.
+    $this->assertText('Module overviews are provided by modules');
+    foreach ($this->getModuleList() as $name) {
+      $this->assertLink($name);
+    }
+
+    // Some users should be able to see the tour section.
+    if ($tours_ok) {
+      $this->assertText('Tours guide you through workflows');
+    }
+    else {
+      $this->assertNoText('Tours guide you through workflows');
+    }
+
+    $titles = $this->getTourList();
+
+    // Test the titles that should be links.
+    foreach ($titles[0] as $title) {
+      if ($tours_ok) {
+        $this->assertLink($title);
+      }
+      else {
+        $this->assertNoLink($title);
+        // Just test the first item in the list of links that should not
+        // be there, because the second matches the name of a module that is
+        // in the Module overviews section, so the link will be there and
+        // this test will fail. Testing one should be sufficient to verify
+        // the page is working correctly.
+        break;
+      }
+    }
+
+    // Test the titles that should not be links.
+    foreach ($titles[1] as $title) {
+      if ($tours_ok) {
+        $this->assertText($title);
+        $this->assertSession()->linkNotExistsExact($title);
+      }
+      else {
+        $this->assertNoText($title);
+        // Just test the first item in the list of text that should not
+        // be there, because the second matches part of the name of a module
+        // that is in the Module overviews section, so the text will be there
+        // and this test will fail. Testing one should be sufficient to verify
+        // the page is working correctly.
+        break;
+      }
+    }
+  }
+
+  /**
+   * Gets a list of modules to test for hook_help() pages.
+   *
+   * @return array
+   *   A list of module names to test.
+   */
+  protected function getModuleList() {
+    return ['Help', 'Tour'];
+  }
+
+  /**
+   * Gets a list of tours to test.
+   *
+   * @return array
+   *   A list of tour titles to test. The first array element is a list of tours
+   *   with links, and the second is a list of tours without links. Assumes
+   *   that the user being tested has 'administer languages' permission but
+   *   not 'translate interface'.
+   */
+  protected function getTourList() {
+    return [['Adding languages', 'Language'], ['Editing languages', 'Translation']];
+  }
+
+}