You are here

Home » API reference » Drupal 9 » EntityUnitTest.php

class EntityUnitTest in Drupal 9

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

@coversDefaultClass \Drupal\Core\Entity\EntityBase @group Entity @group Access

Hierarchy

Expanded class hierarchy of EntityUnitTest

File

core/tests/Drupal/Tests/Core/Entity/EntityUnitTest.php, line 20

Namespace

Drupal\Tests\Core\Entity
View source 
class EntityUnitTest extends UnitTestCase {

  /**
   * The entity under test.
   *
   * @var \Drupal\Core\Entity\Entity|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $entity;

  /**
   * The entity type used for testing.
   *
   * @var \Drupal\Core\Entity\EntityTypeInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $entityType;

  /**
   * The entity type manager used for testing.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $entityTypeManager;

  /**
   * The ID of the type of the entity under test.
   *
   * @var string
   */
  protected $entityTypeId;

  /**
   * The route provider used for testing.
   *
   * @var \Drupal\Core\Routing\RouteProvider|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $routeProvider;

  /**
   * The UUID generator used for testing.
   *
   * @var \Drupal\Component\Uuid\UuidInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $uuid;

  /**
   * The language manager.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $languageManager;

  /**
   * The mocked cache tags invalidator.
   *
   * @var \Drupal\Core\Cache\CacheTagsInvalidatorInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $cacheTagsInvalidator;

  /**
   * The entity values.
   *
   * @var array
   */
  protected $values;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    $this->values = [
      'id' => 1,
      'langcode' => 'en',
      'uuid' => '3bb9ee60-bea5-4622-b89b-a63319d10b3a',
    ];
    $this->entityTypeId = $this
      ->randomMachineName();
    $this->entityType = $this
      ->createMock('\\Drupal\\Core\\Entity\\EntityTypeInterface');
    $this->entityType
      ->expects($this
      ->any())
      ->method('getListCacheTags')
      ->willReturn([
      $this->entityTypeId . '_list',
    ]);
    $this->entityTypeManager = $this
      ->getMockForAbstractClass(EntityTypeManagerInterface::class);
    $this->entityTypeManager
      ->expects($this
      ->any())
      ->method('getDefinition')
      ->with($this->entityTypeId)
      ->will($this
      ->returnValue($this->entityType));
    $this->uuid = $this
      ->createMock('\\Drupal\\Component\\Uuid\\UuidInterface');
    $this->languageManager = $this
      ->createMock('\\Drupal\\Core\\Language\\LanguageManagerInterface');
    $this->languageManager
      ->expects($this
      ->any())
      ->method('getLanguage')
      ->with('en')
      ->will($this
      ->returnValue(new Language([
      'id' => 'en',
    ])));
    $this->cacheTagsInvalidator = $this
      ->createMock('Drupal\\Core\\Cache\\CacheTagsInvalidator');
    $container = new ContainerBuilder();
    $container
      ->set('entity_type.manager', $this->entityTypeManager);
    $container
      ->set('uuid', $this->uuid);
    $container
      ->set('language_manager', $this->languageManager);
    $container
      ->set('cache_tags.invalidator', $this->cacheTagsInvalidator);
    \Drupal::setContainer($container);
    $this->entity = $this
      ->getMockForAbstractClass('\\Drupal\\Core\\Entity\\EntityBase', [
      $this->values,
      $this->entityTypeId,
    ]);
  }

  /**
   * @covers ::id
   */
  public function testId() {
    $this
      ->assertSame($this->values['id'], $this->entity
      ->id());
  }

  /**
   * @covers ::uuid
   */
  public function testUuid() {
    $this
      ->assertSame($this->values['uuid'], $this->entity
      ->uuid());
  }

  /**
   * @covers ::isNew
   * @covers ::enforceIsNew
   */
  public function testIsNew() {

    // We provided an ID, so the entity is not new.
    $this
      ->assertFalse($this->entity
      ->isNew());

    // Force it to be new.
    $this
      ->assertSame($this->entity, $this->entity
      ->enforceIsNew());
    $this
      ->assertTrue($this->entity
      ->isNew());
  }

  /**
   * @covers ::getEntityType
   */
  public function testGetEntityType() {
    $this
      ->assertSame($this->entityType, $this->entity
      ->getEntityType());
  }

  /**
   * @covers ::bundle
   */
  public function testBundle() {
    $this
      ->assertSame($this->entityTypeId, $this->entity
      ->bundle());
  }

  /**
   * @covers ::label
   */
  public function testLabel() {
    $property_label = $this
      ->randomMachineName();
    $this->entityType
      ->expects($this
      ->atLeastOnce())
      ->method('getKey')
      ->with('label')
      ->will($this
      ->returnValue('label'));

    // Set a dummy property on the entity under test to test that the label can
    // be returned form a property if there is no callback.
    $this->entityTypeManager
      ->expects($this
      ->atLeastOnce())
      ->method('getDefinition')
      ->with($this->entityTypeId)
      ->will($this
      ->returnValue([
      'entity_keys' => [
        'label' => 'label',
      ],
    ]));
    $this->entity->label = $property_label;
    $this
      ->assertSame($property_label, $this->entity
      ->label());
  }

  /**
   * @covers ::access
   */
  public function testAccess() {
    $access = $this
      ->createMock('\\Drupal\\Core\\Entity\\EntityAccessControlHandlerInterface');
    $operation = $this
      ->randomMachineName();
    $access
      ->expects($this
      ->once())
      ->method('access')
      ->with($this->entity, $operation)
      ->will($this
      ->returnValue(AccessResult::allowed()));
    $access
      ->expects($this
      ->once())
      ->method('createAccess')
      ->will($this
      ->returnValue(AccessResult::allowed()));
    $this->entityTypeManager
      ->expects($this
      ->exactly(2))
      ->method('getAccessControlHandler')
      ->will($this
      ->returnValue($access));
    $this
      ->assertEquals(AccessResult::allowed(), $this->entity
      ->access($operation));
    $this
      ->assertEquals(AccessResult::allowed(), $this->entity
      ->access('create'));
  }

  /**
   * @covers ::language
   */
  public function testLanguage() {
    $this->entityType
      ->expects($this
      ->any())
      ->method('getKey')
      ->willReturnMap([
      [
        'langcode',
        'langcode',
      ],
    ]);
    $this
      ->assertSame('en', $this->entity
      ->language()
      ->getId());
  }

  /**
   * Setup for the tests of the ::load() method.
   */
  public function setupTestLoad() {

    // Base our mocked entity on a real entity class so we can test if calling
    // Entity::load() on the base class will bubble up to an actual entity.
    $this->entityTypeId = 'entity_test_mul';
    $methods = get_class_methods(EntityTestMul::class);
    unset($methods[array_search('load', $methods)]);
    unset($methods[array_search('loadMultiple', $methods)]);
    unset($methods[array_search('create', $methods)]);
    $this->entity = $this
      ->getMockBuilder(EntityTestMul::class)
      ->disableOriginalConstructor()
      ->setMethods($methods)
      ->getMock();
  }

  /**
   * @covers ::load
   *
   * Tests Entity::load() when called statically on a subclass of Entity.
   */
  public function testLoad() {
    $this
      ->setupTestLoad();
    $class_name = get_class($this->entity);
    $entity_type_repository = $this
      ->getMockForAbstractClass(EntityTypeRepositoryInterface::class);
    $entity_type_repository
      ->expects($this
      ->once())
      ->method('getEntityTypeFromClass')
      ->with($class_name)
      ->willReturn($this->entityTypeId);
    $storage = $this
      ->createMock(EntityStorageInterface::class);
    $storage
      ->expects($this
      ->once())
      ->method('load')
      ->with(1)
      ->will($this
      ->returnValue($this->entity));
    $this->entityTypeManager
      ->expects($this
      ->once())
      ->method('getStorage')
      ->with($this->entityTypeId)
      ->will($this
      ->returnValue($storage));
    \Drupal::getContainer()
      ->set('entity_type.repository', $entity_type_repository);

    // Call Entity::load statically and check that it returns the mock entity.
    $this
      ->assertSame($this->entity, $class_name::load(1));
  }

  /**
   * @covers ::loadMultiple
   *
   * Tests Entity::loadMultiple() when called statically on a subclass of
   * Entity.
   */
  public function testLoadMultiple() {
    $this
      ->setupTestLoad();
    $class_name = get_class($this->entity);
    $entity_type_repository = $this
      ->getMockForAbstractClass(EntityTypeRepositoryInterface::class);
    $entity_type_repository
      ->expects($this
      ->once())
      ->method('getEntityTypeFromClass')
      ->with($class_name)
      ->willReturn($this->entityTypeId);
    $storage = $this
      ->createMock(EntityStorageInterface::class);
    $storage
      ->expects($this
      ->once())
      ->method('loadMultiple')
      ->with([
      1,
    ])
      ->will($this
      ->returnValue([
      1 => $this->entity,
    ]));
    $this->entityTypeManager
      ->expects($this
      ->once())
      ->method('getStorage')
      ->with($this->entityTypeId)
      ->will($this
      ->returnValue($storage));
    \Drupal::getContainer()
      ->set('entity_type.repository', $entity_type_repository);

    // Call Entity::loadMultiple statically and check that it returns the mock
    // entity.
    $this
      ->assertSame([
      1 => $this->entity,
    ], $class_name::loadMultiple([
      1,
    ]));
  }

  /**
   * @covers ::create
   */
  public function testCreate() {
    $this
      ->setupTestLoad();
    $class_name = get_class($this->entity);
    $entity_type_repository = $this
      ->getMockForAbstractClass(EntityTypeRepositoryInterface::class);
    $entity_type_repository
      ->expects($this
      ->once())
      ->method('getEntityTypeFromClass')
      ->with($class_name)
      ->willReturn($this->entityTypeId);
    $storage = $this
      ->createMock(EntityStorageInterface::class);
    $storage
      ->expects($this
      ->once())
      ->method('create')
      ->with([])
      ->will($this
      ->returnValue($this->entity));
    $this->entityTypeManager
      ->expects($this
      ->once())
      ->method('getStorage')
      ->with($this->entityTypeId)
      ->will($this
      ->returnValue($storage));
    \Drupal::getContainer()
      ->set('entity_type.repository', $entity_type_repository);

    // Call Entity::create() statically and check that it returns the mock
    // entity.
    $this
      ->assertSame($this->entity, $class_name::create([]));
  }

  /**
   * @covers ::save
   */
  public function testSave() {
    $storage = $this
      ->createMock('\\Drupal\\Core\\Entity\\EntityStorageInterface');
    $storage
      ->expects($this
      ->once())
      ->method('save')
      ->with($this->entity);
    $this->entityTypeManager
      ->expects($this
      ->once())
      ->method('getStorage')
      ->with($this->entityTypeId)
      ->will($this
      ->returnValue($storage));
    $this->entity
      ->save();
  }

  /**
   * @covers ::delete
   */
  public function testDelete() {
    $this->entity->id = $this
      ->randomMachineName();
    $storage = $this
      ->createMock('\\Drupal\\Core\\Entity\\EntityStorageInterface');

    // Testing the argument of the delete() method consumes too much memory.
    $storage
      ->expects($this
      ->once())
      ->method('delete');
    $this->entityTypeManager
      ->expects($this
      ->once())
      ->method('getStorage')
      ->with($this->entityTypeId)
      ->will($this
      ->returnValue($storage));
    $this->entity
      ->delete();
  }

  /**
   * @covers ::getEntityTypeId
   */
  public function testGetEntityTypeId() {
    $this
      ->assertSame($this->entityTypeId, $this->entity
      ->getEntityTypeId());
  }

  /**
   * @covers ::preSave
   */
  public function testPreSave() {

    // This method is internal, so check for errors on calling it only.
    $storage = $this
      ->createMock('\\Drupal\\Core\\Entity\\EntityStorageInterface');

    // Our mocked entity->preSave() returns NULL, so assert that.
    $this
      ->assertNull($this->entity
      ->preSave($storage));
  }

  /**
   * @covers ::postSave
   */
  public function testPostSave() {
    $this->cacheTagsInvalidator
      ->expects($this
      ->exactly(2))
      ->method('invalidateTags')
      ->withConsecutive([
      [
        // List cache tag.
        $this->entityTypeId . '_list',
      ],
    ], [
      [
        // List cache tag.
        $this->entityTypeId . '_list',
        // Own cache tag.
        $this->entityTypeId . ':' . $this->values['id'],
      ],
    ]);

    // This method is internal, so check for errors on calling it only.
    $storage = $this
      ->createMock('\\Drupal\\Core\\Entity\\EntityStorageInterface');

    // A creation should trigger the invalidation of the "list" cache tag.
    $this->entity
      ->postSave($storage, FALSE);

    // An update should trigger the invalidation of both the "list" and the
    // "own" cache tags.
    $this->entity
      ->postSave($storage, TRUE);
  }

  /**
   * @covers ::postSave
   */
  public function testPostSaveBundle() {
    $this->cacheTagsInvalidator
      ->expects($this
      ->exactly(2))
      ->method('invalidateTags')
      ->withConsecutive([
      [
        // List cache tag.
        $this->entityTypeId . '_list',
        $this->entityTypeId . '_list:' . $this->entity
          ->bundle(),
      ],
    ], [
      [
        // List cache tag.
        $this->entityTypeId . '_list',
        $this->entityTypeId . '_list:' . $this->entity
          ->bundle(),
        // Own cache tag.
        $this->entityTypeId . ':' . $this->values['id'],
      ],
    ]);
    $this->entityType
      ->expects($this
      ->atLeastOnce())
      ->method('hasKey')
      ->with('bundle')
      ->willReturn(TRUE);

    // This method is internal, so check for errors on calling it only.
    $storage = $this
      ->createMock('\\Drupal\\Core\\Entity\\EntityStorageInterface');

    // A creation should trigger the invalidation of the global list cache tag
    // and the one for the bundle.
    $this->entity
      ->postSave($storage, FALSE);

    // An update should trigger the invalidation of the "list", bundle list and
    // the "own" cache tags.
    $this->entity
      ->postSave($storage, TRUE);
  }

  /**
   * @covers ::preCreate
   */
  public function testPreCreate() {

    // This method is internal, so check for errors on calling it only.
    $storage = $this
      ->createMock('\\Drupal\\Core\\Entity\\EntityStorageInterface');
    $values = [];

    // Our mocked entity->preCreate() returns NULL, so assert that.
    $this
      ->assertNull($this->entity
      ->preCreate($storage, $values));
  }

  /**
   * @covers ::postCreate
   */
  public function testPostCreate() {

    // This method is internal, so check for errors on calling it only.
    $storage = $this
      ->createMock('\\Drupal\\Core\\Entity\\EntityStorageInterface');

    // Our mocked entity->postCreate() returns NULL, so assert that.
    $this
      ->assertNull($this->entity
      ->postCreate($storage));
  }

  /**
   * @covers ::preDelete
   */
  public function testPreDelete() {

    // This method is internal, so check for errors on calling it only.
    $storage = $this
      ->createMock('\\Drupal\\Core\\Entity\\EntityStorageInterface');

    // Our mocked entity->preDelete() returns NULL, so assert that.
    $this
      ->assertNull($this->entity
      ->preDelete($storage, [
      $this->entity,
    ]));
  }

  /**
   * @covers ::postDelete
   */
  public function testPostDelete() {
    $this->cacheTagsInvalidator
      ->expects($this
      ->once())
      ->method('invalidateTags')
      ->with([
      $this->entityTypeId . '_list',
      $this->entityTypeId . ':' . $this->values['id'],
    ]);
    $storage = $this
      ->createMock('\\Drupal\\Core\\Entity\\EntityStorageInterface');
    $storage
      ->expects($this
      ->once())
      ->method('getEntityType')
      ->willReturn($this->entityType);
    $entities = [
      $this->values['id'] => $this->entity,
    ];
    $this->entity
      ->postDelete($storage, $entities);
  }

  /**
   * @covers ::postDelete
   */
  public function testPostDeleteBundle() {
    $this->cacheTagsInvalidator
      ->expects($this
      ->once())
      ->method('invalidateTags')
      ->willReturnCallback(function (array $tags) {
      self::assertEqualsCanonicalizing([
        $this->entityTypeId . '_list',
        $this->entityTypeId . ':' . $this->values['id'],
        $this->entityTypeId . '_list:' . $this->entity
          ->bundle(),
      ], $tags);
      return NULL;
    });
    $this->entityType
      ->expects($this
      ->atLeastOnce())
      ->method('hasKey')
      ->with('bundle')
      ->willReturn(TRUE);
    $storage = $this
      ->createMock('\\Drupal\\Core\\Entity\\EntityStorageInterface');
    $storage
      ->expects($this
      ->once())
      ->method('getEntityType')
      ->willReturn($this->entityType);
    $entities = [
      $this->values['id'] => $this->entity,
    ];
    $this->entity
      ->postDelete($storage, $entities);
  }

  /**
   * @covers ::postLoad
   */
  public function testPostLoad() {

    // This method is internal, so check for errors on calling it only.
    $storage = $this
      ->createMock('\\Drupal\\Core\\Entity\\EntityStorageInterface');
    $entities = [
      $this->entity,
    ];

    // Our mocked entity->postLoad() returns NULL, so assert that.
    $this
      ->assertNull($this->entity
      ->postLoad($storage, $entities));
  }

  /**
   * @covers ::referencedEntities
   */
  public function testReferencedEntities() {
    $this
      ->assertSame([], $this->entity
      ->referencedEntities());
  }

  /**
   * @covers ::getCacheTags
   * @covers ::getCacheTagsToInvalidate
   * @covers ::addCacheTags
   */
  public function testCacheTags() {

    // Ensure that both methods return the same by default.
    $this
      ->assertEqualsCanonicalizing([
      $this->entityTypeId . ':' . 1,
    ], $this->entity
      ->getCacheTags());
    $this
      ->assertEqualsCanonicalizing([
      $this->entityTypeId . ':' . 1,
    ], $this->entity
      ->getCacheTagsToInvalidate());

    // Add an additional cache tag and make sure only getCacheTags() returns
    // that.
    $this->entity
      ->addCacheTags([
      'additional_cache_tag',
    ]);

    // EntityTypeId is random so it can shift order. We need to duplicate the
    // sort from \Drupal\Core\Cache\Cache::mergeTags().
    $tags = [
      $this->entityTypeId . ':' . 1,
      'additional_cache_tag',
    ];
    $this
      ->assertEqualsCanonicalizing($tags, $this->entity
      ->getCacheTags());
    $this
      ->assertEqualsCanonicalizing([
      $this->entityTypeId . ':' . 1,
    ], $this->entity
      ->getCacheTagsToInvalidate());
  }

  /**
   * @covers ::getCacheContexts
   * @covers ::addCacheContexts
   */
  public function testCacheContexts() {
    $cache_contexts_manager = $this
      ->getMockBuilder('Drupal\\Core\\Cache\\Context\\CacheContextsManager')
      ->disableOriginalConstructor()
      ->getMock();
    $cache_contexts_manager
      ->method('assertValidTokens')
      ->willReturn(TRUE);
    $container = new ContainerBuilder();
    $container
      ->set('cache_contexts_manager', $cache_contexts_manager);
    \Drupal::setContainer($container);

    // There are no cache contexts by default.
    $this
      ->assertEqualsCanonicalizing([], $this->entity
      ->getCacheContexts());

    // Add an additional cache context.
    $this->entity
      ->addCacheContexts([
      'user',
    ]);
    $this
      ->assertEqualsCanonicalizing([
      'user',
    ], $this->entity
      ->getCacheContexts());
  }

  /**
   * @covers ::getCacheMaxAge
   * @covers ::mergeCacheMaxAge
   */
  public function testCacheMaxAge() {

    // Cache max age is permanent by default.
    $this
      ->assertEquals(Cache::PERMANENT, $this->entity
      ->getCacheMaxAge());

    // Set two cache max ages, the lower value is the one that needs to be
    // returned.
    $this->entity
      ->mergeCacheMaxAge(600);
    $this->entity
      ->mergeCacheMaxAge(1800);
    $this
      ->assertEquals(600, $this->entity
      ->getCacheMaxAge());
  }

}

