class EntityFormTest

Same name in this branch
  1. 11.x core/tests/Drupal/Tests/Core/Entity/EntityFormTest.php \Drupal\Tests\Core\Entity\EntityFormTest
Same name in other branches
  1. 9 core/modules/system/tests/src/Functional/Entity/EntityFormTest.php \Drupal\Tests\system\Functional\Entity\EntityFormTest
  2. 9 core/tests/Drupal/Tests/Core/Entity/EntityFormTest.php \Drupal\Tests\Core\Entity\EntityFormTest
  3. 8.9.x core/modules/system/tests/src/Functional/Entity/EntityFormTest.php \Drupal\Tests\system\Functional\Entity\EntityFormTest
  4. 8.9.x core/tests/Drupal/Tests/Core/Entity/EntityFormTest.php \Drupal\Tests\Core\Entity\EntityFormTest
  5. 10 core/modules/system/tests/src/Functional/Entity/EntityFormTest.php \Drupal\Tests\system\Functional\Entity\EntityFormTest
  6. 10 core/tests/Drupal/Tests/Core/Entity/EntityFormTest.php \Drupal\Tests\Core\Entity\EntityFormTest

Tests the entity form.

@group Entity

Hierarchy

Expanded class hierarchy of EntityFormTest

File

core/modules/system/tests/src/Functional/Entity/EntityFormTest.php, line 18

Namespace

