class OffCanvasTest

Same name in other branches
  1. 9 core/modules/system/tests/src/FunctionalJavascript/OffCanvasTest.php \Drupal\Tests\system\FunctionalJavascript\OffCanvasTest
  2. 8.9.x core/modules/system/tests/src/FunctionalJavascript/OffCanvasTest.php \Drupal\Tests\system\FunctionalJavascript\OffCanvasTest
  3. 11.x core/modules/system/tests/src/FunctionalJavascript/OffCanvasTest.php \Drupal\Tests\system\FunctionalJavascript\OffCanvasTest

Tests the off-canvas dialog functionality.

@group system

Hierarchy

Expanded class hierarchy of OffCanvasTest

File

core/modules/system/tests/src/FunctionalJavascript/OffCanvasTest.php, line 12

Namespace

Drupal\Tests\system\FunctionalJavascript
View source
class OffCanvasTest extends OffCanvasTestBase {
    
    /**
     * Stores to the class that should be on the last dialog.
     *
     * @var string
     *
     * @see \Drupal\off_canvas_test\Controller\TestController::linksDisplay.
     */
    protected $lastDialogClass;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'off_canvas_test',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * Tests that non-contextual links will work with the off-canvas dialog.
     *
     * @dataProvider themeDataProvider
     */
    public function testOffCanvasLinks($theme) : void {
        $this->enableTheme($theme);
        $this->drupalGet('/off-canvas-test-links');
        $page = $this->getSession()
            ->getPage();
        $web_assert = $this->assertSession();
        // Confirm touchevents detection is loaded with Off Canvas assets.
        $this->assertNotNull($web_assert->waitForElement('css', 'html.no-touchevents'));
        // Make sure off-canvas dialog is on page when first loaded.
        $web_assert->elementNotExists('css', '#drupal-off-canvas');
        // Check opening and closing with two separate links.
        // Make sure tray updates to new content.
        // Check the first link again to make sure the empty title class is
        // removed.
        foreach ([
            1,
            2,
            1,
        ] as $link_index) {
            $this->assertOffCanvasDialog($link_index, 'side');
            $header_text = $this->getOffCanvasDialog()
                ->find('css', '.ui-dialog-title')
                ->getText();
            if ($link_index === 2) {
                // Check no title behavior.
                $web_assert->elementExists('css', '.ui-dialog-empty-title');
                $this->assertEquals(' ', $header_text);
                $style = $page->find('css', '.ui-dialog-off-canvas')
                    ->getAttribute('style');
                $this->assertStringContainsString('width: 555px;', $style, 'Dialog width respected.');
                $page->clickLink("Open side panel 1");
                $this->waitForOffCanvasToOpen();
                $style = $page->find('css', '.ui-dialog-off-canvas')
                    ->getAttribute('style');
                $this->assertStringNotContainsString('width: 555px;', $style, 'Dialog width reset to default.');
            }
            else {
                // Check that header is correct.
                $this->assertEquals("Thing {$link_index}", $header_text);
                $web_assert->elementNotExists('css', '.ui-dialog-empty-title');
            }
        }
        // Test the off_canvas_top tray.
        foreach ([
            1,
            2,
        ] as $link_index) {
            $this->assertOffCanvasDialog($link_index, 'top');
            $style = $page->find('css', '.ui-dialog-off-canvas')
                ->getAttribute('style');
            if ($link_index === 1) {
                $this->assertStringContainsString('height: auto;', $style);
            }
            else {
                $this->assertStringContainsString('height: 421px;', $style);
            }
        }
        // Ensure an off-canvas link opened from inside the off-canvas dialog will
        // work.
        $this->drupalGet('/off-canvas-test-links');
        $page->clickLink('Display more links!');
        $this->waitForOffCanvasToOpen();
        $web_assert->linkExists('Off_canvas link!');
        // Click off-canvas link inside off-canvas dialog
        $page->clickLink('Off_canvas link!');
        $this->waitForOffCanvasToOpen();
        $web_assert->elementTextContains('css', '.ui-dialog[aria-describedby="drupal-off-canvas"]', 'Thing 2 says hello');
        // Ensure an off-canvas link opened from inside the off-canvas dialog will
        // work after another dialog has been opened.
        $this->drupalGet('/off-canvas-test-links');
        $page->clickLink("Open side panel 1");
        $this->waitForOffCanvasToOpen();
        $page->clickLink('Display more links!');
        $this->waitForOffCanvasToOpen();
        $web_assert->linkExists('Off_canvas link!');
        // Click off-canvas link inside off-canvas dialog
        $page->clickLink('Off_canvas link!');
        $this->waitForOffCanvasToOpen();
        $web_assert->elementTextContains('css', '.ui-dialog[aria-describedby="drupal-off-canvas"]', 'Thing 2 says hello');
    }
    
    /**
     * Tests the body displacement behaves differently at a narrow width.
     */
    public function testNarrowWidth() : void {
        $narrow_width_breakpoint = 768;
        $offset = 20;
        $height = 800;
        $page = $this->getSession()
            ->getPage();
        $web_assert = $this->assertSession();
        // Test the same functionality on multiple themes.
        foreach (static::getTestThemes() as $theme) {
            $this->enableTheme($theme);
            // Testing at the wider width.
            $this->getSession()
                ->resizeWindow($narrow_width_breakpoint + $offset, $height);
            $this->drupalGet('/off-canvas-test-links');
            $this->assertFalse($page->find('css', '.dialog-off-canvas-main-canvas')
                ->hasAttribute('style'), 'Body not padded on wide page load.');
            $page->clickLink("Open side panel 1");
            $this->waitForOffCanvasToOpen();
            // Check that the main canvas is padded when page is not narrow width and
            // tray is open.
            $page->waitFor(10, function ($page) {
                return $page->find('css', '.dialog-off-canvas-main-canvas')
                    ->hasAttribute('style');
            });
            $web_assert->elementAttributeContains('css', '.dialog-off-canvas-main-canvas', 'style', 'padding-right');
            // Testing at the narrower width.
            $this->getSession()
                ->resizeWindow($narrow_width_breakpoint - $offset, $height);
            $this->drupalGet('/off-canvas-test-links');
            $this->assertFalse($page->find('css', '.dialog-off-canvas-main-canvas')
                ->hasAttribute('style'), 'Body not padded on narrow page load.');
            $page->clickLink("Open side panel 1");
            $this->waitForOffCanvasToOpen();
            $this->assertFalse($page->find('css', '.dialog-off-canvas-main-canvas')
                ->hasAttribute('style'), 'Body not padded on narrow page with tray open.');
        }
    }
    
