MenuActiveTrailTest.php
Same filename in other branches
Namespace
Drupal\Tests\Core\MenuFile
-
core/
tests/ Drupal/ Tests/ Core/ Menu/ MenuActiveTrailTest.php
View source
<?php
namespace Drupal\Tests\Core\Menu;
use Drupal\Core\Menu\MenuActiveTrail;
use Drupal\Core\Routing\CurrentRouteMatch;
use Drupal\Tests\UnitTestCase;
use Symfony\Cmf\Component\Routing\RouteObjectInterface;
use Symfony\Component\DependencyInjection\Container;
use Symfony\Component\HttpFoundation\ParameterBag;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\Routing\Route;
/**
* Tests the active menu trail service.
*
* @group Menu
*
* @coversDefaultClass \Drupal\Core\Menu\MenuActiveTrail
*/
class MenuActiveTrailTest extends UnitTestCase {
/**
* The tested active menu trail service.
*
* @var \Drupal\Core\Menu\MenuActiveTrail
*/
protected $menuActiveTrail;
/**
* The test request stack.
*
* @var \Symfony\Component\HttpFoundation\RequestStack
*/
protected $requestStack;
/**
* The current route match service.
*
* @var \Drupal\Core\Routing\CurrentRouteMatch
*/
protected $currentRouteMatch;
/**
* The mocked menu link manager.
*
* @var \Drupal\Core\Menu\MenuLinkManagerInterface|\PHPUnit\Framework\MockObject\MockObject
*/
protected $menuLinkManager;
/**
* The mocked cache backend.
*
* @var \Drupal\Core\Cache\CacheBackendInterface|\PHPUnit\Framework\MockObject\MockObject
*/
protected $cache;
/**
* The mocked lock.
*
* @var \Drupal\Core\Lock\LockBackendInterface|\PHPUnit\Framework\MockObject\MockObject
*/
protected $lock;
/**
* {@inheritdoc}
*/
protected function setUp() {
parent::setUp();
$this->requestStack = new RequestStack();
$this->currentRouteMatch = new CurrentRouteMatch($this->requestStack);
$this->menuLinkManager = $this->createMock('Drupal\\Core\\Menu\\MenuLinkManagerInterface');
$this->cache = $this->createMock('\\Drupal\\Core\\Cache\\CacheBackendInterface');
$this->lock = $this->createMock('\\Drupal\\Core\\Lock\\LockBackendInterface');
$this->menuActiveTrail = new MenuActiveTrail($this->menuLinkManager, $this->currentRouteMatch, $this->cache, $this->lock);
$container = new Container();
$container->set('cache_tags.invalidator', $this->createMock('\\Drupal\\Core\\Cache\\CacheTagsInvalidatorInterface'));
\Drupal::setContainer($container);
}
/**
* Provides test data for all test methods.
*
* @return array
* Returns a list of test data of which each is an array containing the
* following elements:
* - request: A request object.
* - links: An array of menu links keyed by ID.
* - menu_name: The active menu name.
* - expected_link: The expected active link for the given menu.
*/
public function provider() {
$data = [];
$mock_route = new Route('');
$request = new Request();
$request->attributes
->set(RouteObjectInterface::ROUTE_NAME, 'baby_llama');
$request->attributes
->set(RouteObjectInterface::ROUTE_OBJECT, $mock_route);
$request->attributes
->set('_raw_variables', new ParameterBag([]));
$link_1 = MenuLinkMock::create([
'id' => 'baby_llama_link_1',
'route_name' => 'baby_llama',
'title' => 'Baby llama',
'parent' => 'mama_llama_link',
]);
$link_2 = MenuLinkMock::create([
'id' => 'baby_llama_link_2',
'route_name' => 'baby_llama',
'title' => 'Baby llama',
'parent' => 'papa_llama_link',
]);
// @see \Drupal\Core\Menu\MenuLinkManagerInterface::getParentIds()
$link_1_parent_ids = [
'baby_llama_link_1',
'mama_llama_link',
'',
];
$empty_active_trail = [
'',
];
// No active link is returned when zero links match the current route.
$data[] = [
$request,
[],
$this->randomMachineName(),
NULL,
$empty_active_trail,
];
// The first (and only) matching link is returned when one link matches the
// current route.
$data[] = [
$request,
[
'baby_llama_link_1' => $link_1,
],
$this->randomMachineName(),
$link_1,
$link_1_parent_ids,
];
// The first of multiple matching links is returned when multiple links
// match the current route, where "first" is determined by sorting by key.
$data[] = [
$request,
[
'baby_llama_link_1' => $link_1,
'baby_llama_link_2' => $link_2,
],
$this->randomMachineName(),
$link_1,
$link_1_parent_ids,
];
// No active link is returned in case of a 403.
$request = new Request();
$request->attributes
->set('_exception_statuscode', 403);
$data[] = [
$request,
FALSE,
$this->randomMachineName(),
NULL,
$empty_active_trail,
];
// No active link is returned when the route name is missing.
$request = new Request();
$data[] = [
$request,
FALSE,
$this->randomMachineName(),
NULL,
$empty_active_trail,
];
return $data;
}
/**
* Tests getActiveLink().
*
* @covers ::getActiveLink
* @dataProvider provider
*/
public function testGetActiveLink(Request $request, $links, $menu_name, $expected_link) {
$this->requestStack
->push($request);
if ($links !== FALSE) {
$this->menuLinkManager
->expects($this->exactly(2))
->method('loadLinksbyRoute')
->with('baby_llama')
->will($this->returnValue($links));
}
// Test with menu name.
$this->assertSame($expected_link, $this->menuActiveTrail
->getActiveLink($menu_name));
// Test without menu name.
$this->assertSame($expected_link, $this->menuActiveTrail
->getActiveLink());
}
/**
* Tests getActiveTrailIds().
*
* @covers ::getActiveTrailIds
* @dataProvider provider
*/
public function testGetActiveTrailIds(Request $request, $links, $menu_name, $expected_link, $expected_trail) {
$expected_trail_ids = array_combine($expected_trail, $expected_trail);
$this->requestStack
->push($request);
if ($links !== FALSE) {
// We expect exactly two calls, one for the first call, and one after the
// cache clearing below.
$this->menuLinkManager
->expects($this->exactly(2))
->method('loadLinksbyRoute')
->with('baby_llama')
->will($this->returnValue($links));
if ($expected_link !== NULL) {
$this->menuLinkManager
->expects($this->exactly(2))
->method('getParentIds')
->will($this->returnValueMap([
[
$expected_link->getPluginId(),
$expected_trail_ids,
],
]));
}
}
// Call out the same twice in order to ensure that static caching works.
$this->assertSame($expected_trail_ids, $this->menuActiveTrail
->getActiveTrailIds($menu_name));
$this->assertSame($expected_trail_ids, $this->menuActiveTrail
->getActiveTrailIds($menu_name));
$this->menuActiveTrail
->clear();
$this->assertSame($expected_trail_ids, $this->menuActiveTrail
->getActiveTrailIds($menu_name));
}
/**
* Tests getCid()
*
* @covers ::getCid
*/
public function testGetCid() {
$data = $this->provider()[1];
/** @var \Symfony\Component\HttpFoundation\Request $request */
$request = $data[0];
/** @var \Symfony\Component\Routing\Route $route */
$route = $request->attributes
->get(RouteObjectInterface::ROUTE_OBJECT);
$route->setPath('/test/{b}/{a}');
$request->attributes
->get('_raw_variables')
->add([
'b' => 1,
'a' => 0,
]);
$this->requestStack
->push($request);
$this->menuLinkManager
->expects($this->any())
->method('loadLinksbyRoute')
->with('baby_llama')
->will($this->returnValue($data[1]));
$expected_link = $data[3];
$expected_trail = $data[4];
$expected_trail_ids = array_combine($expected_trail, $expected_trail);
$this->menuLinkManager
->expects($this->any())
->method('getParentIds')
->will($this->returnValueMap([
[
$expected_link->getPluginId(),
$expected_trail_ids,
],
]));
$this->assertSame($expected_trail_ids, $this->menuActiveTrail
->getActiveTrailIds($data[2]));
$this->cache
->expects($this->once())
->method('set')
->with('active-trail:route:baby_llama:route_parameters:' . serialize([
'a' => 0,
'b' => 1,
]));
$this->lock
->expects($this->any())
->method('acquire')
->willReturn(TRUE);
$this->menuActiveTrail
->destruct();
}
}
Classes
Title | Deprecated | Summary |
---|---|---|
MenuActiveTrailTest | Tests the active menu trail service. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.