class ValidationTest in Drupal 10
Same name and namespace in other branches
- 8 core/modules/system/tests/src/Functional/Form/ValidationTest.php \Drupal\Tests\system\Functional\Form\ValidationTest
- 9 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
Hierarchy
- class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses \Drupal\Tests\PhpUnitCompatibilityTrait, \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, FunctionalTestSetupTrait, TestSetupTrait, BlockCreationTrait, ConfigTestTrait, ExtensionListTestTrait, ContentTypeCreationTrait, NodeCreationTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings, UiHelperTrait, UserCreationTrait, XdebugRequestTrait
- class \Drupal\Tests\system\Functional\Form\ValidationTest
Expanded class hierarchy of ValidationTest
File
- core/
modules/ system/ tests/ src/ Functional/ Form/ ValidationTest.php, line 13
Namespace
Drupal\Tests\system\Functional\FormView source
class ValidationTest extends BrowserTestBase {
/**
* Modules to enable.
*
* @var array
*/
protected static $modules = [
'form_test',
];
/**
* {@inheritdoc}
*/
protected $defaultTheme = 'stark';
/**
* Tests #element_validate and #validate.
*/
public function testValidate() {
$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() {
$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() {
$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() {
$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() {
$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']);
}
}
$this
->assertSession()
->pageTextNotContains('An illegal choice has been detected. Please contact the site administrator.');
// 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']);
}
}
$this
->assertSession()
->pageTextNotContains('An illegal choice has been detected. Please contact the site administrator.');
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
BlockCreationTrait:: |
protected | function | Creates a block instance based on default settings. Aliased as: drupalPlaceBlock | |
BrowserHtmlDebugTrait:: |
protected | property | The Base URI to use for links to the output files. | |
BrowserHtmlDebugTrait:: |
protected | property | Class name for HTML output logging. | |
BrowserHtmlDebugTrait:: |
protected | property | Counter for HTML output logging. | |
BrowserHtmlDebugTrait:: |
protected | property | Counter storage for HTML output logging. | |
BrowserHtmlDebugTrait:: |
protected | property | Directory name for HTML output logging. | |
BrowserHtmlDebugTrait:: |
protected | property | HTML output enabled. | |
BrowserHtmlDebugTrait:: |
protected | property | The file name to write the list of URLs to. | |
BrowserHtmlDebugTrait:: |
protected | property | HTML output test ID. | |
BrowserHtmlDebugTrait:: |
protected | function | Formats HTTP headers as string for HTML output logging. | |
BrowserHtmlDebugTrait:: |
protected | function | Returns headers in HTML output format. | 1 |
BrowserHtmlDebugTrait:: |
protected | function | Provides a Guzzle middleware handler to log every response received. | |
BrowserHtmlDebugTrait:: |
protected | function | Logs a HTML output message in a text file. | |
BrowserHtmlDebugTrait:: |
protected | function | Creates the directory to store browser output. | |
BrowserTestBase:: |
protected | property | The base URL. | |
BrowserTestBase:: |
protected | property | The config importer that can be used in a test. | |
BrowserTestBase:: |
protected | property | An array of custom translations suitable for drupal_rewrite_settings(). | |
BrowserTestBase:: |
protected | property | The database prefix of this test run. | |
BrowserTestBase:: |
protected | property | Mink session manager. | |
BrowserTestBase:: |
protected | property | Mink default driver params. | |
BrowserTestBase:: |
protected | property | Mink class for the default driver to use. | 1 |
BrowserTestBase:: |
protected | property | The original container. | |
BrowserTestBase:: |
protected | property | The original array of shutdown function callbacks. | |
BrowserTestBase:: |
protected | property | ||
BrowserTestBase:: |
protected | property | The profile to install as a basis for testing. | 14 |
BrowserTestBase:: |
protected | property | The app root. | |
BrowserTestBase:: |
protected | property | Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests. | |
BrowserTestBase:: |
protected | property | Time limit in seconds for the test. | |
BrowserTestBase:: |
protected | property | The translation file directory for the test environment. | |
BrowserTestBase:: |
protected | function | Clean up the test environment. | |
BrowserTestBase:: |
protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |
BrowserTestBase:: |
public static | function | Ensures test files are deletable. | |
BrowserTestBase:: |
protected | function | Gets an instance of the default Mink driver. | |
BrowserTestBase:: |
protected | function | Gets the JavaScript drupalSettings variable for the currently-loaded page. | 1 |
BrowserTestBase:: |
protected | function | Obtain the HTTP client for the system under test. | |
BrowserTestBase:: |
protected | function | Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests. | 1 |
BrowserTestBase:: |
protected | function | Helper function to get the options of select field. | |
BrowserTestBase:: |
public | function | Returns Mink session. | |
BrowserTestBase:: |
protected | function | Get session cookies from current session. | |
BrowserTestBase:: |
protected | function |
Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait:: |
|
BrowserTestBase:: |
protected | function | Visits the front page when initializing Mink. | 3 |
BrowserTestBase:: |
protected | function | Initializes Mink sessions. | 1 |
BrowserTestBase:: |
public | function | Installs Drupal into the test site. | 1 |
BrowserTestBase:: |
protected | function | Registers additional Mink sessions. | |
BrowserTestBase:: |
protected | function | 132 | |
BrowserTestBase:: |
protected | function | Sets up the root application path. | |
BrowserTestBase:: |
public static | function | ||
BrowserTestBase:: |
protected | function | 2 | |
BrowserTestBase:: |
protected | function | Transforms a nested array into a flat array suitable for submitForm(). | |
BrowserTestBase:: |
protected | function | Performs an xpath search on the contents of the internal browser. | |
BrowserTestBase:: |
public | function | Prevents serializing any properties. | |
ConfigTestTrait:: |
protected | function | Returns a ConfigImporter object to import test configuration. | |
ConfigTestTrait:: |
protected | function | Copies configuration objects from source storage to target storage. | |
ContentTypeCreationTrait:: |
protected | function | Creates a custom content type based on default settings. Aliased as: drupalCreateContentType | |
ExtensionListTestTrait:: |
protected | function | Gets the path for the specified module. | |
ExtensionListTestTrait:: |
protected | function | Gets the path for the specified theme. | |
FunctionalTestSetupTrait:: |
protected | property | The flag to set 'apcu_ensure_unique_prefix' setting. | 1 |
FunctionalTestSetupTrait:: |
protected | property | The class loader to use for installation and initialization of setup. | |
FunctionalTestSetupTrait:: |
protected | property | The "#1" admin user. | |
FunctionalTestSetupTrait:: |
protected | function | Execute the non-interactive installer. | 1 |
FunctionalTestSetupTrait:: |
protected | function | Returns all supported database driver installer objects. | |
FunctionalTestSetupTrait:: |
protected | function | Initialize various configurations post-installation. | |
FunctionalTestSetupTrait:: |
protected | function | Initializes the kernel after installation. | |
FunctionalTestSetupTrait:: |
protected | function | Initialize settings created during install. | |
FunctionalTestSetupTrait:: |
protected | function | Initializes user 1 for the site to be installed. | |
FunctionalTestSetupTrait:: |
protected | function | Installs the default theme defined by `static::$defaultTheme` when needed. | |
FunctionalTestSetupTrait:: |
protected | function | Install modules defined by `static::$modules`. | 1 |
FunctionalTestSetupTrait:: |
protected | function | Returns the parameters that will be used when the test installs Drupal. | 4 |
FunctionalTestSetupTrait:: |
protected | function | Prepares the current environment for running the test. | 21 |
FunctionalTestSetupTrait:: |
protected | function | Creates a mock request and sets it on the generator. | |
FunctionalTestSetupTrait:: |
protected | function | Prepares site settings and services before installation. | 3 |
FunctionalTestSetupTrait:: |
protected | function | Resets and rebuilds the environment after setup. | |
FunctionalTestSetupTrait:: |
protected | function | Rebuilds \Drupal::getContainer(). | |
FunctionalTestSetupTrait:: |
protected | function | Resets all data structures after having enabled new modules. | |
FunctionalTestSetupTrait:: |
protected | function | Changes parameters in the services.yml file. | |
FunctionalTestSetupTrait:: |
protected | function | Sets up the base URL based upon the environment variable. | |
FunctionalTestSetupTrait:: |
protected | function | Rewrites the settings.php file of the test site. | 1 |
NodeCreationTrait:: |
protected | function | Creates a node based on default settings. Aliased as: drupalCreateNode | |
NodeCreationTrait:: |
public | function | Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle | |
PhpUnitWarnings:: |
private static | property | Deprecation warnings from PHPUnit to raise with @trigger_error(). | |
PhpUnitWarnings:: |
public | function | Converts PHPUnit deprecation warnings to E_USER_DEPRECATED. | |
RandomGeneratorTrait:: |
protected | property | The random generator. | |
RandomGeneratorTrait:: |
protected | function | Gets the random generator for the utility methods. | |
RandomGeneratorTrait:: |
protected | function | Generates a unique random string containing letters and numbers. | |
RandomGeneratorTrait:: |
public | function | Generates a random PHP object. | |
RandomGeneratorTrait:: |
public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |
RandomGeneratorTrait:: |
public | function | Callback for random string validation. | |
RefreshVariablesTrait:: |
protected | function | Refreshes in-memory configuration and state information. | 1 |
SessionTestTrait:: |
protected | property | The name of the session cookie. | |
SessionTestTrait:: |
protected | function | Generates a session cookie name. | |
SessionTestTrait:: |
protected | function | Returns the session name in use on the child site. | |
StorageCopyTrait:: |
protected static | function | Copy the configuration from one storage to another and remove stale items. | |
TestRequirementsTrait:: |
private | function | Checks missing module requirements. | |
TestRequirementsTrait:: |
protected | function | Check module requirements for the Drupal use case. | |
TestRequirementsTrait:: |
protected static | function | Returns the Drupal root directory. | |
TestSetupTrait:: |
protected static | property | An array of config object names that are excluded from schema checking. | |
TestSetupTrait:: |
protected | property | The dependency injection container used in the test. | |
TestSetupTrait:: |
protected | property | The DrupalKernel instance used in the test. | |
TestSetupTrait:: |
protected | property | The site directory of the original parent site. | |
TestSetupTrait:: |
protected | property | The private file directory for the test environment. | |
TestSetupTrait:: |
protected | property | The public file directory for the test environment. | |
TestSetupTrait:: |
protected | property | The site directory of this test run. | |
TestSetupTrait:: |
protected | property | Set to TRUE to strict check all configuration saved. | 1 |
TestSetupTrait:: |
protected | property | The temporary file directory for the test environment. | |
TestSetupTrait:: |
protected | property | The test run ID. | |
TestSetupTrait:: |
protected | function | Changes the database connection to the prefixed one. | |
TestSetupTrait:: |
protected | function | Gets the config schema exclusions for this test. | |
TestSetupTrait:: |
public static | function | Returns the database connection to the site under test. | |
TestSetupTrait:: |
protected | function | Generates a database prefix for running tests. | 1 |
UiHelperTrait:: |
protected | property | The current user logged in using the Mink controlled browser. | |
UiHelperTrait:: |
protected | property | The number of meta refresh redirects to follow, or NULL if unlimited. | |
UiHelperTrait:: |
protected | property | The number of meta refresh redirects followed during ::drupalGet(). | |
UiHelperTrait:: |
public | function | Returns WebAssert object. | 1 |
UiHelperTrait:: |
protected | function | Builds an absolute URL from a system path or a URL object. | |
UiHelperTrait:: |
protected | function | Checks for meta refresh tag and if found call drupalGet() recursively. | |
UiHelperTrait:: |
protected | function | Clicks the element with the given CSS selector. | |
UiHelperTrait:: |
protected | function | Follows a link by complete name. | |
UiHelperTrait:: |
protected | function | Searches elements using a CSS selector in the raw content. | |
UiHelperTrait:: |
protected | function | Translates a CSS expression to its XPath equivalent. | |
UiHelperTrait:: |
protected | function | Retrieves a Drupal path or an absolute path. | |
UiHelperTrait:: |
protected | function | Logs in a user using the Mink controlled browser. | |
UiHelperTrait:: |
protected | function | Logs a user out of the Mink controlled browser and confirms. | |
UiHelperTrait:: |
protected | function | Returns whether a given user account is logged in. | |
UiHelperTrait:: |
protected | function | Takes a path and returns an absolute path. | |
UiHelperTrait:: |
protected | function | Retrieves the plain-text content from the current page. | |
UiHelperTrait:: |
protected | function | Get the current URL from the browser. | |
UiHelperTrait:: |
protected | function | Determines if test is using DrupalTestBrowser. | |
UiHelperTrait:: |
protected | function | Prepare for a request to testing site. | 1 |
UiHelperTrait:: |
protected | function | Fills and submits a form. | |
UserCreationTrait:: |
protected | function | Checks whether a given list of permission names is valid. | |
UserCreationTrait:: |
protected | function | Creates an administrative role. | |
UserCreationTrait:: |
protected | function | Creates a role with specified permissions. Aliased as: drupalCreateRole | |
UserCreationTrait:: |
protected | function | Create a user with a given set of permissions. Aliased as: drupalCreateUser | |
UserCreationTrait:: |
protected | function | Grant permissions to a user role. | |
UserCreationTrait:: |
protected | function | Switch the current logged in user. | |
UserCreationTrait:: |
protected | function | Creates a random user account and sets it as current user. | |
ValidationTest:: |
protected | property |
The theme to install as the default for testing. Overrides BrowserTestBase:: |
|
ValidationTest:: |
protected static | property |
Modules to enable. Overrides BrowserTestBase:: |
|
ValidationTest:: |
public | function | Tests #required with custom validation errors. | |
ValidationTest:: |
public | function | Tests that a form with a disabled CSRF token can be validated. | |
ValidationTest:: |
public | function | Tests #pattern validation. | |
ValidationTest:: |
public | function | Tests #element_validate and #validate. | |
ValidationTest:: |
public | function | Tests partial form validation through #limit_validation_errors. | |
XdebugRequestTrait:: |
protected | function | Adds xdebug cookies, from request setup. |