    /**
     * @param int $link_index
     *   The index of the link to test.
     * @param string $position
     *   The position of the dialog to test.
     *
     * @internal
     */
    protected function assertOffCanvasDialog(int $link_index, string $position) : void {
        $page = $this->getSession()
            ->getPage();
        $web_assert = $this->assertSession();
        $link_text = "Open {$position} panel {$link_index}";
        // Click the first test like that should open the page.
        $page->clickLink($link_text);
        if ($this->lastDialogClass) {
            $web_assert->assertNoElementAfterWait('css', '.' . $this->lastDialogClass);
        }
        $this->waitForOffCanvasToOpen($position);
        $this->lastDialogClass = "{$position}-{$link_index}";
        // Check that response text is on page.
        $web_assert->pageTextContains("Thing {$link_index} says hello");
        $off_canvas_tray = $this->getOffCanvasDialog();
        // Check that tray is visible.
        $this->assertEquals(TRUE, $off_canvas_tray->isVisible());
        $tray_text = $off_canvas_tray->findById('drupal-off-canvas')
            ->getText();
        $this->assertEquals("Thing {$link_index} says hello", $tray_text);
    }

}

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::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::$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::getHttpClient protected function Obtain the HTTP client for the system under test.
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::installDrupal public function Installs Drupal into the test site. 2
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::setUp protected function 544
BrowserTestBase::setUpAppRoot protected function Sets up the root application path.
BrowserTestBase::setUpBeforeClass public static function 1
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 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The "#1" 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::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
OffCanvasTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
OffCanvasTest::$lastDialogClass protected property Stores to the class that should be on the last dialog.
OffCanvasTest::$modules protected static property Modules to install. Overrides OffCanvasTestBase::$modules
OffCanvasTest::assertOffCanvasDialog protected function @internal
OffCanvasTest::testNarrowWidth public function Tests the body displacement behaves differently at a narrow width.
OffCanvasTest::testOffCanvasLinks public function Tests that non-contextual links will work with the off-canvas dialog.
OffCanvasTestBase::assertAllContextualLinksLoaded protected function Assert all contextual link areas have be loaded.
OffCanvasTestBase::assertElementVisibleAfterWait protected function Asserts the specified selector is visible after a wait.
OffCanvasTestBase::assertPageLoadComplete protected function Assert the page is completely loaded.
OffCanvasTestBase::drupalGet protected function Retrieves a Drupal path or an absolute path. Overrides UiHelperTrait::drupalGet
OffCanvasTestBase::enableTheme protected function Enables a theme.
OffCanvasTestBase::getOffCanvasDialog protected function Gets the off-canvas dialog element.
OffCanvasTestBase::getTestThemes protected static function Get themes to test. 1
OffCanvasTestBase::themeDataProvider public static function Data provider that returns theme name as the sole argument.
OffCanvasTestBase::waitForOffCanvasToClose protected function Waits for off-canvas dialog to close.
OffCanvasTestBase::waitForOffCanvasToOpen protected function Waits for off-canvas dialog to open.
OffCanvasTestTrait::waitForOffCanvasArea protected function Waits for the off-canvas area to appear, resized and visible.
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
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::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::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.
WebDriverTestBase::$disableCssAnimations protected property Disables CSS animations in tests for more reliable testing.
WebDriverTestBase::$failOnJavascriptConsoleErrors protected property Determines if a test should fail on JavaScript console errors. 2
WebDriverTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. Overrides BrowserTestBase::$minkDefaultDriverClass
WebDriverTestBase::assertJsCondition protected function Waits for the given time or until the given JS condition becomes TRUE.
WebDriverTestBase::assertSession public function Returns WebAssert object. Overrides UiHelperTrait::assertSession
WebDriverTestBase::createScreenshot protected function Creates a screenshot.
WebDriverTestBase::failOnJavaScriptErrors protected function Triggers a test failure if a JavaScript error was encountered.
WebDriverTestBase::getDrupalSettings protected function Gets the current Drupal javascript settings and parses into an array. Overrides BrowserTestBase::getDrupalSettings
WebDriverTestBase::getHtmlOutputHeaders protected function Returns headers in HTML output format. Overrides BrowserHtmlDebugTrait::getHtmlOutputHeaders
WebDriverTestBase::getMinkDriverArgs protected function Gets the Mink driver args from an environment variable. Overrides BrowserTestBase::getMinkDriverArgs 1
WebDriverTestBase::initFrontPage protected function Visits the front page when initializing Mink. Overrides BrowserTestBase::initFrontPage
WebDriverTestBase::initMink protected function Initializes Mink sessions. Overrides BrowserTestBase::initMink
WebDriverTestBase::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. Overrides FunctionalTestSetupTrait::installModulesFromClassProperty 1
WebDriverTestBase::tearDown protected function Overrides BrowserTestBase::tearDown 1
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.