ContextAwarePluginTraitTest.php
Same filename in other branches
Namespace
Drupal\KernelTests\Core\Plugin\ContextFile
-
core/
tests/ Drupal/ KernelTests/ Core/ Plugin/ Context/ ContextAwarePluginTraitTest.php
View source
<?php
namespace Drupal\KernelTests\Core\Plugin\Context;
use Drupal\Component\Plugin\ConfigurableInterface;
use Drupal\Component\Plugin\Context\ContextInterface as ComponentContextInterface;
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\Core\DependencyInjection\ContainerBuilder;
use Drupal\Core\Plugin\Context\ContextDefinition;
use Drupal\Core\Plugin\ContextAwarePluginInterface;
use Drupal\Core\Plugin\ContextAwarePluginTrait;
use Drupal\Core\Plugin\PluginBase;
use Drupal\Core\TypedData\DataDefinition;
use Drupal\Core\TypedData\Plugin\DataType\StringData;
use Drupal\Core\TypedData\TypedDataManagerInterface;
use Drupal\KernelTests\KernelTestBase;
use Drupal\Tests\Traits\ExpectDeprecationTrait;
/**
* @coversDefaultClass \Drupal\Core\Plugin\ContextAwarePluginTrait
*
* @group Plugin
*/
class ContextAwarePluginTraitTest extends KernelTestBase {
use ExpectDeprecationTrait;
/**
* The plugin instance under test.
*
* @var \Drupal\Core\Plugin\ContextAwarePluginTrait
*/
private $plugin;
/**
* The configurable plugin instance under test.
*
* @var \Drupal\Core\Plugin\ContextAwarePluginTrait
*/
private $configurablePlugin;
/**
* {@inheritdoc}
*/
public function setUp() : void {
parent::setUp();
$plugin_definition = new TestContextAwarePluginDefinition();
$plugin_definition->addContextDefinition('nato_letter', ContextDefinition::create('string'));
$this->plugin = new TestContextAwarePlugin([], 'the_sisko', $plugin_definition);
$this->configurablePlugin = new TestConfigurableContextAwarePlugin([], 'the_sisko', $plugin_definition);
}
/**
* @covers ::getContextDefinitions
*/
public function testGetContextDefinitions() {
$this->assertIsArray($this->plugin
->getContextDefinitions());
}
/**
* @covers ::getContextDefinition
*/
public function testGetContextDefinition() {
// The context is not defined, so an exception will be thrown.
$this->expectException(ContextException::class);
$this->expectExceptionMessage('The person context is not a valid context.');
$this->plugin
->getContextDefinition('person');
}
/**
* @covers ::getContextValue
*/
public function testGetContextValue() {
$this->plugin
->setContextValue('nato_letter', 'Alpha');
$this->assertSame('Alpha', $this->plugin
->getContextValue('nato_letter'));
}
/**
* @covers ::getContextValue
* @group legacy
*/
public function testGetContextValueFromConfiguration() {
$this->expectDeprecation('Passing context values to plugins via configuration is deprecated in drupal:9.1.0 and will be removed before drupal:10.0.0. Instead, call ::setContextValue() on the plugin itself. See https://www.drupal.org/node/3120980');
$configuration = [
'context' => [
'nato_letter' => 'Alpha',
],
];
$this->plugin = new TestContextAwarePlugin($configuration, 'the_sisko', $this->plugin
->getPluginDefinition());
// Assert that the context value passed in the plugin configuration is
// available.
$this->assertSame('Alpha', $this->plugin
->getContextValue('nato_letter'));
}
/**
* @covers ::getContextValue
* @group legacy
*/
public function testConfigurableGetContextValueFromConfiguration() {
$this->expectDeprecation('Passing context values to plugins via configuration is deprecated in drupal:9.1.0 and will be removed before drupal:10.0.0. Instead, call ::setContextValue() on the plugin itself. See https://www.drupal.org/node/3120980');
// Assert that the context value passed in the plugin configuration is
// available.
$this->assertSame('Alpha', $this->configurablePlugin
->getContextValue('nato_letter'));
}
/**
* @covers ::setContextValue
*/
public function testSetContextValue() {
$typed_data_manager = $this->prophesize(TypedDataManagerInterface::class);
$container = new ContainerBuilder();
$container->set('typed_data_manager', $typed_data_manager->reveal());
\Drupal::setContainer($container);
$this->plugin
->getPluginDefinition()
->addContextDefinition('foo', new ContextDefinition('string'));
$this->assertFalse($this->plugin->setContextCalled);
$this->plugin
->setContextValue('foo', new StringData(new DataDefinition(), 'bar'));
$this->assertTrue($this->plugin->setContextCalled);
}
}
class TestContextAwarePluginDefinition extends PluginDefinition implements ContextAwarePluginDefinitionInterface {
use ContextAwarePluginDefinitionTrait;
}
class TestContextAwarePlugin extends PluginBase implements ContextAwarePluginInterface {
use ContextAwarePluginTrait {
setContext as setContextTrait;
}
/**
* Indicates if ::setContext() has been called or not.
*
* @var bool
*/
public $setContextCalled = FALSE;
/**
* {@inheritdoc}
*/
public function setContext($name, ComponentContextInterface $context) {
$this->setContextTrait($name, $context);
$this->setContextCalled = TRUE;
}
}
class TestConfigurableContextAwarePlugin extends PluginBase implements ConfigurableInterface, ContextAwarePluginInterface {
use ContextAwarePluginTrait;
/**
* {@inheritdoc}
*/
public function defaultConfiguration() {
return [];
}
/**
* {@inheritdoc}
*/
public function getConfiguration() {
return [
'context' => [
'nato_letter' => 'Alpha',
],
];
}
/**
* {@inheritdoc}
*/
public function setConfiguration(array $configuration) {
}
}
Classes
Title | Deprecated | Summary |
---|---|---|
ContextAwarePluginTraitTest | @coversDefaultClass \Drupal\Core\Plugin\ContextAwarePluginTrait | |
TestConfigurableContextAwarePlugin | ||
TestContextAwarePlugin | ||
TestContextAwarePluginDefinition |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.