You are here

Home » API reference » Drupal 9 » EntityValidationTest.php

class EntityValidationTest in Drupal 9

Same name and namespace in other branches
  1. 8 core/tests/Drupal/KernelTests/Core/Entity/EntityValidationTest.php \Drupal\KernelTests\Core\Entity\EntityValidationTest

Tests the Entity Validation API.

@group Entity

Hierarchy

Expanded class hierarchy of EntityValidationTest

File

core/tests/Drupal/KernelTests/Core/Entity/EntityValidationTest.php, line 13

Namespace

Drupal\KernelTests\Core\Entity
View source 
class EntityValidationTest extends EntityKernelTestBase {

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

  /**
   * @var string
   */
  protected $entityName;

  /**
   * @var \Drupal\user\Entity\User
   */
  protected $entityUser;

  /**
   * @var string
   */
  protected $entityFieldText;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();

    // Enable an additional language.
    ConfigurableLanguage::createFromLangcode('de')
      ->save();
    $this
      ->installEntitySchema('entity_test_mul');
    $this
      ->installEntitySchema('entity_test_mul_langcode_key');
    $this
      ->installEntitySchema('entity_test_mul_changed');
    $this
      ->installEntitySchema('entity_test_rev');
    $this
      ->installEntitySchema('entity_test_mulrev');
    $this
      ->installEntitySchema('entity_test_mulrev_changed');

    // Create the test field.
    module_load_install('entity_test');
    entity_test_install();

