class EntityLinkTest in Drupal 8

@coversDefaultClass \Drupal\Core\Entity\Entity @group Entity

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses PhpunitCompatibilityTrait
  • class \Drupal\Tests\Core\Entity\EntityLinkTest

File

core/tests/Drupal/Tests/Core/Entity/EntityLinkTest.php, line 15

Namespace

Drupal\Tests\Core\Entity

class EntityLinkTest extends UnitTestCase {

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

  /**
   * The tested link generator.
   *
   * @var \Drupal\Core\Utility\LinkGeneratorInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $linkGenerator;

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

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this->entityTypeManager = $this
      ->createMock(EntityTypeManagerInterface::class);
    $this->linkGenerator = $this
      ->createMock('Drupal\\Core\\Utility\\LinkGeneratorInterface');
    $this->languageManager = $this
      ->createMock('Drupal\\Core\\Language\\LanguageManagerInterface');
    $container = new ContainerBuilder();
    $container
      ->set('entity_type.manager', $this->entityTypeManager);
    $container
      ->set('link_generator', $this->linkGenerator);
    $container
      ->set('language_manager', $this->languageManager);
    \Drupal::setContainer($container);
  }

  /**
   * Tests for the Entity::link() method
   *
   * @covers ::link
   *
   * @dataProvider providerTestLink
   *
   * @group legacy
   *
   * Note this is only a legacy test because it triggers a call to
   * \Drupal\Core\Entity\EntityTypeInterface::getLabelCallback() which is mocked
   * and triggers a deprecation error. Remove when ::getLabelCallback() is
   * removed.
   */
  public function testLink($entity_label, $link_text, $expected_text, $link_rel = 'canonical', array $link_options = []) {
    $language = new Language([
      'id' => 'es',
    ]);
    $link_options += [
      'language' => $language,
    ];
    $this->languageManager
      ->expects($this
      ->any())
      ->method('getLanguage')
      ->with('es')
      ->willReturn($language);
    $route_name_map = [
      'canonical' => 'entity.test_entity_type.canonical',
      'edit-form' => 'entity.test_entity_type.edit_form',
    ];
    $route_name = $route_name_map[$link_rel];
    $entity_id = 'test_entity_id';
    $entity_type_id = 'test_entity_type';
    $expected = '<a href="/test_entity_type/test_entity_id">' . $expected_text . '</a>';
    $entity_type = $this
      ->createMock('Drupal\\Core\\Entity\\EntityTypeInterface');
    $entity_type
      ->expects($this
      ->once())
      ->method('getLinkTemplates')
      ->willReturn($route_name_map);
    $entity_type
      ->expects($this
      ->any())
      ->method('getKey')
      ->willReturnMap([
      [
        'label',
        'label',
      ],
      [
        'langcode',
        'langcode',
      ],
    ]);
    $this->entityTypeManager
      ->expects($this
      ->any())
      ->method('getDefinition')
      ->with($entity_type_id)
      ->will($this
      ->returnValue($entity_type));

    /** @var \Drupal\Core\Entity\Entity $entity */
    $entity = $this
      ->getMockForAbstractClass('Drupal\\Core\\Entity\\EntityBase', [
      [
        'id' => $entity_id,
        'label' => $entity_label,
        'langcode' => 'es',
      ],
      $entity_type_id,
    ]);
    $expected_link = Link::createFromRoute($expected_text, $route_name, [
      $entity_type_id => $entity_id,
    ], [
      'entity_type' => $entity_type_id,
      'entity' => $entity,
    ] + $link_options)
      ->setLinkGenerator($this->linkGenerator);
    $this->linkGenerator
      ->expects($this
      ->once())
      ->method('generateFromLink')
      ->with($this
      ->equalTo($expected_link))
      ->willReturn($expected);
    $this
      ->assertSame($expected, $entity
      ->toLink($link_text, $link_rel, $link_options)
      ->toString());
  }

