function TourTest::testTourFunctionality

Test tour functionality.

File

core/modules/tour/tests/src/Functional/TourTest.php, line 67

Class

TourTest

Tests the functionality of tour tips.

Namespace

Code

public function testTourFunctionality() {
    // Navigate to tour-test-1 and verify the tour_test_1 tip is found with appropriate classes.
    $this->drupalGet('tour-test-1');
    // Test the TourTestBase class assertTourTips() method.
    $tips = [];
    $tips[] = [
        'data-id' => 'tour-test-1',
    ];
    $tips[] = [
        'data-class' => 'tour-test-5',
    ];
    $this->assertTourTips($tips);
    $this->assertTourTips();
    $elements = $this->xpath('//li[@data-id=:data_id and @class=:classes and ./p//a[@href=:href and contains(., :text)]]', [
        ':classes' => 'tip-module-tour-test tip-type-text tip-tour-test-1',
        ':data_id' => 'tour-test-1',
        ':href' => Url::fromRoute('<front>', [], [
            'absolute' => TRUE,
        ])->toString(),
        ':text' => 'Drupal',
    ]);
    $this->assertCount(1, $elements, 'Found Token replacement.');
    $elements = $this->cssSelect("li[data-id=tour-test-1] h2:contains('The first tip')");
    $this->assertCount(1, $elements, 'Found English variant of tip 1.');
    $elements = $this->cssSelect("li[data-id=tour-test-2] h2:contains('The quick brown fox')");
    $this->assertNotCount(1, $elements, 'Did not find English variant of tip 2.');
    $elements = $this->cssSelect("li[data-id=tour-test-1] h2:contains('La pioggia cade in spagna')");
    $this->assertNotCount(1, $elements, 'Did not find Italian variant of tip 1.');
    // Ensure that plugins work.
    $elements = $this->xpath('//img[@src="http://local/image.png"]');
    $this->assertCount(1, $elements, 'Image plugin tip found.');
    // Navigate to tour-test-2/subpath and verify the tour_test_2 tip is found.
    $this->drupalGet('tour-test-2/subpath');
    $elements = $this->cssSelect("li[data-id=tour-test-2] h2:contains('The quick brown fox')");
    $this->assertCount(1, $elements, 'Found English variant of tip 2.');
    $elements = $this->cssSelect("li[data-id=tour-test-1] h2:contains('The first tip')");
    $this->assertNotCount(1, $elements, 'Did not find English variant of tip 1.');
    // Enable Italian language and navigate to it/tour-test1 and verify italian
    // version of tip is found.
    ConfigurableLanguage::createFromLangcode('it')->save();
    $this->drupalGet('it/tour-test-1');
    $elements = $this->cssSelect("li[data-id=tour-test-1] h2:contains('La pioggia cade in spagna')");
    $this->assertCount(1, $elements, 'Found Italian variant of tip 1.');
    $elements = $this->cssSelect("li[data-id=tour-test-2] h2:contains('The quick brown fox')");
    $this->assertNotCount(1, $elements, 'Did not find English variant of tip 1.');
    // Programmatically create a tour for use through the remainder of the test.
    $tour = Tour::create([
        'id' => 'tour-entity-create-test-en',
        'label' => 'Tour test english',
        'langcode' => 'en',
        'module' => 'system',
        'routes' => [
            [
                'route_name' => 'tour_test.1',
            ],
        ],
        'tips' => [
            'tour-test-1' => [
                'id' => 'tour-code-test-1',
                'plugin' => 'text',
                'label' => 'The rain in spain',
                'body' => 'Falls mostly on the plain.',
                'weight' => '100',
                'attributes' => [
                    'data-id' => 'tour-code-test-1',
                ],
            ],
            'tour-code-test-2' => [
                'id' => 'tour-code-test-2',
                'plugin' => 'image',
                'label' => 'The awesome image',
                'url' => 'http://local/image.png',
                'weight' => 1,
                'attributes' => [
                    'data-id' => 'tour-code-test-2',
                ],
            ],
        ],
    ]);
    $tour->save();
    // Ensure that a tour entity has the expected dependencies based on plugin
    // providers and the module named in the configuration entity.
    $dependencies = $tour->calculateDependencies()
        ->getDependencies();
    $this->assertEqual($dependencies['module'], [
        'system',
        'tour_test',
    ]);
    $this->drupalGet('tour-test-1');
    // Load it back from the database and verify storage worked.
    $entity_save_tip = Tour::load('tour-entity-create-test-en');
    // Verify that hook_ENTITY_TYPE_load() integration worked.
    $this->assertEqual($entity_save_tip->loaded, 'Load hooks work');
    // Verify that hook_ENTITY_TYPE_presave() integration worked.
    $this->assertEqual($entity_save_tip->label(), 'Tour test english alter');
    // Navigate to tour-test-1 and verify the new tip is found.
    $this->drupalGet('tour-test-1');
    $elements = $this->cssSelect("li[data-id=tour-code-test-1] h2:contains('The rain in spain')");
    $this->assertCount(1, $elements, 'Found the required tip markup for tip 4');
    // Verify that the weight sorting works by ensuring the lower weight item
    // (tip 4) has the 'End tour' button.
    $elements = $this->cssSelect("li[data-id=tour-code-test-1][data-text='End tour']");
    $this->assertCount(1, $elements, 'Found code tip was weighted last and had "End tour".');
    // Test hook_tour_alter().
    $this->assertText('Altered by hook_tour_tips_alter');
    // Navigate to tour-test-3 and verify the tour_test_1 tip is found with
    // appropriate classes.
    $this->drupalGet('tour-test-3/foo');
    $elements = $this->xpath('//li[@data-id=:data_id and @class=:classes and ./h2[contains(., :text)]]', [
        ':classes' => 'tip-module-tour-test tip-type-text tip-tour-test-1',
        ':data_id' => 'tour-test-1',
        ':text' => 'The first tip',
    ]);
    $this->assertCount(1, $elements, 'Found English variant of tip 1.');
    // Navigate to tour-test-3 and verify the tour_test_1 tip is not found with
    // appropriate classes.
    $this->drupalGet('tour-test-3/bar');
    $elements = $this->xpath('//li[@data-id=:data_id and @class=:classes and ./h2[contains(., :text)]]', [
        ':classes' => 'tip-module-tour-test tip-type-text tip-tour-test-1',
        ':data_id' => 'tour-test-1',
        ':text' => 'The first tip',
    ]);
    $this->assertCount(0, $elements, 'Did not find English variant of tip 1.');
}