public function TourTestBase::assertTourTips in Zircon Profile 8

Same name and namespace in other branches

8.0 core/modules/tour/src/Tests/TourTestBase.php \Drupal\tour\Tests\TourTestBase::assertTourTips()

Assert function to determine if tips rendered to the page have a corresponding page element.

// 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);

Parameters

array $tips: A list of tips which provide either a "data-id" or "data-class".

8 calls to TourTestBase::assertTourTips()

LanguageTourTest::testLanguageAddTour in core/modules/language/src/Tests/LanguageTourTest.php: Go to add language page and check the tour tooltips.
LanguageTourTest::testLanguageEditTour in core/modules/language/src/Tests/LanguageTourTest.php: Go to edit language page and check the tour tooltips.
LanguageTourTest::testLanguageTour in core/modules/language/src/Tests/LanguageTourTest.php: Tests language tour tip availability.
LocaleTranslateStringTourTest::testTranslateStringTourTips in core/modules/locale/src/Tests/LocaleTranslateStringTourTest.php: Tests locale tour tip availability.
TourTest::testTourFunctionality in core/modules/tour/src/Tests/TourTest.php: Test tour functionality.

... See full list

File

core/modules/tour/src/Tests/TourTestBase.php, line 37: Contains \Drupal\tour\Tests\TourTestBase.

Class

TourTestBase: Base class for testing Tour functionality.

Namespace

Drupal\tour\Tests

Code

public function assertTourTips($tips = array()) {

  // 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) {
      $attributes = (array) $rendered_tip
        ->attributes();
      $tips[] = $attributes['@attributes'];
    }
  }

  // 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;
    foreach ($tips as $tip) {
      if (!empty($tip['data-id'])) {
        $elements = \PHPUnit_Util_XML::cssSelect('#' . $tip['data-id'], TRUE, $this->content, TRUE);
        $this
          ->assertTrue(!empty($elements) && count($elements) === 1, format_string('Found corresponding page element for tour tip with id #%data-id', array(
          '%data-id' => $tip['data-id'],
        )));
      }
      else {
        if (!empty($tip['data-class'])) {
          $elements = \PHPUnit_Util_XML::cssSelect('.' . $tip['data-class'], TRUE, $this->content, TRUE);
          $this
            ->assertFalse(empty($elements), format_string('Found corresponding page element for tour tip with class .%data-class', array(
            '%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).', array(
      '%total' => $total,
      '%modals' => $modals,
    )));
  }
}

You are here