class ValidationTest

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

Tests form processing and alteration via form validation handlers.

@group Form @group #slow

Hierarchy

Expanded class hierarchy of ValidationTest

File

core/modules/system/tests/src/Functional/Form/ValidationTest.php, line 16

Namespace

Drupal\Tests\system\Functional\Form
View source
class ValidationTest extends BrowserTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'form_test',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * Tests #element_validate and #validate.
     */
    public function testValidate() : void {
        $this->drupalGet('form-test/validate');
        // Verify that #element_validate handlers can alter the form and submitted
        // form values.
        $edit = [
            'name' => 'element_validate',
        ];
        $this->submitForm($edit, 'Save');
        $this->assertSession()
            ->fieldValueEquals('name', '#value changed by #element_validate');
        $this->assertSession()
            ->pageTextContains('Name value: value changed by setValueForElement() in #element_validate');
        // Verify that #validate handlers can alter the form and submitted
        // form values.
        $edit = [
            'name' => 'validate',
        ];
        $this->submitForm($edit, 'Save');
        $this->assertSession()
            ->fieldValueEquals('name', '#value changed by #validate');
        $this->assertSession()
            ->pageTextContains('Name value: value changed by setValueForElement() in #validate');
        // Verify that #element_validate handlers can make form elements
        // inaccessible, but values persist.
        $edit = [
            'name' => 'element_validate_access',
        ];
        $this->submitForm($edit, 'Save');
        $this->assertSession()
            ->fieldNotExists('name');
        $this->assertSession()
            ->pageTextContains('Name value: element_validate_access');
        // Verify that value for inaccessible form element persists.
        $this->submitForm([], 'Save');
        $this->assertSession()
            ->fieldValueNotEquals('name', 'Form element was hidden.');
        $this->assertSession()
            ->pageTextContains('Name value: element_validate_access');
        // Verify that #validate handlers don't run if the CSRF token is invalid.
        $this->drupalLogin($this->drupalCreateUser());
        $this->drupalGet('form-test/validate');
        // $this->assertSession()->fieldExists() does not recognize hidden fields,
        // which breaks $this->submitForm() if we try to change the value of a
        // hidden field such as form_token.
        $this->assertSession()
            ->elementExists('css', 'input[name="form_token"]')
            ->setValue('invalid_token');
        $this->submitForm([
            'name' => 'validate',
        ], 'Save');
        $this->assertSession()
            ->fieldValueNotEquals('name', '#value changed by #validate');
        $this->assertSession()
            ->pageTextNotContains('Name value: value changed by setValueForElement() in #validate');
        $this->assertSession()
            ->pageTextContains('The form has become outdated.');
    }
    
    /**
     * Tests that a form with a disabled CSRF token can be validated.
     */
    public function testDisabledToken() : void {
        $this->drupalGet('form-test/validate-no-token');
        $this->submitForm([], 'Save');
        $this->assertSession()
            ->pageTextContains('The form_test_validate_no_token form has been submitted successfully.');
    }
    
    /**
     * Tests partial form validation through #limit_validation_errors.
     */
    public function testValidateLimitErrors() : void {
        $edit = [
            'test' => 'invalid',
            'test_numeric_index[0]' => 'invalid',
            'test_substring[foo]' => 'invalid',
        ];
        $path = 'form-test/limit-validation-errors';
        // Render the form, and verify that the buttons with limited server-side
        // validation have the proper 'formnovalidate' attribute (to prevent
        // client-side validation by the browser).
        $this->drupalGet($path);
        $expected = 'formnovalidate';
        foreach ([
            'partial',
            'partial-numeric-index',
            'substring',
        ] as $type) {
            // Verify the $type button has the proper formnovalidate attribute.
            $this->assertSession()
                ->elementExists('xpath', "//input[@id='edit-{$type}' and @formnovalidate='{$expected}']");
        }
        // The button with full server-side validation should not have the
        // 'formnovalidate' attribute.
        $this->assertSession()
            ->elementExists('xpath', "//input[@id='edit-full' and not(@formnovalidate)]");
        // Submit the form by pressing the 'Partial validate' button (uses
        // #limit_validation_errors) and ensure that the title field is not
        // validated, but the #element_validate handler for the 'test' field
        // is triggered.
        $this->drupalGet($path);
        $this->submitForm($edit, 'Partial validate');
        $this->assertSession()
            ->pageTextNotContains('Title field is required.');
        $this->assertSession()
            ->pageTextContains('Test element is invalid');
        // Edge case of #limit_validation_errors containing numeric indexes: same
        // thing with the 'Partial validate (numeric index)' button and the
        // 'test_numeric_index' field.
        $this->drupalGet($path);
        $this->submitForm($edit, 'Partial validate (numeric index)');
        $this->assertSession()
            ->pageTextNotContains('Title field is required.');
        $this->assertSession()
            ->pageTextContains('Test (numeric index) element is invalid');
        // Ensure something like 'foobar' isn't considered "inside" 'foo'.
        $this->drupalGet($path);
        $this->submitForm($edit, 'Partial validate (substring)');
        $this->assertSession()
            ->pageTextNotContains('Title field is required.');
        $this->assertSession()
            ->pageTextContains('Test (substring) foo element is invalid');
        // Ensure not validated values are not available to submit handlers.
        $this->drupalGet($path);
        $this->submitForm([
            'title' => '',
            'test' => 'valid',
        ], 'Partial validate');
        $this->assertSession()
            ->pageTextContains('Only validated values appear in the form values.');
        // Now test full form validation and ensure that the #element_validate
        // handler is still triggered.
        $this->drupalGet($path);
        $this->submitForm($edit, 'Full validate');
        $this->assertSession()
            ->pageTextContains('Title field is required.');
        $this->assertSession()
            ->pageTextContains('Test element is invalid');
    }
    
    /**
     * Tests #pattern validation.
     */
    public function testPatternValidation() : void {
        $textfield_error = 'One digit followed by lowercase letters field is not in the right format.';
        $tel_error = 'Everything except numbers field is not in the right format.';
        $password_error = 'Password field is not in the right format.';
        // Invalid textfield, valid tel.
        $edit = [
            'textfield' => 'invalid',
            'tel' => 'valid',
        ];
        $this->drupalGet('form-test/pattern');
        $this->submitForm($edit, 'Submit');
        $this->assertSession()
            ->pageTextContains($textfield_error);
        $this->assertSession()
            ->pageTextNotContains($tel_error);
        $this->assertSession()
            ->pageTextNotContains($password_error);
        // Valid textfield, invalid tel, valid password.
        $edit = [
            'textfield' => '7seven',
            'tel' => '818937',
            'password' => '0100110',
        ];
        $this->drupalGet('form-test/pattern');
        $this->submitForm($edit, 'Submit');
        $this->assertSession()
            ->pageTextNotContains($textfield_error);
        $this->assertSession()
            ->pageTextContains($tel_error);
        $this->assertSession()
            ->pageTextNotContains($password_error);
        // Non required fields are not validated if empty.
        $edit = [
            'textfield' => '',
            'tel' => '',
        ];
        $this->drupalGet('form-test/pattern');
        $this->submitForm($edit, 'Submit');
        $this->assertSession()
            ->pageTextNotContains($textfield_error);
        $this->assertSession()
            ->pageTextNotContains($tel_error);
        $this->assertSession()
            ->pageTextNotContains($password_error);
        // Invalid password.
        $edit = [
            'password' => $this->randomMachineName(),
        ];
        $this->drupalGet('form-test/pattern');
        $this->submitForm($edit, 'Submit');
        $this->assertSession()
            ->pageTextNotContains($textfield_error);
        $this->assertSession()
            ->pageTextNotContains($tel_error);
        $this->assertSession()
            ->pageTextContains($password_error);
        // The pattern attribute overrides #pattern and is not validated on the
        // server side.
        $edit = [
            'textfield' => '',
            'tel' => '',
            'url' => 'http://www.example.com/',
        ];
        $this->drupalGet('form-test/pattern');
        $this->submitForm($edit, 'Submit');
        $this->assertSession()
            ->pageTextNotContains('Client side validation field is not in the right format.');
    }
    
    /**
     * Tests #required with custom validation errors.
     *
     * @see \Drupal\form_test\Form\FormTestValidateRequiredForm
     */
    public function testCustomRequiredError() : void {
        $form = \Drupal::formBuilder()->getForm('\\Drupal\\form_test\\Form\\FormTestValidateRequiredForm');
        // Verify that a custom #required error can be set.
        $edit = [];
        $this->drupalGet('form-test/validate-required');
        $this->submitForm($edit, 'Submit');
        foreach (Element::children($form) as $key) {
            if (isset($form[$key]['#required_error'])) {
                $this->assertSession()
                    ->pageTextNotContains($form[$key]['#title'] . ' field is required.');
                $this->assertSession()
                    ->pageTextContains((string) $form[$key]['#required_error']);
            }
            elseif (isset($form[$key]['#form_test_required_error'])) {
                $this->assertSession()
                    ->pageTextNotContains($form[$key]['#title'] . ' field is required.');
                $this->assertSession()
                    ->pageTextContains((string) $form[$key]['#form_test_required_error']);
            }
            if (isset($form[$key]['#title'])) {
                $this->assertSession()
                    ->pageTextNotContains('The submitted value in the ' . $form[$key]['#title'] . ' element is not allowed.');
            }
        }
        // Verify that no custom validation error appears with valid values.
        $edit = [
            'textfield' => $this->randomString(),
            'checkboxes[foo]' => TRUE,
            'select' => 'foo',
        ];
        $this->drupalGet('form-test/validate-required');
        $this->submitForm($edit, 'Submit');
        foreach (Element::children($form) as $key) {
            if (isset($form[$key]['#required_error'])) {
                $this->assertSession()
                    ->pageTextNotContains($form[$key]['#title'] . ' field is required.');
                $this->assertSession()
                    ->pageTextNotContains((string) $form[$key]['#required_error']);
            }
            elseif (isset($form[$key]['#form_test_required_error'])) {
                $this->assertSession()
                    ->pageTextNotContains($form[$key]['#title'] . ' field is required.');
                $this->assertSession()
                    ->pageTextNotContains((string) $form[$key]['#form_test_required_error']);
            }
            if (isset($form[$key]['#title'])) {
                $this->assertSession()
                    ->pageTextNotContains('The submitted value in the ' . $form[$key]['#title'] . ' element is not allowed.');
            }
        }
    }

}

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::setUp protected function 544
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 '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::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
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.
ValidationTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
ValidationTest::$modules protected static property Modules to install. Overrides BrowserTestBase::$modules
ValidationTest::testCustomRequiredError public function Tests #required with custom validation errors.
ValidationTest::testDisabledToken public function Tests that a form with a disabled CSRF token can be validated.
ValidationTest::testPatternValidation public function Tests #pattern validation.
ValidationTest::testValidate public function Tests #element_validate and #validate.
ValidationTest::testValidateLimitErrors public function Tests partial form validation through #limit_validation_errors.
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.