TourUITest.php in Tour UI 8

Namespace

Drupal\Tests\tour_ui\Functional

File

tests/src/Functional/TourUITest.php

<?php

namespace Drupal\Tests\tour_ui\Functional;

use Drupal\Tests\BrowserTestBase;

/**
 * Tests the Tour UI.
 *
 * @group Tour UI
 */
class TourUITest extends BrowserTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = [
    'tour_ui',
    'tour_test',
  ];

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';

  /**
   * Returns info for the test.
   *
   * {@inheritdoc}
   */
  public static function getInfo() {
    return [
      'name' => 'Tour UI',
      'description' => 'Tests the Tour UI.',
      'group' => 'Tour',
    ];
  }

  /**
   * Tests the listing and editing of a tour.
   */
  public function testUi() {
    $this
      ->drupalLogin($this
      ->drupalCreateUser([
      'administer tour',
    ]));
    $this
      ->listTest();
    $this
      ->editTest();
    $this
      ->tipTest();
  }

  /**
   * Tests the listing of a tour.
   */
  protected function listTest() {

    // Assert that two test tours are shown.
    $this
      ->drupalGet('admin/config/user-interface/tour');
    $elements = $this
      ->xpath('//table/tbody/tr');
    $this
      ->assertEquals(5, count($elements));

    // The first column contains the id.
    // jQuery('table > tbody > tr:first > td:first').text() === tour-test
    // jQuery('table > tbody > tr:first').hasClass('tour-test')
    // jQuery('table > tbody > tr.tip-edit > td:first').text()
    $elements = $this
      ->xpath('//table/tbody/tr[contains(@class, :class)]/td[1]', [
      ':class' => 'tour-test',
    ]);
    $this
      ->assertIdentical($elements[0]
      ->getText(), 'tour-test');

    // The second column contains the title.
    $elements = $this
      ->xpath('//table/tbody/tr[contains(@class, :class)]/td[2]', [
      ':class' => 'tour-test',
    ]);
    $this
      ->assertIdentical($elements[0]
      ->getText(), t('Tour test english')
      ->render());

    // The third column contains the routes.
    // Running "jQuery('table > tbody > tr.tour-test > td:nth(2)').html()"
    // results in "> <div class="tour-routes">tour_test.1<br>tour_test.3</div>".
    // FIX ME: trying to solve this failed. See #3009733 for further information.
    // $elements = $this->xpath('//table/tbody/tr[contains(@class, :class)]/td/div[contains(@class, :class-routes)]', [':class' => 'tour-test-1', ':class-routes' => 'tour-routes']);
    // $routes = strpos($elements[0]->getText(), 'tour_test.1') !== FALSE;
    // $this->assertTrue($routes, 'Route contains "tour_test.1".');
    // The fourth column contains the number of tips.
    $elements = $this
      ->xpath('//table/tbody/tr[contains(@class, :class)]/td[4]', [
      ':class' => 'tour-test',
    ]);
    $this
      ->assertIdentical($elements[0]
      ->getText(), '1', 'Core tour_test/config/tour-test-2 has 1 tip');
    $this
      ->assertIdentical($elements[1]
      ->getText(), '3', 'Core tour_test/config/tour-test-1 has 3 tips');
  }

  /**
   * Tests the editing of a tour.
   */
  protected function editTest() {

    // Create a new tour. Ensure that it comes before the test tours.
    $edit = [
      'label' => 'a' . $this
        ->randomString(),
      'id' => strtolower($this
        ->randomMachineName()),
      'module' => strtolower($this
        ->randomMachineName()),
    ];
    $this
      ->drupalPostForm('admin/config/user-interface/tour/add', $edit, t('Save'));
    $this
      ->assertRaw(t('The %tour tour has been created.', [
      '%tour' => $edit['label'],
    ]));
    $elements = $this
      ->xpath('//table/tbody/tr');
    $this
      ->assertEquals(1, count($elements));

    // Edit and re-save an existing tour.
    $this
      ->assertTitle(t('Edit tour | @site-name', [
      '@site-name' => \Drupal::config('system.site')
        ->get('name'),
    ]));
    $this
      ->drupalPostForm(NULL, [], t('Save'));
    $this
      ->assertRaw(t('Updated the %tour tour', [
      '%tour' => $edit['label'],
    ]));

    // Reorder the tour tips.
    $this
      ->drupalGet('admin/config/user-interface/tour/manage/tour-test');
    $weights = [
      'tips[tour-test-1][weight]' => '2',
      'tips[tour-test-3][weight]' => '1',
    ];
    $this
      ->drupalPostForm(NULL, $weights, t('Save'));
    $this
      ->drupalGet('admin/config/user-interface/tour/manage/tour-test');
    $elements = $this
      ->xpath('//tr[@class=:class and ./td[contains(., :text)]]', [
      ':class' => 'draggable odd',
      ':text' => 'The awesome image',
    ]);
    $this
      ->assertEquals(1, count($elements), 'Found odd tip "The awesome image".');
    $elements = $this
      ->xpath('//tr[@class=:class and ./td[contains(., :text)]]', [
      ':class' => 'draggable even',
      ':text' => 'The first tip',
    ]);
    $this
      ->assertEquals(1, count($elements), 'Found even tip "The first tip".');
    $weights = [
      'tips[tour-test-1][weight]' => '1',
      'tips[tour-test-3][weight]' => '2',
    ];
    $this
      ->drupalPostForm(NULL, $weights, t('Save'));
    $this
      ->drupalGet('admin/config/user-interface/tour/manage/tour-test');
    $elements = $this
      ->xpath('//tr[@class=:class and ./td[contains(., :text)]]', [
      ':class' => 'draggable odd',
      ':text' => 'The first tip',
    ]);
    $this
      ->assertEquals(1, count($elements), 'Found odd tip "The first tip".');
    $elements = $this
      ->xpath('//tr[@class=:class and ./td[contains(., :text)]]', [
      ':class' => 'draggable even',
      ':text' => 'The awesome image',
    ]);
    $this
      ->assertEquals(1, count($elements), 'Found even tip "The awesome image".');

    // Attempt to create a duplicate tour.
    $this
      ->drupalPostForm('admin/config/user-interface/tour/add', $edit, t('Save'));
    $this
      ->assertRaw(t('The machine-readable name is already in use. It must be unique.'));

    // Delete a tour.
    $this
      ->drupalGet('admin/config/user-interface/tour/manage/' . $edit['id']);
    $this
      ->drupalPostForm(NULL, NULL, t('Delete'));
    $this
      ->assertRaw(t('Are you sure you want to delete the %tour tour?', [
      '%tour' => $edit['label'],
    ]));
    $this
      ->clickLink(t('Cancel'));
    $this
      ->clickLink(t('Delete'));
    $this
      ->drupalPostForm(NULL, NULL, t('Delete'));
    $elements = $this
      ->xpath('//table/tbody/tr');
    $this
      ->assertEquals(2, count($elements));
    $this
      ->assertRaw(t('Deleted the %tour tour.', [
      '%tour' => $edit['label'],
    ]));
  }

  /**
   * Tests the add/edit/delete of a tour tip.
   */
  protected function tipTest() {

    // Create a new tour for tips to be added to.
    $edit = [
      'label' => 'a' . $this
        ->randomString(),
      'id' => strtolower($this
        ->randomMachineName()),
      'module' => $this
        ->randomString(),
      'paths' => '',
    ];
    $this
      ->drupalPostForm('admin/config/user-interface/tour/add', $edit, t('Save'));
    $this
      ->assertRaw(t('The %tour tour has been created.', [
      '%tour' => $edit['label'],
    ]));

    // Add a new tip.
    $tip = [
      'new' => 'image',
    ];
    $this
      ->drupalPostForm('admin/config/user-interface/tour/manage/' . $edit['id'], $tip, t('Add'));
    $tip = [
      'label' => 'a' . $this
        ->randomString(),
      'id' => 'tour-ui-test-image-tip',
      'url' => 'http://testimage.png',
      'alt' => 'Testing a new image tip through Tour UI.',
    ];
    $this
      ->drupalPostForm(NULL, $tip, t('Save'));
    $elements = $this
      ->xpath('//tr[@class=:class and ./td[contains(., :text)]]', [
      ':class' => 'draggable odd',
      ':text' => $tip['label'],
    ]);
    $this
      ->assertEquals(1, count($elements), 'Found tip "' . $tip['label'] . '".');

    // Edit the tip.
    $tip_id = $tip['id'];
    unset($tip['id']);
    $tip['label'] = 'a' . $this
      ->randomString();
    $this
      ->drupalPostForm('admin/config/user-interface/tour/manage/' . $edit['id'] . '/tip/edit/' . $tip_id, $tip, t('Save'));
    $elements = $this
      ->xpath('//tr[@class=:class and ./td[contains(., :text)]]', [
      ':class' => 'draggable odd',
      ':text' => $tip['label'],
    ]);
    $this
      ->assertEquals(1, count($elements), 'Found tip "' . $tip['label'] . '".');

    // Delete the tip.
    $this
      ->drupalPostForm('admin/config/user-interface/tour/manage/' . $edit['id'] . '/tip/delete/' . $tip_id, [], t('Delete'));
    $elements = $this
      ->xpath('//tr[@class=:class and ./td[contains(., :text)]]', [
      ':class' => 'draggable odd',
      ':text' => $tip['label'],
    ]);
    $this
      ->assertNotEqual(count($elements), 1, 'Did not find tip "' . $tip['label'] . '".');
  }

}

Classes

Name	Description
TourUITest	Tests the Tour UI.