class EntityConverterTest in Drupal 8

@coversDefaultClass \Drupal\Core\ParamConverter\EntityConverter @group ParamConverter @group Entity

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses PhpunitCompatibilityTrait
  • class \Drupal\Tests\Core\ParamConverter\EntityConverterTest

File

core/tests/Drupal/Tests/Core/ParamConverter/EntityConverterTest.php, line 30

Namespace

Drupal\Tests\Core\ParamConverter

class EntityConverterTest extends UnitTestCase {

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

  /**
   * The mocked entities repository.
   *
   * @var \Drupal\Core\Entity\EntityRepositoryInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $entityRepository;

  /**
   * The tested entity converter.
   *
   * @var \Drupal\Core\ParamConverter\EntityConverter
   */
  protected $entityConverter;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this->entityTypeManager = $this
      ->createMock(EntityTypeManagerInterface::class);
    $this->entityRepository = $this
      ->createMock(EntityRepositoryInterface::class);
    $this->entityConverter = new EntityConverter($this->entityTypeManager, $this->entityRepository);
  }

  /**
   * Sets up mock services and class instances.
   *
   * @param object[] $service_map
   *   An associative array of service instances keyed by service name.
   */
  protected function setUpMocks($service_map = []) {
    $entity = $this
      ->createMock(ContentEntityInterface::class);
    $entity
      ->expects($this
      ->any())
      ->method('getEntityTypeId')
      ->willReturn('entity_test');
    $entity
      ->expects($this
      ->any())
      ->method('id')
      ->willReturn('id');
    $entity
      ->expects($this
      ->any())
      ->method('isTranslatable')
      ->willReturn(FALSE);
    $entity
      ->expects($this
      ->any())
      ->method('getLoadedRevisionId')
      ->willReturn('revision_id');
    $storage = $this
      ->createMock(ContentEntityStorageInterface::class);
    $storage
      ->expects($this
      ->any())
      ->method('load')
      ->with('id')
      ->willReturn($entity);
    $storage
      ->expects($this
      ->any())
      ->method('getLatestRevisionId')
      ->with('id')
      ->willReturn('revision_id');
    $this->entityTypeManager
      ->expects($this
      ->any())
      ->method('getStorage')
      ->with('entity_test')
      ->willReturn($storage);
    $entity_type = $this
      ->createMock(ContentEntityTypeInterface::class);
    $entity_type
      ->expects($this
      ->any())
      ->method('isRevisionable')
      ->willReturn(TRUE);
    $this->entityTypeManager
      ->expects($this
      ->any())
      ->method('getDefinition')
      ->with('entity_test')
      ->willReturn($entity_type);
    $context_repository = $this
      ->createMock(ContextRepositoryInterface::class);
    $context_repository
      ->expects($this
      ->any())
      ->method('getAvailableContexts')
      ->willReturn([]);
    $context_definition = $this
      ->createMock(DataDefinition::class);
    foreach ([
      'setLabel',
      'setDescription',
      'setRequired',
      'setConstraints',
    ] as $method) {
      $context_definition
        ->expects($this
        ->any())
        ->method($method)
        ->willReturn($context_definition);
    }
    $context_definition
      ->expects($this
      ->any())
      ->method('getConstraints')
      ->willReturn([]);
    $typed_data_manager = $this
      ->createMock(TypedDataManagerInterface::class);
    $typed_data_manager
      ->expects($this
      ->any())
      ->method('create')
      ->willReturn($this
      ->createMock(TypedDataInterface::class));
    $typed_data_manager
      ->expects($this
      ->any())
      ->method('createDataDefinition')
      ->willReturn($context_definition);
    $service_map += [
      'context.repository' => $context_repository,
      'typed_data_manager' => $typed_data_manager,
    ];

    /** @var \Symfony\Component\DependencyInjection\ContainerInterface|\PHPUnit\Framework\MockObject\MockObject $container */
    $container = $this
      ->createMock(ContainerInterface::class);
    $return_map = [];
    foreach ($service_map as $name => $service) {
      $return_map[] = [
        $name,
        1,
        $service,
      ];
    }
    $container
      ->expects($this
      ->any())
      ->method('get')
      ->willReturnMap($return_map);
    \Drupal::setContainer($container);
  }

  /**
   * Tests that passing the language manager triggers a deprecation error.
   *
   * @group legacy
   *
   * @expectedDeprecation Calling EntityConverter::__construct() with the $entity_repository argument is supported in drupal:8.7.0 and will be required before drupal:9.0.0. See https://www.drupal.org/node/2549139.
   */
  public function testDeprecatedLanguageManager() {
    $container_entity_repository = clone $this->entityRepository;
    $this
      ->setUpMocks([
      'entity.repository' => $container_entity_repository,
    ]);
    $language_manager = $this
      ->createMock(LanguageManagerInterface::class);
    $this->entityConverter = new EntityConverter($this->entityTypeManager, $language_manager);
  }

  /**
   * Tests that retrieving the language manager triggers a deprecation error.
   *
   * @group legacy
   *
   * @expectedDeprecation The property languageManager (language_manager service) is deprecated in Drupal\Core\ParamConverter\EntityConverter and will be removed before Drupal 9.0.0.
   */
  public function testDeprecatedLanguageManagerMethod() {
    $this
      ->setUpMocks([
      'language_manager' => $this
        ->createMock(LanguageManagerInterface::class),
    ]);
    $this->entityConverter = new EntityConverter($this->entityTypeManager, $this->entityRepository);
    $reflector = new \ReflectionMethod(EntityConverter::class, 'languageManager');
    $reflector
      ->setAccessible(TRUE);
    $this
      ->assertSame(\Drupal::service('language_manager'), $reflector
      ->invoke($this->entityConverter));
  }

  /**
   * Tests that retrieving the language manager triggers a deprecation error.
   *
   * @group legacy
   *
   * @expectedDeprecation The property languageManager (language_manager service) is deprecated in Drupal\Core\ParamConverter\EntityConverter and will be removed before Drupal 9.0.0.
   */
  public function testDeprecatedLanguageManagerProperty() {
    $this
      ->setUpMocks([
      'language_manager' => $this
        ->createMock(LanguageManagerInterface::class),
    ]);
    $this->entityConverter = new EntityConverter($this->entityTypeManager, $this->entityRepository);
    $this
      ->assertSame(\Drupal::service('language_manager'), $this->entityConverter
      ->__get('languageManager'));
  }

  /**
   * Tests that ::getLatestTranslationAffectedRevision() is deprecated.
   *
   * @group legacy
   *
   * @expectedDeprecation \Drupal\Core\ParamConverter\EntityConverter::getLatestTranslationAffectedRevision() is deprecated in Drupal 8.7.0 and will be removed before Drupal 9.0.0. Use \Drupal\Core\Entity\EntityRepositoryInterface::getActive() instead.
   */
  public function testDeprecatedGetLatestTranslationAffectedRevision() {
    $this
      ->setUpMocks();

    /** @var \Drupal\Core\Entity\ContentEntityInterface|\PHPUnit\Framework\MockObject\MockObject $revision */
    $revision = $this
      ->createMock(ContentEntityInterface::class);
    $revision
      ->expects($this
      ->any())
      ->method('getEntityTypeId')
      ->willReturn('entity_test');
    $revision
      ->expects($this
      ->any())
      ->method('id')
      ->willReturn('1');

    /** @var static $test */
    $test = $this;
    $this->entityRepository
      ->expects($this
      ->any())
      ->method('getActive')
      ->willReturnCallback(function ($entity_type_id, $entity_id, $contexts) use ($test) {
      $test
        ->assertSame('entity_test', $entity_type_id);
      $test
        ->assertSame('1', $entity_id);
      $context_id_prefix = '@language.current_language_context:';
      $test
        ->assertTrue(isset($contexts[$context_id_prefix . LanguageInterface::TYPE_CONTENT]));
      $test
        ->assertTrue(isset($contexts[$context_id_prefix . LanguageInterface::TYPE_INTERFACE]));
    });
    $this->entityConverter = new EntityConverter($this->entityTypeManager, $this->entityRepository);
    $reflector = new \ReflectionMethod(EntityConverter::class, 'getLatestTranslationAffectedRevision');
    $reflector
      ->setAccessible(TRUE);
    $reflector
      ->invoke($this->entityConverter, $revision, NULL);
  }

  /**
   * Tests that ::loadRevision() is deprecated.
   *
   * @group legacy
   *
   * @expectedDeprecation \Drupal\Core\ParamConverter\EntityConverter::loadRevision() is deprecated in Drupal 8.7.0 and will be removed before Drupal 9.0.0.
   */
  public function testDeprecatedLoadRevision() {
    $this
      ->setUpMocks();
    $this->entityConverter = new EntityConverter($this->entityTypeManager, $this->entityRepository);
    $reflector = new \ReflectionMethod(EntityConverter::class, 'loadRevision');
    $reflector
      ->setAccessible(TRUE);
    $revision = $this
      ->createMock(ContentEntityInterface::class);
    $reflector
      ->invoke($this->entityConverter, $revision, NULL);
  }

  /**
   * Tests the applies() method.
   *
   * @dataProvider providerTestApplies
   *
   * @covers ::applies
   */
  public function testApplies(array $definition, $name, Route $route, $applies) {
    $this->entityTypeManager
      ->expects($this
      ->any())
      ->method('hasDefinition')
      ->willReturnCallback(function ($entity_type) {
      return 'entity_test' == $entity_type;
    });
    $this
      ->assertEquals($applies, $this->entityConverter
      ->applies($definition, $name, $route));
  }

  /**
   * Provides test data for testApplies()
   */
  public function providerTestApplies() {
    $data = [];
    $data[] = [
      [
        'type' => 'entity:foo',
      ],
      'foo',
      new Route('/test/{foo}/bar'),
      FALSE,
    ];
    $data[] = [
      [
        'type' => 'entity:entity_test',
      ],
      'foo',
      new Route('/test/{foo}/bar'),
      TRUE,
    ];
    $data[] = [
      [
        'type' => 'entity:entity_test',
      ],
      'entity_test',
      new Route('/test/{entity_test}/bar'),
      TRUE,
    ];
    $data[] = [
      [
        'type' => 'entity:{entity_test}',
      ],
      'entity_test',
      new Route('/test/{entity_test}/bar'),
      FALSE,
    ];
    $data[] = [
      [
        'type' => 'entity:{entity_type}',
      ],
      'entity_test',
      new Route('/test/{entity_type}/{entity_test}/bar'),
      TRUE,
    ];
    $data[] = [
      [
        'type' => 'foo',
      ],
      'entity_test',
      new Route('/test/{entity_type}/{entity_test}/bar'),
      FALSE,
    ];
    return $data;
  }

  /**
   * Tests the convert() method.
   *
   * @dataProvider providerTestConvert
   *
   * @covers ::convert
   */
  public function testConvert($value, array $definition, array $defaults, $expected_result) {
    $this
      ->setUpMocks();
    $this->entityRepository
      ->expects($this
      ->any())
      ->method('getCanonical')
      ->willReturnCallback(function ($entity_type_id, $entity_id) {
      return $entity_type_id === 'entity_test' && $entity_id === 'valid_id' ? (object) [
        'id' => 'valid_id',
      ] : NULL;
    });
    $this
      ->assertEquals($expected_result, $this->entityConverter
      ->convert($value, $definition, 'foo', $defaults));
  }

  /**
   * Provides test data for testConvert
   */
  public function providerTestConvert() {
    $data = [];

    // Existing entity type.
    $data[] = [
      'valid_id',
      [
        'type' => 'entity:entity_test',
      ],
      [
        'foo' => 'valid_id',
      ],
      (object) [
        'id' => 'valid_id',
      ],
    ];

    // Invalid ID.
    $data[] = [
      'invalid_id',
      [
        'type' => 'entity:entity_test',
      ],
      [
        'foo' => 'invalid_id',
      ],
      NULL,
    ];

    // Entity type placeholder.
    $data[] = [
      'valid_id',
      [
        'type' => 'entity:{entity_type}',
      ],
      [
        'foo' => 'valid_id',
        'entity_type' => 'entity_test',
      ],
      (object) [
        'id' => 'valid_id',
      ],
    ];
    return $data;
  }

  /**
   * Tests the convert() method with an invalid entity type.
   */
  public function testConvertWithInvalidEntityType() {
    $this
      ->setUpMocks();
    $contexts = [
      EntityRepositoryInterface::CONTEXT_ID_LEGACY_CONTEXT_OPERATION => new Context(new ContextDefinition('string'), 'entity_upcast'),
    ];
    $plugin_id = 'invalid_id';
    $this->entityRepository
      ->expects($this
      ->once())
      ->method('getCanonical')
      ->with($plugin_id, 'id', $contexts)
      ->willThrowException(new PluginNotFoundException($plugin_id));
    $this
      ->expectException(PluginNotFoundException::class);
    $this->entityConverter
      ->convert('id', [
      'type' => 'entity:' . $plugin_id,
    ], 'foo', [
      'foo' => 'id',
    ]);
  }

  /**
   * Tests the convert() method with an invalid dynamic entity type.
   */
  public function testConvertWithInvalidDynamicEntityType() {
    $this
      ->expectException(ParamNotConvertedException::class);
    $this
      ->expectExceptionMessage('The "foo" parameter was not converted because the "invalid_id" parameter is missing.');
    $this->entityConverter
      ->convert('id', [
      'type' => 'entity:{invalid_id}',
    ], 'foo', [
      'foo' => 'id',
    ]);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
EntityConverterTest::$entityConverter	protected	property	The tested entity converter.
EntityConverterTest::$entityRepository	protected	property	The mocked entities repository.
EntityConverterTest::$entityTypeManager	protected	property	The mocked entity type manager.
EntityConverterTest::providerTestApplies	public	function	Provides test data for testApplies()
EntityConverterTest::providerTestConvert	public	function	Provides test data for testConvert
EntityConverterTest::setUp	protected	function	Overrides UnitTestCase::setUp
EntityConverterTest::setUpMocks	protected	function	Sets up mock services and class instances.
EntityConverterTest::testApplies	public	function	Tests the applies() method.
EntityConverterTest::testConvert	public	function	Tests the convert() method.
EntityConverterTest::testConvertWithInvalidDynamicEntityType	public	function	Tests the convert() method with an invalid dynamic entity type.
EntityConverterTest::testConvertWithInvalidEntityType	public	function	Tests the convert() method with an invalid entity type.
EntityConverterTest::testDeprecatedGetLatestTranslationAffectedRevision	public	function	Tests that ::getLatestTranslationAffectedRevision() is deprecated.
EntityConverterTest::testDeprecatedLanguageManager	public	function	Tests that passing the language manager triggers a deprecation error.
EntityConverterTest::testDeprecatedLanguageManagerMethod	public	function	Tests that retrieving the language manager triggers a deprecation error.
EntityConverterTest::testDeprecatedLanguageManagerProperty	public	function	Tests that retrieving the language manager triggers a deprecation error.
EntityConverterTest::testDeprecatedLoadRevision	public	function	Tests that ::loadRevision() is deprecated.
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.