class EntityFormTest in Drupal 10
Same name in this branch
- 10 core/tests/Drupal/Tests/Core/Entity/EntityFormTest.php \Drupal\Tests\Core\Entity\EntityFormTest
- 10 core/modules/system/tests/src/Functional/Entity/EntityFormTest.php \Drupal\Tests\system\Functional\Entity\EntityFormTest
Same name and namespace in other branches
- 8 core/modules/system/tests/src/Functional/Entity/EntityFormTest.php \Drupal\Tests\system\Functional\Entity\EntityFormTest
- 9 core/modules/system/tests/src/Functional/Entity/EntityFormTest.php \Drupal\Tests\system\Functional\Entity\EntityFormTest
Tests the entity form.
@group Entity
Hierarchy
- class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses \Drupal\Tests\PhpUnitCompatibilityTrait, \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, FunctionalTestSetupTrait, TestSetupTrait, BlockCreationTrait, ConfigTestTrait, ExtensionListTestTrait, ContentTypeCreationTrait, NodeCreationTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings, UiHelperTrait, UserCreationTrait, XdebugRequestTrait
- class \Drupal\Tests\system\Functional\Entity\EntityFormTest
Expanded class hierarchy of EntityFormTest
File
- core/
modules/ system/ tests/ src/ Functional/ Entity/ EntityFormTest.php, line 17
Namespace
Drupal\Tests\system\Functional\EntityView source
class EntityFormTest extends BrowserTestBase {
/**
* Modules to enable.
*
* @var array
*/
protected static $modules = [
'entity_test',
'language',
];
/**
* {@inheritdoc}
*/
protected $defaultTheme = 'stark';
protected function setUp() : void {
parent::setUp();
$web_user = $this
->drupalCreateUser([
'administer entity_test content',
'view test entity',
]);
$this
->drupalLogin($web_user);
// Add a language.
ConfigurableLanguage::createFromLangcode('ro')
->save();
}
/**
* Tests basic form CRUD functionality.
*/
public function testFormCRUD() {
// 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() {
// 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().
*
* @see entity_test_entity_form_mode_alter()
*/
public function testEntityFormModeAlter() {
// Create compact entity display.
EntityFormMode::create([
'id' => 'entity_test.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]"]');
}
/**
* 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() {
$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) {
$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, new FormattableMarkup('%entity_type: Entity found in the database.', [
'%entity_type' => $entity_type,
]));
$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, new FormattableMarkup('%entity_type: The entity has been modified.', [
'%entity_type' => $entity_type,
]));
$entity = $this
->loadEntityByName($entity_type, $name2);
$this
->assertNotNull($entity, new FormattableMarkup('%entity_type: Modified entity found in the database.', [
'%entity_type' => $entity_type,
]));
$this
->assertNotEquals($name1, $entity->name->value, new FormattableMarkup('%entity_type: The entity name has been modified.', [
'%entity_type' => $entity_type,
]));
$this
->drupalGet($entity_type . '/manage/' . $entity
->id() . '/edit');
$this
->clickLink('Delete');
$this
->submitForm([], 'Delete');
$entity = $this
->loadEntityByName($entity_type, $name2);
$this
->assertNull($entity, new FormattableMarkup('%entity_type: Entity not found in the database.', [
'%entity_type' => $entity_type,
]));
}
/**
* 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) {
$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, new FormattableMarkup('%entity_type: Entity found in the database.', [
'%entity_type' => $entity_type_id,
]));
// 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, new FormattableMarkup('%entity_type: The translation has been added.', [
'%entity_type' => $entity_type_id,
]));
$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, new FormattableMarkup('%entity_type: Modified translation found in the database.', [
'%entity_type' => $entity_type_id,
]));
$this
->assertEquals($name2_ro, $translated_entity->name->value, new FormattableMarkup('%entity_type: The name of the translation has been modified.', [
'%entity_type' => $entity_type_id,
]));
$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, new FormattableMarkup('%entity_type: The original entity still exists.', [
'%entity_type' => $entity_type_id,
]));
$this
->assertFalse($entity
->hasTranslation('ro'), new FormattableMarkup('%entity_type: Entity translation does not exist anymore.', [
'%entity_type' => $entity_type_id,
]));
}
/**
* 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() {
/** @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 was skipped.', $state
->get('entity_test.form.save.exception'), 'Button-level validation handlers behave correctly.');
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
BlockCreationTrait:: |
protected | function | Creates a block instance based on default settings. Aliased as: drupalPlaceBlock | |
BrowserHtmlDebugTrait:: |
protected | property | The Base URI to use for links to the output files. | |
BrowserHtmlDebugTrait:: |
protected | property | Class name for HTML output logging. | |
BrowserHtmlDebugTrait:: |
protected | property | Counter for HTML output logging. | |
BrowserHtmlDebugTrait:: |
protected | property | Counter storage for HTML output logging. | |
BrowserHtmlDebugTrait:: |
protected | property | Directory name for HTML output logging. | |
BrowserHtmlDebugTrait:: |
protected | property | HTML output enabled. | |
BrowserHtmlDebugTrait:: |
protected | property | The file name to write the list of URLs to. | |
BrowserHtmlDebugTrait:: |
protected | property | HTML output test ID. | |
BrowserHtmlDebugTrait:: |
protected | function | Formats HTTP headers as string for HTML output logging. | |
BrowserHtmlDebugTrait:: |
protected | function | Returns headers in HTML output format. | 1 |
BrowserHtmlDebugTrait:: |
protected | function | Provides a Guzzle middleware handler to log every response received. | |
BrowserHtmlDebugTrait:: |
protected | function | Logs a HTML output message in a text file. | |
BrowserHtmlDebugTrait:: |
protected | function | Creates the directory to store browser output. | |
BrowserTestBase:: |
protected | property | The base URL. | |
BrowserTestBase:: |
protected | property | The config importer that can be used in a test. | |
BrowserTestBase:: |
protected | property | An array of custom translations suitable for drupal_rewrite_settings(). | |
BrowserTestBase:: |
protected | property | The database prefix of this test run. | |
BrowserTestBase:: |
protected | property | Mink session manager. | |
BrowserTestBase:: |
protected | property | Mink default driver params. | |
BrowserTestBase:: |
protected | property | Mink class for the default driver to use. | 1 |
BrowserTestBase:: |
protected | property | The original container. | |
BrowserTestBase:: |
protected | property | The original array of shutdown function callbacks. | |
BrowserTestBase:: |
protected | property | ||
BrowserTestBase:: |
protected | property | The profile to install as a basis for testing. | 14 |
BrowserTestBase:: |
protected | property | The app root. | |
BrowserTestBase:: |
protected | property | Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests. | |
BrowserTestBase:: |
protected | property | Time limit in seconds for the test. | |
BrowserTestBase:: |
protected | property | The translation file directory for the test environment. | |
BrowserTestBase:: |
protected | function | Clean up the test environment. | |
BrowserTestBase:: |
protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |
BrowserTestBase:: |
public static | function | Ensures test files are deletable. | |
BrowserTestBase:: |
protected | function | Gets an instance of the default Mink driver. | |
BrowserTestBase:: |
protected | function | Gets the JavaScript drupalSettings variable for the currently-loaded page. | 1 |
BrowserTestBase:: |
protected | function | Obtain the HTTP client for the system under test. | |
BrowserTestBase:: |
protected | function | Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests. | 1 |
BrowserTestBase:: |
protected | function | Helper function to get the options of select field. | |
BrowserTestBase:: |
public | function | Returns Mink session. | |
BrowserTestBase:: |
protected | function | Get session cookies from current session. | |
BrowserTestBase:: |
protected | function |
Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait:: |
|
BrowserTestBase:: |
protected | function | Visits the front page when initializing Mink. | 3 |
BrowserTestBase:: |
protected | function | Initializes Mink sessions. | 1 |
BrowserTestBase:: |
public | function | Installs Drupal into the test site. | 1 |
BrowserTestBase:: |
protected | function | Registers additional Mink sessions. | |
BrowserTestBase:: |
protected | function | Sets up the root application path. | |
BrowserTestBase:: |
public static | function | ||
BrowserTestBase:: |
protected | function | 2 | |
BrowserTestBase:: |
protected | function | Transforms a nested array into a flat array suitable for submitForm(). | |
BrowserTestBase:: |
protected | function | Performs an xpath search on the contents of the internal browser. | |
BrowserTestBase:: |
public | function | Prevents serializing any properties. | |
ConfigTestTrait:: |
protected | function | Returns a ConfigImporter object to import test configuration. | |
ConfigTestTrait:: |
protected | function | Copies configuration objects from source storage to target storage. | |
ContentTypeCreationTrait:: |
protected | function | Creates a custom content type based on default settings. Aliased as: drupalCreateContentType | |
EntityFormTest:: |
protected | property |
The theme to install as the default for testing. Overrides BrowserTestBase:: |
|
EntityFormTest:: |
protected static | property |
Modules to enable. Overrides BrowserTestBase:: |
|
EntityFormTest:: |
protected | function | Executes the form CRUD tests for the given entity type. | |
EntityFormTest:: |
protected | function | Executes the multilingual form CRUD tests for the given entity type ID. | |
EntityFormTest:: |
protected | function | Loads a test entity by name always resetting the storage cache. | |
EntityFormTest:: |
protected | function |
Overrides BrowserTestBase:: |
|
EntityFormTest:: |
public | function | Tests hook_entity_form_display_alter(). | |
EntityFormTest:: |
public | function | Tests hook_entity_form_mode_alter(). | |
EntityFormTest:: |
public | function | Tests basic form CRUD functionality. | |
EntityFormTest:: |
public | function | Tests basic multilingual form CRUD functionality. | |
EntityFormTest:: |
public | function | Checks that validation handlers works as expected. | |
ExtensionListTestTrait:: |
protected | function | Gets the path for the specified module. | |
ExtensionListTestTrait:: |
protected | function | Gets the path for the specified theme. | |
FunctionalTestSetupTrait:: |
protected | property | The flag to set 'apcu_ensure_unique_prefix' setting. | 1 |
FunctionalTestSetupTrait:: |
protected | property | The class loader to use for installation and initialization of setup. | |
FunctionalTestSetupTrait:: |
protected | property | The "#1" admin user. | |
FunctionalTestSetupTrait:: |
protected | function | Execute the non-interactive installer. | 1 |
FunctionalTestSetupTrait:: |
protected | function | Returns all supported database driver installer objects. | |
FunctionalTestSetupTrait:: |
protected | function | Initialize various configurations post-installation. | |
FunctionalTestSetupTrait:: |
protected | function | Initializes the kernel after installation. | |
FunctionalTestSetupTrait:: |
protected | function | Initialize settings created during install. | |
FunctionalTestSetupTrait:: |
protected | function | Initializes user 1 for the site to be installed. | |
FunctionalTestSetupTrait:: |
protected | function | Installs the default theme defined by `static::$defaultTheme` when needed. | |
FunctionalTestSetupTrait:: |
protected | function | Install modules defined by `static::$modules`. | 1 |
FunctionalTestSetupTrait:: |
protected | function | Returns the parameters that will be used when the test installs Drupal. | 4 |
FunctionalTestSetupTrait:: |
protected | function | Prepares the current environment for running the test. | 21 |
FunctionalTestSetupTrait:: |
protected | function | Creates a mock request and sets it on the generator. | |
FunctionalTestSetupTrait:: |
protected | function | Prepares site settings and services before installation. | 3 |
FunctionalTestSetupTrait:: |
protected | function | Resets and rebuilds the environment after setup. | |
FunctionalTestSetupTrait:: |
protected | function | Rebuilds \Drupal::getContainer(). | |
FunctionalTestSetupTrait:: |
protected | function | Resets all data structures after having enabled new modules. | |
FunctionalTestSetupTrait:: |
protected | function | Changes parameters in the services.yml file. | |
FunctionalTestSetupTrait:: |
protected | function | Sets up the base URL based upon the environment variable. | |
FunctionalTestSetupTrait:: |
protected | function | Rewrites the settings.php file of the test site. | 1 |
NodeCreationTrait:: |
protected | function | Creates a node based on default settings. Aliased as: drupalCreateNode | |
NodeCreationTrait:: |
public | function | Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle | |
PhpUnitWarnings:: |
private static | property | Deprecation warnings from PHPUnit to raise with @trigger_error(). | |
PhpUnitWarnings:: |
public | function | Converts PHPUnit deprecation warnings to E_USER_DEPRECATED. | |
RandomGeneratorTrait:: |
protected | property | The random generator. | |
RandomGeneratorTrait:: |
protected | function | Gets the random generator for the utility methods. | |
RandomGeneratorTrait:: |
protected | function | Generates a unique random string containing letters and numbers. | |
RandomGeneratorTrait:: |
public | function | Generates a random PHP object. | |
RandomGeneratorTrait:: |
public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |
RandomGeneratorTrait:: |
public | function | Callback for random string validation. | |
RefreshVariablesTrait:: |
protected | function | Refreshes in-memory configuration and state information. | 1 |
SessionTestTrait:: |
protected | property | The name of the session cookie. | |
SessionTestTrait:: |
protected | function | Generates a session cookie name. | |
SessionTestTrait:: |
protected | function | Returns the session name in use on the child site. | |
StorageCopyTrait:: |
protected static | function | Copy the configuration from one storage to another and remove stale items. | |
TestRequirementsTrait:: |
private | function | Checks missing module requirements. | |
TestRequirementsTrait:: |
protected | function | Check module requirements for the Drupal use case. | |
TestRequirementsTrait:: |
protected static | function | Returns the Drupal root directory. | |
TestSetupTrait:: |
protected static | property | An array of config object names that are excluded from schema checking. | |
TestSetupTrait:: |
protected | property | The dependency injection container used in the test. | |
TestSetupTrait:: |
protected | property | The DrupalKernel instance used in the test. | |
TestSetupTrait:: |
protected | property | The site directory of the original parent site. | |
TestSetupTrait:: |
protected | property | The private file directory for the test environment. | |
TestSetupTrait:: |
protected | property | The public file directory for the test environment. | |
TestSetupTrait:: |
protected | property | The site directory of this test run. | |
TestSetupTrait:: |
protected | property | Set to TRUE to strict check all configuration saved. | 1 |
TestSetupTrait:: |
protected | property | The temporary file directory for the test environment. | |
TestSetupTrait:: |
protected | property | The test run ID. | |
TestSetupTrait:: |
protected | function | Changes the database connection to the prefixed one. | |
TestSetupTrait:: |
protected | function | Gets the config schema exclusions for this test. | |
TestSetupTrait:: |
public static | function | Returns the database connection to the site under test. | |
TestSetupTrait:: |
protected | function | Generates a database prefix for running tests. | 1 |
UiHelperTrait:: |
protected | property | The current user logged in using the Mink controlled browser. | |
UiHelperTrait:: |
protected | property | The number of meta refresh redirects to follow, or NULL if unlimited. | |
UiHelperTrait:: |
protected | property | The number of meta refresh redirects followed during ::drupalGet(). | |
UiHelperTrait:: |
public | function | Returns WebAssert object. | 1 |
UiHelperTrait:: |
protected | function | Builds an absolute URL from a system path or a URL object. | |
UiHelperTrait:: |
protected | function | Checks for meta refresh tag and if found call drupalGet() recursively. | |
UiHelperTrait:: |
protected | function | Clicks the element with the given CSS selector. | |
UiHelperTrait:: |
protected | function | Follows a link by complete name. | |
UiHelperTrait:: |
protected | function | Searches elements using a CSS selector in the raw content. | |
UiHelperTrait:: |
protected | function | Translates a CSS expression to its XPath equivalent. | |
UiHelperTrait:: |
protected | function | Retrieves a Drupal path or an absolute path. | |
UiHelperTrait:: |
protected | function | Logs in a user using the Mink controlled browser. | |
UiHelperTrait:: |
protected | function | Logs a user out of the Mink controlled browser and confirms. | |
UiHelperTrait:: |
protected | function | Returns whether a given user account is logged in. | |
UiHelperTrait:: |
protected | function | Takes a path and returns an absolute path. | |
UiHelperTrait:: |
protected | function | Retrieves the plain-text content from the current page. | |
UiHelperTrait:: |
protected | function | Get the current URL from the browser. | |
UiHelperTrait:: |
protected | function | Determines if test is using DrupalTestBrowser. | |
UiHelperTrait:: |
protected | function | Prepare for a request to testing site. | 1 |
UiHelperTrait:: |
protected | function | Fills and submits a form. | |
UserCreationTrait:: |
protected | function | Checks whether a given list of permission names is valid. | |
UserCreationTrait:: |
protected | function | Creates an administrative role. | |
UserCreationTrait:: |
protected | function | Creates a role with specified permissions. Aliased as: drupalCreateRole | |
UserCreationTrait:: |
protected | function | Create a user with a given set of permissions. Aliased as: drupalCreateUser | |
UserCreationTrait:: |
protected | function | Grant permissions to a user role. | |
UserCreationTrait:: |
protected | function | Switch the current logged in user. | |
UserCreationTrait:: |
protected | function | Creates a random user account and sets it as current user. | |
XdebugRequestTrait:: |
protected | function | Adds xdebug cookies, from request setup. |