class ConfigEntityMapperTest in Drupal 8

Tests the functionality provided by the configuration entity mapper.

@group config_translation

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses PhpunitCompatibilityTrait
  • class \Drupal\Tests\config_translation\Unit\ConfigEntityMapperTest

File

core/modules/config_translation/tests/src/Unit/ConfigEntityMapperTest.php, line 15

Namespace

Drupal\Tests\config_translation\Unit

class ConfigEntityMapperTest extends UnitTestCase {

  /**
   * The configuration entity mapper to test.
   *
   * @var \Drupal\config_translation\ConfigEntityMapper
   */
  protected $configEntityMapper;

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

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

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

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

  /**
   * The mocked event dispatcher.
   *
   * @var \Symfony\Component\EventDispatcher\EventDispatcherInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $eventDispatcher;
  protected function setUp() {
    $this->entityTypeManager = $this
      ->createMock('Drupal\\Core\\Entity\\EntityTypeManagerInterface');
    $this->entity = $this
      ->createMock('Drupal\\Core\\Config\\Entity\\ConfigEntityInterface');
    $this->routeProvider = $this
      ->createMock('Drupal\\Core\\Routing\\RouteProviderInterface');
    $this->routeProvider
      ->expects($this
      ->any())
      ->method('getRouteByName')
      ->with('entity.configurable_language.edit_form')
      ->will($this
      ->returnValue(new Route('/admin/config/regional/language/edit/{configurable_language}')));
    $definition = [
      'class' => '\\Drupal\\config_translation\\ConfigEntityMapper',
      'base_route_name' => 'entity.configurable_language.edit_form',
      'title' => '@label language',
      'names' => [],
      'entity_type' => 'configurable_language',
      'route_name' => 'config_translation.item.overview.entity.configurable_language.edit_form',
    ];
    $typed_config_manager = $this
      ->createMock('Drupal\\Core\\Config\\TypedConfigManagerInterface');
    $locale_config_manager = $this
      ->getMockBuilder('Drupal\\locale\\LocaleConfigManager')
      ->disableOriginalConstructor()
      ->getMock();
    $this->languageManager = $this
      ->createMock('Drupal\\Core\\Language\\LanguageManagerInterface');
    $this->eventDispatcher = $this
      ->createMock('Symfony\\Component\\EventDispatcher\\EventDispatcherInterface');
    $this->configEntityMapper = new ConfigEntityMapper('configurable_language', $definition, $this
      ->getConfigFactoryStub(), $typed_config_manager, $locale_config_manager, $this
      ->createMock('Drupal\\config_translation\\ConfigMapperManagerInterface'), $this->routeProvider, $this
      ->getStringTranslationStub(), $this->entityTypeManager, $this->languageManager, $this->eventDispatcher);
  }

  /**
   * Tests ConfigEntityMapper::setEntity() and ConfigEntityMapper::getEntity().
   */
  public function testEntityGetterAndSetter() {
    $this->entity
      ->expects($this
      ->once())
      ->method('id')
      ->with()
      ->will($this
      ->returnValue('entity_id'));
    $entity_type = $this
      ->createMock('Drupal\\Core\\Config\\Entity\\ConfigEntityTypeInterface');
    $entity_type
      ->expects($this
      ->any())
      ->method('getConfigPrefix')
      ->will($this
      ->returnValue('config_prefix'));
    $this->entityTypeManager
      ->expects($this
      ->once())
      ->method('getDefinition')
      ->with('configurable_language')
      ->will($this
      ->returnValue($entity_type));

    // No entity is set.
    $this
      ->assertNull($this->configEntityMapper
      ->getEntity());
    $result = $this->configEntityMapper
      ->setEntity($this->entity);
    $this
      ->assertTrue($result);

    // Ensure that the getter provides the entity.
    $this
      ->assertEquals($this->entity, $this->configEntityMapper
      ->getEntity());

    // Ensure that the configuration name was added to the mapper.
    $plugin_definition = $this->configEntityMapper
      ->getPluginDefinition();
    $this
      ->assertContains('config_prefix.entity_id', $plugin_definition['names']);

    // Make sure setEntity() returns FALSE when called a second time.
    $result = $this->configEntityMapper
      ->setEntity($this->entity);
    $this
      ->assertFalse($result);
  }

