DiscoveryTraitTest.php in Drupal 8

Namespace

Drupal\Tests\Component\Plugin\Discovery

File

core/tests/Drupal/Tests/Component/Plugin/Discovery/DiscoveryTraitTest.php

<?php

namespace Drupal\Tests\Component\Plugin\Discovery;

use Drupal\Component\Plugin\Exception\PluginNotFoundException;
use PHPUnit\Framework\TestCase;

/**
 * @group Plugin
 * @coversDefaultClass \Drupal\Component\Plugin\Discovery\DiscoveryTrait
 */
class DiscoveryTraitTest extends TestCase {

  /**
   * Data provider for testDoGetDefinition().
   *
   * @return array
   *   - Expected plugin definition.
   *   - Plugin definition array, to pass to doGetDefinition().
   *   - Plugin ID to get, passed to doGetDefinition().
   */
  public function providerDoGetDefinition() {
    return [
      [
        'definition',
        [
          'plugin_name' => 'definition',
        ],
        'plugin_name',
      ],
      [
        NULL,
        [
          'plugin_name' => 'definition',
        ],
        'bad_plugin_name',
      ],
    ];
  }

  /**
   * @covers ::doGetDefinition
   * @dataProvider providerDoGetDefinition
   */
  public function testDoGetDefinition($expected, $definitions, $plugin_id) {

    // Mock the trait.
    $trait = $this
      ->getMockForTrait('Drupal\\Component\\Plugin\\Discovery\\DiscoveryTrait');

    // Un-protect the method using reflection.
    $method_ref = new \ReflectionMethod($trait, 'doGetDefinition');
    $method_ref
      ->setAccessible(TRUE);

    // Call doGetDefinition, with $exception_on_invalid always FALSE.
    $this
      ->assertSame($expected, $method_ref
      ->invoke($trait, $definitions, $plugin_id, FALSE));
  }

  /**
   * Data provider for testDoGetDefinitionException()
   *
   * @return array
   *   - Expected plugin definition.
   *   - Plugin definition array, to pass to doGetDefinition().
   *   - Plugin ID to get, passed to doGetDefinition().
   */
  public function providerDoGetDefinitionException() {
    return [
      [
        FALSE,
        [
          'plugin_name' => 'definition',
        ],
        'bad_plugin_name',
      ],
    ];
  }

  /**
   * @covers ::doGetDefinition
   * @dataProvider providerDoGetDefinitionException
   * @uses \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public function testDoGetDefinitionException($expected, $definitions, $plugin_id) {

    // Mock the trait.
    $trait = $this
      ->getMockForTrait('Drupal\\Component\\Plugin\\Discovery\\DiscoveryTrait');

    // Un-protect the method using reflection.
    $method_ref = new \ReflectionMethod($trait, 'doGetDefinition');
    $method_ref
      ->setAccessible(TRUE);

    // Call doGetDefinition, with $exception_on_invalid always TRUE.
    $this
      ->expectException(PluginNotFoundException::class);
    $method_ref
      ->invoke($trait, $definitions, $plugin_id, TRUE);
  }

  /**
   * @covers ::getDefinition
   * @dataProvider providerDoGetDefinition
   */
  public function testGetDefinition($expected, $definitions, $plugin_id) {

    // Since getDefinition is a wrapper around doGetDefinition(), we can re-use
    // its data provider. We just have to tell abstract method getDefinitions()
    // to use the $definitions array.
    $trait = $this
      ->getMockForTrait('Drupal\\Component\\Plugin\\Discovery\\DiscoveryTrait');
    $trait
      ->expects($this
      ->once())
      ->method('getDefinitions')
      ->willReturn($definitions);

    // Call getDefinition(), with $exception_on_invalid always FALSE.
    $this
      ->assertSame($expected, $trait
      ->getDefinition($plugin_id, FALSE));
  }

  /**
   * @covers ::getDefinition
   * @dataProvider providerDoGetDefinitionException
   * @uses \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public function testGetDefinitionException($expected, $definitions, $plugin_id) {

    // Since getDefinition is a wrapper around doGetDefinition(), we can re-use
    // its data provider. We just have to tell abstract method getDefinitions()
    // to use the $definitions array.
    $trait = $this
      ->getMockForTrait('Drupal\\Component\\Plugin\\Discovery\\DiscoveryTrait');
    $trait
      ->expects($this
      ->once())
      ->method('getDefinitions')
      ->willReturn($definitions);

    // Call getDefinition(), with $exception_on_invalid always TRUE.
    $this
      ->expectException(PluginNotFoundException::class);
    $trait
      ->getDefinition($plugin_id, TRUE);
  }

  /**
   * Data provider for testHasDefinition().
   *
   * @return array
   *   - Expected TRUE or FALSE.
   *   - Plugin ID to look for.
   */
  public function providerHasDefinition() {
    return [
      [
        TRUE,
        'valid',
      ],
      [
        FALSE,
        'not_valid',
      ],
    ];
  }

  /**
   * @covers ::hasDefinition
   * @dataProvider providerHasDefinition
   */
  public function testHasDefinition($expected, $plugin_id) {
    $trait = $this
      ->getMockBuilder('Drupal\\Component\\Plugin\\Discovery\\DiscoveryTrait')
      ->setMethods([
      'getDefinition',
    ])
      ->getMockForTrait();

    // Set up our mocked getDefinition() to return TRUE for 'valid' and FALSE
    // for 'not_valid'.
    $trait
      ->expects($this
      ->once())
      ->method('getDefinition')
      ->will($this
      ->returnValueMap([
      [
        'valid',
        FALSE,
        TRUE,
      ],
      [
        'not_valid',
        FALSE,
        FALSE,
      ],
    ]));

    // Call hasDefinition().
    $this
      ->assertSame($expected, $trait
      ->hasDefinition($plugin_id));
  }

}

Classes

Name	Description
DiscoveryTraitTest	@group Plugin @coversDefaultClass \Drupal\Component\Plugin\Discovery\DiscoveryTrait