You are here

class EntityFinderTest in Feeds 8.3

@coversDefaultClass \Drupal\feeds\EntityFinder @group feeds

Hierarchy

Expanded class hierarchy of EntityFinderTest

File

tests/src/Unit/EntityFinderTest.php, line 17

Namespace

Drupal\Tests\feeds\Unit
View source
class EntityFinderTest extends FeedsUnitTestCase {

  /**
   * The entity type manager prophecy used in the test.
   *
   * @var \Prophecy\Prophecy\ProphecyInterface|\Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The entity storage prophecy used in the test.
   *
   * @var \Prophecy\Prophecy\ProphecyInterface|\Drupal\Core\Entity\EntityStorageInterface
   */
  protected $entityStorage;

  /**
   * Entity repository used in the test.
   *
   * @var \Prophecy\Prophecy\ProphecyInterface|\Drupal\Core\Entity\EntityRepositoryInterface
   */
  protected $entityRepository;

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

    // Entity type manager.
    $this->entityTypeManager = $this
      ->prophesize(EntityTypeManagerInterface::class);

    // Entity storage (needed for entity queries).
    $this->entityStorage = $this
      ->prophesize(EntityStorageInterface::class);
    $this->entityTypeManager
      ->getStorage('foo')
      ->willReturn($this->entityStorage);

