View source
<?php
namespace Drupal\KernelTests\Core\Plugin;
use Drupal\Component\Plugin\Exception\ContextException;
use Drupal\Core\Plugin\Context\EntityContextDefinition;
use Drupal\KernelTests\KernelTestBase;
use Drupal\node\Entity\Node;
use Drupal\node\Entity\NodeType;
use Drupal\plugin_test\Plugin\MockBlockManager;
use Drupal\user\Entity\User;
class ContextPluginTest extends KernelTestBase {
protected static $modules = [
'system',
'user',
'node',
'field',
'filter',
'text',
];
public function testContext() {
$this
->installEntitySchema('user');
$this
->installEntitySchema('node');
$this
->installEntitySchema('node_type');
$type = NodeType::create([
'type' => 'page',
'name' => 'Page',
]);
$type
->save();
$name = $this
->randomMachineName();
$manager = new MockBlockManager();
$plugin = $manager
->createInstance('user_name');
$node = Node::create([
'type' => 'page',
'title' => $name,
]);
try {
$plugin
->getContextDefinition('not_exists');
$this
->fail('The user context should not yet be set.');
} catch (ContextException $e) {
$this
->assertEquals('The not_exists context is not a valid context.', $e
->getMessage());
}
$user_context_definition = EntityContextDefinition::fromEntityTypeId('user')
->setLabel('User');
$this
->assertEquals($plugin
->getContextDefinitions()['user']
->getLabel(), $user_context_definition
->getLabel());
$this
->assertEquals($plugin
->getContextDefinition('user')
->getLabel(), $user_context_definition
->getLabel());
$this
->assertNotNull($plugin
->getContext('user'), 'Succeeded to get a context with a valid definition.');
try {
$plugin
->getContextValue('user');
} catch (ContextException $e) {
$this
->assertSame("The 'entity:user' context is required and not present.", $e
->getMessage(), 'Requesting a non-set value of a required context should throw a context exception.');
}
$plugin
->setContextValue('user', $node);
$violations = $plugin
->validateContexts();
$this
->assertNotEmpty($violations, 'The provided context value does not pass validation.');
$user = User::create([
'name' => $name,
]);
$plugin
->setContextValue('user', $user);
$this
->assertEquals($user
->getAccountName(), $plugin
->getContextValue('user')
->getAccountName());
$this
->assertEquals($user
->label(), $plugin
->getTitle());
$plugin = $manager
->createInstance('user_name_optional');
$this
->assertNull($plugin
->getContextValue('user'), 'Requesting a non-set value of a valid context should return NULL.');
$complex_plugin = $manager
->createInstance('complex_context');
$complex_plugin
->setContextValue('user', $user);
$values = $complex_plugin
->getContextValues();
$this
->assertNull($values['node'], 'The node context is not yet set.');
$this
->assertNotNull($values['user'], 'The user context is set');
$complex_plugin
->setContextValue('node', $node);
$context_wrappers = $complex_plugin
->getContexts();
$this
->assertEquals($user
->label(), $context_wrappers['user']
->getContextValue()
->label());
$this
->assertEquals($node
->label(), $context_wrappers['node']
->getContextValue()
->label());
$contexts = $complex_plugin
->getContextValues();
$this
->assertEquals($user
->label(), $contexts['user']
->label());
$this
->assertEquals($node
->label(), $contexts['node']
->label());
$this
->assertEquals($user
->label() . ' -- ' . $node
->label(), $complex_plugin
->getTitle());
}
}