class FacetSourcePluginManagerTest in Facets 8

Unit test for plugin manager.

@group facets

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses PhpunitCompatibilityTrait
  • class \Drupal\Tests\facets\Unit\FacetSource\FacetSourcePluginManagerTest

File

tests/src/Unit/FacetSource/FacetSourcePluginManagerTest.php, line 19

Namespace

Drupal\Tests\facets\Unit\FacetSource

class FacetSourcePluginManagerTest extends UnitTestCase {

  /**
   * The cache backend.
   *
   * @var \Drupal\Core\Cache\CacheBackendInterface|\PHPUnit_Framework_MockObject_MockObject
   */
  protected $cache;

  /**
   * The plugin discovery.
   *
   * @var \Drupal\Component\Plugin\Discovery\DiscoveryInterface|\PHPUnit_Framework_MockObject_MockObject
   */
  protected $discovery;

  /**
   * The plugin factory.
   *
   * @var \Drupal\Component\Plugin\Factory\DefaultFactory|\PHPUnit_Framework_MockObject_MockObject
   */
  protected $factory;

  /**
   * The module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface|\PHPUnit_Framework_MockObject_MockObject
   */
  protected $moduleHandler;

  /**
   * The plugin manager under test.
   *
   * @var \Drupal\facets\FacetSource\FacetSourcePluginManager
   */
  public $sut;

  /**
   * {@inheritdoc}
   */
  public function setUp() {
    $this->discovery = $this
      ->createMock(DiscoveryInterface::class);
    $this->factory = $this
      ->getMockBuilder(DefaultFactory::class)
      ->disableOriginalConstructor()
      ->getMock();
    $this->moduleHandler = $this
      ->createMock(ModuleHandlerInterface::class);
    $this->cache = $this
      ->createMock(CacheBackendInterface::class);
    $namespaces = new ArrayObject();
    $this->sut = new FacetSourcePluginManager($namespaces, $this->cache, $this->moduleHandler);
    $discovery_property = new \ReflectionProperty($this->sut, 'discovery');
    $discovery_property
      ->setAccessible(TRUE);
    $discovery_property
      ->setValue($this->sut, $this->discovery);
    $factory_property = new \ReflectionProperty($this->sut, 'factory');
    $factory_property
      ->setAccessible(TRUE);
    $factory_property
      ->setValue($this->sut, $this->factory);
  }

  /**
   * Tests plugin manager constructor.
   */
  public function testConstruct() {
    $namespaces = new ArrayObject();
    $sut = new FacetSourcePluginManager($namespaces, $this->cache, $this->moduleHandler);
    $this
      ->assertInstanceOf(FacetSourcePluginManager::class, $sut);
  }

  /**
   * Tests plugin manager's getDefinitions method.
   */
  public function testGetDefinitions() {
    $definitions = [
      'foo' => [
        'id' => 'foo_bar',
        'label' => 'Foo bar',
        'description' => 'test',
        'display_id' => 'foo',
      ],
    ];
    $this->discovery
      ->expects($this
      ->once())
      ->method('getDefinitions')
      ->willReturn($definitions);
    $this
      ->assertSame($definitions, $this->sut
      ->getDefinitions());
  }

  /**
   * Tests plugin manager definitions.
   *
   * @dataProvider invalidDefinitions
   */
  public function testInvalidDefinitions($invalid_definition) {
    $definitions = [
      'foo' => [
        $invalid_definition,
      ],
    ];
    $this->discovery
      ->expects($this
      ->once())
      ->method('getDefinitions')
      ->willReturn($definitions);
    $this
      ->expectException(PluginException::class);
    $this->sut
      ->getDefinitions();
  }

  /**
   * Provides invalid definitions.
   *
   * @return array
   *   An invalid data provider.
   */
  public function invalidDefinitions() {
    return [
      'only id' => [
        'id' => 'owl',
      ],
      'only display_id' => [
        'display_id' => 'search_api:owl',
      ],
      'only label' => [
        'label' => 'Owl',
      ],
      'no label' => [
        'id' => 'owl',
        'display_id' => 'Owl',
      ],
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FacetSourcePluginManagerTest::$cache	protected	property	The cache backend.
FacetSourcePluginManagerTest::$discovery	protected	property	The plugin discovery.
FacetSourcePluginManagerTest::$factory	protected	property	The plugin factory.
FacetSourcePluginManagerTest::$moduleHandler	protected	property	The module handler.
FacetSourcePluginManagerTest::$sut	public	property	The plugin manager under test.
FacetSourcePluginManagerTest::invalidDefinitions	public	function	Provides invalid definitions.
FacetSourcePluginManagerTest::setUp	public	function	Overrides UnitTestCase::setUp
FacetSourcePluginManagerTest::testConstruct	public	function	Tests plugin manager constructor.
FacetSourcePluginManagerTest::testGetDefinitions	public	function	Tests plugin manager's getDefinitions method.
FacetSourcePluginManagerTest::testInvalidDefinitions	public	function	Tests plugin manager definitions.
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.