Members

Namesort descending Modifiers Type Description Overrides
EntityUnitTest::$cacheTagsInvalidator protected property The mocked cache tags invalidator.
EntityUnitTest::$entity protected property The entity under test.
EntityUnitTest::$entityType protected property The entity type used for testing.
EntityUnitTest::$entityTypeId protected property The ID of the type of the entity under test.
EntityUnitTest::$entityTypeManager protected property The entity type manager used for testing.
EntityUnitTest::$languageManager protected property The language manager.
EntityUnitTest::$routeProvider protected property The route provider used for testing.
EntityUnitTest::$uuid protected property The UUID generator used for testing.
EntityUnitTest::$values protected property The entity values.
EntityUnitTest::setUp protected function Overrides UnitTestCase::setUp
EntityUnitTest::setupTestLoad public function Setup for the tests of the ::load() method.
EntityUnitTest::testAccess public function @covers ::access
EntityUnitTest::testBundle public function @covers ::bundle
EntityUnitTest::testCacheContexts public function @covers ::getCacheContexts @covers ::addCacheContexts
EntityUnitTest::testCacheMaxAge public function @covers ::getCacheMaxAge @covers ::mergeCacheMaxAge
EntityUnitTest::testCacheTags public function @covers ::getCacheTags @covers ::getCacheTagsToInvalidate @covers ::addCacheTags
EntityUnitTest::testCreate public function @covers ::create
EntityUnitTest::testDelete public function @covers ::delete
EntityUnitTest::testGetEntityType public function @covers ::getEntityType
EntityUnitTest::testGetEntityTypeId public function @covers ::getEntityTypeId
EntityUnitTest::testId public function @covers ::id
EntityUnitTest::testIsNew public function @covers ::isNew @covers ::enforceIsNew
EntityUnitTest::testLabel public function @covers ::label
EntityUnitTest::testLanguage public function @covers ::language
EntityUnitTest::testLoad public function @covers ::load
EntityUnitTest::testLoadMultiple public function @covers ::loadMultiple
EntityUnitTest::testPostCreate public function @covers ::postCreate
EntityUnitTest::testPostDelete public function @covers ::postDelete
EntityUnitTest::testPostDeleteBundle public function @covers ::postDelete
EntityUnitTest::testPostLoad public function @covers ::postLoad
EntityUnitTest::testPostSave public function @covers ::postSave
EntityUnitTest::testPostSaveBundle public function @covers ::postSave
EntityUnitTest::testPreCreate public function @covers ::preCreate
EntityUnitTest::testPreDelete public function @covers ::preDelete
EntityUnitTest::testPreSave public function @covers ::preSave
EntityUnitTest::testReferencedEntities public function @covers ::referencedEntities
EntityUnitTest::testSave public function @covers ::save
EntityUnitTest::testUuid public function @covers ::uuid
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.
UnitTestCase::$randomGenerator protected property The random generator.
UnitTestCase::$root protected property The app root. 1
UnitTestCase::assertArrayEquals Deprecated protected function Asserts if two arrays are equal by sorting them first.
UnitTestCase::getClassResolverStub protected function Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub public function Returns a stub config factory that behaves according to the passed array.
UnitTestCase::getConfigStorageStub public function Returns a stub config storage that returns the supplied configuration.
UnitTestCase::getContainerWithCacheTagsInvalidator protected function Sets up a container with a cache tags invalidator.
UnitTestCase::getRandomGenerator protected function Gets the random generator for the utility methods.
UnitTestCase::getStringTranslationStub public function Returns a stub translation manager that just returns the passed string.
UnitTestCase::randomMachineName public function Generates a unique random string containing letters and numbers.
UnitTestCase::setUpBeforeClass public static function