View source
<?php
namespace Drupal\Tests\Core\Menu;
use Drupal\Core\Access\AccessResult;
use Drupal\Core\Cache\Cache;
use Drupal\Core\Cache\CacheableDependencyInterface;
use Drupal\Core\Cache\CacheableMetadata;
use Drupal\Core\Cache\Context\CacheContextsManager;
use Drupal\Core\Controller\ControllerResolver;
use Drupal\Core\DependencyInjection\ContainerBuilder;
use Drupal\Core\Language\Language;
use Drupal\Core\Menu\LocalTaskInterface;
use Drupal\Core\Menu\LocalTaskManager;
use Drupal\Tests\UnitTestCase;
use Prophecy\Argument;
use Symfony\Component\HttpFoundation\ParameterBag;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RequestStack;
class LocalTaskManagerTest extends UnitTestCase {
protected $manager;
protected $argumentResolver;
protected $request;
protected $routeProvider;
protected $pluginDiscovery;
protected $factory;
protected $cacheBackend;
protected $accessManager;
protected $routeMatch;
protected $account;
protected function setUp() {
parent::setUp();
$this->argumentResolver = $this
->createMock('Symfony\\Component\\HttpKernel\\Controller\\ArgumentResolverInterface');
$this->request = new Request();
$this->routeProvider = $this
->createMock('Drupal\\Core\\Routing\\RouteProviderInterface');
$this->pluginDiscovery = $this
->createMock('Drupal\\Component\\Plugin\\Discovery\\DiscoveryInterface');
$this->factory = $this
->createMock('Drupal\\Component\\Plugin\\Factory\\FactoryInterface');
$this->cacheBackend = $this
->createMock('Drupal\\Core\\Cache\\CacheBackendInterface');
$this->accessManager = $this
->createMock('Drupal\\Core\\Access\\AccessManagerInterface');
$this->routeMatch = $this
->createMock('Drupal\\Core\\Routing\\RouteMatchInterface');
$this->account = $this
->createMock('Drupal\\Core\\Session\\AccountInterface');
$this
->setupLocalTaskManager();
$this
->setupNullCacheabilityMetadataValidation();
}
public function testGetLocalTasksForRouteSingleLevelTitle() {
$definitions = $this
->getLocalTaskFixtures();
$this->pluginDiscovery
->expects($this
->once())
->method('getDefinitions')
->will($this
->returnValue($definitions));
$mock_plugin = $this
->createMock('Drupal\\Core\\Menu\\LocalTaskInterface');
$this
->setupFactory($mock_plugin);
$this
->setupLocalTaskManager();
$local_tasks = $this->manager
->getLocalTasksForRoute('menu_local_task_test_tasks_view');
$result = $this
->getLocalTasksForRouteResult($mock_plugin);
$this
->assertEquals($result, $local_tasks);
}
public function testGetLocalTasksForRouteForChild() {
$definitions = $this
->getLocalTaskFixtures();
$this->pluginDiscovery
->expects($this
->once())
->method('getDefinitions')
->will($this
->returnValue($definitions));
$mock_plugin = $this
->createMock('Drupal\\Core\\Menu\\LocalTaskInterface');
$this
->setupFactory($mock_plugin);
$this
->setupLocalTaskManager();
$local_tasks = $this->manager
->getLocalTasksForRoute('menu_local_task_test_tasks_child1_page');
$result = $this
->getLocalTasksForRouteResult($mock_plugin);
$this
->assertEquals($result, $local_tasks);
}
public function testGetLocalTaskForRouteWithEmptyCache() {
$definitions = $this
->getLocalTaskFixtures();
$this->pluginDiscovery
->expects($this
->once())
->method('getDefinitions')
->will($this
->returnValue($definitions));
$mock_plugin = $this
->createMock('Drupal\\Core\\Menu\\LocalTaskInterface');
$this
->setupFactory($mock_plugin);
$this
->setupLocalTaskManager();
$result = $this
->getLocalTasksForRouteResult($mock_plugin);
$this->cacheBackend
->expects($this
->at(0))
->method('get')
->with('local_task_plugins:en:menu_local_task_test_tasks_view');
$this->cacheBackend
->expects($this
->at(1))
->method('get')
->with('local_task_plugins:en');
$this->cacheBackend
->expects($this
->at(2))
->method('set')
->with('local_task_plugins:en', $definitions, Cache::PERMANENT);
$expected_set = $this
->getLocalTasksCache();
$this->cacheBackend
->expects($this
->at(3))
->method('set')
->with('local_task_plugins:en:menu_local_task_test_tasks_view', $expected_set, Cache::PERMANENT, [
'local_task',
]);
$local_tasks = $this->manager
->getLocalTasksForRoute('menu_local_task_test_tasks_view');
$this
->assertEquals($result, $local_tasks);
}
public function testGetLocalTaskForRouteWithFilledCache() {
$this->pluginDiscovery
->expects($this
->never())
->method('getDefinitions');
$mock_plugin = $this
->createMock('Drupal\\Core\\Menu\\LocalTaskInterface');
$this
->setupFactory($mock_plugin);
$this
->setupLocalTaskManager();
$result = $this
->getLocalTasksCache($mock_plugin);
$this->cacheBackend
->expects($this
->at(0))
->method('get')
->with('local_task_plugins:en:menu_local_task_test_tasks_view')
->will($this
->returnValue((object) [
'data' => $result,
]));
$this->cacheBackend
->expects($this
->never())
->method('set');
$result = $this
->getLocalTasksForRouteResult($mock_plugin);
$local_tasks = $this->manager
->getLocalTasksForRoute('menu_local_task_test_tasks_view');
$this
->assertEquals($result, $local_tasks);
}
public function testGetTitle() {
$menu_local_task = $this
->createMock('Drupal\\Core\\Menu\\LocalTaskInterface');
$menu_local_task
->expects($this
->once())
->method('getTitle');
$this->argumentResolver
->expects($this
->once())
->method('getArguments')
->with($this->request, [
$menu_local_task,
'getTitle',
])
->will($this
->returnValue([]));
$this->manager
->getTitle($menu_local_task);
}
public function testControllerResolverDeprecation() {
if (!in_array('Symfony\\Component\\HttpKernel\\Controller\\ArgumentResolverInterface', class_implements('Symfony\\Component\\HttpKernel\\Controller\\ControllerResolver'))) {
$this
->markTestSkipped("Do not test ::getArguments() method when it is not implemented by Symfony's ControllerResolver.");
}
$controller_resolver = $this
->getMockBuilder(ControllerResolver::class)
->disableOriginalConstructor()
->getMock();
$request_stack = new RequestStack();
$request_stack
->push($this->request);
$module_handler = $this
->createMock('Drupal\\Core\\Extension\\ModuleHandlerInterface');
$module_handler
->expects($this
->any())
->method('getModuleDirectories')
->willReturn([]);
$language_manager = $this
->createMock('Drupal\\Core\\Language\\LanguageManagerInterface');
$language_manager
->expects($this
->any())
->method('getCurrentLanguage')
->will($this
->returnValue(new Language([
'id' => 'en',
])));
new LocalTaskManager($controller_resolver, $request_stack, $this->routeMatch, $this->routeProvider, $module_handler, $this->cacheBackend, $language_manager, $this->accessManager, $this->account);
}
protected function setupLocalTaskManager() {
$request_stack = new RequestStack();
$request_stack
->push($this->request);
$module_handler = $this
->createMock('Drupal\\Core\\Extension\\ModuleHandlerInterface');
$module_handler
->expects($this
->any())
->method('getModuleDirectories')
->willReturn([]);
$language_manager = $this
->createMock('Drupal\\Core\\Language\\LanguageManagerInterface');
$language_manager
->expects($this
->any())
->method('getCurrentLanguage')
->will($this
->returnValue(new Language([
'id' => 'en',
])));
$this->manager = new LocalTaskManager($this->argumentResolver, $request_stack, $this->routeMatch, $this->routeProvider, $module_handler, $this->cacheBackend, $language_manager, $this->accessManager, $this->account);
$property = new \ReflectionProperty('Drupal\\Core\\Menu\\LocalTaskManager', 'discovery');
$property
->setAccessible(TRUE);
$property
->setValue($this->manager, $this->pluginDiscovery);
$property = new \ReflectionProperty('Drupal\\Core\\Menu\\LocalTaskManager', 'factory');
$property
->setAccessible(TRUE);
$property
->setValue($this->manager, $this->factory);
}
protected function getLocalTaskFixtures() {
$definitions = [];
$definitions['menu_local_task_test_tasks_settings'] = [
'route_name' => 'menu_local_task_test_tasks_settings',
'title' => 'Settings',
'base_route' => 'menu_local_task_test_tasks_view',
];
$definitions['menu_local_task_test_tasks_edit'] = [
'route_name' => 'menu_local_task_test_tasks_edit',
'title' => 'Settings',
'base_route' => 'menu_local_task_test_tasks_view',
'weight' => 20,
];
$definitions['menu_local_task_test_tasks_view.tab'] = [
'route_name' => 'menu_local_task_test_tasks_view',
'title' => 'Settings',
'base_route' => 'menu_local_task_test_tasks_view',
];
$definitions['menu_local_task_test_tasks_view_child1'] = [
'route_name' => 'menu_local_task_test_tasks_child1_page',
'title' => 'Settings child #1',
'parent_id' => 'menu_local_task_test_tasks_view.tab',
];
$definitions['menu_local_task_test_tasks_view_child2'] = [
'route_name' => 'menu_local_task_test_tasks_child2_page',
'title' => 'Settings child #2',
'parent_id' => 'menu_local_task_test_tasks_view.tab',
'base_route' => 'this_should_be_replaced',
];
foreach ($definitions as $id => &$info) {
$info['id'] = $id;
$info += [
'id' => '',
'route_name' => '',
'route_parameters' => [],
'title' => '',
'base_route' => '',
'parent_id' => NULL,
'weight' => 0,
'options' => [],
'class' => 'Drupal\\Core\\Menu\\LocalTaskDefault',
];
}
return $definitions;
}
protected function setupFactory($mock_plugin) {
$map = [];
foreach ($this
->getLocalTaskFixtures() as $info) {
$map[] = [
$info['id'],
[],
$mock_plugin,
];
}
$this->factory
->expects($this
->any())
->method('createInstance')
->will($this
->returnValueMap($map));
}
protected function getLocalTasksForRouteResult($mock_plugin) {
$result = [
0 => [
'menu_local_task_test_tasks_settings' => $mock_plugin,
'menu_local_task_test_tasks_view.tab' => $mock_plugin,
'menu_local_task_test_tasks_edit' => $mock_plugin,
],
1 => [
'menu_local_task_test_tasks_view_child1' => $mock_plugin,
'menu_local_task_test_tasks_view_child2' => $mock_plugin,
],
];
return $result;
}
protected function getLocalTasksCache() {
$local_task_fixtures = $this
->getLocalTaskFixtures();
$local_tasks = [
'base_routes' => [
'menu_local_task_test_tasks_view' => 'menu_local_task_test_tasks_view',
],
'parents' => [
'menu_local_task_test_tasks_view.tab' => TRUE,
],
'children' => [
'> menu_local_task_test_tasks_view' => [
'menu_local_task_test_tasks_settings' => $local_task_fixtures['menu_local_task_test_tasks_settings'],
'menu_local_task_test_tasks_edit' => $local_task_fixtures['menu_local_task_test_tasks_edit'],
'menu_local_task_test_tasks_view.tab' => $local_task_fixtures['menu_local_task_test_tasks_view.tab'],
],
'menu_local_task_test_tasks_view.tab' => [
'menu_local_task_test_tasks_view_child1' => [
'base_route' => 'menu_local_task_test_tasks_view',
] + $local_task_fixtures['menu_local_task_test_tasks_view_child1'],
'menu_local_task_test_tasks_view_child2' => [
'base_route' => 'menu_local_task_test_tasks_view',
] + $local_task_fixtures['menu_local_task_test_tasks_view_child2'],
],
],
];
$local_tasks['children']['> menu_local_task_test_tasks_view']['menu_local_task_test_tasks_settings']['weight'] = 0;
$local_tasks['children']['> menu_local_task_test_tasks_view']['menu_local_task_test_tasks_edit']['weight'] = 20 + 1.0E-6;
$local_tasks['children']['> menu_local_task_test_tasks_view']['menu_local_task_test_tasks_view.tab']['weight'] = 2.0E-6;
$local_tasks['children']['menu_local_task_test_tasks_view.tab']['menu_local_task_test_tasks_view_child1']['weight'] = 3.0E-6;
$local_tasks['children']['menu_local_task_test_tasks_view.tab']['menu_local_task_test_tasks_view_child2']['weight'] = 4.0E-6;
return $local_tasks;
}
public function testGetTasksBuildWithCacheabilityMetadata() {
$definitions = $this
->getLocalTaskFixtures();
$this->pluginDiscovery
->expects($this
->once())
->method('getDefinitions')
->will($this
->returnValue($definitions));
$definitions['menu_local_task_test_tasks_settings']['cache_tags'] = [
'tag.example1',
];
$definitions['menu_local_task_test_tasks_settings']['cache_contexts'] = [
'context.example1',
];
$definitions['menu_local_task_test_tasks_edit']['cache_tags'] = [
'tag.example2',
];
$definitions['menu_local_task_test_tasks_edit']['cache_contexts'] = [
'context.example2',
];
$definitions['menu_local_task_test_tasks_view_child1']['access'] = AccessResult::allowed()
->addCacheContexts([
'user.permissions',
]);
$this
->setupFactoryAndLocalTaskPlugins($definitions, 'menu_local_task_test_tasks_view');
$this
->setupLocalTaskManager();
$this->argumentResolver
->expects($this
->any())
->method('getArguments')
->willReturn([]);
$this->routeMatch
->expects($this
->any())
->method('getRouteName')
->willReturn('menu_local_task_test_tasks_view');
$this->routeMatch
->expects($this
->any())
->method('getRawParameters')
->willReturn(new ParameterBag());
$cacheability = new CacheableMetadata();
$local_tasks = $this->manager
->getTasksBuild('menu_local_task_test_tasks_view', $cacheability);
$this
->assertEquals([
'tag.example1',
'tag.example2',
], $cacheability
->getCacheTags());
$this
->assertEquals([
'context.example1',
'context.example2',
'route',
'user.permissions',
], $cacheability
->getCacheContexts());
}
protected function setupFactoryAndLocalTaskPlugins(array $definitions, $active_plugin_id) {
$map = [];
$access_manager_map = [];
foreach ($definitions as $plugin_id => $info) {
$info += [
'access' => AccessResult::allowed(),
];
$mock = $this
->prophesize(LocalTaskInterface::class);
$mock
->willImplement(CacheableDependencyInterface::class);
$mock
->getRouteName()
->willReturn($info['route_name']);
$mock
->getTitle()
->willReturn($info['title']);
$mock
->getRouteParameters(Argument::cetera())
->willReturn([]);
$mock
->getOptions(Argument::cetera())
->willReturn([]);
$mock
->getActive()
->willReturn($plugin_id === $active_plugin_id);
$mock
->getWeight()
->willReturn(isset($info['weight']) ? $info['weight'] : 0);
$mock
->getCacheContexts()
->willReturn(isset($info['cache_contexts']) ? $info['cache_contexts'] : []);
$mock
->getCacheTags()
->willReturn(isset($info['cache_tags']) ? $info['cache_tags'] : []);
$mock
->getCacheMaxAge()
->willReturn(isset($info['cache_max_age']) ? $info['cache_max_age'] : Cache::PERMANENT);
$access_manager_map[] = [
$info['route_name'],
[],
$this->account,
TRUE,
$info['access'],
];
$map[] = [
$info['id'],
[],
$mock
->reveal(),
];
}
$this->accessManager
->expects($this
->any())
->method('checkNamedRoute')
->willReturnMap($access_manager_map);
$this->factory
->expects($this
->any())
->method('createInstance')
->will($this
->returnValueMap($map));
}
protected function setupNullCacheabilityMetadataValidation() {
$container = \Drupal::hasContainer() ? \Drupal::getContainer() : new ContainerBuilder();
$cache_context_manager = $this
->prophesize(CacheContextsManager::class);
foreach ([
NULL,
[
'user.permissions',
],
[
'route',
],
[
'route',
'context.example1',
],
[
'context.example1',
'route',
],
[
'context.example1',
'route',
'context.example2',
],
[
'context.example1',
'context.example2',
'route',
],
[
'context.example1',
'context.example2',
'route',
'user.permissions',
],
] as $argument) {
$cache_context_manager
->assertValidTokens($argument)
->willReturn(TRUE);
}
$container
->set('cache_contexts_manager', $cache_context_manager
->reveal());
\Drupal::setContainer($container);
}
}