Issue #2940089 by Mile23: Clean up tour_example tests

Author: Mile23

tour_example/config/install/tour.tour.tour-example.yml

@@ -73,7 +73,7 @@ tips:
     weight: 2
     location: bottom
     attributes:
-      data-id: tour-id-1
+      data-id: tour-target-1
   second-item:
     id: second-item
     plugin: text
@@ -82,7 +82,7 @@ tips:
     weight: 3
     location: top
     attributes:
-      data-id: tour-id-2
+      data-id: tour-target-2
   third-item:
     id: third-item
     plugin: text
@@ -91,7 +91,7 @@ tips:
     weight: 4
     location: bottom
     attributes:
-      data-id: tour-id-3
+      data-id: tour-target-3
   fourth-item:
     id: fourth-item
     plugin: text
@@ -100,4 +100,4 @@ tips:
     weight: 5
     location: left
     attributes:
-      data-id: tour-id-4
+      data-id: tour-target-4

tour_example/templates/description.html.twig

@@ -2,17 +2,23 @@
 
 Description text for the Tour Example.
 
+Note that we have defined some 'buttons.' These page elements are targets for
+the tour we're demonstrating.
+
+The id of the target elements are used in the tour definition file as targets
+for the various tour steps.
+
 #}
 
 {% trans %}
 
 
 <h2>The Tour:</h2>
 <p>Click the 'Tour' icon in the admin menu bar to start.</p>
-<div class="button" id="tour-id-1">First item.</div>
-<div class="button" id="tour-id-2">Second item.</div>
-<div class="button" id="tour-id-3">Third item.</div>
-<div class="button" id="tour-id-4">Fourth item.</div>
+<div class="button" id="tour-target-1">First item.</div>
+<div class="button" id="tour-target-2">Second item.</div>
+<div class="button" id="tour-target-3">Third item.</div>
+<div class="button" id="tour-target-4">Fourth item.</div>
 
 <h2>About Tours</h2>
 

tour_example/tests/src/Functional/TourExampleTest.php

@@ -2,6 +2,9 @@
 
 namespace Drupal\Tests\tour_example\Functional;
 
+use Drupal\Core\Url;
+use Drupal\Tests\tour\Functional\TourTestBasic;
+
 /**
  * Regression tests for the tour_example module.
  *
@@ -19,7 +22,7 @@ class TourExampleTest extends TourTestBasic {
    *
    * @var array
    */
-  public static $modules = ['tour', 'tour_example'];
+  public static $modules = ['tour_example'];
 
   /**
    * The installation profile to use with this test.
@@ -31,23 +34,44 @@ class TourExampleTest extends TourTestBasic {
   /**
    * Main test.
    *
-   * Enable Tour Example and see if it can successfully return its main page
-   * and if there is a link to the tour example in the Tools menu.
+   * Make sure the Tour Example link is on the front page. Make sure all the
+   * tour tips exist on the page. Make sure all the corresponding target
+   * elements exist for tour tips that have targets.
    */
   public function testTourExample() {
-
     $assert = $this->assertSession();
 
     // Test for a link to the tour_example in the Tools menu.
-    $this->drupalGet('');
+    $this->drupalGet(Url::fromRoute('<front>'));
     $assert->statusCodeEquals(200);
     $assert->linkByHrefExists('examples/tour-example');
 
-    // Verify if the can successfully access the tour_examples page.
-    $this->drupalGet('examples/tour-example');
+    // Verify anonymous user can successfully access the tour_examples page.
+    $this->drupalGet(Url::fromRoute('tour_example_description'));
     $assert->statusCodeEquals(200);
 
-    // Verify that the tour tips exist on this page.
+    // Get all the tour elements. These are the IDs of each tour tip. See them
+    // in config/install/tour.tour.tour-example.yml.
+    $tip_ids = [
+      'introduction',
+      'first-item',
+      'second-item',
+      'third-item',
+      'fourth-item',
+    ];
+
+    // Ensure that we have the same number of tour tips that we expect.
+    $this->assertCount(count($tip_ids), $this->xpath("//ol[@id = \"tour\"]//li"));
+
+    // Ensure each item exists.
+    foreach ($tip_ids as $tip_id) {
+      $this->assertNotEmpty(
+        $this->xpath("//ol[@id = \"tour\"]//li[contains(@class, \"tip-$tip_id\")]"),
+        "Tip id: $tip_id"
+      );
+    }
+
+    // Verify that existing tour tips have corresponding target page elements.
     $this->assertTourTips();
   }