class JavascriptStatesTest

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

Tests the state of elements based on another elements.

The form being tested is JavascriptStatesForm provided by the 'form_test' module under 'system' (core/modules/system/tests/module/form_test).

@group javascript

Hierarchy

Expanded class hierarchy of JavascriptStatesTest

See also

Drupal\form_test\Form\JavascriptStatesForm

File

core/tests/Drupal/FunctionalJavascriptTests/Core/Form/JavascriptStatesTest.php, line 20

Namespace

Drupal\FunctionalJavascriptTests\Core\Form
View source 
class JavascriptStatesTest extends WebDriverTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'form_test',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // Add text formats.
        $filtered_html_format = FilterFormat::create([
            'format' => 'filtered_html',
            'name' => 'Filtered HTML',
            'weight' => 0,
            'filters' => [],
        ]);
        $filtered_html_format->save();
        $full_html_format = FilterFormat::create([
            'format' => 'full_html',
            'name' => 'Full HTML',
            'weight' => 1,
            'filters' => [],
        ]);
        $full_html_format->save();
        $normal_user = $this->drupalCreateUser([
            'use text format filtered_html',
            'use text format full_html',
        ]);
        $this->drupalLogin($normal_user);
    }
    
    /**
     * Tests the JavaScript #states functionality of form elements.
     *
     * To avoid the large cost of a dataProvider in FunctionalJavascript tests,
     * this is a single public test method that invokes a series of protected
     * methods to do assertions on specific kinds of triggering elements.
     */
    public function testJavascriptStates() : void {
        $this->doCheckboxTriggerTests();
        $this->doCheckboxesTriggerTests();
        $this->doTextfieldTriggerTests();
        $this->doRadiosTriggerTests();
        $this->doSelectTriggerTests();
        $this->doMultipleSelectTriggerTests();
        $this->doMultipleTriggerTests();
        $this->doNestedTriggerTests();
        $this->doElementsDisabledStateTests();
    }
    
    /**
     * Tests states of elements triggered by a checkbox element.
     */
    protected function doCheckboxTriggerTests() {
        $this->drupalGet('form-test/javascript-states-form');
        $page = $this->getSession()
            ->getPage();
        // Find trigger and target elements.
        $trigger = $page->findField('checkbox_trigger');
        $this->assertNotEmpty($trigger);
        $textfield_invisible_element = $page->findField('textfield_invisible_when_checkbox_trigger_checked');
        $this->assertNotEmpty($textfield_invisible_element);
        $textfield_required_element = $page->findField('textfield_required_when_checkbox_trigger_checked');
        $this->assertNotEmpty($textfield_required_element);
        $textfield_readonly_element = $page->findField('textfield_readonly_when_checkbox_trigger_checked');
        $this->assertNotEmpty($textfield_readonly_element);
        $textarea_readonly_element = $page->findField('textarea_readonly_when_checkbox_trigger_checked');
        $this->assertNotEmpty($textarea_readonly_element);
        $details = $this->assertSession()
            ->elementExists('css', '#edit-details-expanded-when-checkbox-trigger-checked');
        $textfield_in_details = $details->findField('textfield_in_details');
        $this->assertNotEmpty($textfield_in_details);
        $checkbox_checked_element = $page->findField('checkbox_checked_when_checkbox_trigger_checked');
        $this->assertNotEmpty($checkbox_checked_element);
        $checkbox_unchecked_element = $page->findField('checkbox_unchecked_when_checkbox_trigger_checked');
        $this->assertNotEmpty($checkbox_unchecked_element);
        $checkbox_visible_element = $page->findField('checkbox_visible_when_checkbox_trigger_checked');
        $this->assertNotEmpty($checkbox_visible_element);
        $text_format_invisible_value = $page->findField('text_format_invisible_when_checkbox_trigger_checked[value]');
        $this->assertNotEmpty($text_format_invisible_value);
        $text_format_invisible_format = $page->findField('text_format_invisible_when_checkbox_trigger_checked[format]');
        $this->assertNotEmpty($text_format_invisible_format);
        $link = $page->findLink('Link states test');
        $checkboxes_all_checked_element_value1 = $page->findField('checkboxes_all_checked_when_checkbox_trigger_checked[value1]');
        $this->assertNotEmpty($checkboxes_all_checked_element_value1);
        $checkboxes_all_checked_element_value2 = $page->findField('checkboxes_all_checked_when_checkbox_trigger_checked[value2]');
        $this->assertNotEmpty($checkboxes_all_checked_element_value2);
        $checkboxes_all_checked_element_value3 = $page->findField('checkboxes_all_checked_when_checkbox_trigger_checked[value3]');
        $this->assertNotEmpty($checkboxes_all_checked_element_value3);
        $checkboxes_some_checked_element_value1 = $page->findField('checkboxes_some_checked_when_checkbox_trigger_checked[value1]');
        $this->assertNotEmpty($checkboxes_some_checked_element_value1);
        $checkboxes_some_checked_element_value2 = $page->findField('checkboxes_some_checked_when_checkbox_trigger_checked[value2]');
        $this->assertNotEmpty($checkboxes_some_checked_element_value2);
        $checkboxes_some_checked_element_value3 = $page->findField('checkboxes_some_checked_when_checkbox_trigger_checked[value3]');
        $this->assertNotEmpty($checkboxes_some_checked_element_value3);
        $checkboxes_all_disabled_element_value1 = $page->findField('checkboxes_all_disabled_when_checkbox_trigger_checked[value1]');
        $this->assertNotEmpty($checkboxes_all_disabled_element_value1);
        $checkboxes_all_disabled_element_value2 = $page->findField('checkboxes_all_disabled_when_checkbox_trigger_checked[value2]');
        $this->assertNotEmpty($checkboxes_all_disabled_element_value2);
        $checkboxes_all_disabled_element_value3 = $page->findField('checkboxes_all_disabled_when_checkbox_trigger_checked[value3]');
        $this->assertNotEmpty($checkboxes_all_disabled_element_value3);
        $checkboxes_some_disabled_element_value1 = $page->findField('checkboxes_some_disabled_when_checkbox_trigger_checked[value1]');
        $this->assertNotEmpty($checkboxes_some_disabled_element_value1);
        $checkboxes_some_disabled_element_value2 = $page->findField('checkboxes_some_disabled_when_checkbox_trigger_checked[value2]');
        $this->assertNotEmpty($checkboxes_some_disabled_element_value2);
        $checkboxes_some_disabled_element_value3 = $page->findField('checkboxes_some_disabled_when_checkbox_trigger_checked[value3]');
        $radios_checked_element = $page->findField('radios_checked_when_checkbox_trigger_checked');
        $this->assertNotEmpty($radios_checked_element);
        // We want to select the specific radio buttons, not the whole radios field itself.
        $radios_all_disabled_value1 = $this->xpath('//input[@name=:name][@value=:value]', [
            ':name' => 'radios_all_disabled_when_checkbox_trigger_checked',
            ':value' => 'value1',
        ]);
        $this->assertCount(1, $radios_all_disabled_value1);
        // We want to access the radio button directly for the rest of the test, so
        // take it out of the array we got back from xpath().
        $radios_all_disabled_value1 = reset($radios_all_disabled_value1);
        $radios_all_disabled_value2 = $this->xpath('//input[@name=:name][@value=:value]', [
            ':name' => 'radios_all_disabled_when_checkbox_trigger_checked',
            ':value' => 'value2',
        ]);
        $this->assertCount(1, $radios_all_disabled_value2);
        $radios_all_disabled_value2 = reset($radios_all_disabled_value2);
        $radios_some_disabled_value1 = $this->xpath('//input[@name=:name][@value=:value]', [
            ':name' => 'radios_some_disabled_when_checkbox_trigger_checked',
            ':value' => 'value1',
        ]);
        $this->assertCount(1, $radios_some_disabled_value1);
        $radios_some_disabled_value1 = reset($radios_some_disabled_value1);
        $radios_some_disabled_value2 = $this->xpath('//input[@name=:name][@value=:value]', [
            ':name' => 'radios_some_disabled_when_checkbox_trigger_checked',
            ':value' => 'value2',
        ]);
        $this->assertCount(1, $radios_some_disabled_value2);
        $radios_some_disabled_value2 = reset($radios_some_disabled_value2);
        // Verify initial state.
        $this->assertTrue($textfield_invisible_element->isVisible());
        $this->assertFalse($details->hasAttribute('open'));
        $this->assertFalse($textfield_in_details->isVisible());
        $this->assertFalse($textfield_required_element->hasAttribute('required'));
        $this->assertFalse($textfield_readonly_element->hasAttribute('readonly'));
        $this->assertFalse($textarea_readonly_element->hasAttribute('readonly'));
        $this->assertFalse($checkbox_checked_element->isChecked());
        $this->assertTrue($checkbox_unchecked_element->isChecked());
        $this->assertFalse($checkbox_visible_element->isVisible());
        $this->assertTrue($text_format_invisible_value->isVisible());
        $this->assertTrue($text_format_invisible_format->isVisible());
        $this->assertFalse($checkboxes_all_checked_element_value1->isChecked());
        $this->assertFalse($checkboxes_all_checked_element_value2->isChecked());
        $this->assertFalse($checkboxes_all_checked_element_value3->isChecked());
        $this->assertFalse($checkboxes_some_checked_element_value1->isChecked());
        $this->assertFalse($checkboxes_some_checked_element_value2->isChecked());
        $this->assertFalse($checkboxes_some_checked_element_value3->isChecked());
        $this->assertFalse($checkboxes_all_disabled_element_value1->hasAttribute('disabled'));
        $this->assertFalse($checkboxes_all_disabled_element_value2->hasAttribute('disabled'));
        $this->assertFalse($checkboxes_all_disabled_element_value3->hasAttribute('disabled'));
        $this->assertFalse($checkboxes_some_disabled_element_value1->hasAttribute('disabled'));
        $this->assertFalse($checkboxes_some_disabled_element_value2->hasAttribute('disabled'));
        $this->assertFalse($checkboxes_some_disabled_element_value3->hasAttribute('disabled'));
        $this->assertFalse($radios_checked_element->isChecked());
        $this->assertEquals(NULL, $radios_checked_element->getValue());
        $this->assertFalse($radios_all_disabled_value1->hasAttribute('disabled'));
        $this->assertFalse($radios_all_disabled_value2->hasAttribute('disabled'));
        $this->assertFalse($radios_some_disabled_value1->hasAttribute('disabled'));
        $this->assertFalse($radios_some_disabled_value2->hasAttribute('disabled'));
        // Check if the link is visible.
        $this->assertTrue($link->isVisible());
        // Check enter password is visible.
        $this->assertSession()
            ->pageTextContains('Enter password');
        // Change state: check the checkbox.
        $trigger->check();
        // Verify triggered state.
        $this->assertFalse($textfield_invisible_element->isVisible());
        $this->assertEquals('required', $textfield_required_element->getAttribute('required'));
        $this->assertTrue($textfield_readonly_element->hasAttribute('readonly'));
        $this->assertTrue($textarea_readonly_element->hasAttribute('readonly'));
        $this->assertTrue($details->hasAttribute('open'));
        $this->assertTrue($textfield_in_details->isVisible());
        $this->assertTrue($checkbox_checked_element->isChecked());
        $this->assertFalse($checkbox_unchecked_element->isChecked());
        $this->assertTrue($checkbox_visible_element->isVisible());
        $this->assertFalse($text_format_invisible_value->isVisible());
        $this->assertFalse($text_format_invisible_format->isVisible());
        // All 3 of the other set should be checked.
        $this->assertTrue($checkboxes_all_checked_element_value1->isChecked());
        $this->assertTrue($checkboxes_all_checked_element_value2->isChecked());
        $this->assertTrue($checkboxes_all_checked_element_value3->isChecked());
        // Value 1 and 3 should now be checked.
        $this->assertTrue($checkboxes_some_checked_element_value1->isChecked());
        $this->assertTrue($checkboxes_some_checked_element_value3->isChecked());
        // Only value 2 should remain unchecked.
        $this->assertFalse($checkboxes_some_checked_element_value2->isChecked());
        // All 3 of these should be disabled.
        $this->assertTrue($checkboxes_all_disabled_element_value1->hasAttribute('disabled'));
        $this->assertTrue($checkboxes_all_disabled_element_value2->hasAttribute('disabled'));
        $this->assertTrue($checkboxes_all_disabled_element_value3->hasAttribute('disabled'));
        // Only values 1 and 3 should be disabled, 2 should still be enabled.
        $this->assertTrue($checkboxes_some_disabled_element_value1->hasAttribute('disabled'));
        $this->assertFalse($checkboxes_some_disabled_element_value2->hasAttribute('disabled'));
        $this->assertTrue($checkboxes_some_disabled_element_value3->hasAttribute('disabled'));
        $this->assertEquals('value1', $radios_checked_element->getValue());
        // Both of these should now be disabled.
        $this->assertTrue($radios_all_disabled_value1->hasAttribute('disabled'));
        $this->assertTrue($radios_all_disabled_value2->hasAttribute('disabled'));
        // Only value1 should be disabled, value 2 should remain enabled.
        $this->assertTrue($radios_some_disabled_value1->hasAttribute('disabled'));
        $this->assertFalse($radios_some_disabled_value2->hasAttribute('disabled'));
        // The link shouldn't be visible.
        $this->assertFalse($link->isVisible());
        // Check enter password is not visible.
        $this->assertSession()
            ->pageTextNotContains('Enter password');
        // Change state: uncheck the checkbox.
        $trigger->uncheck();
        // Verify triggered state, which should match the initial state.
        $this->assertTrue($textfield_invisible_element->isVisible());
        $this->assertFalse($details->hasAttribute('open'));
        $this->assertFalse($textfield_in_details->isVisible());
        $this->assertFalse($textfield_required_element->hasAttribute('required'));
        $this->assertFalse($textfield_readonly_element->hasAttribute('readonly'));
        $this->assertFalse($textarea_readonly_element->hasAttribute('readonly'));
        $this->assertFalse($checkbox_checked_element->isChecked());
        $this->assertTrue($checkbox_unchecked_element->isChecked());
        $this->assertFalse($checkbox_visible_element->isVisible());
        $this->assertTrue($text_format_invisible_value->isVisible());
        $this->assertTrue($text_format_invisible_format->isVisible());
        $this->assertFalse($checkboxes_all_checked_element_value1->isChecked());
        $this->assertFalse($checkboxes_all_checked_element_value2->isChecked());
        $this->assertFalse($checkboxes_all_checked_element_value3->isChecked());
        $this->assertFalse($checkboxes_some_checked_element_value1->isChecked());
        $this->assertFalse($checkboxes_some_checked_element_value2->isChecked());
        $this->assertFalse($checkboxes_some_checked_element_value3->isChecked());
        $this->assertFalse($checkboxes_all_disabled_element_value1->hasAttribute('disabled'));
        $this->assertFalse($checkboxes_all_disabled_element_value2->hasAttribute('disabled'));
        $this->assertFalse($checkboxes_all_disabled_element_value3->hasAttribute('disabled'));
        $this->assertFalse($checkboxes_some_disabled_element_value1->hasAttribute('disabled'));
        $this->assertFalse($checkboxes_some_disabled_element_value2->hasAttribute('disabled'));
        $this->assertFalse($checkboxes_some_disabled_element_value3->hasAttribute('disabled'));
        $this->assertFalse($radios_checked_element->isChecked());
        $this->assertEquals(NULL, $radios_checked_element->getValue());
        $this->assertFalse($radios_all_disabled_value1->hasAttribute('disabled'));
        $this->assertFalse($radios_all_disabled_value2->hasAttribute('disabled'));
        $this->assertFalse($radios_some_disabled_value1->hasAttribute('disabled'));
        $this->assertFalse($radios_some_disabled_value2->hasAttribute('disabled'));
        // Check if the link is turned back to visible state.
        $this->assertTrue($link->isVisible());
        // Check enter password is visible.
        $this->assertSession()
            ->pageTextContains('Enter password');
    }
    
    /**
     * Tests states of elements triggered by a checkboxes element.
     */
    protected function doCheckboxesTriggerTests() {
        $this->drupalGet('form-test/javascript-states-form');
        $page = $this->getSession()
            ->getPage();
        // Find trigger and target elements.
        $trigger_value1 = $page->findField('checkboxes_trigger[value1]');
        $this->assertNotEmpty($trigger_value1);
        $trigger_value2 = $page->findField('checkboxes_trigger[value2]');
        $this->assertNotEmpty($trigger_value2);
        $trigger_value3 = $page->findField('checkboxes_trigger[value3]');
        $this->assertNotEmpty($trigger_value3);
        $textfield_visible_value2 = $page->findField('textfield_visible_when_checkboxes_trigger_value2_checked');
        $this->assertNotEmpty($textfield_visible_value2);
        $textfield_visible_value3 = $page->findField('textfield_visible_when_checkboxes_trigger_value3_checked');
        $this->assertNotEmpty($textfield_visible_value3);
        // Verify initial state.
        $this->assertFalse($textfield_visible_value2->isVisible());
        $this->assertFalse($textfield_visible_value3->isVisible());
        // Change state: check the 'Value 1' checkbox.
        $trigger_value1->check();
        $this->assertFalse($textfield_visible_value2->isVisible());
        $this->assertFalse($textfield_visible_value3->isVisible());
        // Change state: check the 'Value 2' checkbox.
        $trigger_value2->check();
        $this->assertTrue($textfield_visible_value2->isVisible());
        $this->assertFalse($textfield_visible_value3->isVisible());
        // Change state: check the 'Value 3' checkbox.
        $trigger_value3->check();
        $this->assertTrue($textfield_visible_value2->isVisible());
        $this->assertTrue($textfield_visible_value3->isVisible());
        // Change state: uncheck the 'Value 2' checkbox.
        $trigger_value2->uncheck();
        $this->assertFalse($textfield_visible_value2->isVisible());
        $this->assertTrue($textfield_visible_value3->isVisible());
    }
    
    /**
     * Tests states of elements triggered by a textfield element.
     */
    protected function doTextfieldTriggerTests() {
        $this->drupalGet('form-test/javascript-states-form');
        $page = $this->getSession()
            ->getPage();
        // Find trigger and target elements.
        $trigger = $page->findField('textfield_trigger');
        $this->assertNotEmpty($trigger);
        $checkbox_checked_target = $page->findField('checkbox_checked_when_textfield_trigger_filled');
        $this->assertNotEmpty($checkbox_checked_target);
        $checkbox_unchecked_target = $page->findField('checkbox_unchecked_when_textfield_trigger_filled');
        $this->assertNotEmpty($checkbox_unchecked_target);
        $select_invisible_target = $page->findField('select_invisible_when_textfield_trigger_filled');
        $this->assertNotEmpty($select_invisible_target);
        $select_visible_target = $page->findField('select_visible_when_textfield_trigger_filled');
        $this->assertNotEmpty($select_visible_target);
        $textfield_required_target = $page->findField('textfield_required_when_textfield_trigger_filled');
        $this->assertNotEmpty($textfield_required_target);
        $details = $this->assertSession()
            ->elementExists('css', '#edit-details-expanded-when-textfield-trigger-filled');
        $textfield_in_details = $details->findField('textfield_in_details');
        $this->assertNotEmpty($textfield_in_details);
        // Verify initial state.
        $this->assertFalse($checkbox_checked_target->isChecked());
        $this->assertTrue($checkbox_unchecked_target->isChecked());
        $this->assertTrue($select_invisible_target->isVisible());
        $this->assertFalse($select_visible_target->isVisible());
        $this->assertFalse($textfield_required_target->hasAttribute('required'));
        $this->assertFalse($details->hasAttribute('open'));
        $this->assertFalse($textfield_in_details->isVisible());
        // Change state: fill the textfield.
        $trigger->setValue('filled');
        // Verify triggered state.
        $this->assertTrue($checkbox_checked_target->isChecked());
        $this->assertFalse($checkbox_unchecked_target->isChecked());
        $this->assertFalse($select_invisible_target->isVisible());
        $this->assertTrue($select_visible_target->isVisible());
        $this->assertEquals('required', $textfield_required_target->getAttribute('required'));
        $this->assertTrue($details->hasAttribute('open'));
        $this->assertTrue($textfield_in_details->isVisible());
    }
    
    /**
     * Tests states of elements triggered by a radios element.
     */
    protected function doRadiosTriggerTests() {
        $this->drupalGet('form-test/javascript-states-form');
        $page = $this->getSession()
            ->getPage();
        // Find trigger and target elements.
        $trigger = $page->findField('radios_trigger');
        $this->assertNotEmpty($trigger);
        $fieldset_visible_when_value2 = $this->assertSession()
            ->elementExists('css', '#edit-fieldset-visible-when-radios-trigger-has-value2');
        $textfield_in_fieldset = $fieldset_visible_when_value2->findField('textfield_in_fieldset');
        $this->assertNotEmpty($textfield_in_fieldset);
        $checkbox_checked_target = $page->findField('checkbox_checked_when_radios_trigger_has_value3');
        $this->assertNotEmpty($checkbox_checked_target);
        $checkbox_unchecked_target = $page->findField('checkbox_unchecked_when_radios_trigger_has_value3');
        $this->assertNotEmpty($checkbox_unchecked_target);
        $textfield_invisible_target = $page->findField('textfield_invisible_when_radios_trigger_has_value2');
        $this->assertNotEmpty($textfield_invisible_target);
        $select_required_target = $page->findField('select_required_when_radios_trigger_has_value2');
        $this->assertNotEmpty($select_required_target);
        $details = $this->assertSession()
            ->elementExists('css', '#edit-details-expanded-when-radios-trigger-has-value3');
        $textfield_in_details = $details->findField('textfield_in_details');
        $this->assertNotEmpty($textfield_in_details);
        // Verify initial state, both the fieldset and something inside it.
        $this->assertFalse($fieldset_visible_when_value2->isVisible());
        $this->assertFalse($textfield_in_fieldset->isVisible());
        $this->assertFalse($checkbox_checked_target->isChecked());
        $this->assertTrue($checkbox_unchecked_target->isChecked());
        $this->assertTrue($textfield_invisible_target->isVisible());
        $this->assertFalse($select_required_target->hasAttribute('required'));
        $this->assertFalse($details->hasAttribute('open'));
        $this->assertFalse($textfield_in_details->isVisible());
        // Change state: select the value2 radios option.
        $trigger->selectOption('value2');
        // Verify triggered state.
        $this->assertTrue($fieldset_visible_when_value2->isVisible());
        $this->assertTrue($textfield_in_fieldset->isVisible());
        $this->assertFalse($textfield_invisible_target->isVisible());
        $this->assertTrue($select_required_target->hasAttribute('required'));
        // Checkboxes and details should not have changed state, yet.
        $this->assertFalse($checkbox_checked_target->isChecked());
        $this->assertTrue($checkbox_unchecked_target->isChecked());
        $this->assertFalse($details->hasAttribute('open'));
        $this->assertFalse($textfield_in_details->isVisible());
        // Change state: select the value3 radios option.
        $trigger->selectOption('value3');
        // Fieldset and contents should re-disappear.
        $this->assertFalse($fieldset_visible_when_value2->isVisible());
        $this->assertFalse($textfield_in_fieldset->isVisible());
        // Textfield and select should revert to initial state.
        $this->assertTrue($textfield_invisible_target->isVisible());
        $this->assertFalse($select_required_target->hasAttribute('required'));
        // Checkbox states should now change.
        $this->assertTrue($checkbox_checked_target->isChecked());
        $this->assertFalse($checkbox_unchecked_target->isChecked());
        // Details should now be expanded.
        $this->assertTrue($details->hasAttribute('open'));
        $this->assertTrue($textfield_in_details->isVisible());
    }
    
    /**
     * Tests states of elements triggered by a select element.
     */
    protected function doSelectTriggerTests() {
        $this->drupalGet('form-test/javascript-states-form');
        $page = $this->getSession()
            ->getPage();
        // Find trigger and target elements.
        $trigger = $page->findField('select_trigger');
        $this->assertNotEmpty($trigger);
        $item_visible_value2 = $this->assertSession()
            ->elementExists('css', '#edit-item-visible-when-select-trigger-has-value2');
        $textfield_visible_value3 = $page->findField('textfield_visible_when_select_trigger_has_value3');
        $this->assertNotEmpty($textfield_visible_value3);
        $textfield_visible_value2_or_value3 = $page->findField('textfield_visible_when_select_trigger_has_value2_or_value3');
        $this->assertNotEmpty($textfield_visible_value2_or_value3);
        // Verify initial state.
        $this->assertFalse($item_visible_value2->isVisible());
        $this->assertFalse($textfield_visible_value3->isVisible());
        $this->assertFalse($textfield_visible_value2_or_value3->isVisible());
        // Change state: select the 'Value 2' option.
        $trigger->setValue('value2');
        $this->assertTrue($item_visible_value2->isVisible());
        $this->assertFalse($textfield_visible_value3->isVisible());
        $this->assertTrue($textfield_visible_value2_or_value3->isVisible());
        // Change state: select the 'Value 3' option.
        $trigger->setValue('value3');
        $this->assertFalse($item_visible_value2->isVisible());
        $this->assertTrue($textfield_visible_value3->isVisible());
        $this->assertTrue($textfield_visible_value2_or_value3->isVisible());
        $this->container
            ->get('module_installer')
            ->install([
            'big_pipe',
        ]);
        $this->drupalGet('form-test/javascript-states-form');
        $select_visible_2 = $this->assertSession()
            ->elementExists('css', 'select[name="select_visible_2"]');
        $select_visible_3 = $this->assertSession()
            ->elementExists('css', 'select[name="select_visible_3"]');
        $this->assertFalse($select_visible_3->isVisible());
        $select_visible_2->setValue('1');
        $this->assertTrue($select_visible_3->isVisible());
    }
    
    /**
     * Tests states of elements triggered by a multiple select element.
     */
    protected function doMultipleSelectTriggerTests() {
        $this->drupalGet('form-test/javascript-states-form');
        $page = $this->getSession()
            ->getPage();
        // Find trigger and target elements.
        $trigger = $page->findField('multiple_select_trigger[]');
        $this->assertNotEmpty($trigger);
        $item_visible_value2 = $this->assertSession()
            ->elementExists('css', '#edit-item-visible-when-multiple-select-trigger-has-value2');
        $item_visible_no_value = $this->assertSession()
            ->elementExists('css', '#edit-item-visible-when-multiple-select-trigger-has-no-value');
        $textfield_visible_value3 = $page->findField('textfield_visible_when_multiple_select_trigger_has_value3');
        $this->assertNotEmpty($textfield_visible_value3);
        $textfield_visible_value2_or_value3 = $page->findField('textfield_visible_when_multiple_select_trigger_has_value2_or_value3');
        $this->assertNotEmpty($textfield_visible_value2_or_value3);
        $textfield_visible_value2_and_value3 = $page->findField('textfield_visible_when_multiple_select_trigger_has_value2_and_value3');
        $this->assertNotEmpty($textfield_visible_value2_and_value3);
        // Verify initial state.
        $this->assertFalse($item_visible_value2->isVisible());
        $this->assertTrue($item_visible_no_value->isVisible());
        $this->assertFalse($textfield_visible_value3->isVisible());
        $this->assertFalse($textfield_visible_value2_or_value3->isVisible());
        $this->assertFalse($textfield_visible_value2_and_value3->isVisible());
        // Change state: select the 'Value 2' option.
        $trigger->setValue('value2');
        $this->assertTrue($item_visible_value2->isVisible());
        $this->assertFalse($item_visible_no_value->isVisible());
        $this->assertFalse($textfield_visible_value3->isVisible());
        $this->assertTrue($textfield_visible_value2_or_value3->isVisible());
        $this->assertFalse($textfield_visible_value2_and_value3->isVisible());
        // Change state: select the 'Value 3' option.
        $trigger->setValue('value3');
        $this->assertFalse($item_visible_value2->isVisible());
        $this->assertFalse($item_visible_no_value->isVisible());
        $this->assertTrue($textfield_visible_value3->isVisible());
        $this->assertTrue($textfield_visible_value2_or_value3->isVisible());
        $this->assertFalse($textfield_visible_value2_and_value3->isVisible());
        // Change state: select 'Value2' and 'Value 3' options.
        $trigger->setValue([
            'value2',
            'value3',
        ]);
        $this->assertFalse($item_visible_value2->isVisible());
        $this->assertFalse($item_visible_no_value->isVisible());
        $this->assertFalse($textfield_visible_value3->isVisible());
        $this->assertFalse($textfield_visible_value2_or_value3->isVisible());
        $this->assertTrue($textfield_visible_value2_and_value3->isVisible());
        // Restore initial trigger state (clear the values).
        $trigger->setValue([]);
        // Make sure the initial element states are restored.
        $this->assertFalse($item_visible_value2->isVisible());
        $this->assertFalse($textfield_visible_value3->isVisible());
        $this->assertFalse($textfield_visible_value2_or_value3->isVisible());
        // @todo These last two look to be correct, but the assertion is failing.
        // @see https://www.drupal.org/project/drupal/issues/3367310
        // $this->assertTrue($item_visible_no_value->isVisible());
        // $this->assertFalse($textfield_visible_value2_and_value3->isVisible());
    }
    
    /**
     * Tests states of elements triggered by multiple elements.
     */
    protected function doMultipleTriggerTests() {
        $this->drupalGet('form-test/javascript-states-form');
        $page = $this->getSession()
            ->getPage();
        // Find trigger and target elements.
        $select_trigger = $page->findField('select_trigger');
        $this->assertNotEmpty($select_trigger);
        $textfield_trigger = $page->findField('textfield_trigger');
        $this->assertNotEmpty($textfield_trigger);
        $item_visible_value2_and_textfield = $this->assertSession()
            ->elementExists('css', '#edit-item-visible-when-select-trigger-has-value2-and-textfield-trigger-filled');
        // Verify initial state.
        $this->assertFalse($item_visible_value2_and_textfield->isVisible());
        // Change state: select the 'Value 2' option.
        $select_trigger->setValue('value2');
        $this->assertFalse($item_visible_value2_and_textfield->isVisible());
        // Change state: fill the textfield.
        $textfield_trigger->setValue('filled');
        $this->assertTrue($item_visible_value2_and_textfield->isVisible());
    }
    
    /**
     * Tests states of radios element triggered by other radios element.
     */
    protected function doNestedTriggerTests() {
        $this->drupalGet('form-test/javascript-states-form');
        $page = $this->getSession()
            ->getPage();
        // Find trigger and target elements.
        $radios_opposite1 = $page->findField('radios_opposite1');
        $this->assertNotEmpty($radios_opposite1);
        $radios_opposite2 = $page->findField('radios_opposite2');
        $this->assertNotEmpty($radios_opposite2);
        // Verify initial state.
        $this->assertEquals('0', $radios_opposite1->getValue());
        $this->assertEquals('1', $radios_opposite2->getValue());
        // Set $radios_opposite2 value to 0, $radios_opposite1 value should be 1.
        $radios_opposite2->setValue('0');
        $this->assertEquals('1', $radios_opposite1->getValue());
        // Set $radios_opposite1 value to 1, $radios_opposite2 value should be 0.
        $radios_opposite1->setValue('0');
        $this->assertEquals('1', $radios_opposite2->getValue());
    }
    
    /**
     * Tests the submit button, select and textarea disabled states.
     *
     * The element should be disabled when visit the form
     * then they should enable when trigger by a checkbox.
     */
    public function doElementsDisabledStateTests() : void {
        $this->drupalGet('form-test/javascript-states-form');
        $session = $this->assertSession();
        // The submit button should be disabled when visit the form.
        $button = $session->elementExists('css', 'input[value="Submit button disabled when checkbox not checked"]');
        $this->assertTrue($button->hasAttribute('disabled'));
        // The submit button should be enabled when the checkbox is checked.
        $session->elementExists('css', 'input[name="checkbox_enable_submit_button"]')
            ->check();
        $this->assertFalse($button->hasAttribute('disabled'));
        // The text field should be disabled when visit the form.
        $textfield = $session->elementExists('css', 'input[name="input_textfield"]');
        $this->assertTrue($textfield->hasAttribute('disabled'));
        // The text field should be enabled when the checkbox is checked.
        $session->elementExists('css', 'input[name="checkbox_enable_input_textfield"]')
            ->check();
        $this->assertFalse($textfield->hasAttribute('disabled'));
        // The select should be disabled when visit the form.
        $select = $session->elementExists('css', 'select[name="test_select_disabled"]');
        $this->assertTrue($select->hasAttribute('disabled'));
        // The select should be enabled when the checkbox is checked.
        $session->elementExists('css', 'input[name="checkbox_enable_select"]')
            ->check();
        $this->assertFalse($select->hasAttribute('disabled'));
        // The textarea should be disabled when visit the form.
        $textarea = $session->elementExists('css', 'textarea[name="test_textarea_disabled"]');
        $this->assertTrue($textarea->hasAttribute('disabled'));
        // The textarea should be enabled when the checkbox is checked.
        $session->elementExists('css', 'input[name="checkbox_enable_textarea"]')
            ->check();
        $this->assertFalse($textarea->hasAttribute('disabled'));
    }

}

