class FormGroupingElementsTest

Same name in other branches
  1. 9 core/tests/Drupal/FunctionalJavascriptTests/Core/Form/FormGroupingElementsTest.php \Drupal\FunctionalJavascriptTests\Core\Form\FormGroupingElementsTest
  2. 8.9.x core/tests/Drupal/FunctionalJavascriptTests/Core/Form/FormGroupingElementsTest.php \Drupal\FunctionalJavascriptTests\Core\Form\FormGroupingElementsTest
  3. 11.x core/tests/Drupal/FunctionalJavascriptTests/Core/Form/FormGroupingElementsTest.php \Drupal\FunctionalJavascriptTests\Core\Form\FormGroupingElementsTest

Tests for form grouping elements.

@group form

Hierarchy

Expanded class hierarchy of FormGroupingElementsTest

File

core/tests/Drupal/FunctionalJavascriptTests/Core/Form/FormGroupingElementsTest.php, line 14

Namespace

Drupal\FunctionalJavascriptTests\Core\Form
View source
class FormGroupingElementsTest extends WebDriverTestBase {
    
    /**
     * Required modules.
     *
     * @var array
     */
    protected static $modules = [
        'form_test',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $account = $this->drupalCreateUser();
        $this->drupalLogin($account);
    }
    
    /**
     * Tests that vertical tab children become visible.
     *
     * Makes sure that a child element of a vertical tab that is not visible,
     * becomes visible when the tab is clicked, a fragment link to the child is
     * clicked or when the URI fragment pointing to that child changes.
     */
    public function testVerticalTabChildVisibility() : void {
        $session = $this->getSession();
        $web_assert = $this->assertSession();
        // Request the group vertical tabs testing page with a fragment identifier
        // to the second element.
        $this->drupalGet('form-test/group-vertical-tabs', [
            'fragment' => 'edit-element-2',
        ]);
        $page = $session->getPage();
        $tab_link_1 = $page->find('css', '.vertical-tabs__menu-item > a');
        $child_1_selector = '#edit-element';
        $child_1 = $page->find('css', $child_1_selector);
        $child_2_selector = '#edit-element-2';
        $child_2 = $page->find('css', $child_2_selector);
        // Assert that the child in the second vertical tab becomes visible.
        // It should be visible after initial load due to the fragment in the URI.
        $this->assertTrue($child_2->isVisible(), 'Child 2 is visible due to a URI fragment');
        // Click on a fragment link pointing to an invisible child inside an
        // inactive vertical tab.
        $session->executeScript("jQuery('<a href=\"{$child_1_selector}\"></a>').insertAfter('h1')[0].click()");
        // Assert that the child in the first vertical tab becomes visible.
        $web_assert->waitForElementVisible('css', $child_1_selector, 50);
        // Trigger a URI fragment change (hashchange) to show the second vertical
        // tab again.
        $session->executeScript("location.replace('{$child_2_selector}')");
        // Assert that the child in the second vertical tab becomes visible again.
        $web_assert->waitForElementVisible('css', $child_2_selector, 50);
        $tab_link_1->click();
        // Assert that the child in the first vertical tab is visible again after
        // a click on the first tab.
        $this->assertTrue($child_1->isVisible(), 'Child 1 is visible after clicking the parent tab');
    }
    
    /**
     * Tests that details element children become visible.
     *
     * Makes sure that a child element of a details element that is not visible,
     * becomes visible when a fragment link to the child is clicked or when the
     * URI fragment pointing to that child changes.
     */
    public function testDetailsChildVisibility() : void {
        $session = $this->getSession();
        $web_assert = $this->assertSession();
        // Store reusable JavaScript code to remove the current URI fragment and
        // close all details.
        $reset_js = "location.replace('#'); jQuery('details').removeAttr('open')";
        // Request the group details testing page.
        $this->drupalGet('form-test/group-details');
        $page = $session->getPage();
        $session->executeScript($reset_js);
        $child_selector = '#edit-element';
        $child = $page->find('css', $child_selector);
        // Assert that the child is not visible.
        $this->assertFalse($child->isVisible(), 'Child is not visible');
        // Trigger a URI fragment change (hashchange) to open all parent details
        // elements of the child.
        $session->executeScript("location.replace('{$child_selector}')");
        // Assert that the child becomes visible again after a hash change.
        $web_assert->waitForElementVisible('css', $child_selector, 50);
        $session->executeScript($reset_js);
        // Click on a fragment link pointing to an invisible child inside a closed
        // details element.
        $session->executeScript("jQuery('<a href=\"{$child_selector}\"></a>').insertAfter('h1')[0].click()");
        // Assert that the child is visible again after a fragment link click.
        $web_assert->waitForElementVisible('css', $child_selector, 50);
        // Find the summary belonging to the closest details element.
        $summary = $page->find('css', '#edit-meta > summary');
        // Assert that both aria-expanded and aria-pressed are true.
        $this->assertEquals('true', $summary->getAttribute('aria-expanded'));
    }
    