    // Install required default configuration for filter module.
    $this
      ->installConfig([
      'system',
      'filter',
    ]);
  }

  /**
   * Creates a test entity.
   *
   * @param string $entity_type
   *   An entity type.
   *
   * @return \Drupal\Core\Entity\EntityInterface
   *   The created test entity.
   */
  protected function createTestEntity($entity_type) {
    $this->entityName = $this
      ->randomMachineName();
    $this->entityUser = $this
      ->createUser();

    // Pass in the value of the name field when creating. With the user
    // field we test setting a field after creation.
    $entity = $this->container
      ->get('entity_type.manager')
      ->getStorage($entity_type)
      ->create();
    $entity->user_id->target_id = $this->entityUser
      ->id();
    $entity->name->value = $this->entityName;

    // Set a value for the test field.
    if ($entity
      ->hasField('field_test_text')) {
      $this->entityFieldText = $this
        ->randomMachineName();
      $entity->field_test_text->value = $this->entityFieldText;
    }
    return $entity;
  }

  /**
   * Tests validating test entity types.
   */
  public function testValidation() {

    // Ensure that the constraint manager is marked as cached cleared.
    // Use the protected property on the cache_clearer first to check whether
    // the constraint manager is added there.
    // Ensure that the proxy class is initialized, which has the necessary
    // method calls attached.
    \Drupal::service('plugin.cache_clearer');
    $plugin_cache_clearer = \Drupal::service('drupal.proxy_original_service.plugin.cache_clearer');
    $get_cached_discoveries = function () {
      return $this->cachedDiscoveries;
    };
    $get_cached_discoveries = $get_cached_discoveries
      ->bindTo($plugin_cache_clearer, $plugin_cache_clearer);
    $cached_discoveries = $get_cached_discoveries();
    $cached_discovery_classes = [];
    foreach ($cached_discoveries as $cached_discovery) {
      $cached_discovery_classes[] = get_class($cached_discovery);
    }
    $this
      ->assertContains('Drupal\\Core\\Validation\\ConstraintManager', $cached_discovery_classes);

    // All entity variations have to have the same results.
    foreach (entity_test_entity_types() as $entity_type) {
      $this
        ->checkValidation($entity_type);
    }
  }

  /**
   * Executes the validation test set for a defined entity type.
   *
   * @param string $entity_type
   *   The entity type to run the tests with.
   */
  protected function checkValidation($entity_type) {
    $entity = $this
      ->createTestEntity($entity_type);
    $violations = $entity
      ->validate();
    $this
      ->assertEquals(0, $violations
      ->count(), 'Validation passes.');

    // Test triggering a fail for each of the constraints specified.
    $test_entity = clone $entity;
    $test_entity->id->value = -1;
    $violations = $test_entity
      ->validate();
    $this
      ->assertEquals(1, $violations
      ->count(), 'Validation failed.');
    $this
      ->assertEquals(t('%name: The integer must be larger or equal to %min.', [
      '%name' => 'ID',
      '%min' => 0,
    ]), $violations[0]
      ->getMessage());
    $test_entity = clone $entity;
    $test_entity->uuid->value = $this
      ->randomString(129);
    $violations = $test_entity
      ->validate();
    $this
      ->assertEquals(1, $violations
      ->count(), 'Validation failed.');
    $this
      ->assertEquals(t('%name: may not be longer than @max characters.', [
      '%name' => 'UUID',
      '@max' => 128,
    ]), $violations[0]
      ->getMessage());
    $test_entity = clone $entity;
    $langcode_key = $this->entityTypeManager
      ->getDefinition($entity_type)
      ->getKey('langcode');
    $test_entity->{$langcode_key}->value = $this
      ->randomString(13);
    $violations = $test_entity
      ->validate();

    // This should fail on AllowedValues and Length constraints.
    $this
      ->assertEquals(2, $violations
      ->count(), 'Validation failed.');
    $this
      ->assertEquals(t('This value is too long. It should have %limit characters or less.', [
      '%limit' => '12',
    ]), $violations[0]
      ->getMessage());
    $this
      ->assertEquals('The value you selected is not a valid choice.', $violations[1]
      ->getMessage());
    $test_entity = clone $entity;
    $test_entity->type->value = NULL;
    $violations = $test_entity
      ->validate();
    $this
      ->assertEquals(1, $violations
      ->count(), 'Validation failed.');
    $this
      ->assertEquals('This value should not be null.', $violations[0]
      ->getMessage());
    $test_entity = clone $entity;
    $test_entity->name->value = $this
      ->randomString(33);
    $violations = $test_entity
      ->validate();
    $this
      ->assertEquals(1, $violations
      ->count(), 'Validation failed.');
    $this
      ->assertEquals(t('%name: may not be longer than @max characters.', [
      '%name' => 'Name',
      '@max' => 32,
    ]), $violations[0]
      ->getMessage());

    // Make sure the information provided by a violation is correct.
    $violation = $violations[0];
    $this
      ->assertEquals($test_entity, $violation
      ->getRoot()
      ->getValue(), 'Violation root is entity.');
    $this
      ->assertEquals('name.0.value', $violation
      ->getPropertyPath(), 'Violation property path is correct.');
    $this
      ->assertEquals($test_entity->name->value, $violation
      ->getInvalidValue(), 'Violation contains invalid value.');
    $test_entity = clone $entity;
    $test_entity
      ->set('user_id', 9999);
    $violations = $test_entity
      ->validate();
    $this
      ->assertEquals(1, $violations
      ->count(), 'Validation failed.');
    $this
      ->assertEquals(t('The referenced entity (%type: %id) does not exist.', [
      '%type' => 'user',
      '%id' => 9999,
    ]), $violations[0]
      ->getMessage());
    $test_entity = clone $entity;
    $test_entity->field_test_text->format = $this
      ->randomString(33);
    $violations = $test_entity
      ->validate();
    $this
      ->assertEquals(1, $violations
      ->count(), 'Validation failed.');
    $this
      ->assertEquals('The value you selected is not a valid choice.', $violations[0]
      ->getMessage());

    // Make sure the information provided by a violation is correct.
    $violation = $violations[0];
    $this
      ->assertEquals($test_entity, $violation
      ->getRoot()
      ->getValue(), 'Violation root is entity.');
    $this
      ->assertEquals('field_test_text.0.format', $violation
      ->getPropertyPath(), 'Violation property path is correct.');
    $this
      ->assertEquals($test_entity->field_test_text->format, $violation
      ->getInvalidValue(), 'Violation contains invalid value.');
  }

  /**
   * Tests composite constraints.
   */
  public function testCompositeConstraintValidation() {
    $entity = $this
      ->createTestEntity('entity_test_composite_constraint');
    $violations = $entity
      ->validate();
    $this
      ->assertEquals(0, $violations
      ->count());

    // Trigger violation condition.
    $entity->name->value = 'test';
    $entity->type->value = 'test2';
    $violations = $entity
      ->validate();
    $this
      ->assertEquals(1, $violations
      ->count());

    // Make sure we can determine this is composite constraint.
    $constraint = $violations[0]
      ->getConstraint();
    $this
      ->assertInstanceOf(CompositeConstraintBase::class, $constraint);
    $this
      ->assertEquals('type', $violations[0]
      ->getPropertyPath());

    /** @var \Drupal\Core\Entity\Plugin\Validation\Constraint\CompositeConstraintBase $constraint */
    $this
      ->assertEquals([
      'name',
      'type',
    ], $constraint
      ->coversFields(), 'Information about covered fields can be retrieved.');
  }

  /**
   * Tests the EntityChangedConstraintValidator with multiple translations.
   */
  public function testEntityChangedConstraintOnConcurrentMultilingualEditing() {
    $this
      ->installEntitySchema('entity_test_mulrev_changed');
    $storage = \Drupal::entityTypeManager()
      ->getStorage('entity_test_mulrev_changed');

    // Create a test entity.
    $entity = $this
      ->createTestEntity('entity_test_mulrev_changed');
    $entity
      ->save();
    $entity
      ->setChangedTime($entity
      ->getChangedTime() - 1);
    $violations = $entity
      ->validate();
    $this
      ->assertEquals(1, $violations
      ->count());
    $this
      ->assertEquals('The content has either been modified by another user, or you have already submitted modifications. As a result, your changes cannot be saved.', $violations[0]
      ->getMessage());
    $entity = $storage
      ->loadUnchanged($entity
      ->id());
    $translation = $entity
      ->addTranslation('de');
    $entity
      ->save();

    // Ensure that the new translation has a newer changed timestamp than the
    // default translation.
    $this
      ->assertGreaterThan($entity
      ->getChangedTime(), $translation
      ->getChangedTime());

    // Simulate concurrent form editing by saving the entity with an altered
    // non-translatable field in order for the changed timestamp to be updated
    // across all entity translations.
    $original_entity_time = $entity
      ->getChangedTime();
    $entity
      ->set('not_translatable', $this
      ->randomString());
    $entity
      ->save();

    // Simulate form submission of an uncached form by setting the previous
    // timestamp of an entity translation on the saved entity object. This
    // happens in the entity form API where we put the changed timestamp of
    // the entity in a form hidden value and then set it on the entity which on
    // form submit is loaded from the storage if the form is not yet cached.
    $entity
      ->setChangedTime($original_entity_time);

    // Setting the changed timestamp from the user input on the entity loaded
    // from the storage is used as a prevention from saving a form built with a
    // previous version of the entity and thus reverting changes by other users.
    $violations = $entity
      ->validate();
    $this
      ->assertEquals(1, $violations
      ->count());
    $this
      ->assertEquals('The content has either been modified by another user, or you have already submitted modifications. As a result, your changes cannot be saved.', $violations[0]
      ->getMessage());
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated protected function
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.
EntityKernelTestBase::$entityTypeManager protected property The entity type manager service. 1
EntityKernelTestBase::$generatedIds protected property A list of generated identifiers.
EntityKernelTestBase::$state protected property The state service.
EntityKernelTestBase::createUser protected function Creates a user.
EntityKernelTestBase::generateRandomEntityId protected function Generates a random ID avoiding collisions.
EntityKernelTestBase::getHooksInfo protected function Returns the entity_test hook invocation info.
EntityKernelTestBase::installModule protected function Installs a module and refreshes services.
EntityKernelTestBase::refreshServices protected function Refresh services. 1
EntityKernelTestBase::reloadEntity protected function Reloads the given entity from the storage and returns it.
EntityKernelTestBase::uninstallModule protected function Uninstalls a module and refreshes services.
EntityValidationTest::$entityFieldText protected property
EntityValidationTest::$entityName protected property
EntityValidationTest::$entityUser protected property
EntityValidationTest::$modules protected static property Modules to enable. Overrides EntityKernelTestBase::$modules
EntityValidationTest::checkValidation protected function Executes the validation test set for a defined entity type.
EntityValidationTest::createTestEntity protected function Creates a test entity.
EntityValidationTest::setUp protected function Overrides EntityKernelTestBase::setUp
EntityValidationTest::testCompositeConstraintValidation public function Tests composite constraints.
EntityValidationTest::testEntityChangedConstraintOnConcurrentMultilingualEditing public function Tests the EntityChangedConstraintValidator with multiple translations.
EntityValidationTest::testValidation public function Tests validating test entity types.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 7
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 6
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel private function Bootstraps a kernel for a test.
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 3
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 24
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 4
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__sleep public function Prevents serializing any properties.
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. 1
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.
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. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid. Aliased as: drupalCheckPermissions
UserCreationTrait::createAdminRole protected function Creates an administrative role. Aliased as: drupalCreateAdminRole
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. Aliased as: drupalGrantPermissions
UserCreationTrait::setCurrentUser protected function Switch the current logged in user. Aliased as: drupalSetCurrentUser
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user. Aliased as: drupalSetUpCurrentUser