class EntityValidationTest

Tests Entity API base functionality.

Hierarchy

Expanded class hierarchy of EntityValidationTest

File

drupal/core/modules/system/lib/Drupal/system/Tests/Entity/EntityValidationTest.php, line 18
Contains \Drupal\system\Tests\Entity\EntityValidationTest.

Namespace

Drupal\system\Tests\Entity
View source
class EntityValidationTest extends EntityUnitTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = array(
    'filter',
    'text',
  );
  public static function getInfo() {
    return array(
      'name' => 'Entity Validation API',
      'description' => 'Tests the Entity Validation API',
      'group' => 'Entity API',
    );
  }

  /**
   * {@inheritdoc}
   */
  public function setUp() {
    parent::setUp();
    $this
      ->installSchema('user', array(
      'users_roles',
      'users_data',
    ));
    $this
      ->installSchema('entity_test', array(
      'entity_test_mul',
      'entity_test_mul_property_data',
      'entity_test_rev',
      'entity_test_rev_revision',
      'entity_test_mulrev',
      'entity_test_mulrev_property_data',
      'entity_test_mulrev_property_revision',
    ));

    // Create the test field.
    entity_test_install();

    // Install required default configuration for filter module.
    $this
      ->installConfig(array(
      '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->entity_name = $this
      ->randomName();
    $this->entity_user = $this
      ->createUser();
    $this->entity_field_text = $this
      ->randomName();

    // Pass in the value of the name field when creating. With the user
    // field we test setting a field after creation.
    $entity = entity_create($entity_type, array());
    $entity->user_id->target_id = $this->entity_user->uid;
    $entity->name->value = $this->entity_name;

    // Set a value for the test field.
    $entity->field_test_text->value = $this->entity_field_text;
    return $entity;
  }

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

    // 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
      ->assertEqual($violations
      ->count(), 0, 'Validation passes.');

    // Test triggering a fail for each of the constraints specified.
    $test_entity = clone $entity;
    $test_entity->uuid->value = $this
      ->randomString(129);
    $violations = $test_entity
      ->validate();
    $this
      ->assertEqual($violations
      ->count(), 1, 'Validation failed.');
    $this
      ->assertEqual($violations[0]
      ->getMessage(), t('This value is too long. It should have %limit characters or less.', array(
      '%limit' => '128',
    )));
    $test_entity = clone $entity;
    $test_entity->langcode->value = $this
      ->randomString(13);
    $violations = $test_entity
      ->validate();
    $this
      ->assertEqual($violations
      ->count(), 1, 'Validation failed.');
    $this
      ->assertEqual($violations[0]
      ->getMessage(), t('This value is too long. It should have %limit characters or less.', array(
      '%limit' => '12',
    )));
    $test_entity = clone $entity;
    $test_entity->type->value = NULL;
    $violations = $test_entity
      ->validate();
    $this
      ->assertEqual($violations
      ->count(), 1, 'Validation failed.');
    $this
      ->assertEqual($violations[0]
      ->getMessage(), t('This value should not be null.'));
    $test_entity = clone $entity;
    $test_entity->name->value = $this
      ->randomString(33);
    $violations = $test_entity
      ->validate();
    $this
      ->assertEqual($violations
      ->count(), 1, 'Validation failed.');
    $this
      ->assertEqual($violations[0]
      ->getMessage(), t('This value is too long. It should have %limit characters or less.', array(
      '%limit' => '32',
    )));

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

}

Members

Namesort descending Modifiers Type Description Overrides
DrupalUnitTestBase::$keyValueFactory protected property A KeyValueMemoryFactory instance to use when building the container.
DrupalUnitTestBase::$moduleFiles private property
DrupalUnitTestBase::$themeData private property
DrupalUnitTestBase::$themeFiles private property
DrupalUnitTestBase::containerBuild public function Sets up the base service container for this test. 1
DrupalUnitTestBase::disableModules protected function Disables modules for this test.
DrupalUnitTestBase::enableModules protected function Enables modules for this test.
DrupalUnitTestBase::installConfig protected function Installs default configuration for a given list of modules.
DrupalUnitTestBase::installSchema protected function Installs a specific table from a module schema definition.
DrupalUnitTestBase::tearDown protected function Deletes created files, database tables, and reverts all environment changes. Overrides TestBase::tearDown 2
DrupalUnitTestBase::__construct function Overrides \Drupal\simpletest\UnitTestBase::__construct(). Overrides UnitTestBase::__construct
EntityUnitTestBase::createUser protected function Creates a user.
EntityValidationTest::$modules public static property Modules to enable. Overrides EntityUnitTestBase::$modules
EntityValidationTest::checkValidation protected function Executes the validation test set for a defined entity type.
EntityValidationTest::createTestEntity protected function Creates a test entity.
EntityValidationTest::getInfo public static function
EntityValidationTest::setUp public function Sets up Drupal unit test environment. Overrides EntityUnitTestBase::setUp
EntityValidationTest::testValidation public function Tests validating test entity types.
TestBase::$assertions protected property Assertions thrown in that test case.
TestBase::$configImporter protected property The config importer that can used in a test. 1
TestBase::$container protected property The dependency injection container used in the test. 1
TestBase::$databasePrefix protected property The database prefix of this test run.
TestBase::$dieOnFail public property Whether to die in case any test assertion fails.
TestBase::$originalFileDirectory protected property The original file directory, before it was changed for testing purposes.
TestBase::$originalPrefix protected property The original database prefix when running inside Simpletest.
TestBase::$originalSettings protected property The settings array.
TestBase::$public_files_directory protected property The public file directory for the test environment.
TestBase::$results public property Current results of this test case.
TestBase::$setup protected property Flag to indicate whether the test has been set up.
TestBase::$setupDatabasePrefix protected property
TestBase::$setupEnvironment protected property
TestBase::$skipClasses protected property This class is skipped when looking for the source of an assertion.
TestBase::$testId protected property The test run ID.
TestBase::$timeLimit protected property Time limit for the test.
TestBase::$verbose protected property TRUE if verbose debugging is enabled.
TestBase::$verboseClassName protected property Safe class name for use in verbose output filenames.
TestBase::$verboseDirectory protected property Directory where verbose output files are put.
TestBase::$verboseDirectoryUrl protected property URL to the verbose output file directory.
TestBase::$verboseId protected property Incrementing identifier for verbose output filenames.
TestBase::assert protected function Internal helper: stores the assert.
TestBase::assertEqual protected function Check to see if two values are equal.
TestBase::assertFalse protected function Check to see if a value is false (an empty string, 0, NULL, or FALSE).
TestBase::assertIdentical protected function Check to see if two values are identical.
TestBase::assertIdenticalObject protected function Checks to see if two objects are identical.
TestBase::assertNotEqual protected function Check to see if two values are not equal.
TestBase::assertNotIdentical protected function Check to see if two values are not identical.
TestBase::assertNotNull protected function Check to see if a value is not NULL.
TestBase::assertNull protected function Check to see if a value is NULL.
TestBase::assertTrue protected function Check to see if a value is not false (not an empty string, 0, NULL, or FALSE).
TestBase::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestBase::checkRequirements protected function Checks the matching requirements for Test. 4
TestBase::configImporter public function Returns a ConfigImporter object to import test importing of configuration. 1
TestBase::copyConfig public function Copies configuration objects from source storage to target storage.
TestBase::deleteAssert public static function Delete an assertion record by message ID.
TestBase::error protected function Fire an error assertion. 1
TestBase::errorHandler public function Handle errors during test runs.
TestBase::exceptionHandler protected function Handle exceptions.
TestBase::fail protected function Fire an assertion that is always negative.
TestBase::filePreDeleteCallback public static function Ensures test files are deletable within file_unmanaged_delete_recursive().
TestBase::generatePermutations public static function Converts a list of possible parameters into a stack of permutations.
TestBase::getAssertionCall protected function Cycles through backtrace until the first non-assertion method is found.
TestBase::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestBase::insertAssert public static function Store an assertion from outside the testing context.
TestBase::pass protected function Fire an assertion that is always positive.
TestBase::prepareConfigDirectories protected function Create and set new configuration directories. 1
TestBase::prepareDatabasePrefix protected function Generates a database prefix for running tests.
TestBase::prepareEnvironment protected function Prepares the current environment for running the test.
TestBase::randomName public static function Generates a random string containing letters and numbers.
TestBase::randomObject public static function Generates a random PHP object.
TestBase::randomString public static function Generates a random string of ASCII characters of codes 32 to 126.
TestBase::rebuildContainer protected function Rebuild drupal_container(). 1
TestBase::run public function Run all tests in this class.
TestBase::settingsSet protected function Changes in memory settings.
TestBase::verbose protected function Logs verbose message in a text file.
UnitTestBase::$configDirectories protected property