class PluginHierarchyTraitTest in Plugin 8.2

@coversDefaultClass \Drupal\plugin\PluginHierarchyTrait

@group Plugin

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses PhpunitCompatibilityTrait
  • class \Drupal\Tests\plugin\Unit\PluginHierarchyTraitTest

File

tests/src/Unit/PluginHierarchyTraitTest.php, line 16

Namespace

Drupal\Tests\plugin\Unit

class PluginHierarchyTraitTest extends UnitTestCase {

  /**
   * The class under test.
   *
   * @var \Drupal\plugin\PluginHierarchyTrait
   */
  protected $sut;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this->sut = $this
      ->getMockForTrait(PluginHierarchyTrait::class);
  }

  /**
   * @covers ::buildPluginHierarchy
   * @covers ::buildPluginHierarchyLevel
   */
  public function testBuildPluginHierarchy() {
    $plugin_definition_id_a = $this
      ->randomMachineName();
    $plugin_definition_label_a = 'foo';
    $plugin_definition_a = $this
      ->createMock(PluginLabelDefinitionInterface::class);
    $plugin_definition_a
      ->expects($this
      ->any())
      ->method('getLabel')
      ->willReturn($plugin_definition_label_a);
    $plugin_definition_id_b = $this
      ->randomMachineName();
    $plugin_definition_label_b = 'Bar';
    $plugin_definition_b = $this
      ->createMock(PluginLabelDefinitionInterface::class);
    $plugin_definition_b
      ->expects($this
      ->any())
      ->method('getLabel')
      ->willReturn($plugin_definition_label_b);
    $plugin_definition_id_c = $this
      ->randomMachineName();
    $plugin_definition_c = $this
      ->createMock(PluginHierarchyDefinitionInterface::class);
    $plugin_definition_c
      ->expects($this
      ->any())
      ->method('getId')
      ->willReturn($plugin_definition_id_c);
    $plugin_definition_c
      ->expects($this
      ->any())
      ->method('getParentId')
      ->willReturn($plugin_definition_id_a);
    $plugin_discovery = $this
      ->createMock(TypedDiscoveryInterface::class);
    $plugin_discovery
      ->expects($this
      ->any())
      ->method('getDefinitions')
      ->willReturn([
      $plugin_definition_id_a => $plugin_definition_a,
      $plugin_definition_id_b => $plugin_definition_b,
      $plugin_definition_id_c => $plugin_definition_c,
    ]);
    $method = new \ReflectionMethod($this->sut, 'buildPluginHierarchy');
    $method
      ->setAccessible(TRUE);

    // We need to suppress errors, because using mocks inside user comparison
    // functions always causes the "Array was modified by the user comparison
    // function" error. Because we check the output, we catch (most) problems
    // anyway.
    $hierarchy = @$method
      ->invokeArgs($this->sut, array(
      $plugin_discovery,
    ));
    $expected = [
      $plugin_definition_id_b => [],
      $plugin_definition_id_a => [
        $plugin_definition_id_c => [],
      ],
    ];
    $this
      ->assertSame($expected, $hierarchy);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.
PluginHierarchyTraitTest::$sut	protected	property	The class under test.
PluginHierarchyTraitTest::setUp	protected	function	Overrides UnitTestCase::setUp
PluginHierarchyTraitTest::testBuildPluginHierarchy	public	function	@covers ::buildPluginHierarchy @covers ::buildPluginHierarchyLevel
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.