class EntityUUIDTest

Tests creation, saving, and loading of entity UUIDs.

Hierarchy

Expanded class hierarchy of EntityUUIDTest

File

drupal/core/modules/system/lib/Drupal/system/Tests/Entity/EntityUUIDTest.php, line 15
Definition of Drupal\system\Tests\Entity\EntityUUIDTest.

Namespace

Drupal\system\Tests\Entity
View source
class EntityUUIDTest extends EntityUnitTestBase {
  public static function getInfo() {
    return array(
      'name' => 'Entity UUIDs',
      'description' => 'Tests creation, saving, and loading of entity UUIDs.',
      'group' => 'Entity API',
    );
  }
  public function setUp() {
    parent::setUp();
    $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',
    ));
  }

  /**
   * Tests UUID generation in entity CRUD operations.
   */
  function testCRUD() {

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

  /**
   * Executes the UUID CRUD tests for the given entity type.
   *
   * @param string $entity_type
   *   The entity type to run the tests with.
   */
  protected function assertCRUD($entity_type) {

    // Verify that no UUID is auto-generated when passing one for creation.
    $uuid_service = new Uuid();
    $uuid = $uuid_service
      ->generate();
    $custom_entity = entity_create($entity_type, array(
      'name' => $this
        ->randomName(),
      'uuid' => $uuid,
    ));
    $this
      ->assertIdentical($custom_entity
      ->uuid(), $uuid);

    // Save this entity, so we have more than one later.
    $custom_entity
      ->save();

    // Verify that a new UUID is generated upon creating an entity.
    $entity = entity_create($entity_type, array(
      'name' => $this
        ->randomName(),
    ));
    $uuid = $entity
      ->uuid();
    $this
      ->assertTrue($uuid);

    // Verify that the new UUID is different.
    $this
      ->assertNotEqual($custom_entity
      ->uuid(), $uuid);

    // Verify that the UUID is retained upon saving.
    $entity
      ->save();
    $this
      ->assertIdentical($entity
      ->uuid(), $uuid);

    // Verify that the UUID is retained upon loading.
    $entity_loaded = entity_load($entity_type, $entity
      ->id(), TRUE);
    $this
      ->assertIdentical($entity_loaded
      ->uuid(), $uuid);

    // Verify that entity_load_by_uuid() loads the same entity.
    $entity_loaded_by_uuid = entity_load_by_uuid($entity_type, $uuid, TRUE);
    $this
      ->assertIdentical($entity_loaded_by_uuid
      ->uuid(), $uuid);
    $this
      ->assertEqual($entity_loaded_by_uuid
      ->id(), $entity_loaded
      ->id());

    // Creating a duplicate needs to result in a new UUID.
    $entity_duplicate = $entity
      ->createDuplicate();
    foreach ($entity
      ->getProperties() as $property => $value) {
      switch ($property) {
        case 'uuid':
          $this
            ->assertNotNull($entity_duplicate
            ->uuid());
          $this
            ->assertNotNull($entity
            ->uuid());
          $this
            ->assertNotEqual($entity_duplicate
            ->uuid(), $entity
            ->uuid());
          break;
        case 'id':
          $this
            ->assertNull($entity_duplicate
            ->id());
          $this
            ->assertNotNull($entity
            ->id());
          $this
            ->assertNotEqual($entity_duplicate
            ->id(), $entity
            ->id());
          break;
        case 'revision_id':
          $this
            ->assertNull($entity_duplicate
            ->getRevisionId());
          $this
            ->assertNotNull($entity
            ->getRevisionId());
          $this
            ->assertNotEqual($entity_duplicate
            ->getRevisionId(), $entity
            ->getRevisionId());
          $this
            ->assertNotEqual($entity_duplicate->{$property}
            ->getValue(), $entity->{$property}
            ->getValue());
          break;
        default:
          $this
            ->assertEqual($entity_duplicate->{$property}
            ->getValue(), $entity->{$property}
            ->getValue());
      }
    }
    $entity_duplicate
      ->save();
    $this
      ->assertNotEqual($entity
      ->id(), $entity_duplicate
      ->id());
  }

}

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::$modules public static property Modules to enable. Overrides DrupalUnitTestBase::$modules 11
EntityUnitTestBase::createUser protected function Creates a user.
EntityUUIDTest::assertCRUD protected function Executes the UUID CRUD tests for the given entity type.
EntityUUIDTest::getInfo public static function
EntityUUIDTest::setUp public function Sets up Drupal unit test environment. Overrides EntityUnitTestBase::setUp
EntityUUIDTest::testCRUD function Tests UUID generation in entity CRUD operations.
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