class SettingsTrayBlockFormTest

Same name in other branches
  1. 8.9.x core/modules/settings_tray/tests/src/FunctionalJavascript/SettingsTrayBlockFormTest.php \Drupal\Tests\settings_tray\FunctionalJavascript\SettingsTrayBlockFormTest
  2. 10 core/modules/settings_tray/tests/src/FunctionalJavascript/SettingsTrayBlockFormTest.php \Drupal\Tests\settings_tray\FunctionalJavascript\SettingsTrayBlockFormTest
  3. 11.x core/modules/settings_tray/tests/src/FunctionalJavascript/SettingsTrayBlockFormTest.php \Drupal\Tests\settings_tray\FunctionalJavascript\SettingsTrayBlockFormTest

Testing opening and saving block forms in the off-canvas dialog.

@group #slow @group settings_tray

Hierarchy

Expanded class hierarchy of SettingsTrayBlockFormTest

File

core/modules/settings_tray/tests/src/FunctionalJavascript/SettingsTrayBlockFormTest.php, line 15

Namespace

Drupal\Tests\settings_tray\FunctionalJavascript
View source
class SettingsTrayBlockFormTest extends SettingsTrayTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'node',
        'search',
        'settings_tray_test',
        'off_canvas_test',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $user = $this->createUser([
            'administer blocks',
            'access contextual links',
            'access toolbar',
            'administer nodes',
            'search content',
        ]);
        $this->drupalLogin($user);
    }
    
    /**
     * Tests opening off-canvas dialog by click blocks and elements in the blocks.
     */
    public function testBlocks() {
        foreach ($this->getBlockTests() as $test) {
            call_user_func_array([
                $this,
                'doTestBlocks',
            ], array_values($test));
        }
    }
    
    /**
     * Tests opening off-canvas dialog by click blocks and elements in the blocks.
     */
    protected function doTestBlocks($theme, $block_plugin, $new_page_text, $element_selector, $label_selector, $button_text, $toolbar_item, $permissions) {
        if ($permissions) {
            $this->grantPermissions(Role::load(Role::AUTHENTICATED_ID), $permissions);
        }
        if ($new_page_text) {
            // Some asserts can be based on this value, so it should not be the same
            // for different blocks, because it can be saved in the site config.
            $new_page_text = $new_page_text . ' ' . $theme . ' ' . $block_plugin;
        }
        $web_assert = $this->assertSession();
        $page = $this->getSession()
            ->getPage();
        $this->enableTheme($theme);
        $block = $this->placeBlock($block_plugin);
        $block_selector = $this->getBlockSelector($block);
        $block_id = $block->id();
        $this->drupalGet('user');
        $link = $web_assert->waitForElement('css', "{$block_selector} .contextual-links li a");
        $this->assertEquals('Quick edit', $link->getHtml(), "'Quick edit' is the first contextual link for the block.");
        $destination = (string) $this->loggedInUser
            ->toUrl()
            ->toString();
        $this->assertStringContainsString("/admin/structure/block/manage/{$block_id}/settings-tray?destination={$destination}", $link->getAttribute('href'));
        if (isset($toolbar_item)) {
            // Check that you can open a toolbar tray and it will be closed after
            // entering edit mode.
            if ($element = $page->find('css', "#toolbar-administration a.is-active")) {
                // If a tray was open from page load close it.
                $element->click();
                $web_assert->assertNoElementAfterWait('css', "#toolbar-administration a.is-active");
            }
            $page->find('css', $toolbar_item)
                ->click();
            $this->assertElementVisibleAfterWait('css', "{$toolbar_item}.is-active");
        }
        $this->enableEditMode();
        if (isset($toolbar_item)) {
            $web_assert->assertNoElementAfterWait('css', "{$toolbar_item}.is-active");
        }
        $this->openBlockForm($block_selector);
        switch ($block_plugin) {
            case 'system_powered_by_block':
                // Confirm "Display Title" is not checked.
                $web_assert->checkboxNotChecked('settings[label_display]');
                // Confirm Title is not visible.
                $this->assertFalse($this->isLabelInputVisible(), 'Label is not visible');
                $page->checkField('settings[label_display]');
                $this->assertTrue($this->isLabelInputVisible(), 'Label is visible');
                // Fill out form, save the form.
                $page->fillField('settings[label]', $new_page_text);
                break;
            case 'system_branding_block':
                // Fill out form, save the form.
                $page->fillField('settings[site_information][site_name]', $new_page_text);
                break;
            case 'settings_tray_test_class':
                $web_assert->elementExists('css', '[data-drupal-selector="edit-settings-some-setting"]');
                break;
        }
        if (isset($new_page_text)) {
            $page->pressButton($button_text);
            // Make sure the changes are present.
            $new_page_text_locator = "{$block_selector} {$label_selector}:contains({$new_page_text})";
            $this->assertElementVisibleAfterWait('css', $new_page_text_locator);
            // The page is loaded with the new change but make sure page is
            // completely loaded.
            $this->assertPageLoadComplete();
        }
        $this->openBlockForm($block_selector);
        $this->disableEditMode();
        // Canvas should close when editing module is closed.
        $this->waitForOffCanvasToClose();
        $this->enableEditMode();
        // Open block form by clicking an element inside the block.
        // This confirms that default action for links and form elements is
        // suppressed.
        $this->openBlockForm("{$block_selector} {$element_selector}", $block_selector);
        $web_assert->elementTextContains('css', '.contextual-toolbar-tab button', 'Editing');
        $web_assert->elementAttributeContains('css', '.dialog-off-canvas-main-canvas', 'class', 'js-settings-tray-edit-mode');
        // Simulate press the Escape key.
        $this->getSession()
            ->executeScript('jQuery("body").trigger(jQuery.Event("keyup", { keyCode: 27 }));');
        $this->waitForOffCanvasToClose();
        $this->getSession()
            ->wait(100);
        $this->getSession()
            ->executeScript("jQuery('[data-quickedit-entity-id]').trigger('mouseleave')");
        $this->getSession()
            ->getPage()
            ->find('css', static::TOOLBAR_EDIT_LINK_SELECTOR)
            ->mouseOver();
        $this->assertEditModeDisabled();
        $this->assertNotEmpty($web_assert->waitForElement('css', '#drupal-live-announce:contains(Exited edit mode)'));
        $web_assert->assertNoElementAfterWait('css', '.contextual-toolbar-tab button:contains(Editing)');
        $web_assert->elementAttributeNotContains('css', '.dialog-off-canvas-main-canvas', 'class', 'js-settings-tray-edit-mode');
        // Clean up test data so each test does not impact the next.
        $block->delete();
        if ($permissions) {
            user_role_revoke_permissions(Role::AUTHENTICATED_ID, $permissions);
        }
    }
    
    /**
     * Creates tests for ::testBlocks().
     */
    public function getBlockTests() {
        $blocks = [];
        foreach ($this->getTestThemes() as $theme) {
            $blocks += [
                "{$theme}: block-powered" => [
                    'theme' => $theme,
                    'block_plugin' => 'system_powered_by_block',
                    'new_page_text' => 'Can you imagine anyone showing the label on this block',
                    'element_selector' => 'span a',
                    'label_selector' => 'h2',
                    'button_text' => 'Save Powered by Drupal',
                    'toolbar_item' => '#toolbar-item-user',
                    NULL,
                ],
                "{$theme}: block-branding" => [
                    'theme' => $theme,
                    'block_plugin' => 'system_branding_block',
                    'new_page_text' => 'The site that will live a very short life',
                    'element_selector' => "a[rel='home']:last-child",
                    'label_selector' => "a[rel='home']:last-child",
                    'button_text' => 'Save Site branding',
                    'toolbar_item' => '#toolbar-item-administration',
                    [
                        'administer site configuration',
                    ],
                ],
                "{$theme}: block-search" => [
                    'theme' => $theme,
                    'block_plugin' => 'search_form_block',
                    'new_page_text' => NULL,
                    'element_selector' => '[data-drupal-selector="edit-submit"]',
                    'label_selector' => 'h2',
                    'button_text' => 'Save Search form',
                    'toolbar_item' => NULL,
                    NULL,
                ],
                // This is the functional JS test coverage accompanying
                // \Drupal\Tests\settings_tray\Functional\SettingsTrayTest::testPossibleAnnotations().
"{$theme}: " . SettingsTrayFormAnnotationIsClassBlock::class => [
                    'theme' => $theme,
                    'block_plugin' => 'settings_tray_test_class',
                    'new_page_text' => NULL,
                    'element_selector' => 'span',
                    'label_selector' => NULL,
                    'button_text' => NULL,
                    'toolbar_item' => NULL,
                    NULL,
                ],
                // This is the functional JS test coverage accompanying
                // \Drupal\Tests\settings_tray\Functional\SettingsTrayTest::testPossibleAnnotations().
"{$theme}: " . SettingsTrayFormAnnotationNoneBlock::class => [
                    'theme' => $theme,
                    'block_plugin' => 'settings_tray_test_none',
                    'new_page_text' => NULL,
                    'element_selector' => 'span',
                    'label_selector' => NULL,
                    'button_text' => NULL,
                    'toolbar_item' => NULL,
                    NULL,
                ],
            ];
        }
        return $blocks;
    }
    
    /**
     * Tests enabling and disabling Edit Mode.
     */
    public function testEditModeEnableDisable() {
        foreach ($this->getTestThemes() as $theme) {
            $this->enableTheme($theme);
            $block = $this->placeBlock('system_powered_by_block');
            foreach ([
                'contextual_link',
                'toolbar_link',
            ] as $enable_option) {
                $this->drupalGet('user');
                $this->assertEditModeDisabled();
                switch ($enable_option) {
                    // Enable Edit mode.
                    case 'contextual_link':
                        $this->clickContextualLink($this->getBlockSelector($block), "Quick edit");
                        $this->waitForOffCanvasToOpen();
                        $this->assertEditModeEnabled();
                        break;
                    case 'toolbar_link':
                        $this->enableEditMode();
                        break;
                }
                $this->disableEditMode();
                // Make another page request to ensure Edit mode is still disabled.
                $this->drupalGet('user');
                $this->assertEditModeDisabled();
                // Make sure on this page request it also re-enables and disables
                // correctly.
                $this->enableEditMode();
                $this->disableEditMode();
            }
        }
    }
    
    /**
     * Tests that validation errors appear in the off-canvas dialog.
     */
    public function testValidationMessages() {
        $page = $this->getSession()
            ->getPage();
        $web_assert = $this->assertSession();
        foreach ($this->getTestThemes() as $theme) {
            $this->enableTheme($theme);
            $block = $this->placeBlock('settings_tray_test_validation');
            $this->drupalGet('user');
            $this->enableEditMode();
            $this->openBlockForm($this->getBlockSelector($block));
            $page->pressButton('Save Block with validation error');
            $web_assert->assertWaitOnAjaxRequest();
            // The settings_tray_test_validation test plugin form always has a
            // validation error.
            $web_assert->elementContains('css', '#drupal-off-canvas', 'Sorry system error. Please save again');
            $this->disableEditMode();
            $block->delete();
        }
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertCacheTag Deprecated protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent Deprecated protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent Deprecated protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertEscaped Deprecated protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField Deprecated protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById Deprecated protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName Deprecated protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath Deprecated protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue Deprecated protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader Deprecated protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertLink Deprecated protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref Deprecated protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag Deprecated protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped Deprecated protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField Deprecated protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById Deprecated protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName Deprecated protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath Deprecated protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink Deprecated protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref Deprecated protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption Deprecated protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern Deprecated protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw Deprecated protected function Passes if the raw text IS not found on the loaded page, fail otherwise.
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNoText Deprecated protected function Passes if the page (with HTML stripped) does not contains the text.
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::assertNoUniqueText Deprecated protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption Deprecated protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText Deprecated protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected Deprecated protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern Deprecated protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw Deprecated protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertLegacyTrait::assertResponse Deprecated protected function Asserts the page responds with the specified response code.
AssertLegacyTrait::assertText Deprecated protected function Passes if the page (with HTML stripped) contains the text.
AssertLegacyTrait::assertTextHelper Deprecated protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle Deprecated protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText Deprecated protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl Deprecated protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery Deprecated protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath Deprecated protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions Deprecated protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent Deprecated protected function Gets the current raw content.
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated protected function
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 drupal_rewrite_settings().
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. 37
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 Simpletest environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::drupalGetHeader Deprecated protected function Gets the value of an HTTP response header.
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 Simpletest site. 1
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::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::__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
ContextualLinkClickTrait::clickContextualLink protected function Clicks a contextual link. 1
ContextualLinkClickTrait::toggleContextualTriggerVisibility protected function Toggles the visibility of a contextual trigger.
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::doInstall protected function Execute the non-interactive installer. 1
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.
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 8
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 22
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. 3
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
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::themeDataProvider public 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::$randomGenerator protected property The random generator.
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. 1
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 public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 1
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.
SettingsTrayBlockFormTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
SettingsTrayBlockFormTest::$modules protected static property Modules to enable. Overrides SettingsTrayTestBase::$modules
SettingsTrayBlockFormTest::doTestBlocks protected function Tests opening off-canvas dialog by click blocks and elements in the blocks.
SettingsTrayBlockFormTest::getBlockTests public function Creates tests for ::testBlocks().
SettingsTrayBlockFormTest::setUp protected function Overrides BrowserTestBase::setUp
SettingsTrayBlockFormTest::testBlocks public function Tests opening off-canvas dialog by click blocks and elements in the blocks.
SettingsTrayBlockFormTest::testEditModeEnableDisable public function Tests enabling and disabling Edit Mode.
SettingsTrayBlockFormTest::testValidationMessages public function Tests that validation errors appear in the off-canvas dialog.
SettingsTrayTestBase::assertEditModeDisabled protected function Assert that edit mode has been properly disabled.
SettingsTrayTestBase::assertEditModeEnabled protected function Assert that edit mode has been properly enabled.
SettingsTrayTestBase::assertOffCanvasBlockFormIsValid protected function Asserts that Off-Canvas block form is valid.
SettingsTrayTestBase::disableEditMode protected function Disables edit mode by pressing edit button in the toolbar.
SettingsTrayTestBase::enableEditMode protected function Enables edit mode by pressing edit button in the toolbar.
SettingsTrayTestBase::getBlockSelector public function Gets the block CSS selector.
SettingsTrayTestBase::getTestThemes protected function Get themes to test. Overrides OffCanvasTestBase::getTestThemes 1
SettingsTrayTestBase::isLabelInputVisible protected function Determines if the label input is visible.
SettingsTrayTestBase::LABEL_INPUT_SELECTOR constant
SettingsTrayTestBase::openBlockForm protected function Open block form by clicking the element found with a css selector.
SettingsTrayTestBase::pressToolbarEditButton protected function Press the toolbar Edit button provided by the contextual module.
SettingsTrayTestBase::TOOLBAR_EDIT_LINK_SELECTOR constant
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements 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. 1
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. 1
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 public static function Returns the database connection to the site running Simpletest.
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::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::drupalPostForm Deprecated protected function Executes a form submission.
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. 3
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::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
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
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.