Members

Title 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.
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::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
JavascriptStatesTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
JavascriptStatesTest::$modules protected static property Modules to install. Overrides BrowserTestBase::$modules
JavascriptStatesTest::doCheckboxesTriggerTests protected function Tests states of elements triggered by a checkboxes element.
JavascriptStatesTest::doCheckboxTriggerTests protected function Tests states of elements triggered by a checkbox element.
JavascriptStatesTest::doElementsDisabledStateTests public function Tests the submit button, select and textarea disabled states.
JavascriptStatesTest::doMultipleSelectTriggerTests protected function Tests states of elements triggered by a multiple select element.
JavascriptStatesTest::doMultipleTriggerTests protected function Tests states of elements triggered by multiple elements.
JavascriptStatesTest::doNestedTriggerTests protected function Tests states of radios element triggered by other radios element.
JavascriptStatesTest::doRadiosTriggerTests protected function Tests states of elements triggered by a radios element.
JavascriptStatesTest::doSelectTriggerTests protected function Tests states of elements triggered by a select element.
JavascriptStatesTest::doTextfieldTriggerTests protected function Tests states of elements triggered by a textfield element.
JavascriptStatesTest::setUp protected function Overrides BrowserTestBase::setUp
JavascriptStatesTest::testJavascriptStates public function Tests the JavaScript #states functionality of form elements.
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.