class ElementInfoManagerTest in Drupal 8

@coversDefaultClass \Drupal\Core\Render\ElementInfoManager @group Render

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses PhpunitCompatibilityTrait
  • class \Drupal\Tests\Core\Render\ElementInfoManagerTest

File

core/tests/Drupal/Tests/Core/Render/ElementInfoManagerTest.php, line 18

Contains \Drupal\Tests\Core\Render\ElementInfoManagerTest.

Namespace

Drupal\Tests\Core\Render

class ElementInfoManagerTest extends UnitTestCase {

  /**
   * The mocked element_info.
   *
   * @var \Drupal\Core\Render\ElementInfoManagerInterface
   */
  protected $elementInfo;

  /**
   * The cache backend to use.
   *
   * @var \Drupal\Core\Cache\CacheBackendInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $cache;

  /**
   * The mocked module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $moduleHandler;

  /**
   * The mocked theme manager.
   *
   * @var \Drupal\Core\Theme\ThemeManagerInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $themeManager;

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

  /**
   * {@inheritdoc}
   *
   * @covers ::__construct
   */
  protected function setUp() {
    parent::setUp();
    $this->cache = $this
      ->createMock('Drupal\\Core\\Cache\\CacheBackendInterface');
    $this->cacheTagsInvalidator = $this
      ->createMock('Drupal\\Core\\Cache\\CacheTagsInvalidatorInterface');
    $this->moduleHandler = $this
      ->createMock('Drupal\\Core\\Extension\\ModuleHandlerInterface');
    $this->themeManager = $this
      ->createMock('Drupal\\Core\\Theme\\ThemeManagerInterface');
    $this->elementInfo = new ElementInfoManager(new \ArrayObject(), $this->cache, $this->cacheTagsInvalidator, $this->moduleHandler, $this->themeManager);
  }

  /**
   * Tests the getInfo() method when render element plugins are used.
   *
   * @covers ::getInfo
   * @covers ::buildInfo
   *
   * @dataProvider providerTestGetInfoElementPlugin
   */
  public function testGetInfoElementPlugin($plugin_class, $expected_info) {
    $this->moduleHandler
      ->expects($this
      ->once())
      ->method('alter')
      ->with('element_info', $this
      ->anything())
      ->will($this
      ->returnArgument(0));
    $plugin = $this
      ->createMock($plugin_class);
    $plugin
      ->expects($this
      ->once())
      ->method('getInfo')
      ->willReturn([
      '#theme' => 'page',
    ]);
    $element_info = $this
      ->getMockBuilder('Drupal\\Core\\Render\\ElementInfoManager')
      ->setConstructorArgs([
      new \ArrayObject(),
      $this->cache,
      $this->cacheTagsInvalidator,
      $this->moduleHandler,
      $this->themeManager,
    ])
      ->setMethods([
      'getDefinitions',
      'createInstance',
    ])
      ->getMock();
    $this->themeManager
      ->expects($this
      ->any())
      ->method('getActiveTheme')
      ->willReturn(new ActiveTheme([
      'name' => 'test',
    ]));
    $element_info
      ->expects($this
      ->once())
      ->method('createInstance')
      ->with('page')
      ->willReturn($plugin);
    $element_info
      ->expects($this
      ->once())
      ->method('getDefinitions')
      ->willReturn([
      'page' => [
        'class' => 'TestElementPlugin',
      ],
    ]);
    $this
      ->assertEquals($expected_info, $element_info
      ->getInfo('page'));
  }

  /**
   * Provides tests data for testGetInfoElementPlugin().
   *
   * @return array
   */
  public function providerTestGetInfoElementPlugin() {
    $data = [];
    $data[] = [
      'Drupal\\Core\\Render\\Element\\ElementInterface',
      [
        '#type' => 'page',
        '#theme' => 'page',
        '#defaults_loaded' => TRUE,
      ],
    ];
    $data[] = [
      'Drupal\\Core\\Render\\Element\\FormElementInterface',
      [
        '#type' => 'page',
        '#theme' => 'page',
        '#input' => TRUE,
        '#value_callback' => [
          'TestElementPlugin',
          'valueCallback',
        ],
        '#defaults_loaded' => TRUE,
      ],
    ];
    return $data;
  }

  /**
   * @covers ::getInfoProperty
   */
  public function testGetInfoProperty() {
    $this->themeManager
      ->method('getActiveTheme')
      ->willReturn(new ActiveTheme([
      'name' => 'test',
    ]));
    $element_info = new TestElementInfoManager(new \ArrayObject(), $this->cache, $this->cacheTagsInvalidator, $this->moduleHandler, $this->themeManager);
    $this
      ->assertSame('baz', $element_info
      ->getInfoProperty('foo', '#bar'));
    $this
      ->assertNull($element_info
      ->getInfoProperty('foo', '#non_existing_property'));
    $this
      ->assertSame('qux', $element_info
      ->getInfoProperty('foo', '#non_existing_property', 'qux'));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ElementInfoManagerTest::$cache	protected	property	The cache backend to use.
ElementInfoManagerTest::$cacheTagsInvalidator	protected	property	The cache tags invalidator.
ElementInfoManagerTest::$elementInfo	protected	property	The mocked element_info.
ElementInfoManagerTest::$moduleHandler	protected	property	The mocked module handler.
ElementInfoManagerTest::$themeManager	protected	property	The mocked theme manager.
ElementInfoManagerTest::providerTestGetInfoElementPlugin	public	function	Provides tests data for testGetInfoElementPlugin().
ElementInfoManagerTest::setUp	protected	function	@covers ::__construct Overrides UnitTestCase::setUp
ElementInfoManagerTest::testGetInfoElementPlugin	public	function	Tests the getInfo() method when render element plugins are used.
ElementInfoManagerTest::testGetInfoProperty	public	function	@covers ::getInfoProperty
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.