    /**
     * Confirms tabs containing a field with a validation error are open.
     */
    public function testVerticalTabValidationVisibility() : void {
        $page = $this->getSession()
            ->getPage();
        $assert_session = $this->assertSession();
        $this->drupalGet('form-test/group-vertical-tabs');
        $page->clickLink('Second group element');
        $input_field = $assert_session->waitForField('element_2');
        $this->assertNotNull($input_field);
        // Enter a value that will trigger a validation error.
        $input_field->setValue('bad');
        // Switch to a tab that does not have the error-causing field.
        $page->clickLink('First group element');
        $this->assertNotNull($assert_session->waitForElementVisible('css', '#edit-meta'));
        // Submit the form.
        $page->pressButton('Save');
        // Confirm there is an error.
        $assert_session->waitForText('there was an error');
        // Confirm the tab containing the field with error is open.
        $this->assertNotNull($assert_session->waitForElementVisible('css', '[name="element_2"].error'));
    }
    
    /**
     * Tests form submit with a required field in closed details element.
     */
    public function testDetailsContainsRequiredTextfield() : void {
        $this->drupalGet('form_test/details-contains-required-textfield');
        $details = $this->assertSession()
            ->elementExists('css', 'details[data-drupal-selector="edit-meta"]');
        // Make sure details element is not open at the beginning.
        $this->assertFalse($details->hasAttribute('open'));
        $textfield = $this->assertSession()
            ->elementExists('css', 'input[name="required_textfield_in_details"]');
        // The text field inside the details element is not visible too.
        $this->assertFalse($textfield->isVisible(), 'Text field is not visible');
        // Submit the form with invalid data in the required fields.
        $this->assertSession()
            ->elementExists('css', 'input[data-drupal-selector="edit-submit"]')
            ->click();
        // Confirm the required field is visible.
        $this->assertTrue($textfield->isVisible(), 'Text field is visible');
    }
    
    /**
     * Tests required field in closed details element with ajax form.
     */
    public function testDetailsContainsRequiredTextfieldAjaxForm() : void {
        $this->drupalGet('form_test/details-contains-required-textfield/true');
        $assert_session = $this->assertSession();
        $textfield = $assert_session->elementExists('css', 'input[name="required_textfield_in_details"]');
        // Submit the ajax form to open the details element at the first time.
        $assert_session->elementExists('css', 'input[value="Submit Ajax"]')
            ->click();
        $assert_session->waitForElementVisible('css', 'input[name="required_textfield_in_details"]');
        // Close the details element.
        $assert_session->elementExists('css', 'form summary')
            ->click();
        // Submit the form with invalid data in the required fields without ajax.
        $assert_session->elementExists('css', 'input[data-drupal-selector="edit-submit"]')
            ->click();
        // Confirm the required field is visible.
        $this->assertTrue($textfield->isVisible(), 'Text field is visible');
    }

}

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::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.
FormGroupingElementsTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
FormGroupingElementsTest::$modules protected static property Required modules. Overrides BrowserTestBase::$modules
FormGroupingElementsTest::setUp protected function Overrides BrowserTestBase::setUp
FormGroupingElementsTest::testDetailsChildVisibility public function Tests that details element children become visible.
FormGroupingElementsTest::testDetailsContainsRequiredTextfield public function Tests form submit with a required field in closed details element.
FormGroupingElementsTest::testDetailsContainsRequiredTextfieldAjaxForm public function Tests required field in closed details element with ajax form.
FormGroupingElementsTest::testVerticalTabChildVisibility public function Tests that vertical tab children become visible.
FormGroupingElementsTest::testVerticalTabValidationVisibility public function Confirms tabs containing a field with a validation error are open.
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::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
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::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.
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.