  /**
   * Tests for the Entity::toLink() method
   *
   * @covers ::toLink
   *
   * @dataProvider providerTestLink
   *
   * @group legacy
   *
   * Note this is only a legacy test because it triggers a call to
   * \Drupal\Core\Entity\EntityTypeInterface::getLabelCallback() which is mocked
   * and triggers a deprecation error. Remove when ::getLabelCallback() is
   * removed.
   */
  public function testToLink($entity_label, $link_text, $expected_text, $link_rel = 'canonical', array $link_options = []) {
    $language = new Language([
      'id' => 'es',
    ]);
    $link_options += [
      'language' => $language,
    ];
    $this->languageManager
      ->expects($this
      ->any())
      ->method('getLanguage')
      ->with('es')
      ->willReturn($language);
    $route_name_map = [
      'canonical' => 'entity.test_entity_type.canonical',
      'edit-form' => 'entity.test_entity_type.edit_form',
    ];
    $route_name = $route_name_map[$link_rel];
    $entity_id = 'test_entity_id';
    $entity_type_id = 'test_entity_type';
    $expected = '<a href="/test_entity_type/test_entity_id">' . $expected_text . '</a>';
    $entity_type = $this
      ->createMock('Drupal\\Core\\Entity\\EntityTypeInterface');
    $entity_type
      ->expects($this
      ->once())
      ->method('getLinkTemplates')
      ->willReturn($route_name_map);
    $entity_type
      ->expects($this
      ->any())
      ->method('getKey')
      ->willReturnMap([
      [
        'label',
        'label',
      ],
      [
        'langcode',
        'langcode',
      ],
    ]);
    $this->entityTypeManager
      ->expects($this
      ->any())
      ->method('getDefinition')
      ->with($entity_type_id)
      ->will($this
      ->returnValue($entity_type));

    /** @var \Drupal\Core\Entity\Entity $entity */
    $entity = $this
      ->getMockForAbstractClass('Drupal\\Core\\Entity\\EntityBase', [
      [
        'id' => $entity_id,
        'label' => $entity_label,
        'langcode' => 'es',
      ],
      $entity_type_id,
    ]);
    $expected_link = Link::createFromRoute($expected_text, $route_name, [
      $entity_type_id => $entity_id,
    ], [
      'entity_type' => $entity_type_id,
      'entity' => $entity,
    ] + $link_options);
    $result_link = $entity
      ->toLink($link_text, $link_rel, $link_options);
    $this
      ->assertEquals($expected_link, $result_link);
  }

  /**
   * Provides test data for testLink().
   */
  public function providerTestLink() {
    $data = [];
    $data[] = [
      'some_entity_label',
      'qwerqwer',
      'qwerqwer',
    ];
    $data[] = [
      'some_entity_label',
      NULL,
      'some_entity_label',
    ];
    $data[] = [
      'some_entity_label',
      '0',
      '0',
    ];
    $data[] = [
      'some_entity_label',
      'qwerqwer',
      'qwerqwer',
      'edit-form',
    ];
    $data[] = [
      'some_entity_label',
      'qwerqwer',
      'qwerqwer',
      'edit-form',
    ];
    $data[] = [
      'some_entity_label',
      'qwerqwer',
      'qwerqwer',
      'edit-form',
      [
        'foo' => 'qwer',
      ],
    ];
    return $data;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
EntityLinkTest::$entityTypeManager	protected	property	The mocked entity type manager.
EntityLinkTest::$languageManager	protected	property	The mocked language manager.
EntityLinkTest::$linkGenerator	protected	property	The tested link generator.
EntityLinkTest::providerTestLink	public	function	Provides test data for testLink().
EntityLinkTest::setUp	protected	function	Overrides UnitTestCase::setUp
EntityLinkTest::testLink	public	function	Tests for the Entity::link() method
EntityLinkTest::testToLink	public	function	Tests for the Entity::toLink() method
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.