Drupal\Tests\system\Functional\Entity
View source
class EntityFormTest extends BrowserTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'entity_test',
        'language',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * The current user of the test.
     *
     * @var \Drupal\user\Entity\User|false
     */
    protected $webUser;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->webUser = $this->drupalCreateUser([
            'administer entity_test content',
            'view test entity',
        ]);
        $this->drupalLogin($this->webUser);
        // Add a language.
        ConfigurableLanguage::createFromLangcode('ro')->save();
    }
    
    /**
     * Tests basic form CRUD functionality.
     */
    public function testFormCRUD() : void {
        // All entity variations have to have the same results.
        foreach (entity_test_entity_types() as $entity_type) {
            $this->doTestFormCRUD($entity_type);
        }
    }
    
    /**
     * Tests basic multilingual form CRUD functionality.
     */
    public function testMultilingualFormCRUD() : void {
        // All entity variations have to have the same results.
        foreach (entity_test_entity_types(ENTITY_TEST_TYPES_MULTILINGUAL) as $entity_type) {
            $this->doTestMultilingualFormCRUD($entity_type);
        }
    }
    
    /**
     * Tests hook_entity_form_mode_alter() and hook_ENTITY_TYPE_form_mode_alter().
     *
     * @see entity_test_entity_form_mode_alter()
     * @see entity_test_entity_test_form_mode_alter()
     */
    public function testEntityFormModeAlter() : void {
        // Create compact entity display.
        EntityFormMode::create([
            'id' => 'entity_test.compact',
            'label' => 'Compact',
            'targetEntityType' => 'entity_test',
        ])->save();
        EntityFormDisplay::create([
            'targetEntityType' => 'entity_test',
            'bundle' => 'entity_test',
            'mode' => 'compact',
            'status' => TRUE,
        ])->removeComponent('field_test_text')
            ->save();
        // The field should be available on default form mode.
        $entity1 = EntityTest::create([
            'name' => $this->randomString(),
        ]);
        $entity1->save();
        $this->drupalGet($entity1->toUrl('edit-form'));
        $this->assertSession()
            ->elementExists('css', 'input[name="field_test_text[0][value]"]');
        // The field should be hidden on compact form mode.
        // See: entity_test_entity_form_mode_alter().
        $entity2 = EntityTest::create([
            'name' => 'compact_form_mode',
        ]);
        $entity2->save();
        $this->drupalGet($entity2->toUrl('edit-form'));
        $this->assertSession()
            ->elementNotExists('css', 'input[name="field_test_text[0][value]"]');
        $entity3 = EntityTest::create([
            'name' => 'test_entity_type_form_mode_alter',
        ]);
        $entity3->save();
        $this->drupalGet($entity3->toUrl('edit-form'));
        $this->assertSession()
            ->elementNotExists('css', 'input[name="field_test_text[0][value]"]');
    }
    
    /**
     * Tests hook_entity_form_display_alter().
     *
     * Verify that the altered field has the correct size value.
     *
     * @see entity_test_entity_form_display_alter()
     */
    public function testEntityFormDisplayAlter() : void {
        $this->drupalGet('entity_test/add');
        $altered_field = $this->assertSession()
            ->fieldExists('field_test_text[0][value]');
        $this->assertEquals(42, $altered_field->getAttribute('size'));
    }
    
    /**
     * Executes the form CRUD tests for the given entity type.
     *
     * @param string $entity_type
     *   The entity type to run the tests with.
     */
    protected function doTestFormCRUD($entity_type) : void {
        $name1 = $this->randomMachineName(8);
        $name2 = $this->randomMachineName(10);
        $edit = [
            'name[0][value]' => $name1,
            'field_test_text[0][value]' => $this->randomMachineName(16),
        ];
        $this->drupalGet($entity_type . '/add');
        $this->submitForm($edit, 'Save');
        $entity = $this->loadEntityByName($entity_type, $name1);
        $this->assertNotNull($entity, "{$entity_type}: Entity found in the database.");
        $edit['name[0][value]'] = $name2;
        $this->drupalGet($entity_type . '/manage/' . $entity->id() . '/edit');
        $this->submitForm($edit, 'Save');
        $entity = $this->loadEntityByName($entity_type, $name1);
        $this->assertNull($entity, "{$entity_type}: The entity has been modified.");
        $entity = $this->loadEntityByName($entity_type, $name2);
        $this->assertNotNull($entity, "{$entity_type}: Modified entity found in the database.");
        $this->assertNotEquals($name1, $entity->name->value, "{$entity_type}: The entity name has been modified.");
        $this->drupalGet($entity_type . '/manage/' . $entity->id() . '/edit');
        $this->clickLink('Delete');
        $this->submitForm([], 'Delete');
        $entity = $this->loadEntityByName($entity_type, $name2);
        $this->assertNull($entity, "{$entity_type}: Entity not found in the database.");
    }
    
    /**
     * Executes the multilingual form CRUD tests for the given entity type ID.
     *
     * @param string $entity_type_id
     *   The ID of entity type to run the tests with.
     */
    protected function doTestMultilingualFormCRUD($entity_type_id) : void {
        $name1 = $this->randomMachineName(8);
        $name1_ro = $this->randomMachineName(9);
        $name2_ro = $this->randomMachineName(11);
        $edit = [
            'name[0][value]' => $name1,
            'field_test_text[0][value]' => $this->randomMachineName(16),
        ];
        $this->drupalGet($entity_type_id . '/add');
        $this->submitForm($edit, 'Save');
        $entity = $this->loadEntityByName($entity_type_id, $name1);
        $this->assertNotNull($entity, "{$entity_type_id}: Entity found in the database.");
        // Add a translation to the newly created entity without using the Content
        // translation module.
        $entity->addTranslation('ro', [
            'name' => $name1_ro,
        ])
            ->save();
        $translated_entity = $this->loadEntityByName($entity_type_id, $name1)
            ->getTranslation('ro');
        $this->assertEquals($name1_ro, $translated_entity->name->value, "{$entity_type_id}: The translation has been added.");
        $edit['name[0][value]'] = $name2_ro;
        $this->drupalGet('ro/' . $entity_type_id . '/manage/' . $entity->id() . '/edit');
        $this->submitForm($edit, 'Save');
        $translated_entity = $this->loadEntityByName($entity_type_id, $name1)
            ->getTranslation('ro');
        $this->assertNotNull($translated_entity, "{$entity_type_id}: Modified translation found in the database.");
        $this->assertEquals($name2_ro, $translated_entity->name->value, "{$entity_type_id}: The name of the translation has been modified.");
        $this->drupalGet('ro/' . $entity_type_id . '/manage/' . $entity->id() . '/edit');
        $this->clickLink('Delete');
        $this->submitForm([], 'Delete Romanian translation');
        $entity = $this->loadEntityByName($entity_type_id, $name1);
        $this->assertNotNull($entity, "{$entity_type_id}: The original entity still exists.");
        $this->assertFalse($entity->hasTranslation('ro'), "{$entity_type_id}: Entity translation does not exist anymore.");
    }
    
    /**
     * Loads a test entity by name always resetting the storage cache.
     */
    protected function loadEntityByName($entity_type, $name) {
        // Always load the entity from the database to ensure that changes are
        // correctly picked up.
        $entity_storage = $this->container
            ->get('entity_type.manager')
            ->getStorage($entity_type);
        $entity_storage->resetCache();
        $entities = $entity_storage->loadByProperties([
            'name' => $name,
        ]);
        return $entities ? current($entities) : NULL;
    }
    
    /**
     * Checks that validation handlers works as expected.
     */
    public function testValidationHandlers() : void {
        
        /** @var \Drupal\Core\State\StateInterface $state */
        $state = $this->container
            ->get('state');
        // Check that from-level validation handlers can be defined and can alter
        // the form array.
        $state->set('entity_test.form.validate.test', 'form-level');
        $this->drupalGet('entity_test/add');
        $this->submitForm([], 'Save');
        $this->assertTrue($state->get('entity_test.form.validate.result'), 'Form-level validation handlers behave correctly.');
        // Check that defining a button-level validation handler causes an exception
        // to be thrown.
        $state->set('entity_test.form.validate.test', 'button-level');
        $this->drupalGet('entity_test/add');
        $this->submitForm([], 'Save');
        $this->assertEquals('Drupal\\Core\\Entity\\EntityStorageException: Entity validation is required, but was skipped.', $state->get('entity_test.form.save.exception'), 'Button-level validation handlers behave correctly.');
    }
    
    /**
     * Tests the route add-page with multiple parameters.
     */
    public function testAddPageWithMultipleParameters() : void {
        $this->drupalGet('entity_test_add_page/' . $this->webUser
            ->id() . '/add');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->pageTextContains('Add entity test route add page');
    }

}