  /**
   * Tests ConfigEntityMapper::getOverviewRouteParameters().
   */
  public function testGetOverviewRouteParameters() {
    $entity_type = $this
      ->createMock('Drupal\\Core\\Config\\Entity\\ConfigEntityTypeInterface');
    $this->entityTypeManager
      ->expects($this
      ->once())
      ->method('getDefinition')
      ->with('configurable_language')
      ->will($this
      ->returnValue($entity_type));
    $this->configEntityMapper
      ->setEntity($this->entity);
    $this->entity
      ->expects($this
      ->once())
      ->method('id')
      ->with()
      ->will($this
      ->returnValue('entity_id'));
    $result = $this->configEntityMapper
      ->getOverviewRouteParameters();
    $this
      ->assertSame([
      'configurable_language' => 'entity_id',
    ], $result);
  }

  /**
   * Tests ConfigEntityMapper::getType().
   */
  public function testGetType() {
    $result = $this->configEntityMapper
      ->getType();
    $this
      ->assertSame('configurable_language', $result);
  }

  /**
   * Tests ConfigEntityMapper::getTypeName().
   */
  public function testGetTypeName() {
    $entity_type = $this
      ->createMock('Drupal\\Core\\Config\\Entity\\ConfigEntityTypeInterface');
    $entity_type
      ->expects($this
      ->once())
      ->method('getLabel')
      ->will($this
      ->returnValue('test'));
    $this->entityTypeManager
      ->expects($this
      ->once())
      ->method('getDefinition')
      ->with('configurable_language')
      ->will($this
      ->returnValue($entity_type));
    $result = $this->configEntityMapper
      ->getTypeName();
    $this
      ->assertSame('test', $result);
  }

  /**
   * Tests ConfigEntityMapper::getTypeLabel().
   */
  public function testGetTypeLabel() {
    $entity_type = $this
      ->createMock('Drupal\\Core\\Config\\Entity\\ConfigEntityTypeInterface');
    $entity_type
      ->expects($this
      ->once())
      ->method('getLabel')
      ->will($this
      ->returnValue('test'));
    $this->entityTypeManager
      ->expects($this
      ->once())
      ->method('getDefinition')
      ->with('configurable_language')
      ->will($this
      ->returnValue($entity_type));
    $result = $this->configEntityMapper
      ->getTypeLabel();
    $this
      ->assertSame('test', $result);
  }

  /**
   * Tests ConfigEntityMapper::getOperations().
   */
  public function testGetOperations() {
    $result = $this->configEntityMapper
      ->getOperations();
    $expected = [
      'list' => [
        'title' => 'List',
        'url' => Url::fromRoute('config_translation.entity_list', [
          'mapper_id' => 'configurable_language',
        ]),
      ],
    ];
    $this
      ->assertEquals($expected, $result);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigEntityMapperTest::$configEntityMapper	protected	property	The configuration entity mapper to test.
ConfigEntityMapperTest::$entity	protected	property	The entity instance used for testing.
ConfigEntityMapperTest::$entityTypeManager	protected	property	The entity type manager used for testing.
ConfigEntityMapperTest::$eventDispatcher	protected	property	The mocked event dispatcher.
ConfigEntityMapperTest::$languageManager	protected	property	The mocked language manager.
ConfigEntityMapperTest::$routeProvider	protected	property	The route provider used for testing.
ConfigEntityMapperTest::setUp	protected	function	Overrides UnitTestCase::setUp
ConfigEntityMapperTest::testEntityGetterAndSetter	public	function	Tests ConfigEntityMapper::setEntity() and ConfigEntityMapper::getEntity().
ConfigEntityMapperTest::testGetOperations	public	function	Tests ConfigEntityMapper::getOperations().
ConfigEntityMapperTest::testGetOverviewRouteParameters	public	function	Tests ConfigEntityMapper::getOverviewRouteParameters().
ConfigEntityMapperTest::testGetType	public	function	Tests ConfigEntityMapper::getType().
ConfigEntityMapperTest::testGetTypeLabel	public	function	Tests ConfigEntityMapper::getTypeLabel().
ConfigEntityMapperTest::testGetTypeName	public	function	Tests ConfigEntityMapper::getTypeName().
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.