class DerivativeDiscoveryDecoratorTest
Same name in other branches
- 9 core/tests/Drupal/Tests/Core/Plugin/Discovery/DerivativeDiscoveryDecoratorTest.php \Drupal\Tests\Core\Plugin\Discovery\DerivativeDiscoveryDecoratorTest
- 8.9.x core/tests/Drupal/Tests/Core/Plugin/Discovery/DerivativeDiscoveryDecoratorTest.php \Drupal\Tests\Core\Plugin\Discovery\DerivativeDiscoveryDecoratorTest
- 10 core/tests/Drupal/Tests/Core/Plugin/Discovery/DerivativeDiscoveryDecoratorTest.php \Drupal\Tests\Core\Plugin\Discovery\DerivativeDiscoveryDecoratorTest
Unit tests for the derivative discovery decorator.
@coversDefaultClass \Drupal\Component\Plugin\Discovery\DerivativeDiscoveryDecorator
@group Plugin
Hierarchy
- class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses \Drupal\Tests\PhpUnitCompatibilityTrait, \Prophecy\PhpUnit\ProphecyTrait, \Drupal\TestTools\Extension\DeprecationBridge\ExpectDeprecationTrait, \Drupal\Tests\RandomGeneratorTrait
- class \Drupal\Tests\Core\Plugin\Discovery\DerivativeDiscoveryDecoratorTest extends \Drupal\Tests\UnitTestCase
Expanded class hierarchy of DerivativeDiscoveryDecoratorTest
File
-
core/
tests/ Drupal/ Tests/ Core/ Plugin/ Discovery/ DerivativeDiscoveryDecoratorTest.php, line 19
Namespace
Drupal\Tests\Core\Plugin\DiscoveryView source
class DerivativeDiscoveryDecoratorTest extends UnitTestCase {
/**
* The mock main discovery object.
*
* @var \Drupal\Component\Plugin\Discovery\DiscoveryInterface|\PHPUnit\Framework\MockObject\MockObject
*/
protected $discoveryMain;
/**
* {@inheritdoc}
*/
protected function setUp() : void {
parent::setUp();
$this->discoveryMain = $discovery_main = $this->createMock('Drupal\\Component\\Plugin\\Discovery\\DiscoveryInterface');
}
/**
* Tests the getDerivativeFetcher method.
*
* @see \Drupal\Component\Plugin\Discovery\DerivativeDiscoveryDecorator::getDerivativeFetcher()
*/
public function testGetDerivativeFetcher() : void {
$definitions = [];
$definitions['non_container_aware_discovery'] = [
'id' => 'non_container_aware_discovery',
'deriver' => '\\Drupal\\Tests\\Core\\Plugin\\Discovery\\TestDerivativeDiscovery',
];
$this->discoveryMain
->expects($this->any())
->method('getDefinitions')
->willReturn($definitions);
$discovery = new DerivativeDiscoveryDecorator($this->discoveryMain);
$definitions = $discovery->getDefinitions();
// Ensure that both test derivatives got added.
$this->assertCount(2, $definitions);
$this->assertEquals('non_container_aware_discovery', $definitions['non_container_aware_discovery:test_discovery_0']['id']);
$this->assertEquals('\\Drupal\\Tests\\Core\\Plugin\\Discovery\\TestDerivativeDiscovery', $definitions['non_container_aware_discovery:test_discovery_0']['deriver']);
$this->assertEquals('non_container_aware_discovery', $definitions['non_container_aware_discovery:test_discovery_1']['id']);
$this->assertEquals('\\Drupal\\Tests\\Core\\Plugin\\Discovery\\TestDerivativeDiscovery', $definitions['non_container_aware_discovery:test_discovery_1']['deriver']);
}
/**
* Tests the getDerivativeFetcher method with objects instead of arrays.
*/
public function testGetDerivativeFetcherWithAnnotationObjects() : void {
$definitions = [];
$definitions['non_container_aware_discovery'] = (object) [
'id' => 'non_container_aware_discovery',
'deriver' => '\\Drupal\\Tests\\Core\\Plugin\\Discovery\\TestDerivativeDiscoveryWithObject',
];
$this->discoveryMain
->expects($this->any())
->method('getDefinitions')
->willReturn($definitions);
$discovery = new DerivativeDiscoveryDecorator($this->discoveryMain);
$definitions = $discovery->getDefinitions();
// Ensure that both test derivatives got added.
$this->assertCount(2, $definitions);
$this->assertInstanceOf('\\stdClass', $definitions['non_container_aware_discovery:test_discovery_0']);
$this->assertEquals('non_container_aware_discovery', $definitions['non_container_aware_discovery:test_discovery_0']->id);
$this->assertEquals('\\Drupal\\Tests\\Core\\Plugin\\Discovery\\TestDerivativeDiscoveryWithObject', $definitions['non_container_aware_discovery:test_discovery_0']->deriver);
$this->assertInstanceOf('\\stdClass', $definitions['non_container_aware_discovery:test_discovery_1']);
$this->assertEquals('non_container_aware_discovery', $definitions['non_container_aware_discovery:test_discovery_1']->id);
$this->assertEquals('\\Drupal\\Tests\\Core\\Plugin\\Discovery\\TestDerivativeDiscoveryWithObject', $definitions['non_container_aware_discovery:test_discovery_1']->deriver);
}
/**
* Tests getDeriverClass with classed objects instead of arrays.
*
* @covers ::getDeriverClass
*/
public function testGetDeriverClassWithClassedDefinitions() : void {
$definitions = [];
$definition = $this->prophesize(DerivablePluginDefinitionInterface::class);
$definition->id()
->willReturn('non_container_aware_discovery');
$definition->getDeriver()
->willReturn(TestDerivativeDiscoveryWithObject::class);
$definitions['non_container_aware_discovery'] = $definition->reveal();
$this->discoveryMain
->expects($this->any())
->method('getDefinitions')
->willReturn($definitions);
$discovery = new DerivativeDiscoveryDecorator($this->discoveryMain);
$definitions = $discovery->getDefinitions();
// Ensure that both test derivatives got added.
$this->assertContainsOnlyInstancesOf(DerivablePluginDefinitionInterface::class, $definitions);
$this->assertEquals([
'non_container_aware_discovery:test_discovery_0',
'non_container_aware_discovery:test_discovery_1',
], array_keys($definitions));
}
/**
* @covers ::getDeriverClass
*/
public function testGetDeriverClassWithInvalidClassedDefinitions() : void {
$definition = $this->prophesize(DerivablePluginDefinitionInterface::class);
$definition->id()
->willReturn('non_existent_discovery');
$definition->getDeriver()
->willReturn('\\Drupal\\system\\Tests\\Plugin\\NonExistentDeriver');
$definitions['non_existent_discovery'] = $definition->reveal();
$this->discoveryMain
->expects($this->any())
->method('getDefinitions')
->willReturn($definitions);
$discovery = new DerivativeDiscoveryDecorator($this->discoveryMain);
$this->expectException(InvalidDeriverException::class);
$this->expectExceptionMessage('Plugin (non_existent_discovery) deriver "\\Drupal\\system\\Tests\\Plugin\\NonExistentDeriver" does not exist.');
$discovery->getDefinitions();
}
/**
* Tests the getDerivativeFetcher method with a non-existent class.
*
* @see \Drupal\Component\Plugin\Discovery\DerivativeDiscoveryDecorator::getDeriver().\
*/
public function testNonExistentDerivativeFetcher() : void {
$definitions = [];
// Do this with a class that doesn't exist.
$definitions['non_existent_discovery'] = [
'id' => 'non_existent_discovery',
'deriver' => '\\Drupal\\system\\Tests\\Plugin\\NonExistentDeriver',
];
$this->discoveryMain
->expects($this->any())
->method('getDefinitions')
->willReturn($definitions);
$discovery = new DerivativeDiscoveryDecorator($this->discoveryMain);
$this->expectException(InvalidDeriverException::class);
$this->expectExceptionMessage('Plugin (non_existent_discovery) deriver "\\Drupal\\system\\Tests\\Plugin\\NonExistentDeriver" does not exist.');
$discovery->getDefinitions();
}
/**
* Tests the getDerivativeFetcher method with an invalid class.
*
* @see \Drupal\Component\Plugin\Discovery\DerivativeDiscoveryDecorator::getDeriver().\
*/
public function testInvalidDerivativeFetcher() : void {
$definitions = [];
// Do this with a class that doesn't implement the interface.
$definitions['invalid_discovery'] = [
'id' => 'invalid_discovery',
'deriver' => '\\Drupal\\KernelTests\\Core\\Plugin\\DerivativeTest',
];
$this->discoveryMain
->expects($this->any())
->method('getDefinitions')
->willReturn($definitions);
$discovery = new DerivativeDiscoveryDecorator($this->discoveryMain);
$this->expectException(InvalidDeriverException::class);
$this->expectExceptionMessage('Plugin (invalid_discovery) deriver "\\Drupal\\KernelTests\\Core\\Plugin\\DerivativeTest" must implement \\Drupal\\Component\\Plugin\\Derivative\\DeriverInterface.');
$discovery->getDefinitions();
}
/**
* Tests derivative definitions when a definition already exists.
*/
public function testExistingDerivative() : void {
$definitions = [];
$definitions['non_container_aware_discovery'] = [
'id' => 'non_container_aware_discovery',
'deriver' => '\\Drupal\\Tests\\Core\\Plugin\\Discovery\\TestDerivativeDiscovery',
'string' => 'string',
'empty_string' => 'not_empty',
'array' => [
'one',
'two',
],
'empty_array' => [
'three',
],
'null_value' => TRUE,
];
// This will clash with a derivative id.
// @see \Drupal\Tests\Core\Plugin\Discovery\TestDerivativeDiscovery
$definitions['non_container_aware_discovery:test_discovery_1'] = [
'id' => 'non_container_aware_discovery:test_discovery_1',
'string' => 'string',
'empty_string' => '',
'array' => [
'one',
'two',
],
'empty_array' => [],
'null_value' => NULL,
];
$this->discoveryMain
->expects($this->any())
->method('getDefinitions')
->willReturn($definitions);
$discovery = new DerivativeDiscoveryDecorator($this->discoveryMain);
$returned_definitions = $discovery->getDefinitions();
// If the definition was merged, there should only be two.
$this->assertCount(2, $returned_definitions);
$expected = $definitions['non_container_aware_discovery'];
$expected['id'] = 'non_container_aware_discovery:test_discovery_1';
$this->assertEquals($expected, $returned_definitions['non_container_aware_discovery:test_discovery_1']);
}
/**
* Tests a single definition when a derivative already exists.
*/
public function testSingleExistingDerivative() : void {
$base_definition = [
'id' => 'non_container_aware_discovery',
'deriver' => '\\Drupal\\Tests\\Core\\Plugin\\Discovery\\TestDerivativeDiscovery',
'string' => 'string',
'empty_string' => 'not_empty',
'array' => [
'one',
'two',
],
'empty_array' => [
'three',
],
'null_value' => TRUE,
];
// This will clash with a derivative id.
// @see \Drupal\Tests\Core\Plugin\Discovery\TestDerivativeDiscovery
$derivative_definition = [
'id' => 'non_container_aware_discovery:test_discovery_1',
'string' => 'string',
'empty_string' => '',
'array' => [
'one',
'two',
],
'empty_array' => [],
'null_value' => NULL,
];
$ids = [
$derivative_definition['id'],
$base_definition['id'],
];
$this->discoveryMain
->expects($this->exactly(count($ids)))
->method('getDefinition')
->with($this->callback(function (string $id) use (&$ids) : bool {
return array_shift($ids) === $id;
}))
->willReturnOnConsecutiveCalls($derivative_definition, $base_definition);
$discovery = new DerivativeDiscoveryDecorator($this->discoveryMain);
$expected = $base_definition;
$expected['id'] = 'non_container_aware_discovery:test_discovery_1';
$this->assertEquals($expected, $discovery->getDefinition('non_container_aware_discovery:test_discovery_1'));
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
DerivativeDiscoveryDecoratorTest::$discoveryMain | protected | property | The mock main discovery object. | |
DerivativeDiscoveryDecoratorTest::setUp | protected | function | Overrides UnitTestCase::setUp | |
DerivativeDiscoveryDecoratorTest::testExistingDerivative | public | function | Tests derivative definitions when a definition already exists. | |
DerivativeDiscoveryDecoratorTest::testGetDerivativeFetcher | public | function | Tests the getDerivativeFetcher method. | |
DerivativeDiscoveryDecoratorTest::testGetDerivativeFetcherWithAnnotationObjects | public | function | Tests the getDerivativeFetcher method with objects instead of arrays. | |
DerivativeDiscoveryDecoratorTest::testGetDeriverClassWithClassedDefinitions | public | function | Tests getDeriverClass with classed objects instead of arrays. | |
DerivativeDiscoveryDecoratorTest::testGetDeriverClassWithInvalidClassedDefinitions | public | function | @covers ::getDeriverClass | |
DerivativeDiscoveryDecoratorTest::testInvalidDerivativeFetcher | public | function | Tests the getDerivativeFetcher method with an invalid class. | |
DerivativeDiscoveryDecoratorTest::testNonExistentDerivativeFetcher | public | function | Tests the getDerivativeFetcher method with a non-existent class. | |
DerivativeDiscoveryDecoratorTest::testSingleExistingDerivative | public | function | Tests a single definition when a derivative already exists. | |
ExpectDeprecationTrait::expectDeprecation | public | function | Adds an expected deprecation. | |
ExpectDeprecationTrait::getCallableName | private static | function | Returns a callable as a string suitable for inclusion in a message. | |
ExpectDeprecationTrait::setUpErrorHandler | public | function | Sets up the test error handler. | |
ExpectDeprecationTrait::tearDownErrorHandler | public | function | Tears down the test error handler. | |
RandomGeneratorTrait::getRandomGenerator | protected | function | Gets the random generator for the utility methods. | |
RandomGeneratorTrait::randomMachineName | protected | function | Generates a unique random string containing letters and numbers. | |
RandomGeneratorTrait::randomObject | public | function | Generates a random PHP object. | |
RandomGeneratorTrait::randomString | public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |
UnitTestCase::$root | protected | property | The app root. | |
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::getStringTranslationStub | public | function | Returns a stub translation manager that just returns the passed string. | |
UnitTestCase::setUpBeforeClass | public static | function |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.