Members

Title Sort descending 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::$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 SettingsEditor::rewrite().
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::$profile protected property The profile to install as a basis for testing. 41
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 Gets the Mink driver args from an environment variable. 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. 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::tearDown protected function 3
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::__construct public function 1
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
EntityFormTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
EntityFormTest::$modules protected static property Modules to install. Overrides BrowserTestBase::$modules
EntityFormTest::$webUser protected property The current user of the test.
EntityFormTest::doTestFormCRUD protected function Executes the form CRUD tests for the given entity type.
EntityFormTest::doTestMultilingualFormCRUD protected function Executes the multilingual form CRUD tests for the given entity type ID.
EntityFormTest::loadEntityByName protected function Loads a test entity by name always resetting the storage cache.
EntityFormTest::setUp protected function Overrides BrowserTestBase::setUp
EntityFormTest::testAddPageWithMultipleParameters public function Tests the route add-page with multiple parameters.
EntityFormTest::testEntityFormDisplayAlter public function Tests hook_entity_form_display_alter().
EntityFormTest::testEntityFormModeAlter public function Tests hook_entity_form_mode_alter() and hook_ENTITY_TYPE_form_mode_alter().
EntityFormTest::testFormCRUD public function Tests basic form CRUD functionality.
EntityFormTest::testMultilingualFormCRUD public function Tests basic multilingual form CRUD functionality.
EntityFormTest::testValidationHandlers public function Checks that validation handlers works as expected.
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
ExpectDeprecationTrait::getCallableName private static function Returns a callable as a string suitable for inclusion in a message.
ExpectDeprecationTrait::setUpErrorHandler public function Sets up the test error handler.
ExpectDeprecationTrait::tearDownErrorHandler public function Tears down the test error handler.
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. 8
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. 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::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. 8
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 29
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
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
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.
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::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. 3
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::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::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. 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.
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.