View source
<?php
namespace Drupal\Tests\Core\Plugin;
use Drupal\Component\Plugin\ConfigurableInterface;
use Drupal\Component\Plugin\DependentPluginInterface;
use Drupal\Component\Plugin\Definition\ContextAwarePluginDefinitionInterface;
use Drupal\Component\Plugin\Definition\ContextAwarePluginDefinitionTrait;
use Drupal\Component\Plugin\Definition\PluginDefinition;
use Drupal\Component\Plugin\Exception\ContextException;
use Drupal\Component\Plugin\Exception\MissingValueContextException;
use Drupal\Core\Cache\NullBackend;
use Drupal\Core\DependencyInjection\ClassResolverInterface;
use Drupal\Core\DependencyInjection\ContainerBuilder;
use Drupal\Core\Extension\ModuleHandlerInterface;
use Drupal\Core\Plugin\Context\ContextDefinition;
use Drupal\Core\Plugin\Context\ContextHandler;
use Drupal\Core\Plugin\ContextAwarePluginInterface;
use Drupal\Core\TypedData\TypedDataManager;
use Drupal\Core\Validation\ConstraintManager;
use Drupal\Tests\UnitTestCase;
use Prophecy\Argument;
class ContextHandlerTest extends UnitTestCase {
protected $contextHandler;
protected function setUp() {
parent::setUp();
$this->contextHandler = new ContextHandler();
$namespaces = new \ArrayObject([
'Drupal\\Core\\TypedData' => $this->root . '/core/lib/Drupal/Core/TypedData',
'Drupal\\Core\\Validation' => $this->root . '/core/lib/Drupal/Core/Validation',
]);
$cache_backend = new NullBackend('cache');
$module_handler = $this
->prophesize(ModuleHandlerInterface::class);
$class_resolver = $this
->prophesize(ClassResolverInterface::class);
$class_resolver
->getInstanceFromDefinition(Argument::type('string'))
->will(function ($arguments) {
$class_name = $arguments[0];
return new $class_name();
});
$type_data_manager = new TypedDataManager($namespaces, $cache_backend, $module_handler
->reveal(), $class_resolver
->reveal());
$type_data_manager
->setValidationConstraintManager(new ConstraintManager($namespaces, $cache_backend, $module_handler
->reveal()));
$container = new ContainerBuilder();
$container
->set('typed_data_manager', $type_data_manager);
\Drupal::setContainer($container);
}
public function testCheckRequirements($contexts, $requirements, $expected) {
$this
->assertSame($expected, $this->contextHandler
->checkRequirements($contexts, $requirements));
}
public function providerTestCheckRequirements() {
$requirement_optional = new ContextDefinition();
$requirement_optional
->setRequired(FALSE);
$requirement_any = new ContextDefinition();
$requirement_any
->setRequired(TRUE);
$context_any = $this
->createMock('Drupal\\Core\\Plugin\\Context\\ContextInterface');
$context_any
->expects($this
->atLeastOnce())
->method('getContextDefinition')
->will($this
->returnValue(new ContextDefinition('any')));
$requirement_specific = new ContextDefinition('string');
$requirement_specific
->setConstraints([
'Blank' => [],
]);
$context_constraint_mismatch = $this
->createMock('Drupal\\Core\\Plugin\\Context\\ContextInterface');
$context_constraint_mismatch
->expects($this
->atLeastOnce())
->method('getContextDefinition')
->will($this
->returnValue(new ContextDefinition('foo')));
$context_datatype_mismatch = $this
->createMock('Drupal\\Core\\Plugin\\Context\\ContextInterface');
$context_datatype_mismatch
->expects($this
->atLeastOnce())
->method('getContextDefinition')
->will($this
->returnValue(new ContextDefinition('fuzzy')));
$context_definition_specific = new ContextDefinition('string');
$context_definition_specific
->setConstraints([
'Blank' => [],
]);
$context_specific = $this
->createMock('Drupal\\Core\\Plugin\\Context\\ContextInterface');
$context_specific
->expects($this
->atLeastOnce())
->method('getContextDefinition')
->will($this
->returnValue($context_definition_specific));
$data = [];
$data[] = [
[],
[],
TRUE,
];
$data[] = [
[],
[
$requirement_any,
],
FALSE,
];
$data[] = [
[],
[
$requirement_optional,
],
TRUE,
];
$data[] = [
[],
[
$requirement_any,
$requirement_optional,
],
FALSE,
];
$data[] = [
[
$context_any,
],
[
$requirement_any,
],
TRUE,
];
$data[] = [
[
$context_constraint_mismatch,
],
[
$requirement_specific,
],
FALSE,
];
$data[] = [
[
$context_datatype_mismatch,
],
[
$requirement_specific,
],
FALSE,
];
$data[] = [
[
$context_specific,
],
[
$requirement_specific,
],
TRUE,
];
return $data;
}
public function testGetMatchingContexts($contexts, $requirement, $expected = NULL) {
if (is_null($expected)) {
$expected = $contexts;
}
$this
->assertSame($expected, $this->contextHandler
->getMatchingContexts($contexts, $requirement));
}
public function providerTestGetMatchingContexts() {
$requirement_any = new ContextDefinition();
$requirement_specific = new ContextDefinition('string');
$requirement_specific
->setConstraints([
'Blank' => [],
]);
$context_any = $this
->createMock('Drupal\\Core\\Plugin\\Context\\ContextInterface');
$context_any
->expects($this
->atLeastOnce())
->method('getContextDefinition')
->will($this
->returnValue(new ContextDefinition('any')));
$context_constraint_mismatch = $this
->createMock('Drupal\\Core\\Plugin\\Context\\ContextInterface');
$context_constraint_mismatch
->expects($this
->atLeastOnce())
->method('getContextDefinition')
->will($this
->returnValue(new ContextDefinition('foo')));
$context_datatype_mismatch = $this
->createMock('Drupal\\Core\\Plugin\\Context\\ContextInterface');
$context_datatype_mismatch
->expects($this
->atLeastOnce())
->method('getContextDefinition')
->will($this
->returnValue(new ContextDefinition('fuzzy')));
$context_definition_specific = new ContextDefinition('string');
$context_definition_specific
->setConstraints([
'Blank' => [],
]);
$context_specific = $this
->createMock('Drupal\\Core\\Plugin\\Context\\ContextInterface');
$context_specific
->expects($this
->atLeastOnce())
->method('getContextDefinition')
->will($this
->returnValue($context_definition_specific));
$data = [];
$data[] = [
[],
$requirement_any,
];
$data[] = [
[
$context_any,
],
$requirement_any,
];
$data[] = [
[
$context_specific,
],
$requirement_specific,
];
$data[] = [
[
$context_constraint_mismatch,
],
$requirement_specific,
[],
];
$data[] = [
[
$context_datatype_mismatch,
],
$requirement_specific,
[],
];
return $data;
}
public function testFilterPluginDefinitionsByContexts($has_context, $definitions, $expected) {
if ($has_context) {
$context = $this
->createMock('Drupal\\Core\\Plugin\\Context\\ContextInterface');
$expected_context_definition = (new ContextDefinition('string'))
->setConstraints([
'Blank' => [],
]);
$context
->expects($this
->atLeastOnce())
->method('getContextDefinition')
->will($this
->returnValue($expected_context_definition));
$contexts = [
$context,
];
}
else {
$contexts = [];
}
$this
->assertSame($expected, $this->contextHandler
->filterPluginDefinitionsByContexts($contexts, $definitions));
}
public function providerTestFilterPluginDefinitionsByContexts() {
$data = [];
$plugins = [];
$data[] = [
FALSE,
$plugins,
[],
];
$plugins = [
'expected_array_plugin' => [],
'expected_object_plugin' => new ContextAwarePluginDefinition(),
];
$data[] = [
FALSE,
$plugins,
$plugins,
];
$plugins = [
'expected_array_plugin' => [
'context_definitions' => [],
],
'expected_object_plugin' => new ContextAwarePluginDefinition(),
];
$data[] = [
FALSE,
$plugins,
$plugins,
];
$plugins = [
'expected_array_plugin' => [
'context_definitions' => [
'context1' => new ContextDefinition('string'),
],
],
'expected_object_plugin' => (new ContextAwarePluginDefinition())
->addContextDefinition('context1', new ContextDefinition('string')),
];
$data[] = [
FALSE,
$plugins,
[],
];
$data[] = [
TRUE,
$plugins,
$plugins,
];
$mismatched_context_definition = (new ContextDefinition('expected_data_type'))
->setConstraints([
'mismatched_constraint_name' => 'mismatched_constraint_value',
]);
$plugins = [
'expected_array_plugin' => [
'context_definitions' => [
'context1' => $mismatched_context_definition,
],
],
'expected_object_plugin' => (new ContextAwarePluginDefinition())
->addContextDefinition('context1', $mismatched_context_definition),
];
$data[] = [
TRUE,
$plugins,
[],
];
$optional_mismatched_context_definition = clone $mismatched_context_definition;
$optional_mismatched_context_definition
->setRequired(FALSE);
$plugins = [
'expected_array_plugin' => [
'context_definitions' => [
'context1' => $optional_mismatched_context_definition,
],
],
'expected_object_plugin' => (new ContextAwarePluginDefinition())
->addContextDefinition('context1', $optional_mismatched_context_definition),
];
$data[] = [
FALSE,
$plugins,
$plugins,
];
$expected_context_definition = (new ContextDefinition('string'))
->setConstraints([
'Blank' => [],
]);
$plugins = [
'expected_array_plugin' => [
'context_definitions' => [
'context1' => $expected_context_definition,
],
],
'expected_object_plugin' => (new ContextAwarePluginDefinition())
->addContextDefinition('context1', $expected_context_definition),
];
$data[] = [
TRUE,
$plugins,
$plugins,
];
$optional_expected_context_definition = clone $expected_context_definition;
$optional_expected_context_definition
->setRequired(FALSE);
$plugins = [
'expected_array_plugin' => [
'context_definitions' => [
'context1' => $optional_expected_context_definition,
],
],
'expected_object_plugin' => (new ContextAwarePluginDefinition())
->addContextDefinition('context1', $optional_expected_context_definition),
];
$data[] = [
FALSE,
$plugins,
$plugins,
];
$unexpected_context_definition = (new ContextDefinition('unexpected_data_type'))
->setConstraints([
'mismatched_constraint_name' => 'mismatched_constraint_value',
]);
$plugins = [
'unexpected_array_plugin' => [
'context_definitions' => [
'context1' => $unexpected_context_definition,
],
],
'expected_array_plugin' => [
'context_definitions' => [
'context2' => new ContextDefinition('string'),
],
],
'unexpected_object_plugin' => (new ContextAwarePluginDefinition())
->addContextDefinition('context1', $unexpected_context_definition),
'expected_object_plugin' => (new ContextAwarePluginDefinition())
->addContextDefinition('context2', new ContextDefinition('string')),
];
$data[] = [
TRUE,
$plugins,
[
'expected_array_plugin' => $plugins['expected_array_plugin'],
'expected_object_plugin' => $plugins['expected_object_plugin'],
],
];
return $data;
}
public function testApplyContextMapping() {
$context_hit = $this
->createMock('Drupal\\Core\\Plugin\\Context\\ContextInterface');
$context_hit
->expects($this
->atLeastOnce())
->method('hasContextValue')
->willReturn(TRUE);
$context_miss = $this
->createMock('Drupal\\Core\\Plugin\\Context\\ContextInterface');
$contexts = [
'hit' => $context_hit,
'miss' => $context_miss,
];
$context_definition = $this
->createMock('Drupal\\Core\\Plugin\\Context\\ContextDefinitionInterface');
$plugin = $this
->createMock('Drupal\\Core\\Plugin\\ContextAwarePluginInterface');
$plugin
->expects($this
->once())
->method('getContextMapping')
->willReturn([]);
$plugin
->expects($this
->once())
->method('getContextDefinitions')
->will($this
->returnValue([
'hit' => $context_definition,
]));
$plugin
->expects($this
->once())
->method('setContext')
->with('hit', $context_hit);
$plugin_context = $this
->createMock('Drupal\\Core\\Plugin\\Context\\ContextInterface');
$plugin_context
->expects($this
->once())
->method('addCacheableDependency')
->with($context_hit);
$plugin
->expects($this
->once())
->method('getContext')
->with('hit')
->willReturn($plugin_context);
$this->contextHandler
->applyContextMapping($plugin, $contexts);
}
public function testApplyContextMappingMissingRequired() {
$context = $this
->createMock('Drupal\\Core\\Plugin\\Context\\ContextInterface');
$context
->expects($this
->never())
->method('getContextValue');
$contexts = [
'name' => $context,
];
$context_definition = $this
->createMock('Drupal\\Core\\Plugin\\Context\\ContextDefinitionInterface');
$context_definition
->expects($this
->atLeastOnce())
->method('isRequired')
->willReturn(TRUE);
$plugin = $this
->createMock('Drupal\\Tests\\Core\\Plugin\\TestConfigurableContextAwarePluginInterface');
$plugin
->expects($this
->once())
->method('getContextMapping')
->willReturn([]);
$plugin
->expects($this
->once())
->method('getContextDefinitions')
->will($this
->returnValue([
'hit' => $context_definition,
]));
$plugin
->expects($this
->never())
->method('setContext');
$plugin
->expects($this
->any())
->method('getContext')
->willThrowException(new ContextException());
$this
->expectException(MissingValueContextException::class);
$this
->expectExceptionMessage('Required contexts without a value: hit');
$this->contextHandler
->applyContextMapping($plugin, $contexts);
}
public function testApplyContextMappingMissingNotRequired() {
$context = $this
->createMock('Drupal\\Core\\Plugin\\Context\\ContextInterface');
$context
->expects($this
->never())
->method('getContextValue');
$contexts = [
'name' => $context,
];
$context_definition = $this
->createMock('Drupal\\Core\\Plugin\\Context\\ContextDefinitionInterface');
$context_definition
->expects($this
->atLeastOnce())
->method('isRequired')
->willReturn(FALSE);
$plugin = $this
->createMock('Drupal\\Tests\\Core\\Plugin\\TestConfigurableContextAwarePluginInterface');
$plugin
->expects($this
->once())
->method('getContextMapping')
->willReturn([
'optional' => 'missing',
]);
$plugin
->expects($this
->once())
->method('getContextDefinitions')
->will($this
->returnValue([
'optional' => $context_definition,
]));
$plugin
->expects($this
->never())
->method('setContext');
$plugin
->expects($this
->any())
->method('getContext')
->willThrowException(new ContextException());
$this->contextHandler
->applyContextMapping($plugin, $contexts);
}
public function testApplyContextMappingNoValueRequired() {
$context = $this
->createMock('Drupal\\Core\\Plugin\\Context\\ContextInterface');
$context
->expects($this
->never())
->method('getContextValue');
$context
->expects($this
->atLeastOnce())
->method('hasContextValue')
->willReturn(FALSE);
$contexts = [
'hit' => $context,
];
$context_definition = $this
->createMock('Drupal\\Core\\Plugin\\Context\\ContextDefinitionInterface');
$context_definition
->expects($this
->atLeastOnce())
->method('isRequired')
->willReturn(TRUE);
$plugin = $this
->createMock('Drupal\\Tests\\Core\\Plugin\\TestConfigurableContextAwarePluginInterface');
$plugin
->expects($this
->once())
->method('getContextMapping')
->willReturn([]);
$plugin
->expects($this
->once())
->method('getContextDefinitions')
->will($this
->returnValue([
'hit' => $context_definition,
]));
$plugin
->expects($this
->never())
->method('setContext');
$this
->expectException(MissingValueContextException::class);
$this
->expectExceptionMessage('Required contexts without a value: hit');
$this->contextHandler
->applyContextMapping($plugin, $contexts);
}
public function testApplyContextMappingNoValueNonRequired() {
$context = $this
->createMock('Drupal\\Core\\Plugin\\Context\\ContextInterface');
$context
->expects($this
->never())
->method('getContextValue');
$context
->expects($this
->atLeastOnce())
->method('hasContextValue')
->willReturn(FALSE);
$contexts = [
'hit' => $context,
];
$context_definition = $this
->createMock('Drupal\\Core\\Plugin\\Context\\ContextDefinitionInterface');
$context_definition
->expects($this
->atLeastOnce())
->method('isRequired')
->willReturn(FALSE);
$plugin = $this
->createMock('Drupal\\Tests\\Core\\Plugin\\TestConfigurableContextAwarePluginInterface');
$plugin
->expects($this
->once())
->method('getContextMapping')
->willReturn([]);
$plugin
->expects($this
->once())
->method('getContextDefinitions')
->will($this
->returnValue([
'hit' => $context_definition,
]));
$plugin
->expects($this
->never())
->method('setContext');
$this->contextHandler
->applyContextMapping($plugin, $contexts);
}
public function testApplyContextMappingConfigurableAssigned() {
$context = $this
->createMock('Drupal\\Core\\Plugin\\Context\\ContextInterface');
$context
->expects($this
->atLeastOnce())
->method('hasContextValue')
->willReturn(TRUE);
$contexts = [
'name' => $context,
];
$context_definition = $this
->createMock('Drupal\\Core\\Plugin\\Context\\ContextDefinitionInterface');
$plugin = $this
->createMock('Drupal\\Tests\\Core\\Plugin\\TestConfigurableContextAwarePluginInterface');
$plugin
->expects($this
->once())
->method('getContextMapping')
->willReturn([]);
$plugin
->expects($this
->once())
->method('getContextDefinitions')
->will($this
->returnValue([
'hit' => $context_definition,
]));
$plugin
->expects($this
->once())
->method('setContext')
->with('hit', $context);
$plugin_context = $this
->createMock('Drupal\\Core\\Plugin\\Context\\ContextInterface');
$plugin_context
->expects($this
->once())
->method('addCacheableDependency')
->with($context);
$plugin
->expects($this
->once())
->method('getContext')
->with('hit')
->willReturn($plugin_context);
$this->contextHandler
->applyContextMapping($plugin, $contexts, [
'hit' => 'name',
]);
}
public function testApplyContextMappingConfigurableAssignedMiss() {
$context = $this
->createMock('Drupal\\Core\\Plugin\\Context\\ContextInterface');
$context
->expects($this
->never())
->method('getContextValue');
$contexts = [
'name' => $context,
];
$context_definition = $this
->createMock('Drupal\\Core\\Plugin\\Context\\ContextDefinitionInterface');
$plugin = $this
->createMock('Drupal\\Tests\\Core\\Plugin\\TestConfigurableContextAwarePluginInterface');
$plugin
->expects($this
->once())
->method('getContextMapping')
->willReturn([]);
$plugin
->expects($this
->once())
->method('getContextDefinitions')
->will($this
->returnValue([
'hit' => $context_definition,
]));
$plugin
->expects($this
->never())
->method('setContext');
$this
->expectException(ContextException::class);
$this
->expectExceptionMessage('Assigned contexts were not satisfied: miss');
$this->contextHandler
->applyContextMapping($plugin, $contexts, [
'miss' => 'name',
]);
}
}
interface TestConfigurableContextAwarePluginInterface extends ContextAwarePluginInterface, ConfigurableInterface, DependentPluginInterface {
}
class ContextAwarePluginDefinition extends PluginDefinition implements ContextAwarePluginDefinitionInterface {
use ContextAwarePluginDefinitionTrait;
}