class TourTest

Same name in this branch
  1. 10 core/modules/tour/tests/src/Unit/Entity/TourTest.php \Drupal\Tests\tour\Unit\Entity\TourTest
  2. 10 core/modules/tour/tests/src/Functional/Jsonapi/TourTest.php \Drupal\Tests\tour\Functional\Jsonapi\TourTest
Same name in other branches
  1. 9 core/modules/jsonapi/tests/src/Functional/TourTest.php \Drupal\Tests\jsonapi\Functional\TourTest
  2. 9 core/modules/tour/tests/src/Unit/Entity/TourTest.php \Drupal\Tests\tour\Unit\Entity\TourTest
  3. 9 core/modules/tour/tests/src/Functional/TourTest.php \Drupal\Tests\tour\Functional\TourTest
  4. 8.9.x core/modules/jsonapi/tests/src/Functional/TourTest.php \Drupal\Tests\jsonapi\Functional\TourTest
  5. 8.9.x core/modules/tour/tests/src/Unit/Entity/TourTest.php \Drupal\Tests\tour\Unit\Entity\TourTest
  6. 8.9.x core/modules/tour/tests/src/Functional/TourTest.php \Drupal\Tests\tour\Functional\TourTest
  7. 11.x core/modules/tour/tests/src/Unit/Entity/TourTest.php \Drupal\Tests\tour\Unit\Entity\TourTest
  8. 11.x core/modules/tour/tests/src/Functional/TourTest.php \Drupal\Tests\tour\Functional\TourTest
  9. 11.x core/modules/tour/tests/src/Functional/Jsonapi/TourTest.php \Drupal\Tests\tour\Functional\Jsonapi\TourTest

Tests the functionality of tour tips.

@group tour @group legacy

Hierarchy

Expanded class hierarchy of TourTest

File

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

Namespace

Drupal\Tests\tour\Functional
View source
class TourTest extends TourTestBasic {
    
    /**
     * Modules to enable.
     *
     * @var array
     */
    protected static $modules = [
        'block',
        'tour',
        'locale',
        'language',
        'tour_test',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * The permissions required for a logged in user to test tour tips.
     *
     * @var array
     *   A list of permissions.
     */
    protected $permissions = [
        'access tour',
        'administer languages',
    ];
    
    /**
     * Tour tip attributes to be tested. Keyed by the path.
     *
     * @var array
     *   An array of tip attributes, keyed by path.
     */
    protected $tips = [
        'tour-test-1' => [],
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->drupalPlaceBlock('local_actions_block', [
            'theme' => 'claro',
            'region' => 'content',
        ]);
    }
    
    /**
     * Tests tour functionality.
     */
    public function testTourFunctionality() : void {
        // 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();
        $tips = $this->getTourTips();
        $href = Url::fromRoute('<front>', [], [
            'absolute' => TRUE,
        ])->toString();
        $elements = [];
        foreach ($tips as $tip) {
            if ($tip['id'] == 'tour-test-1' && $tip['module'] == 'tour_test' && $tip['type'] == 'text' && str_contains($tip['body'], $href) && str_contains($tip['body'], 'Drupal')) {
                $elements[] = $tip;
            }
        }
        $this->assertCount(1, $elements, 'Found Token replacement.');
        $elements = $this->findTip([
            'id' => 'tour-test-1',
            'title' => 'The first tip',
        ]);
        $this->assertCount(1, $elements, 'Found English variant of tip 1.');
        $elements = $this->findTip([
            'id' => 'tour-test-2',
            'title' => 'The quick brown fox',
        ]);
        $this->assertNotCount(1, $elements, 'Did not find English variant of tip 2.');
        $elements = $this->findTip([
            'id' => 'tour-test-1',
            'title' => 'La pioggia cade in spagna',
        ]);
        $this->assertNotCount(1, $elements, 'Did not find Italian variant of tip 1.');
        // Ensure that plugins work.
        $elements = [];
        foreach ($tips as $tip) {
            if (str_contains($tip['body'], 'http://local/image.png')) {
                $elements[] = $tip;
            }
        }
        $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->findTip([
            'id' => 'tour-test-2',
            'title' => 'The quick brown fox',
        ]);
        $this->assertCount(1, $elements, 'Found English variant of tip 2.');
        $elements = $this->findTip([
            'id' => 'tour-test-1',
            'title' => '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->findTip([
            'id' => 'tour-test-1',
            'title' => 'La pioggia cade in spagna',
        ]);
        $this->assertCount(1, $elements, 'Found Italian variant of tip 1.');
        $elements = $this->findTip([
            'id' => 'tour-test-2',
            'title' => '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 is <strong>strong</strong>',
                    'body' => 'Falls mostly on the plain.',
                    'weight' => '100',
                    'selector' => '#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,
                    'selector' => '#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->assertEquals([
            'system',
            'tour_test',
        ], $dependencies['module']);
        $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->assertEquals('Load hooks work', $entity_save_tip->loaded);
        // Verify that hook_ENTITY_TYPE_presave() integration worked.
        $this->assertEquals('Tour test english alter', $entity_save_tip->label());
        // Navigate to tour-test-1 and verify the new tip is found.
        $this->drupalGet('tour-test-1');
        $elements = $this->findTip([
            'id' => 'tour-code-test-1',
            'title' => 'The rain in spain is <strong>strong</strong>',
        ]);
        $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->findTip([
            'id' => 'tour-code-test-1',
            'text' => 'End tour',
        ]);
        $this->assertCount(1, $elements, 'Found code tip was weighted last and had "End tour".');
        // Test hook_tour_alter().
        $this->assertSession()
            ->responseContains('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->findTip([
            'id' => 'tour-test-1',
            'module' => 'tour_test',
            'type' => 'text',
            'title' => '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->findTip([
            'id' => 'tour-test-1',
            'module' => 'tour_test',
            'type' => 'text',
            'title' => 'The first tip',
        ]);
        $this->assertCount(0, $elements, 'Did not find English variant of tip 1.');
    }
    
