class ElementsTableSelectTest in Drupal 10
Same name in this branch
- 10 core/modules/system/tests/src/Functional/Form/ElementsTableSelectTest.php \Drupal\Tests\system\Functional\Form\ElementsTableSelectTest
- 10 core/modules/system/tests/src/FunctionalJavascript/Form/ElementsTableSelectTest.php \Drupal\Tests\system\FunctionalJavascript\Form\ElementsTableSelectTest
Same name and namespace in other branches
- 8 core/modules/system/tests/src/Functional/Form/ElementsTableSelectTest.php \Drupal\Tests\system\Functional\Form\ElementsTableSelectTest
- 9 core/modules/system/tests/src/Functional/Form/ElementsTableSelectTest.php \Drupal\Tests\system\Functional\Form\ElementsTableSelectTest
Tests the tableselect form element for expected behavior.
@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\ElementsTableSelectTest
Expanded class hierarchy of ElementsTableSelectTest
File
- core/
modules/ system/ tests/ src/ Functional/ Form/ ElementsTableSelectTest.php, line 13
Namespace
Drupal\Tests\system\Functional\FormView source
class ElementsTableSelectTest extends BrowserTestBase {
/**
* Modules to enable.
*
* @var array
*/
protected static $modules = [
'form_test',
];
/**
* {@inheritdoc}
*/
protected $defaultTheme = 'stark';
/**
* Tests the display of checkboxes when #multiple is TRUE.
*/
public function testMultipleTrue() {
$this
->drupalGet('form_test/tableselect/multiple-true');
$this
->assertSession()
->responseNotContains('Empty text.');
// Test for the presence of the Select all rows tableheader.
$this
->assertNotEmpty($this
->xpath('//th[@class="select-all"]'), 'Presence of the "Select all" checkbox.');
$rows = [
'row1',
'row2',
'row3',
];
foreach ($rows as $row) {
$this
->assertNotEmpty($this
->xpath('//input[@type="checkbox"]', [
$row,
]), "Checkbox for the value {$row}.");
}
}
/**
* Tests the display of radios when #multiple is FALSE.
*/
public function testMultipleFalse() {
$this
->drupalGet('form_test/tableselect/multiple-false');
$this
->assertSession()
->pageTextNotContains('Empty text.');
// Test for the absence of the Select all rows tableheader.
$this
->assertSession()
->elementNotExists('xpath', '//th[@class="select-all"]');
$rows = [
'row1',
'row2',
'row3',
];
foreach ($rows as $row) {
$this
->assertNotEmpty($this
->xpath('//input[@type="radio"]', [
$row,
], "Radio button value: {$row}"));
}
}
/**
* Tests the display when #colspan is set.
*/
public function testTableSelectColSpan() {
$this
->drupalGet('form_test/tableselect/colspan');
// Verify presence of column three and absence of column four.
$this
->assertSession()
->pageTextContains('Three');
$this
->assertSession()
->pageTextNotContains('Four');
// There should be three labeled column headers and 1 for the input.
$table_head = $this
->xpath('//thead/tr/th');
$this
->assertCount(4, $table_head, 'There are four column headers');
// The first two body rows should each have 5 table cells: One for the
// radio, one cell in the first column, one cell in the second column,
// and two cells in the third column which has colspan 2.
for ($i = 0; $i <= 1; $i++) {
$this
->assertCount(5, $this
->xpath('//tbody/tr[' . ($i + 1) . ']/td'), 'There are five cells in row ' . $i);
}
// The third row should have 3 cells, one for the radio, one spanning the
// first and second column, and a third in column 3 (which has colspan 3).
$this
->assertCount(3, $this
->xpath('//tbody/tr[3]/td'), 'There are three cells in row 3.');
}
/**
* Tests the display of the #empty text when #options is an empty array.
*/
public function testEmptyText() {
$this
->drupalGet('form_test/tableselect/empty-text');
$this
->assertSession()
->pageTextContains('Empty text.');
}
/**
* Tests the submission of single and multiple values when #multiple is TRUE.
*/
public function testMultipleTrueSubmit() {
// Test a submission with one checkbox checked.
$edit = [];
$edit['tableselect[row1]'] = TRUE;
$this
->drupalGet('form_test/tableselect/multiple-true');
$this
->submitForm($edit, 'Submit');
$assert_session = $this
->assertSession();
$assert_session
->pageTextContains('Submitted: row1 = row1');
$assert_session
->pageTextContains('Submitted: row2 = 0');
$assert_session
->pageTextContains('Submitted: row3 = 0');
// Test a submission with multiple checkboxes checked.
$edit['tableselect[row1]'] = TRUE;
$edit['tableselect[row3]'] = TRUE;
$this
->drupalGet('form_test/tableselect/multiple-true');
$this
->submitForm($edit, 'Submit');
$assert_session
->pageTextContains('Submitted: row1 = row1');
$assert_session
->pageTextContains('Submitted: row2 = 0');
$assert_session
->pageTextContains('Submitted: row3 = row3');
}
/**
* Tests submission of values when #multiple is FALSE.
*/
public function testMultipleFalseSubmit() {
$edit['tableselect'] = 'row1';
$this
->drupalGet('form_test/tableselect/multiple-false');
$this
->submitForm($edit, 'Submit');
$this
->assertSession()
->pageTextContains('Submitted: row1');
}
/**
* Tests the #js_select property.
*/
public function testAdvancedSelect() {
// When #multiple = TRUE a Select all checkbox should be displayed by default.
$this
->drupalGet('form_test/tableselect/advanced-select/multiple-true-default');
$this
->assertSession()
->elementExists('xpath', '//th[@class="select-all"]');
// When #js_select is set to FALSE, a "Select all" checkbox should not be displayed.
$this
->drupalGet('form_test/tableselect/advanced-select/multiple-true-no-advanced-select');
$this
->assertSession()
->elementNotExists('xpath', '//th[@class="select-all"]');
// A "Select all" checkbox never makes sense when #multiple = FALSE, regardless of the value of #js_select.
$this
->drupalGet('form_test/tableselect/advanced-select/multiple-false-default');
$this
->assertSession()
->elementNotExists('xpath', '//th[@class="select-all"]');
$this
->drupalGet('form_test/tableselect/advanced-select/multiple-false-advanced-select');
$this
->assertSession()
->elementNotExists('xpath', '//th[@class="select-all"]');
}
/**
* Tests the whether the option checker gives an error on invalid
* tableselect values for checkboxes.
*/
public function testMultipleTrueOptionchecker() {
[
$header,
$options,
] = _form_test_tableselect_get_data();
$form['tableselect'] = [
'#type' => 'tableselect',
'#header' => $header,
'#options' => $options,
];
// Test with a valid value.
[
,
,
$errors,
] = $this
->formSubmitHelper($form, [
'tableselect' => [
'row1' => 'row1',
],
]);
$this
->assertFalse(isset($errors['tableselect']), 'Option checker allows valid values for checkboxes.');
// Test with an invalid value.
[
,
,
$errors,
] = $this
->formSubmitHelper($form, [
'tableselect' => [
'non_existing_value' => 'non_existing_value',
],
]);
$this
->assertTrue(isset($errors['tableselect']), 'Option checker disallows invalid values for checkboxes.');
}
/**
* Tests the whether the option checker gives an error on invalid
* tableselect values for radios.
*/
public function testMultipleFalseOptionchecker() {
[
$header,
$options,
] = _form_test_tableselect_get_data();
$form['tableselect'] = [
'#type' => 'tableselect',
'#header' => $header,
'#options' => $options,
'#multiple' => FALSE,
];
// Test with a valid value.
[
,
,
$errors,
] = $this
->formSubmitHelper($form, [
'tableselect' => 'row1',
]);
$this
->assertFalse(isset($errors['tableselect']), 'Option checker allows valid values for radio buttons.');
// Test with an invalid value.
[
,
,
$errors,
] = $this
->formSubmitHelper($form, [
'tableselect' => 'non_existing_value',
]);
$this
->assertTrue(isset($errors['tableselect']), 'Option checker disallows invalid values for radio buttons.');
}
/**
* Helper function for the option check test to submit a form while collecting errors.
*
* @param array $form
* Nested array of form elements that comprise the form.
* @param array $edit
* An array containing post data.
*
* @return array
* An array containing the processed form, the form_state and any errors.
*
* @internal param $form_element A form element to test.
* A form element to test.
*/
private function formSubmitHelper($form, $edit) {
$form_id = $this
->randomMachineName();
$form_state = new FormState();
$form['op'] = [
'#type' => 'submit',
'#value' => 'Submit',
];
// The form token CSRF protection should not interfere with this test, so we
// bypass it by setting the token to FALSE.
$form['#token'] = FALSE;
$edit['form_id'] = $form_id;
// Disable page redirect for forms submitted programmatically. This is a
// solution to skip the redirect step (there are no pages, then the redirect
// isn't possible).
$form_state
->disableRedirect();
$form_state
->setUserInput($edit);
$form_state
->setFormObject(new StubForm($form_id, $form));
\Drupal::formBuilder()
->prepareForm($form_id, $form, $form_state);
\Drupal::formBuilder()
->processForm($form_id, $form, $form_state);
$errors = $form_state
->getErrors();
// Clear errors and messages.
\Drupal::messenger()
->deleteAll();
$form_state
->clearErrors();
// Return the processed form together with form_state and errors
// to allow the caller lowlevel access to the form.
return [
$form,
$form_state,
$errors,
];
}
}
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 | |
ElementsTableSelectTest:: |
protected | property |
The theme to install as the default for testing. Overrides BrowserTestBase:: |
|
ElementsTableSelectTest:: |
protected static | property |
Modules to enable. Overrides BrowserTestBase:: |
|
ElementsTableSelectTest:: |
private | function | Helper function for the option check test to submit a form while collecting errors. | |
ElementsTableSelectTest:: |
public | function | Tests the #js_select property. | |
ElementsTableSelectTest:: |
public | function | Tests the display of the #empty text when #options is an empty array. | |
ElementsTableSelectTest:: |
public | function | Tests the display of radios when #multiple is FALSE. | |
ElementsTableSelectTest:: |
public | function | Tests the whether the option checker gives an error on invalid tableselect values for radios. | |
ElementsTableSelectTest:: |
public | function | Tests submission of values when #multiple is FALSE. | |
ElementsTableSelectTest:: |
public | function | Tests the display of checkboxes when #multiple is TRUE. | |
ElementsTableSelectTest:: |
public | function | Tests the whether the option checker gives an error on invalid tableselect values for checkboxes. | |
ElementsTableSelectTest:: |
public | function | Tests the submission of single and multiple values when #multiple is TRUE. | |
ElementsTableSelectTest:: |
public | function | Tests the display when #colspan is set. | |
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. | |
XdebugRequestTrait:: |
protected | function | Adds xdebug cookies, from request setup. |