class MultipleValueWidgetTest

Same name in other branches
  1. 11.x core/modules/field/tests/src/FunctionalJavascript/MultipleValueWidgetTest.php \Drupal\Tests\field\FunctionalJavascript\MultipleValueWidgetTest

Tests widget form for a multiple value field.

@group field

Hierarchy

Expanded class hierarchy of MultipleValueWidgetTest

File

core/modules/field/tests/src/FunctionalJavascript/MultipleValueWidgetTest.php, line 18

Namespace

Drupal\Tests\field\FunctionalJavascript
View source
class MultipleValueWidgetTest extends WebDriverTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'field_test',
        'entity_test',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $account = $this->drupalCreateUser([
            'view test entity',
            'administer entity_test content',
        ]);
        $this->drupalLogin($account);
        $field = [
            'field_name' => 'field_unlimited',
            'entity_type' => 'entity_test',
            'bundle' => 'entity_test',
            'label' => $this->randomMachineName() . '_label',
            'description' => '[site:name]_description',
            'weight' => mt_rand(0, 127),
            'settings' => [
                'test_field_setting' => $this->randomMachineName(),
            ],
        ];
        FieldStorageConfig::create([
            'field_name' => 'field_unlimited',
            'entity_type' => 'entity_test',
            'type' => 'test_field',
            'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
        ])->save();
        FieldConfig::create($field)->save();
        $entity_form_display = EntityFormDisplay::load($field['entity_type'] . '.' . $field['bundle'] . '.default');
        $entity_form_display->setComponent($field['field_name'])
            ->save();
    }
    
    /**
     * Tests the 'Add more' functionality.
     */
    public function testFieldMultipleValueWidget() : void {
        $this->drupalGet('entity_test/add');
        $assert_session = $this->assertSession();
        $page = $this->getSession()
            ->getPage();
        $add_more_button = $page->findButton('field_unlimited_add_more');
        // First set a value on the first input field.
        $field_0 = $page->findField('field_unlimited[0][value]');
        $field_0->setValue('1');
        $field_0_remove_button = $page->findButton('field_unlimited_0_remove_button');
        $this->assertNotEmpty($field_0_remove_button, 'First field has a remove button.');
        // Add another item.
        $add_more_button->click();
        $field_1 = $assert_session->waitForField('field_unlimited[1][value]');
        $this->assertNotEmpty($field_1, 'Successfully added another item.');
        $field_1_remove_button = $page->findButton('field_unlimited_1_remove_button');
        $this->assertNotEmpty($field_1_remove_button, 'Also second field has a remove button.');
        // Validate the value of the first field has not changed.
        $this->assertEquals('1', $field_0->getValue(), 'Value for the first item has not changed.');
        // Validate the value of the second item is empty.
        $this->assertEmpty($field_1->getValue(), 'Value for the second item is currently empty.');
        // Add another item.
        $add_more_button->click();
        $field_2 = $assert_session->waitForField('field_unlimited[2][value]');
        $this->assertNotEmpty($field_2, 'Successfully added another item.');
        // Set values for the 2nd and 3rd fields to validate dragging.
        $field_1->setValue('2');
        $field_2->setValue('3');
        $field_weight_0 = $page->findField('field_unlimited[0][_weight]');
        $field_weight_1 = $page->findField('field_unlimited[1][_weight]');
        $field_weight_2 = $page->findField('field_unlimited[2][_weight]');
        // Assert starting situation matches expectations.
        $this->assertGreaterThan($field_weight_0->getValue(), $field_weight_1->getValue());
        $this->assertGreaterThan($field_weight_1->getValue(), $field_weight_2->getValue());
        // Drag the first row after the third row.
        $dragged = $field_0->find('xpath', 'ancestor::tr[contains(@class, "draggable")]//a[starts-with(@class, "tabledrag-handle")]');
        $target = $field_2->find('xpath', 'ancestor::tr[contains(@class, "draggable")]');
        $dragged->dragTo($target);
        // Assert the order of items is updated correctly after dragging.
        $this->assertGreaterThan($field_weight_2->getValue(), $field_weight_0->getValue());
        $this->assertGreaterThan($field_weight_1->getValue(), $field_weight_2->getValue());
        // Validate the order of items conforms to the last drag action after a
        // updating the form via the server.
        $add_more_button->click();
        $field_3 = $assert_session->waitForField('field_unlimited[3][value]');
        $this->assertNotEmpty($field_3);
        $this->assertGreaterThan($field_weight_2->getValue(), $field_weight_0->getValue());
        $this->assertGreaterThan($field_weight_1->getValue(), $field_weight_2->getValue());
        // Validate no extraneous widget is displayed.
        $element = $page->findField('field_unlimited[4][value]');
        $this->assertEmpty($element);
        // Test removing items/values.
        $field_0_remove_button->click();
        $this->assertSession()
            ->assertWaitOnAjaxRequest();
        // Test the updated widget.
        // First item is the initial second item.
        $this->assertEquals('2', $field_0->getValue(), 'Value for the first item has changed.');
        // We do not have the initial first item anymore.
        $this->assertEmpty($field_2->getValue(), 'Value for the third item is currently empty.');
        $element = $page->findField('field_unlimited[3][value]');
        $this->assertEmpty($element);
        // We can also remove empty items.
        $field_2_remove_button = $page->findButton('field_unlimited_2_remove_button');
        $field_2_remove_button->click();
        $this->assertSession()
            ->assertWaitOnAjaxRequest();
        $element = $page->findField('field_unlimited[2][value]');
        $this->assertEmpty($element, 'Empty field also removed.');
        // Assert that the wrapper exists and isn't nested.
        $this->assertSession()
            ->elementsCount('css', '[data-drupal-selector="edit-field-unlimited-wrapper"]', 1);
        // Test removing items/values on saved entities resets to initial value.
        $this->submitForm([], 'Save');
        $field_2_remove_button->click();
        $this->assertSession()
            ->assertWaitOnAjaxRequest();
        $field_1_remove_button->click();
        $this->assertSession()
            ->assertWaitOnAjaxRequest();
        $field_0_remove_button->click();
        $this->assertSession()
            ->assertWaitOnAjaxRequest();
        $add_more_button->click();
        $this->assertSession()
            ->assertWaitOnAjaxRequest();
        $this->assertSame('', $field_0->getValue());
        $add_more_button->click();
        $this->assertSession()
            ->assertWaitOnAjaxRequest();
        $this->assertSame('', $field_1->getValue());
    }
    
    /**
     * Tests that no validation occurs on field on "Add more" click.
     */
    public function testFieldMultipleValueWidgetAddMoreNoValidation() : void {
        // Set unlimited field to be required.
        $field_name = 'field_unlimited';
        $field = FieldConfig::loadByName('entity_test', 'entity_test', $field_name);
        $field->setRequired(TRUE);
        $field->save();
        $this->drupalGet('entity_test/add');
        $assert_session = $this->assertSession();
        $page = $this->getSession()
            ->getPage();
        // Add another item with the first item being empty, even though the field
        // is required.
        $add_more_button = $page->findButton('field_unlimited_add_more');
        $add_more_button->click();
        $field_1 = $assert_session->waitForField('field_unlimited[1][value]');
        $this->assertNotEmpty($field_1, 'Successfully added another item.');
        // Confirm the new item has focus.
        $this->assertHasFocusByAttribute('name', 'field_unlimited[1][value]');
        // The first item should not be in error state.
        $assert_session->elementNotExists('css', 'input[name="field_unlimited[0][value]"].error');
    }
    
    /**
     * Asserts an element specified by an attribute value has focus.
     *
     * @param string $name
     *   The attribute name.
     * @param string $value
     *   The attribute value.
     *
     * @todo Replace with assertHasFocus() in https://drupal.org/i/3041768.
     */
    private function assertHasFocusByAttribute(string $name, string $value) : void {
        $active_element = $this->getSession()
            ->evaluateScript('document.activeElement');
        $this->assertSame($value, $active_element->attribute($name));
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::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
MultipleValueWidgetTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
MultipleValueWidgetTest::$modules protected static property Modules to install. Overrides BrowserTestBase::$modules
MultipleValueWidgetTest::assertHasFocusByAttribute private function Asserts an element specified by an attribute value has focus.
MultipleValueWidgetTest::setUp protected function Overrides BrowserTestBase::setUp
MultipleValueWidgetTest::testFieldMultipleValueWidget public function Tests the 'Add more' functionality.
MultipleValueWidgetTest::testFieldMultipleValueWidgetAddMoreNoValidation public function Tests that no validation occurs on field on "Add more" click.
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.