Issue #2379419 by Mile23, DuaelFr: Expand unit testing for Drupal\Component\Plugin\Discovery\StaticDiscoveryDecorator
webchick
parent
ba40d78ce6
commit
9df9e020e7
|
|
@ -0,0 +1,234 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @file
|
||||||
|
* Contains \Drupal\Tests\Component\Plugin\Discovery\DiscoveryTraitTest.
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace Drupal\Tests\Component\Plugin\Discovery;
|
||||||
|
|
||||||
|
use Drupal\Tests\UnitTestCase;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @group Plugin
|
||||||
|
* @coversDefaultClass Drupal\Component\Plugin\Discovery\StaticDiscoveryDecorator
|
||||||
|
*/
|
||||||
|
class StaticDiscoveryDecoratorTest extends UnitTestCase {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Helper method to provide a mocked callback object with expectations.
|
||||||
|
*
|
||||||
|
* If there should be a registered definition, then we have to place a
|
||||||
|
* \Callable in the mock object. The return value of this callback is
|
||||||
|
* never used.
|
||||||
|
*
|
||||||
|
* @return mock
|
||||||
|
* Mocked object with expectation of registerDefinitionsCallback() being
|
||||||
|
* called once.
|
||||||
|
*/
|
||||||
|
public function getRegisterDefinitionsCallback() {
|
||||||
|
$mock_callable = $this->getMockBuilder('\stdClass')
|
||||||
|
->setMethods(array('registerDefinitionsCallback'))
|
||||||
|
->getMock();
|
||||||
|
// Set expectations for the callback method.
|
||||||
|
$mock_callable->expects($this->once())
|
||||||
|
->method('registerDefinitionsCallback');
|
||||||
|
return $mock_callable;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Data provider for testGetDefinitions().
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
* - Expected plugin definition.
|
||||||
|
* - Whether we require the method to register definitions through a
|
||||||
|
* callback.
|
||||||
|
* - Whether to throw an exception if the definition is invalid.
|
||||||
|
* - A plugin definition.
|
||||||
|
* - Base plugin ID.
|
||||||
|
*/
|
||||||
|
public function providerGetDefinition() {
|
||||||
|
return [
|
||||||
|
['is_defined', TRUE, FALSE, ['plugin-definition' => 'is_defined'], 'plugin-definition'],
|
||||||
|
// Make sure we don't call the decorated method if we shouldn't.
|
||||||
|
['is_defined', FALSE, FALSE, ['plugin-definition' => 'is_defined'], 'plugin-definition'],
|
||||||
|
// Return NULL for bad plugin id.
|
||||||
|
[NULL, FALSE, FALSE, ['plugin-definition' => 'is_defined'], 'BAD-plugin-definition'],
|
||||||
|
// Generate an exception.
|
||||||
|
[NULL, FALSE, TRUE, ['plugin-definition' => 'is_defined'], 'BAD-plugin-definition'],
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @covers ::getDefinition
|
||||||
|
* @dataProvider providerGetDefinition
|
||||||
|
*/
|
||||||
|
public function testGetDefinition($expected, $has_register_definitions, $exception_on_invalid, $definitions, $base_plugin_id) {
|
||||||
|
// Mock our StaticDiscoveryDecorator.
|
||||||
|
$mock_decorator = $this->getMockBuilder('Drupal\Component\Plugin\Discovery\StaticDiscoveryDecorator')
|
||||||
|
->disableOriginalConstructor()
|
||||||
|
->setMethods(array('registeredDefintionCallback'))
|
||||||
|
->getMock();
|
||||||
|
|
||||||
|
// Set up the ::$registerDefinitions property.
|
||||||
|
$ref_register_definitions = new \ReflectionProperty($mock_decorator, 'registerDefinitions');
|
||||||
|
$ref_register_definitions->setAccessible(TRUE);
|
||||||
|
if ($has_register_definitions) {
|
||||||
|
// Set the callback object on the mocked decorator.
|
||||||
|
$ref_register_definitions->setValue(
|
||||||
|
$mock_decorator,
|
||||||
|
array($this->getRegisterDefinitionsCallback(), 'registerDefinitionsCallback')
|
||||||
|
);
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
// There should be no registerDefinitions callback.
|
||||||
|
$ref_register_definitions->setValue($mock_decorator, NULL);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Set up ::$definitions to an empty array.
|
||||||
|
$ref_definitions = new \ReflectionProperty($mock_decorator, 'definitions');
|
||||||
|
$ref_definitions->setAccessible(TRUE);
|
||||||
|
$ref_definitions->setValue($mock_decorator, array());
|
||||||
|
|
||||||
|
// Mock a decorated object.
|
||||||
|
$mock_decorated = $this->getMockBuilder('Drupal\Component\Plugin\Discovery\DiscoveryInterface')
|
||||||
|
->setMethods(array('getDefinitions'))
|
||||||
|
->getMockForAbstractClass();
|
||||||
|
// Return our definitions from getDefinitions().
|
||||||
|
$mock_decorated->expects($this->once())
|
||||||
|
->method('getDefinitions')
|
||||||
|
->willReturn($definitions);
|
||||||
|
|
||||||
|
// Set up ::$decorated to our mocked decorated object.
|
||||||
|
$ref_decorated = new \ReflectionProperty($mock_decorator, 'decorated');
|
||||||
|
$ref_decorated->setAccessible(TRUE);
|
||||||
|
$ref_decorated->setValue($mock_decorator, $mock_decorated);
|
||||||
|
|
||||||
|
if ($exception_on_invalid) {
|
||||||
|
$this->setExpectedException('Drupal\Component\Plugin\Exception\PluginNotFoundException');
|
||||||
|
}
|
||||||
|
|
||||||
|
// Exercise getDefinition(). It calls parent::getDefinition().
|
||||||
|
$this->assertEquals(
|
||||||
|
$expected,
|
||||||
|
$mock_decorator->getDefinition($base_plugin_id, $exception_on_invalid)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Data provider for testGetDefinitions().
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
* - bool Whether the test mock has a callback.
|
||||||
|
* - array Plugin definitions.
|
||||||
|
*/
|
||||||
|
public function providerGetDefinitions() {
|
||||||
|
return [
|
||||||
|
[TRUE, ['definition' => 'is_fake']],
|
||||||
|
[FALSE, ['definition' => 'array_of_stuff']],
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @covers ::getDefinitions
|
||||||
|
* @dataProvider providerGetDefinitions
|
||||||
|
*/
|
||||||
|
public function testGetDefinitions($has_register_definitions, $definitions) {
|
||||||
|
// Mock our StaticDiscoveryDecorator.
|
||||||
|
$mock_decorator = $this->getMockBuilder('Drupal\Component\Plugin\Discovery\StaticDiscoveryDecorator')
|
||||||
|
->disableOriginalConstructor()
|
||||||
|
->setMethods(array('registeredDefintionCallback'))
|
||||||
|
->getMock();
|
||||||
|
|
||||||
|
// Set up the ::$registerDefinitions property.
|
||||||
|
$ref_register_definitions = new \ReflectionProperty($mock_decorator, 'registerDefinitions');
|
||||||
|
$ref_register_definitions->setAccessible(TRUE);
|
||||||
|
if ($has_register_definitions) {
|
||||||
|
// Set the callback object on the mocked decorator.
|
||||||
|
$ref_register_definitions->setValue(
|
||||||
|
$mock_decorator,
|
||||||
|
array($this->getRegisterDefinitionsCallback(), 'registerDefinitionsCallback')
|
||||||
|
);
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
// There should be no registerDefinitions callback.
|
||||||
|
$ref_register_definitions->setValue($mock_decorator, NULL);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Set up ::$definitions to an empty array.
|
||||||
|
$ref_definitions = new \ReflectionProperty($mock_decorator, 'definitions');
|
||||||
|
$ref_definitions->setAccessible(TRUE);
|
||||||
|
$ref_definitions->setValue($mock_decorator, array());
|
||||||
|
|
||||||
|
// Mock a decorated object.
|
||||||
|
$mock_decorated = $this->getMockBuilder('Drupal\Component\Plugin\Discovery\DiscoveryInterface')
|
||||||
|
->setMethods(array('getDefinitions'))
|
||||||
|
->getMockForAbstractClass();
|
||||||
|
// Our mocked method will return any arguments sent to it.
|
||||||
|
$mock_decorated->expects($this->once())
|
||||||
|
->method('getDefinitions')
|
||||||
|
->willReturn($definitions);
|
||||||
|
|
||||||
|
// Set up ::$decorated to our mocked decorated object.
|
||||||
|
$ref_decorated = new \ReflectionProperty($mock_decorator, 'decorated');
|
||||||
|
$ref_decorated->setAccessible(TRUE);
|
||||||
|
$ref_decorated->setValue($mock_decorator, $mock_decorated);
|
||||||
|
|
||||||
|
// Exercise getDefinitions(). It calls parent::getDefinitions() but in this
|
||||||
|
// case there will be no side-effects.
|
||||||
|
$this->assertArrayEquals(
|
||||||
|
$definitions,
|
||||||
|
$mock_decorator->getDefinitions()
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Data provider for testCall().
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
* - Method name.
|
||||||
|
* - Array of arguments to pass to the method, with the expectation that our
|
||||||
|
* mocked __call() will return them.
|
||||||
|
*/
|
||||||
|
public function providerCall() {
|
||||||
|
return [
|
||||||
|
['complexArguments', ['1', 2.0, 3, ['4' => 'five']]],
|
||||||
|
['noArguments', []],
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @covers ::__call
|
||||||
|
* @dataProvider providerCall
|
||||||
|
*/
|
||||||
|
public function testCall($method, $args) {
|
||||||
|
// Mock a decorated object.
|
||||||
|
$mock_decorated = $this->getMockBuilder('Drupal\Component\Plugin\Discovery\DiscoveryInterface')
|
||||||
|
->setMethods(array($method))
|
||||||
|
->getMockForAbstractClass();
|
||||||
|
// Our mocked method will return any arguments sent to it.
|
||||||
|
$mock_decorated->expects($this->once())
|
||||||
|
->method($method)
|
||||||
|
->willReturnCallback(
|
||||||
|
function () {
|
||||||
|
return \func_get_args();
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
|
// Create a mock decorator.
|
||||||
|
$mock_decorator = $this->getMockBuilder('Drupal\Component\Plugin\Discovery\StaticDiscoveryDecorator')
|
||||||
|
->disableOriginalConstructor()
|
||||||
|
->getMock();
|
||||||
|
// Poke the decorated object into our decorator.
|
||||||
|
$ref_decorated = new \ReflectionProperty($mock_decorator, 'decorated');
|
||||||
|
$ref_decorated->setAccessible(TRUE);
|
||||||
|
$ref_decorated->setValue($mock_decorator, $mock_decorated);
|
||||||
|
|
||||||
|
// Exercise __call.
|
||||||
|
$this->assertArrayEquals(
|
||||||
|
$args,
|
||||||
|
\call_user_func_array(array($mock_decorated, $method), $args)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
Loading…
Reference in New Issue