class ContextualLinkManagerTest in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/tests/Drupal/Tests/Core/Menu/ContextualLinkManagerTest.php \Drupal\Tests\Core\Menu\ContextualLinkManagerTest
@coversDefaultClass \Drupal\Core\Menu\ContextualLinkManager @group Menu
Hierarchy
- class \Drupal\Tests\UnitTestCase extends \Drupal\Tests\PHPUnit_Framework_TestCase
- class \Drupal\Tests\Core\Menu\ContextualLinkManagerTest
Expanded class hierarchy of ContextualLinkManagerTest
File
- core/
tests/ Drupal/ Tests/ Core/ Menu/ ContextualLinkManagerTest.php, line 19 - Contains \Drupal\Tests\Core\Menu\ContextualLinkManagerTest.
Namespace
Drupal\Tests\Core\MenuView source
class ContextualLinkManagerTest extends UnitTestCase {
/**
* The tested contextual link manager.
*
* @var \Drupal\Core\Menu\ContextualLinkManager
*/
protected $contextualLinkManager;
/**
* The mocked controller resolver.
*
* @var \Symfony\Component\HttpKernel\Controller\ControllerResolverInterface|\Drupal\Core\\PHPUnit_Framework_MockObject_MockObject
*/
protected $controllerResolver;
/**
* The mocked plugin discovery.
*
* @var \Drupal\Component\Plugin\Discovery\DiscoveryInterface|\PHPUnit_Framework_MockObject_MockObject
*/
protected $pluginDiscovery;
/**
* The plugin factory used in the test.
*
* @var \Drupal\Component\Plugin\Factory\FactoryInterface|\PHPUnit_Framework_MockObject_MockObject
*/
protected $factory;
/**
* The cache backend used in the test.
*
* @var \Drupal\Core\Cache\CacheBackendInterface|\PHPUnit_Framework_MockObject_MockObject
*/
protected $cacheBackend;
/**
* The mocked module handler.
*
* @var \Drupal\Core\Extension\ModuleHandlerInterface|\PHPUnit_Framework_MockObject_MockObject
*/
protected $moduleHandler;
/**
* The mocked access manager.
*
* @var \Drupal\Core\Access\AccessManagerInterface|\PHPUnit_Framework_MockObject_MockObject
*/
protected $accessManager;
/**
* The mocked account.
*
* @var \Drupal\Core\Session\AccountInterface|\PHPUnit_Framework_MockObject_MockObject
*/
protected $account;
protected function setUp() {
$this->contextualLinkManager = $this
->getMockBuilder('Drupal\\Core\\Menu\\ContextualLinkManager')
->disableOriginalConstructor()
->setMethods(NULL)
->getMock();
$this->controllerResolver = $this
->getMock('Symfony\\Component\\HttpKernel\\Controller\\ControllerResolverInterface');
$this->pluginDiscovery = $this
->getMock('Drupal\\Component\\Plugin\\Discovery\\DiscoveryInterface');
$this->factory = $this
->getMock('Drupal\\Component\\Plugin\\Factory\\FactoryInterface');
$this->cacheBackend = $this
->getMock('Drupal\\Core\\Cache\\CacheBackendInterface');
$this->moduleHandler = $this
->getMock('\\Drupal\\Core\\Extension\\ModuleHandlerInterface');
$this->accessManager = $this
->getMock('Drupal\\Core\\Access\\AccessManagerInterface');
$this->account = $this
->getMock('Drupal\\Core\\Session\\AccountInterface');
$property = new \ReflectionProperty('Drupal\\Core\\Menu\\ContextualLinkManager', 'controllerResolver');
$property
->setAccessible(TRUE);
$property
->setValue($this->contextualLinkManager, $this->controllerResolver);
$property = new \ReflectionProperty('Drupal\\Core\\Menu\\ContextualLinkManager', 'discovery');
$property
->setAccessible(TRUE);
$property
->setValue($this->contextualLinkManager, $this->pluginDiscovery);
$property = new \ReflectionProperty('Drupal\\Core\\Menu\\ContextualLinkManager', 'factory');
$property
->setAccessible(TRUE);
$property
->setValue($this->contextualLinkManager, $this->factory);
$property = new \ReflectionProperty('Drupal\\Core\\Menu\\ContextualLinkManager', 'account');
$property
->setAccessible(TRUE);
$property
->setValue($this->contextualLinkManager, $this->account);
$property = new \ReflectionProperty('Drupal\\Core\\Menu\\ContextualLinkManager', 'accessManager');
$property
->setAccessible(TRUE);
$property
->setValue($this->contextualLinkManager, $this->accessManager);
$property = new \ReflectionProperty('Drupal\\Core\\Menu\\ContextualLinkManager', 'moduleHandler');
$property
->setAccessible(TRUE);
$property
->setValue($this->contextualLinkManager, $this->moduleHandler);
$language_manager = $this
->getMock('Drupal\\Core\\Language\\LanguageManagerInterface');
$language_manager
->expects($this
->any())
->method('getCurrentLanguage')
->will($this
->returnValue(new Language(array(
'id' => 'en',
))));
$request_stack = new RequestStack();
$property = new \ReflectionProperty('Drupal\\Core\\Menu\\ContextualLinkManager', 'requestStack');
$property
->setAccessible(TRUE);
$property
->setValue($this->contextualLinkManager, $request_stack);
$method = new \ReflectionMethod('Drupal\\Core\\Menu\\ContextualLinkManager', 'alterInfo');
$method
->setAccessible(TRUE);
$method
->invoke($this->contextualLinkManager, 'contextual_links_plugins');
$this->contextualLinkManager
->setCacheBackend($this->cacheBackend, 'contextual_links_plugins:en');
}
/**
* Tests the getContextualLinkPluginsByGroup method.
*
* @see \Drupal\Core\Menu\ContextualLinkManager::getContextualLinkPluginsByGroup()
*/
public function testGetContextualLinkPluginsByGroup() {
$definitions = array(
'test_plugin1' => array(
'id' => 'test_plugin1',
'class' => '\\Drupal\\Core\\Menu\\ContextualLinkDefault',
'group' => 'group1',
'route_name' => 'test_route',
),
'test_plugin2' => array(
'id' => 'test_plugin2',
'class' => '\\Drupal\\Core\\Menu\\ContextualLinkDefault',
'group' => 'group1',
'route_name' => 'test_route2',
),
'test_plugin3' => array(
'id' => 'test_plugin3',
'class' => '\\Drupal\\Core\\Menu\\ContextualLinkDefault',
'group' => 'group2',
'route_name' => 'test_router3',
),
);
$this->pluginDiscovery
->expects($this
->once())
->method('getDefinitions')
->will($this
->returnValue($definitions));
// Test with a non existing group.
$result = $this->contextualLinkManager
->getContextualLinkPluginsByGroup('group_non_existing');
$this
->assertEmpty($result);
$result = $this->contextualLinkManager
->getContextualLinkPluginsByGroup('group1');
$this
->assertEquals(array(
'test_plugin1',
'test_plugin2',
), array_keys($result));
$result = $this->contextualLinkManager
->getContextualLinkPluginsByGroup('group2');
$this
->assertEquals(array(
'test_plugin3',
), array_keys($result));
}
/**
* Tests the getContextualLinkPluginsByGroup method with a prefilled cache.
*/
public function testGetContextualLinkPluginsByGroupWithCache() {
$definitions = array(
'test_plugin1' => array(
'id' => 'test_plugin1',
'class' => '\\Drupal\\Core\\Menu\\ContextualLinkDefault',
'group' => 'group1',
'route_name' => 'test_route',
),
'test_plugin2' => array(
'id' => 'test_plugin2',
'class' => '\\Drupal\\Core\\Menu\\ContextualLinkDefault',
'group' => 'group1',
'route_name' => 'test_route2',
),
);
$this->cacheBackend
->expects($this
->once())
->method('get')
->with('contextual_links_plugins:en:group1')
->will($this
->returnValue((object) array(
'data' => $definitions,
)));
$result = $this->contextualLinkManager
->getContextualLinkPluginsByGroup('group1');
$this
->assertEquals($definitions, $result);
// Ensure that the static cache works, so no second cache get is executed.
$result = $this->contextualLinkManager
->getContextualLinkPluginsByGroup('group1');
$this
->assertEquals($definitions, $result);
}
/**
* Tests processDefinition() by passing a plugin definition without a route.
*
* @see \Drupal\Core\Menu\ContextualLinkManager::processDefinition()
*
* @expectedException \Drupal\Component\Plugin\Exception\PluginException
*/
public function testProcessDefinitionWithoutRoute() {
$definition = array(
'class' => '\\Drupal\\Core\\Menu\\ContextualLinkDefault',
'group' => 'example',
'id' => 'test_plugin',
);
$this->contextualLinkManager
->processDefinition($definition, 'test_plugin');
}
/**
* Tests processDefinition() by passing a plugin definition without a group.
*
* @see \Drupal\Core\Menu\ContextualLinkManager::processDefinition()
*
* @expectedException \Drupal\Component\Plugin\Exception\PluginException
*/
public function testProcessDefinitionWithoutGroup() {
$definition = array(
'class' => '\\Drupal\\Core\\Menu\\ContextualLinkDefault',
'route_name' => 'example',
'id' => 'test_plugin',
);
$this->contextualLinkManager
->processDefinition($definition, 'test_plugin');
}
/**
* Tests the getContextualLinksArrayByGroup method.
*
* @see \Drupal\Core\Menu\ContextualLinkManager::getContextualLinksArrayByGroup()
*/
public function testGetContextualLinksArrayByGroup() {
$definitions = array(
'test_plugin1' => array(
'id' => 'test_plugin1',
'class' => '\\Drupal\\Core\\Menu\\ContextualLinkDefault',
'title' => 'Plugin 1',
'weight' => 0,
'group' => 'group1',
'route_name' => 'test_route',
'options' => array(),
),
'test_plugin2' => array(
'id' => 'test_plugin2',
'class' => '\\Drupal\\Core\\Menu\\ContextualLinkDefault',
'title' => 'Plugin 2',
'weight' => 2,
'group' => 'group1',
'route_name' => 'test_route2',
'options' => array(
'key' => 'value',
),
),
'test_plugin3' => array(
'id' => 'test_plugin3',
'class' => '\\Drupal\\Core\\Menu\\ContextualLinkDefault',
'title' => 'Plugin 3',
'weight' => 5,
'group' => 'group2',
'route_name' => 'test_router3',
'options' => array(),
),
);
$this->pluginDiscovery
->expects($this
->once())
->method('getDefinitions')
->will($this
->returnValue($definitions));
$this->accessManager
->expects($this
->any())
->method('checkNamedRoute')
->will($this
->returnValue(AccessResult::allowed()));
// Set up mocking of the plugin factory.
$map = array();
foreach ($definitions as $plugin_id => $definition) {
$plugin = $this
->getMock('Drupal\\Core\\Menu\\ContextualLinkInterface');
$plugin
->expects($this
->any())
->method('getRouteName')
->will($this
->returnValue($definition['route_name']));
$plugin
->expects($this
->any())
->method('getTitle')
->will($this
->returnValue($definition['title']));
$plugin
->expects($this
->any())
->method('getWeight')
->will($this
->returnValue($definition['weight']));
$plugin
->expects($this
->any())
->method('getOptions')
->will($this
->returnValue($definition['options']));
$map[] = array(
$plugin_id,
array(),
$plugin,
);
}
$this->factory
->expects($this
->any())
->method('createInstance')
->will($this
->returnValueMap($map));
$this->moduleHandler
->expects($this
->at(1))
->method('alter')
->with($this
->equalTo('contextual_links'), new \PHPUnit_Framework_Constraint_Count(2), $this
->equalTo('group1'), $this
->equalTo(array(
'key' => 'value',
)));
$result = $this->contextualLinkManager
->getContextualLinksArrayByGroup('group1', array(
'key' => 'value',
));
$this
->assertCount(2, $result);
foreach (array(
'test_plugin1',
'test_plugin2',
) as $plugin_id) {
$definition = $definitions[$plugin_id];
$this
->assertEquals($definition['weight'], $result[$plugin_id]['weight']);
$this
->assertEquals($definition['title'], $result[$plugin_id]['title']);
$this
->assertEquals($definition['route_name'], $result[$plugin_id]['route_name']);
}
}
/**
* Tests the access checking of the getContextualLinksArrayByGroup method.
*
* @see \Drupal\Core\Menu\ContextualLinkManager::getContextualLinksArrayByGroup()
*/
public function testGetContextualLinksArrayByGroupAccessCheck() {
$definitions = array(
'test_plugin1' => array(
'id' => 'test_plugin1',
'class' => '\\Drupal\\Core\\Menu\\ContextualLinkDefault',
'title' => 'Plugin 1',
'weight' => 0,
'group' => 'group1',
'route_name' => 'test_route',
'options' => array(),
),
'test_plugin2' => array(
'id' => 'test_plugin2',
'class' => '\\Drupal\\Core\\Menu\\ContextualLinkDefault',
'title' => 'Plugin 2',
'weight' => 2,
'group' => 'group1',
'route_name' => 'test_route2',
'options' => array(
'key' => 'value',
),
),
);
$this->pluginDiscovery
->expects($this
->once())
->method('getDefinitions')
->will($this
->returnValue($definitions));
$this->accessManager
->expects($this
->any())
->method('checkNamedRoute')
->will($this
->returnValueMap(array(
array(
'test_route',
array(
'key' => 'value',
),
$this->account,
FALSE,
TRUE,
),
array(
'test_route2',
array(
'key' => 'value',
),
$this->account,
FALSE,
FALSE,
),
)));
// Set up mocking of the plugin factory.
$map = array();
foreach ($definitions as $plugin_id => $definition) {
$plugin = $this
->getMock('Drupal\\Core\\Menu\\ContextualLinkInterface');
$plugin
->expects($this
->any())
->method('getRouteName')
->will($this
->returnValue($definition['route_name']));
$plugin
->expects($this
->any())
->method('getTitle')
->will($this
->returnValue($definition['title']));
$plugin
->expects($this
->any())
->method('getWeight')
->will($this
->returnValue($definition['weight']));
$plugin
->expects($this
->any())
->method('getOptions')
->will($this
->returnValue($definition['options']));
$map[] = array(
$plugin_id,
array(),
$plugin,
);
}
$this->factory
->expects($this
->any())
->method('createInstance')
->will($this
->returnValueMap($map));
$result = $this->contextualLinkManager
->getContextualLinksArrayByGroup('group1', array(
'key' => 'value',
));
// Ensure that access checking was respected.
$this
->assertTrue(isset($result['test_plugin1']));
$this
->assertFalse(isset($result['test_plugin2']));
}
/**
* Tests the plugins alter hook.
*/
public function testPluginDefinitionAlter() {
$definitions['test_plugin'] = array(
'id' => 'test_plugin',
'class' => '\\Drupal\\Core\\Menu\\ContextualLinkDefault',
'title' => 'Plugin',
'weight' => 2,
'group' => 'group1',
'route_name' => 'test_route',
'options' => array(
'key' => 'value',
),
);
$this->pluginDiscovery
->expects($this
->once())
->method('getDefinitions')
->will($this
->returnValue($definitions));
$this->moduleHandler
->expects($this
->once())
->method('alter')
->with('contextual_links_plugins', $definitions);
$this->contextualLinkManager
->getDefinition('test_plugin');
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ContextualLinkManagerTest:: |
protected | property | The mocked access manager. | |
ContextualLinkManagerTest:: |
protected | property | The mocked account. | |
ContextualLinkManagerTest:: |
protected | property | The cache backend used in the test. | |
ContextualLinkManagerTest:: |
protected | property | The tested contextual link manager. | |
ContextualLinkManagerTest:: |
protected | property | The mocked controller resolver. | |
ContextualLinkManagerTest:: |
protected | property | The plugin factory used in the test. | |
ContextualLinkManagerTest:: |
protected | property | The mocked module handler. | |
ContextualLinkManagerTest:: |
protected | property | The mocked plugin discovery. | |
ContextualLinkManagerTest:: |
protected | function |
Overrides UnitTestCase:: |
|
ContextualLinkManagerTest:: |
public | function | Tests the getContextualLinkPluginsByGroup method. | |
ContextualLinkManagerTest:: |
public | function | Tests the getContextualLinkPluginsByGroup method with a prefilled cache. | |
ContextualLinkManagerTest:: |
public | function | Tests the getContextualLinksArrayByGroup method. | |
ContextualLinkManagerTest:: |
public | function | Tests the access checking of the getContextualLinksArrayByGroup method. | |
ContextualLinkManagerTest:: |
public | function | Tests the plugins alter hook. | |
ContextualLinkManagerTest:: |
public | function | Tests processDefinition() by passing a plugin definition without a group. | |
ContextualLinkManagerTest:: |
public | function | Tests processDefinition() by passing a plugin definition without a route. | |
UnitTestCase:: |
protected | property | The random generator. | |
UnitTestCase:: |
protected | property | The app root. | |
UnitTestCase:: |
protected | function | Asserts if two arrays are equal by sorting them first. | |
UnitTestCase:: |
protected | function | Mocks a block with a block plugin. | |
UnitTestCase:: |
protected | function | Returns a stub class resolver. | |
UnitTestCase:: |
public | function | Returns a stub config factory that behaves according to the passed in array. | |
UnitTestCase:: |
public | function | Returns a stub config storage that returns the supplied configuration. | |
UnitTestCase:: |
protected | function | Sets up a container with a cache tags invalidator. | |
UnitTestCase:: |
protected | function | Gets the random generator for the utility methods. | |
UnitTestCase:: |
public | function | Returns a stub translation manager that just returns the passed string. | |
UnitTestCase:: |
public | function | Generates a unique random string containing letters and numbers. |