Issue #2767275 by GoZ, Jo Fitzgerald, claudiu.cristea, boaloysius, andypost,...

Issue #2767275 by GoZ, Jo Fitzgerald, claudiu.cristea, boaloysius, andypost, klausi, dawehner: Convert web tests to browser tests for tour module

core/modules/language/src/Tests/LanguageTourTest.php → core/modules/language/tests/src/Functional/LanguageTourTest.php

 <?php
 
-namespace Drupal\language\Tests;
+namespace Drupal\Tests\language\Functional;
 
-use Drupal\tour\Tests\TourTestBase;
+use Drupal\Tests\tour\Functional\TourTestBase;
 
 /**
  * Tests tour functionality.

core/modules/locale/tests/src/Functional/LocaleTranslateStringTourTest.php

@@ -2,7 +2,7 @@
 
 namespace Drupal\Tests\locale\Functional;
 
-use Drupal\tour\Tests\TourTestBase;
+use Drupal\Tests\tour\Functional\TourTestBase;
 
 /**
  * Tests the Translate Interface tour.

core/modules/tour/src/Tests/TourTestBase.php

@@ -4,8 +4,13 @@
 
 use Drupal\simpletest\WebTestBase;
 
+@trigger_error('\Drupal\tour\Tests\TourTestBase is deprecated in 8.4.0 and will be removed before Drupal 9.0.0. Instead, use \Drupal\Tests\tour\Functional\TourTestBase.', E_USER_DEPRECATED);
+
 /**
  * Base class for testing Tour functionality.
+ *
+ * @deprecated in Drupal 8.4.0 and will be removed before Drupal 9.0.0.
+ *   Use \Drupal\Tests\tour\Functional\TourTestBase instead.
  */
 abstract class TourTestBase extends WebTestBase {
 

core/modules/tour/tests/src/Functional/TourCacheTagsTest.php

@@ -3,7 +3,7 @@
 namespace Drupal\Tests\tour\Functional;
 
 use Drupal\Core\Url;
-use Drupal\system\Tests\Cache\PageCacheTagsTestBase;
+use Drupal\Tests\system\Functional\Cache\PageCacheTagsTestBase;
 use Drupal\tour\Entity\Tour;
 use Drupal\user\Entity\Role;
 use Drupal\user\RoleInterface;

core/modules/tour/src/Tests/TourHelpPageTest.php → core/modules/tour/tests/src/Functional/TourHelpPageTest.php

 <?php
 
-namespace Drupal\tour\Tests;
+namespace Drupal\Tests\tour\Functional;
 
-use Drupal\simpletest\WebTestBase;
+use Drupal\Tests\BrowserTestBase;
 
 /**
  * Verifies help page display of tours.
  *
  * @group help
  */
-class TourHelpPageTest extends WebTestBase {
+class TourHelpPageTest extends BrowserTestBase {
 
   /**
    * Modules to enable, including some providing tours.
@@ -101,7 +101,7 @@ protected function verifyHelp($tours_ok = TRUE) {
     foreach ($titles[1] as $title) {
       if ($tours_ok) {
         $this->assertText($title);
-        $this->assertNoLink($title);
+        $this->assertSession()->linkNotExistsExact($title);
       }
       else {
         $this->assertNoText($title);

core/modules/tour/src/Tests/TourTest.php → core/modules/tour/tests/src/Functional/TourTest.php

 <?php
 
-namespace Drupal\tour\Tests;
+namespace Drupal\Tests\tour\Functional;
 
 use Drupal\language\Entity\ConfigurableLanguage;
 use Drupal\tour\Entity\Tour;

core/modules/tour/tests/src/Functional/TourTestBase.php

+<?php
+
+namespace Drupal\Tests\tour\Functional;
+
+use Drupal\Tests\BrowserTestBase;
+
+/**
+ * Base class for testing Tour functionality.
+ */
+abstract class TourTestBase extends BrowserTestBase {
+
+  /**
+   * Assert function to determine if tips rendered to the page
+   * have a corresponding page element.
+   *
+   * @param array $tips
+   *   A list of tips which provide either a "data-id" or "data-class".
+   *
+   * @code
+   * // Basic example.
+   * $this->assertTourTips();
+   *
+   * // Advanced example. The following would be used for multipage or
+   * // targeting a specific subset of tips.
+   * $tips = array();
+   * $tips[] = array('data-id' => 'foo');
+   * $tips[] = array('data-id' => 'bar');
+   * $tips[] = array('data-class' => 'baz');
+   * $this->assertTourTips($tips);
+   * @endcode
+   */
+  public function assertTourTips($tips = []) {
+    // Get the rendered tips and their data-id and data-class attributes.
+    if (empty($tips)) {
+      // Tips are rendered as <li> elements inside <ol id="tour">.
+      $rendered_tips = $this->xpath('//ol[@id = "tour"]//li[starts-with(@class, "tip")]');
+      foreach ($rendered_tips as $rendered_tip) {
+        $tips[] = [
+          'data-id' => $rendered_tip->getAttribute('data-id'),
+          'data-class' => $rendered_tip->getAttribute('data-class'),
+        ];
+      }
+    }
+
+    // If the tips are still empty we need to fail.
+    if (empty($tips)) {
+      $this->fail('Could not find tour tips on the current page.');
+    }
+    else {
+      // Check for corresponding page elements.
+      $total = 0;
+      $modals = 0;
+      $raw_content = $this->getSession()->getPage()->getContent();
+      foreach ($tips as $tip) {
+        if (!empty($tip['data-id'])) {
+          $elements = \PHPUnit_Util_XML::cssSelect('#' . $tip['data-id'], TRUE, $raw_content, TRUE);
+          $this->assertTrue(!empty($elements) && count($elements) === 1, format_string('Found corresponding page element for tour tip with id #%data-id', ['%data-id' => $tip['data-id']]));
+        }
+        elseif (!empty($tip['data-class'])) {
+          $elements = \PHPUnit_Util_XML::cssSelect('.' . $tip['data-class'], TRUE, $raw_content, TRUE);
+          $this->assertFalse(empty($elements), format_string('Found corresponding page element for tour tip with class .%data-class', ['%data-class' => $tip['data-class']]));
+        }
+        else {
+          // It's a modal.
+          $modals++;
+        }
+        $total++;
+      }
+      $this->pass(format_string('Total %total Tips tested of which %modals modal(s).', ['%total' => $total, '%modals' => $modals]));
+    }
+  }
+
+}

core/modules/tour/src/Tests/TourTestBasic.php → core/modules/tour/tests/src/Functional/TourTestBasic.php

 <?php
 
-namespace Drupal\tour\Tests;
+namespace Drupal\Tests\tour\Functional;
 
 /**
  * Simple tour tips test base.

core/modules/views_ui/src/Tests/ViewsUITourTest.php → core/modules/views_ui/tests/src/Functional/ViewsUITourTest.php

 <?php
 
-namespace Drupal\views_ui\Tests;
+namespace Drupal\Tests\views_ui\Functional;
 
-use Drupal\tour\Tests\TourTestBase;
+use Drupal\Tests\tour\Functional\TourTestBase;
 use Drupal\language\Entity\ConfigurableLanguage;
 
 /**