class EntityApiTest

Tests the basic Entity API.

Hierarchy

Expanded class hierarchy of EntityApiTest

File

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

Namespace

Drupal\system\Tests\Entity
View source
class EntityApiTest extends EntityUnitTestBase {
  public static function getInfo() {
    return array(
      'name' => 'Entity CRUD',
      'description' => 'Tests basic CRUD functionality.',
      '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 basic CRUD functionality of the Entity API.
   */
  public function testCRUD() {

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

  /**
   * Executes a test set for a defined entity type and user.
   *
   * @param string $entity_type
   *   The entity type to run the tests with.
   * @param \Drupal\user\UserInterface $user1
   *   The user to run the tests with.
   */
  protected function assertCRUD($entity_type, UserInterface $user1) {

    // Create some test entities.
    $entity = entity_create($entity_type, array(
      'name' => 'test',
      'user_id' => $user1->uid,
    ));
    $entity
      ->save();
    $entity = entity_create($entity_type, array(
      'name' => 'test2',
      'user_id' => $user1->uid,
    ));
    $entity
      ->save();
    $entity = entity_create($entity_type, array(
      'name' => 'test',
      'user_id' => NULL,
    ));
    $entity
      ->save();
    $entities = array_values(entity_load_multiple_by_properties($entity_type, array(
      'name' => 'test',
    )));
    $this
      ->assertEqual($entities[0]->name->value, 'test', format_string('%entity_type: Created and loaded entity', array(
      '%entity_type' => $entity_type,
    )));
    $this
      ->assertEqual($entities[1]->name->value, 'test', format_string('%entity_type: Created and loaded entity', array(
      '%entity_type' => $entity_type,
    )));

    // Test loading a single entity.
    $loaded_entity = entity_load($entity_type, $entity
      ->id());
    $this
      ->assertEqual($loaded_entity
      ->id(), $entity
      ->id(), format_string('%entity_type: Loaded a single entity by id.', array(
      '%entity_type' => $entity_type,
    )));

    // Test deleting an entity.
    $entities = array_values(entity_load_multiple_by_properties($entity_type, array(
      'name' => 'test2',
    )));
    $entities[0]
      ->delete();
    $entities = array_values(entity_load_multiple_by_properties($entity_type, array(
      'name' => 'test2',
    )));
    $this
      ->assertEqual($entities, array(), format_string('%entity_type: Entity deleted.', array(
      '%entity_type' => $entity_type,
    )));

    // Test updating an entity.
    $entities = array_values(entity_load_multiple_by_properties($entity_type, array(
      'name' => 'test',
    )));
    $entities[0]->name->value = 'test3';
    $entities[0]
      ->save();
    $entity = entity_load($entity_type, $entities[0]
      ->id());
    $this
      ->assertEqual($entity->name->value, 'test3', format_string('%entity_type: Entity updated.', array(
      '%entity_type' => $entity_type,
    )));

    // Try deleting multiple test entities by deleting all.
    $ids = array_keys(entity_load_multiple($entity_type));
    entity_delete_multiple($entity_type, $ids);
    $all = entity_load_multiple($entity_type);
    $this
      ->assertTrue(empty($all), format_string('%entity_type: Deleted all entities.', array(
      '%entity_type' => $entity_type,
    )));
  }

  /**
   * Tests that exceptions are properly thrown when saving or deleting an
   * entity.
   */
  public function testEntityStorageExceptionHandling() {
    $entity = entity_create('entity_test', array(
      'name' => 'test',
    ));
    try {
      $GLOBALS['entity_test_throw_exception'] = TRUE;
      $entity
        ->save();
      $this
        ->fail('Entity presave EntityStorageException thrown but not caught.');
    } catch (EntityStorageException $e) {
      $this
        ->assertEqual($e
        ->getcode(), 1, 'Entity presave EntityStorageException caught.');
    }
    $entity = entity_create('entity_test', array(
      'name' => 'test2',
    ));
    try {
      unset($GLOBALS['entity_test_throw_exception']);
      $entity
        ->save();
      $this
        ->pass('Exception presave not thrown and not caught.');
    } catch (EntityStorageException $e) {
      $this
        ->assertNotEqual($e
        ->getCode(), 1, 'Entity presave EntityStorageException caught.');
    }
    $entity = entity_create('entity_test', array(
      'name' => 'test3',
    ));
    $entity
      ->save();
    try {
      $GLOBALS['entity_test_throw_exception'] = TRUE;
      $entity
        ->delete();
      $this
        ->fail('Entity predelete EntityStorageException not thrown.');
    } catch (EntityStorageException $e) {
      $this
        ->assertEqual($e
        ->getCode(), 2, 'Entity predelete EntityStorageException caught.');
    }
    unset($GLOBALS['entity_test_throw_exception']);
    $entity = entity_create('entity_test', array(
      'name' => 'test4',
    ));
    $entity
      ->save();
    try {
      $entity
        ->delete();
      $this
        ->pass('Entity predelete EntityStorageException not thrown and not caught.');
    } catch (EntityStorageException $e) {
      $this
        ->assertNotEqual($e
        ->getCode(), 2, 'Entity predelete EntityStorageException thrown.');
    }
  }

}

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
EntityApiTest::assertCRUD protected function Executes a test set for a defined entity type and user.
EntityApiTest::getInfo public static function
EntityApiTest::setUp public function Sets up Drupal unit test environment. Overrides EntityUnitTestBase::setUp
EntityApiTest::testCRUD public function Tests basic CRUD functionality of the Entity API.
EntityApiTest::testEntityStorageExceptionHandling public function Tests that exceptions are properly thrown when saving or deleting an entity.
EntityUnitTestBase::$modules public static property Modules to enable. Overrides DrupalUnitTestBase::$modules 11
EntityUnitTestBase::createUser protected function Creates a user.
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