DefaultFactoryTest.php in Zircon Profile 8

Contains \Drupal\Tests\Component\Plugin\DefaultFactoryTest.

Namespace

Drupal\Tests\Component\Plugin

File

core/tests/Drupal/Tests/Component/Plugin/DefaultFactoryTest.php

<?php

/**
 * @file
 * Contains \Drupal\Tests\Component\Plugin\DefaultFactoryTest.
 */
namespace Drupal\Tests\Component\Plugin;

use Drupal\Component\Plugin\Definition\PluginDefinitionInterface;
use Drupal\Component\Plugin\Factory\DefaultFactory;
use Drupal\plugin_test\Plugin\plugin_test\fruit\Cherry;
use Drupal\plugin_test\Plugin\plugin_test\fruit\FruitInterface;
use Drupal\plugin_test\Plugin\plugin_test\fruit\Kale;
use Drupal\Tests\UnitTestCase;

/**
 * @coversDefaultClass \Drupal\Component\Plugin\Factory\DefaultFactory
 * @group Plugin
 */
class DefaultFactoryTest extends UnitTestCase {

  /**
   * Tests getPluginClass() with a valid array plugin definition.
   *
   * @covers ::getPluginClass
   */
  public function testGetPluginClassWithValidArrayPluginDefinition() {
    $plugin_class = Cherry::class;
    $class = DefaultFactory::getPluginClass('cherry', [
      'class' => $plugin_class,
    ]);
    $this
      ->assertEquals($plugin_class, $class);
  }

  /**
   * Tests getPluginClass() with a valid object plugin definition.
   *
   * @covers ::getPluginClass
   */
  public function testGetPluginClassWithValidObjectPluginDefinition() {
    $plugin_class = Cherry::class;
    $plugin_definition = $this
      ->getMock(PluginDefinitionInterface::class);
    $plugin_definition
      ->expects($this
      ->atLeastOnce())
      ->method('getClass')
      ->willReturn($plugin_class);
    $class = DefaultFactory::getPluginClass('cherry', $plugin_definition);
    $this
      ->assertEquals($plugin_class, $class);
  }

  /**
   * Tests getPluginClass() with a missing class definition.
   *
   * @covers ::getPluginClass
   *
   * @expectedException \Drupal\Component\Plugin\Exception\PluginException
   * @expectedExceptionMessage The plugin (cherry) did not specify an instance class.
   */
  public function testGetPluginClassWithMissingClassWithArrayPluginDefinition() {
    DefaultFactory::getPluginClass('cherry', []);
  }

  /**
   * Tests getPluginClass() with a missing class definition.
   *
   * @covers ::getPluginClass
   *
   * @expectedException \Drupal\Component\Plugin\Exception\PluginException
   * @expectedExceptionMessage The plugin (cherry) did not specify an instance class.
   */
  public function testGetPluginClassWithMissingClassWithObjectPluginDefinition() {
    $plugin_definition = $this
      ->getMock(PluginDefinitionInterface::class);
    DefaultFactory::getPluginClass('cherry', $plugin_definition);
  }

  /**
   * Tests getPluginClass() with a not existing class definition.
   *
   * @covers ::getPluginClass
   *
   * @expectedException \Drupal\Component\Plugin\Exception\PluginException
   * @expectedExceptionMessage Plugin (kiwifruit) instance class "\Drupal\plugin_test\Plugin\plugin_test\fruit\Kiwifruit" does not exist.
   */
  public function testGetPluginClassWithNotExistingClassWithArrayPluginDefinition() {
    DefaultFactory::getPluginClass('kiwifruit', [
      'class' => '\\Drupal\\plugin_test\\Plugin\\plugin_test\\fruit\\Kiwifruit',
    ]);
  }

  /**
   * Tests getPluginClass() with a not existing class definition.
   *
   * @covers ::getPluginClass
   *
   * @expectedException \Drupal\Component\Plugin\Exception\PluginException
   */
  public function testGetPluginClassWithNotExistingClassWithObjectPluginDefinition() {
    $plugin_class = '\\Drupal\\plugin_test\\Plugin\\plugin_test\\fruit\\Kiwifruit';
    $plugin_definition = $this
      ->getMock(PluginDefinitionInterface::class);
    $plugin_definition
      ->expects($this
      ->atLeastOnce())
      ->method('getClass')
      ->willReturn($plugin_class);
    DefaultFactory::getPluginClass('kiwifruit', $plugin_definition);
  }

  /**
   * Tests getPluginClass() with a required interface.
   *
   * @covers ::getPluginClass
   */
  public function testGetPluginClassWithInterfaceWithArrayPluginDefinition() {
    $plugin_class = Cherry::class;
    $class = DefaultFactory::getPluginClass('cherry', [
      'class' => $plugin_class,
    ], FruitInterface::class);
    $this
      ->assertEquals($plugin_class, $class);
  }

  /**
   * Tests getPluginClass() with a required interface.
   *
   * @covers ::getPluginClass
   */
  public function testGetPluginClassWithInterfaceWithObjectPluginDefinition() {
    $plugin_class = Cherry::class;
    $plugin_definition = $this
      ->getMock(PluginDefinitionInterface::class);
    $plugin_definition
      ->expects($this
      ->atLeastOnce())
      ->method('getClass')
      ->willReturn($plugin_class);
    $class = DefaultFactory::getPluginClass('cherry', $plugin_definition, FruitInterface::class);
    $this
      ->assertEquals($plugin_class, $class);
  }

  /**
   * Tests getPluginClass() with a required interface but no implementation.
   *
   * @covers ::getPluginClass
   *
   * @expectedException \Drupal\Component\Plugin\Exception\PluginException
   * @expectedExceptionMessage Plugin "cherry" (Drupal\plugin_test\Plugin\plugin_test\fruit\Kale) must implement interface Drupal\plugin_test\Plugin\plugin_test\fruit\FruitInterface.
   */
  public function testGetPluginClassWithInterfaceAndInvalidClassWithArrayPluginDefinition() {
    $plugin_class = Kale::class;
    DefaultFactory::getPluginClass('cherry', [
      'class' => $plugin_class,
      'provider' => 'core',
    ], FruitInterface::class);
  }

  /**
   * Tests getPluginClass() with a required interface but no implementation.
   *
   * @covers ::getPluginClass
   *
   * @expectedException \Drupal\Component\Plugin\Exception\PluginException
   */
  public function testGetPluginClassWithInterfaceAndInvalidClassWithObjectPluginDefinition() {
    $plugin_class = Kale::class;
    $plugin_definition = $this
      ->getMock(PluginDefinitionInterface::class);
    $plugin_definition
      ->expects($this
      ->atLeastOnce())
      ->method('getClass')
      ->willReturn($plugin_class);
    DefaultFactory::getPluginClass('cherry', $plugin_definition, FruitInterface::class);
  }

}

Classes

Name	Description
DefaultFactoryTest	@coversDefaultClass \Drupal\Component\Plugin\Factory\DefaultFactory @group Plugin