    /**
     * Tests enabling and disabling the tour tip functionality.
     */
    public function testStatus() : void {
        // Set tour tip status as enabled.
        $tour = Tour::load('tour-test');
        $tour->setStatus(TRUE);
        $tour->save();
        $this->drupalGet('tour-test-1');
        $this->assertSession()
            ->statusCodeEquals(200);
        // Tour tips should be visible on the page.
        $this->assertTourTips();
        $tour->setStatus(FALSE);
        $tour->save();
        // Navigate and verify the tour_test_1 tip is not found with
        // appropriate classes.
        $this->drupalGet('tour-test-1');
        $this->assertSession()
            ->statusCodeEquals(200);
        // No tips expected as tour is disabled.
        $this->assertTourTips(expectEmpty: TRUE);
    }
    
    /**
     * Gets tour tips from the JavaScript drupalSettings variable.
     *
     * @return array
     *   A list of tips and their data.
     */
    protected function getTourTips() {
        $tips = [];
        $drupalSettings = $this->getDrupalSettings();
        if (isset($drupalSettings['_tour_internal'])) {
            foreach ($drupalSettings['_tour_internal'] as $tip) {
                $tips[] = $tip;
            }
        }
        return $tips;
    }
    
    /**
     * Find specific tips by their parameters in the list of tips.
     *
     * @param array $params
     *   The list of search parameters and their values.
     *
     * @return array
     *   A list of tips which match the parameters.
     */
    protected function findTip(array $params) {
        $tips = $this->getTourTips();
        $elements = [];
        foreach ($tips as $tip) {
            foreach ($params as $param => $value) {
                if (isset($tip[$param]) && $tip[$param] != $value) {
                    continue 2;
                }
            }
            $elements[] = $tip;
        }
        return $elements;
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received.
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for SettingsEditor::rewrite().
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 40
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between
code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the test environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Gets the Mink driver args from an environment variable. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the test site. 2
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::setUpAppRoot protected function Sets up the root application path.
BrowserTestBase::setUpBeforeClass public static function 1
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__get public function
BrowserTestBase::__sleep public function Prevents serializing any properties.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set &#039;apcu_ensure_unique_prefix&#039; setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The &quot;#1&quot; admin user.
FunctionalTestSetupTrait::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 10
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 2
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 1
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed. 1
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when the test installs Drupal. 8
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 28
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 4
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site. 1
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers.
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate Deprecated public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 2
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements Deprecated private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements Deprecated protected function Check module requirements for the Drupal use case.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 2
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$databasePrefix protected property The database prefix of this test run.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$root protected property The app root.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 4
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection Deprecated public static function Returns the database connection to the site under test.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 1
TourTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
TourTest::$modules protected static property Modules to enable. Overrides BrowserTestBase::$modules
TourTest::$permissions protected property The permissions required for a logged in user to test tour tips. Overrides TourTestBasic::$permissions
TourTest::$tips protected property Tour tip attributes to be tested. Keyed by the path. Overrides TourTestBasic::$tips
TourTest::findTip protected function Find specific tips by their parameters in the list of tips.
TourTest::getTourTips protected function Gets tour tips from the JavaScript drupalSettings variable.
TourTest::setUp protected function Overrides TourTestBasic::setUp
TourTest::testStatus public function Tests enabling and disabling the tour tip functionality.
TourTest::testTourFunctionality public function Tests tour functionality.
TourTestBase::assertTourTips public function Asserts the presence of page elements for tour tips.
TourTestBasic::$adminUser protected property An admin user with administrative permissions for tour.
TourTestBasic::testTips public function A simple tip test.
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::$useOneTimeLoginLinks protected property Use one-time login links instead of submitting the login form. 3
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalResetSession protected function Resets the current active session back to Anonymous session.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::isTestUsingGuzzleClient protected function Determines if test is using DrupalTestBrowser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.