    // Entity repository.
    $this->entityRepository = $this
      ->prophesize(EntityRepositoryInterface::class);
  }

  /**
   * Creates an entity finder instance.
   *
   * @return \Drupal\feeds\EntityFinder
   *   The entity finder instance to test with.
   */
  protected function createEntityFinderInstance() {
    return new EntityFinder($this->entityTypeManager
      ->reveal(), $this->entityRepository
      ->reveal());
  }

  /**
   * @covers ::findEntities
   */
  public function testFindEntities() {

    // Entity query.
    $entity_query = $this
      ->prophesize(QueryInterface::class);
    $entity_query
      ->range(0, 1)
      ->willReturn($entity_query);
    $entity_query
      ->condition('field_ref', 1)
      ->willReturn($entity_query);
    $entity_query
      ->execute()
      ->willReturn([
      12,
    ]);
    $this->entityStorage
      ->getQuery()
      ->willReturn($entity_query)
      ->shouldBeCalled();
    $entity_ids = $this
      ->createEntityFinderInstance()
      ->findEntities('foo', 'field_ref', 1);
    $this
      ->assertEquals([
      12,
    ], $entity_ids);
  }

  /**
   * @covers ::findEntities
   */
  public function testFindEntitiesNotFound() {

    // Entity query.
    $entity_query = $this
      ->prophesize(QueryInterface::class);
    $entity_query
      ->range(0, 1)
      ->willReturn($entity_query);
    $entity_query
      ->condition('field_ref', 1)
      ->willReturn($entity_query);
    $entity_query
      ->execute()
      ->willReturn([]);
    $this->entityStorage
      ->getQuery()
      ->willReturn($entity_query)
      ->shouldBeCalled();
    $entity_ids = $this
      ->createEntityFinderInstance()
      ->findEntities('foo', 'field_ref', 1);
    $this
      ->assertEquals([], $entity_ids);
  }

  /**
   * @covers ::findEntities
   */
  public function testFindMultipleEntities() {

    // Entity query.
    $entity_query = $this
      ->prophesize(QueryInterface::class);
    $entity_query
      ->range(0, 1)
      ->shouldNotBeCalled();
    $entity_query
      ->condition('field_ref', 1)
      ->willReturn($entity_query);
    $entity_query
      ->execute()
      ->willReturn([
      12,
      13,
      14,
    ]);
    $this->entityStorage
      ->getQuery()
      ->willReturn($entity_query)
      ->shouldBeCalled();
    $entity_ids = $this
      ->createEntityFinderInstance()
      ->findEntities('foo', 'field_ref', 1, [], TRUE);
    $this
      ->assertEquals([
      12,
      13,
      14,
    ], $entity_ids);
  }

  /**
   * @covers ::findEntities
   * @covers ::getBundleKey
   */
  public function testFindEntitiesWithBundleRestriction() {
    $entity_type = $this
      ->prophesize(EntityTypeInterface::class);
    $entity_type
      ->getKey('bundle')
      ->willReturn('type')
      ->shouldBeCalled();
    $this->entityTypeManager
      ->getDefinition('foo')
      ->willReturn($entity_type
      ->reveal())
      ->shouldBeCalled();

    // Entity query.
    $entity_query = $this
      ->prophesize(QueryInterface::class);
    $entity_query
      ->condition('type', [
      'qux',
    ], 'IN')
      ->willReturn($entity_query);
    $entity_query
      ->range(0, 1)
      ->willReturn($entity_query);
    $entity_query
      ->condition('field_ref', 1)
      ->willReturn($entity_query);
    $entity_query
      ->execute()
      ->willReturn([
      16,
    ]);
    $this->entityStorage
      ->getQuery()
      ->willReturn($entity_query)
      ->shouldBeCalled();
    $entity_ids = $this
      ->createEntityFinderInstance()
      ->findEntities('foo', 'field_ref', 1, [
      'qux',
    ]);
    $this
      ->assertEquals([
      16,
    ], $entity_ids);
  }

  /**
   * @covers ::findEntities
   */
  public function testFindEntitiesByUuid() {
    $entity = $this
      ->prophesize(ContentEntityInterface::class);
    $entity
      ->id()
      ->willReturn(17);
    $this->entityRepository
      ->loadEntityByUuid('foo', '31835cb0-7302-403b-92ab-c228547d13fc')
      ->willReturn($entity);
    $entity_ids = $this
      ->createEntityFinderInstance()
      ->findEntities('foo', 'uuid', '31835cb0-7302-403b-92ab-c228547d13fc');
    $this
      ->assertEquals([
      17,
    ], $entity_ids);
  }

  /**
   * @covers ::findEntities
   */
  public function testFindEntitiesByUuidNotFound() {
    $this->entityRepository
      ->loadEntityByUuid('foo', '31835cb0-7302-403b-92ab-c228547d13fc')
      ->willReturn(NULL);
    $entity_ids = $this
      ->createEntityFinderInstance()
      ->findEntities('foo', 'uuid', '31835cb0-7302-403b-92ab-c228547d13fc');
    $this
      ->assertEquals([], $entity_ids);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
EntityFinderTest::$entityRepository protected property Entity repository used in the test.
EntityFinderTest::$entityStorage protected property The entity storage prophecy used in the test.
EntityFinderTest::$entityTypeManager protected property The entity type manager prophecy used in the test.
EntityFinderTest::createEntityFinderInstance protected function Creates an entity finder instance.
EntityFinderTest::setUp public function Overrides FeedsUnitTestCase::setUp
EntityFinderTest::testFindEntities public function @covers ::findEntities
EntityFinderTest::testFindEntitiesByUuid public function @covers ::findEntities
EntityFinderTest::testFindEntitiesByUuidNotFound public function @covers ::findEntities
EntityFinderTest::testFindEntitiesNotFound public function @covers ::findEntities
EntityFinderTest::testFindEntitiesWithBundleRestriction public function @covers ::findEntities @covers ::getBundleKey
EntityFinderTest::testFindMultipleEntities public function @covers ::findEntities
FeedsMockingTrait::getMockAccount protected function Mocks an account object.
FeedsMockingTrait::getMockedAccountSwitcher protected function Returns a mocked AccountSwitcher object.
FeedsMockingTrait::getMockFeed protected function Returns a mocked feed entity.
FeedsMockingTrait::getMockFeedType protected function Returns a mocked feed type entity.
FeedsMockingTrait::getMockFieldDefinition protected function Mocks a field definition. 1
FeedsMockingTrait::getMockFileSystem protected function Mocks the file system.
FeedsReflectionTrait::callProtectedMethod protected function Calls a protected method on the given object.
FeedsReflectionTrait::getMethod protected function Gets a ReflectionMethod for a class method.
FeedsReflectionTrait::getProtectedClosure protected function Returns a dynamically created closure for the object's method.
FeedsReflectionTrait::setProtectedProperty protected function Sets a protected property.
FeedsUnitTestCase::absolutePath protected function Returns the absolute directory path of the Feeds module.
FeedsUnitTestCase::defineConstants protected function Defines stub constants.
FeedsUnitTestCase::getMockStreamWrapperManager protected function Returns a mock stream wrapper manager.
FeedsUnitTestCase::resourcesPath protected function Returns the absolute directory path of the resources folder.
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
UnitTestCase::$randomGenerator protected property The random generator.
UnitTestCase::$root protected property The app root. 1
UnitTestCase::assertArrayEquals protected function Asserts if two arrays are equal by sorting them first.
UnitTestCase::getBlockMockWithMachineName Deprecated protected function Mocks a block with a block plugin. 1
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.