You are here

Home » API reference » Drupal 10 » ElementTest.php

class ElementTest in Drupal 10

Same name in this branch
  1. 10 core/tests/Drupal/Tests/Core/Render/ElementTest.php \Drupal\Tests\Core\Render\ElementTest
  2. 10 core/modules/system/tests/src/Functional/Form/ElementTest.php \Drupal\Tests\system\Functional\Form\ElementTest
Same name and namespace in other branches
  1. 8 core/modules/system/tests/src/Functional/Form/ElementTest.php \Drupal\Tests\system\Functional\Form\ElementTest
  2. 9 core/modules/system/tests/src/Functional/Form/ElementTest.php \Drupal\Tests\system\Functional\Form\ElementTest

Tests building and processing of core form elements.

@group Form

Hierarchy

Expanded class hierarchy of ElementTest

File

core/modules/system/tests/src/Functional/Form/ElementTest.php, line 13

Namespace

Drupal\Tests\system\Functional\Form
View source 
class ElementTest extends BrowserTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  protected static $modules = [
    'form_test',
  ];

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'classy';

  /**
   * Tests placeholder text for elements that support placeholders.
   */
  public function testPlaceHolderText() {
    $this
      ->drupalGet('form-test/placeholder-text');
    foreach ([
      'textfield',
      'tel',
      'url',
      'password',
      'email',
      'number',
      'textarea',
    ] as $type) {
      $field = $this
        ->assertSession()
        ->fieldExists("edit-{$type}");
      $this
        ->assertSame('placeholder-text', $field
        ->getAttribute('placeholder'));
    }
  }

  /**
   * Tests expansion of #options for #type checkboxes and radios.
   */
  public function testOptions() {
    $this
      ->drupalGet('form-test/checkboxes-radios');

    // Verify that all options appear in their defined order.
    foreach ([
      'checkbox',
      'radio',
    ] as $type) {
      $elements = $this
        ->xpath('//input[@type=:type]', [
        ':type' => $type,
      ]);
      $expected_values = [
        '0',
        'foo',
        '1',
        'bar',
        '>',
      ];
      foreach ($elements as $element) {
        $expected = array_shift($expected_values);
        $this
          ->assertSame($expected, (string) $element
          ->getAttribute('value'));
      }
    }

    // Verify that the choices are admin filtered as expected.
    $this
      ->assertSession()
      ->responseContains("<em>Special Char</em>alert('checkboxes');");
    $this
      ->assertSession()
      ->responseContains("<em>Special Char</em>alert('radios');");
    $this
      ->assertSession()
      ->responseContains('<em>Bar - checkboxes</em>');
    $this
      ->assertSession()
      ->responseContains('<em>Bar - radios</em>');

    // Enable customized option sub-elements.
    $this
      ->drupalGet('form-test/checkboxes-radios/customize');

    // Verify that all options appear in their defined order, taking a custom
    // #weight into account.
    foreach ([
      'checkbox',
      'radio',
    ] as $type) {
      $elements = $this
        ->xpath('//input[@type=:type]', [
        ':type' => $type,
      ]);
      $expected_values = [
        '0',
        'foo',
        'bar',
        '>',
        '1',
      ];
      foreach ($elements as $element) {
        $expected = array_shift($expected_values);
        $this
          ->assertSame($expected, (string) $element
          ->getAttribute('value'));
      }
    }

    // Verify that custom #description properties are output.
    foreach ([
      'checkboxes',
      'radios',
    ] as $type) {
      $this
        ->assertSession()
        ->elementExists('xpath', "//input[@id='edit-{$type}-foo']/following-sibling::div[@class='description']");
    }
  }

  /**
   * Tests correct checked attribute for radios element.
   */
  public function testRadiosChecked() {

    // Verify that there is only one radio option checked.
    $this
      ->drupalGet('form-test/radios-checked');
    $this
      ->assertSession()
      ->elementsCount('xpath', '//input[@name="radios" and @checked]', 1);
    $this
      ->assertSession()
      ->fieldValueEquals("radios", '0');
    $this
      ->assertSession()
      ->elementsCount('xpath', '//input[@name="radios-string" and @checked]', 1);
    $this
      ->assertSession()
      ->fieldValueEquals("radios-string", 'bar');
    $this
      ->assertSession()
      ->elementsCount('xpath', '//input[@name="radios-boolean-true" and @checked]', 1);
    $this
      ->assertSession()
      ->fieldValueEquals("radios-boolean-true", '1');

    // A default value of FALSE indicates that nothing is set.
    $this
      ->assertSession()
      ->elementNotExists('xpath', '//input[@name="radios-boolean-false" and @checked]');
    $this
      ->assertSession()
      ->elementsCount('xpath', '//input[@name="radios-boolean-any" and @checked]', 1);
    $this
      ->assertSession()
      ->fieldValueEquals("radios-boolean-any", 'All');
    $this
      ->assertSession()
      ->elementsCount('xpath', '//input[@name="radios-string-zero" and @checked]', 1);
    $this
      ->assertSession()
      ->fieldValueEquals("radios-string-zero", '0');
    $this
      ->assertSession()
      ->elementsCount('xpath', '//input[@name="radios-int-non-zero" and @checked]', 1);
    $this
      ->assertSession()
      ->fieldValueEquals("radios-int-non-zero", '10');
    $this
      ->assertSession()
      ->elementsCount('xpath', '//input[@name="radios-int-non-zero-as-string" and @checked]', 1);
    $this
      ->assertSession()
      ->fieldValueEquals("radios-int-non-zero-as-string", '100');
    $this
      ->assertSession()
      ->elementsCount('xpath', '//input[@name="radios-empty-string" and @checked]', 1);
    $this
      ->assertSession()
      ->fieldValueEquals("radios-empty-string", '0');
    $this
      ->assertSession()
      ->elementNotExists('xpath', '//input[@name="radios-empty-array" and @checked]');
    $this
      ->assertSession()
      ->elementsCount('xpath', '//input[@name="radios-key-FALSE" and @checked]', 1);
    $this
      ->assertSession()
      ->fieldValueEquals("radios-key-FALSE", '0');
  }

  /**
   * Tests wrapper ids for checkboxes and radios.
   */
  public function testWrapperIds() {
    $this
      ->drupalGet('form-test/checkboxes-radios');

    // Verify that wrapper id is different from element id.
    foreach ([
      'checkboxes',
      'radios',
    ] as $type) {

      // A single element id is found.
      $this
        ->assertSession()
        ->elementsCount('xpath', "//div[@id='edit-{$type}']", 1);
      $wrapper_ids = $this
        ->xpath('//fieldset[@id=:id]', [
        ':id' => 'edit-' . $type . '--wrapper',
      ]);
      $this
        ->assertCount(1, $wrapper_ids, new FormattableMarkup('A single wrapper id found for type %type', [
        '%type' => $type,
      ]));
    }
  }

  /**
   * Tests button classes.
   */
  public function testButtonClasses() {
    $this
      ->drupalGet('form-test/button-class');

    // Just contains(@class, "button") won't do because then
    // "button--foo" would contain "button". Instead, check
    // " button ". Make sure it matches in the beginning and the end too
    // by adding a space before and after.
    $this
      ->assertCount(2, $this
      ->xpath('//*[contains(concat(" ", @class, " "), " button ")]'));
    $this
      ->assertCount(1, $this
      ->xpath('//*[contains(concat(" ", @class, " "), " button--foo ")]'));
    $this
      ->assertCount(1, $this
      ->xpath('//*[contains(concat(" ", @class, " "), " button--danger ")]'));
  }

  /**
   * Tests the #group property.
   */
  public function testGroupElements() {
    $this
      ->drupalGet('form-test/group-details');
    $this
      ->assertSession()
      ->elementsCount('xpath', '//div[@class="details-wrapper"]//div[@class="details-wrapper"]//label', 1);
    $this
      ->drupalGet('form-test/group-container');
    $this
      ->assertSession()
      ->elementsCount('xpath', '//div[@id="edit-container"]//div[@class="details-wrapper"]//label', 1);
    $this
      ->drupalGet('form-test/group-fieldset');
    $this
      ->assertSession()
      ->elementsCount('xpath', '//fieldset[@id="edit-fieldset"]//div[@id="edit-meta"]//label', 1);
    $this
      ->assertSession()
      ->elementTextEquals('xpath', '//fieldset[@id="edit-fieldset-zero"]//legend', '0');
    $this
      ->drupalGet('form-test/group-vertical-tabs');
    $this
      ->assertSession()
      ->elementsCount('xpath', '//div[@data-vertical-tabs-panes]//details[@id="edit-meta"]//label', 1);
    $this
      ->assertSession()
      ->elementsCount('xpath', '//div[@data-vertical-tabs-panes]//details[@id="edit-meta-2"]//label', 1);
  }

  /**
   * Tests the #required property on details and fieldset elements.
   */
  public function testRequiredFieldsetsAndDetails() {
    $this
      ->drupalGet('form-test/group-details');
    $this
      ->assertEmpty($this
      ->cssSelect('summary.form-required'));
    $this
      ->drupalGet('form-test/group-details/1');
    $this
      ->assertNotEmpty($this
      ->cssSelect('summary.form-required'));
    $this
      ->drupalGet('form-test/group-fieldset');
    $this
      ->assertEmpty($this
      ->cssSelect('span.form-required'));
    $this
      ->drupalGet('form-test/group-fieldset/1');
    $this
      ->assertNotEmpty($this
      ->cssSelect('span.form-required'));
  }

  /**
   * Tests a form with an autocomplete setting..
   */
  public function testFormAutocomplete() {
    $this
      ->drupalGet('form-test/autocomplete');

    // Ensure that the user does not have access to the autocompletion.
    $this
      ->assertSession()
      ->elementNotExists('xpath', '//input[@id="edit-autocomplete-1" and contains(@data-autocomplete-path, "form-test/autocomplete-1")]');
    $this
      ->assertSession()
      ->elementNotExists('xpath', '//input[@id="edit-autocomplete-2" and contains(@data-autocomplete-path, "form-test/autocomplete-2/value")]');
    $user = $this
      ->drupalCreateUser([
      'access autocomplete test',
    ]);
    $this
      ->drupalLogin($user);
    $this
      ->drupalGet('form-test/autocomplete');

    // Make sure that the autocomplete library is added.
    $this
      ->assertSession()
      ->responseContains('core/misc/autocomplete.js');

    // Ensure that the user does have access to the autocompletion.
    $this
      ->assertSession()
      ->elementExists('xpath', '//input[@id="edit-autocomplete-1" and contains(@data-autocomplete-path, "form-test/autocomplete-1")]');
    $this
      ->assertSession()
      ->elementExists('xpath', '//input[@id="edit-autocomplete-2" and contains(@data-autocomplete-path, "form-test/autocomplete-2/value")]');
  }

  /**
   * Tests form element error messages.
   */
  public function testFormElementErrors() {
    $this
      ->drupalGet('form_test/details-form');
    $this
      ->submitForm([], 'Submit');
    $this
      ->assertSession()
      ->pageTextContains('I am an error on the details element.');
  }

  /**
   * Tests summary attributes of details.
   */
  public function testDetailsSummaryAttributes() {
    $this
      ->drupalGet('form-test/group-details');
    $this
      ->assertSession()
      ->elementExists('css', 'summary[data-summary-attribute="test"]');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received.
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix protected property The database prefix of this test run.
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 14
BrowserTestBase::$root protected property The app root.
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the test environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function 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::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the test site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::setUp protected function 132
BrowserTestBase::setUpAppRoot protected function Sets up the root application path.
BrowserTestBase::setUpBeforeClass public static function
BrowserTestBase::tearDown protected function 2
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::__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
ElementTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
ElementTest::$modules protected static property Modules to enable. Overrides BrowserTestBase::$modules
ElementTest::testButtonClasses public function Tests button classes.
ElementTest::testDetailsSummaryAttributes public function Tests summary attributes of details.
ElementTest::testFormAutocomplete public function Tests a form with an autocomplete setting..
ElementTest::testFormElementErrors public function Tests form element error messages.
ElementTest::testGroupElements public function Tests the #group property.
ElementTest::testOptions public function Tests expansion of #options for #type checkboxes and radios.
ElementTest::testPlaceHolderText public function Tests placeholder text for elements that support placeholders.
ElementTest::testRadiosChecked public function Tests correct checked attribute for radios element.
ElementTest::testRequiredFieldsetsAndDetails public function Tests the #required property on details and fieldset elements.
ElementTest::testWrapperIds public function Tests wrapper ids for checkboxes and radios.
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::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation.
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.
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when the test installs Drupal. 4
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 21
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. 3
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site. 1
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
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 public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 1
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 private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements 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.
TestSetupTrait::$container protected property The dependency injection container used in the test.
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::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 1
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 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::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path.
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::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.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.