Skip to content
Snippets Groups Projects
Commit b2de0262 authored by Pablo López's avatar Pablo López Committed by Cristina Chumillas
Browse files

Issue #3426374: Tests for SystemMenuNavigationBlock

parent 1710970b
Branches
Tags
1 merge request!184Issue #3426374: Tests for SystemMenuNavigationBlock
Pipeline #119804 passed with warnings
Stage: build
Stage: validate
Stage: test
Show whitespace changes
Inline Side-by-side
README.txt
+ 2
− 2
View file @ b2de0262
# Drupal core new administration navigation
This repo contains the initial work for the reworking of the core administration toolbar in Drupal core. We are building an HTML mockup of a left-aligned, collapsable, vertical sidebar navigation. This exploration/prototype serves a specific purpose: to test and check its feasibility.
This repo contains the initial work for the reworking of the core administration toolbar in Drupal core. We are building an HTML mockup of a left-aligned, collapsible, vertical sidebar navigation. This exploration/prototype serves a specific purpose: to test and check its feasibility.
The longer-term goal is to propose the new navigation for Drupal core as part of the plam Administration UX improvements (https://www.drupal.org/project/drupal/issues/3373303).
The longer-term goal is to propose the new navigation for Drupal core as part of the plan Administration UX improvements (https://www.drupal.org/project/drupal/issues/3373303).
# Installation
Download a regular Drupal module and install it. It'll replace the existing Toolbar with the new Sidebar.
......
navigation.module
+ 1
− 1
View file @ b2de0262
......@@ -21,7 +21,7 @@ function navigation_help($route_name, RouteMatchInterface $route_match) {
case 'help.page.navigation':
$output = '';
$output .= '<h3>' . t('About') . '</h3>';
$output .= '<p>' . t('Navigation module provides mockup of a left-aligned, collapsable, vertical sidebar navigation. For more information, see the <a href=":docs">online documentation for the Navigation module</a>.', [
$output .= '<p>' . t('Navigation module provides mockup of a left-aligned, collapsible, vertical sidebar navigation. For more information, see the <a href=":docs">online documentation for the Navigation module</a>.', [
':docs' => 'https://www.drupal.org/project/navigation',
]) . '</p>';
return $output;
......
src/Plugin/NavigationBlock/SystemMenuNavigationBlock.php
+ 15
− 2
View file @ b2de0262
......@@ -127,10 +127,12 @@ class SystemMenuNavigationBlock extends NavigationBlockPluginBase implements Con
*/
public function build(): array {
$menu_name = $this->getDerivativeId();
$level = $this->configuration['level'];
$depth = $this->configuration['depth'];
$parameters = new MenuTreeParameters();
$parameters
->setMinDepth($this->configuration['level'])
->setMaxDepth($this->configuration['level'] + $this->configuration['depth'])
->setMinDepth($level)
->setMaxDepth(min($level + $depth, $this->menuLinkTree->maxDepth()))
->onlyEnabledLinks();
$tree = $this->menuLinkTree->load($menu_name, $parameters);
$manipulators = [
......@@ -146,4 +148,15 @@ class SystemMenuNavigationBlock extends NavigationBlockPluginBase implements Con
return $build;
}
/**
* {@inheritdoc}
*/
public function calculateDependencies() {
return [
'module' => [
'system',
],
];
}
}
templates/toolbar-button.html.twig
+ 2
− 2
View file @ b2de0262
{# Extra clasess variable added to be sure that modifiers will
{# Extra classess variable added to be sure that modifiers will
appear after main classes #}
{%
set classes = [
......
tests/src/Kernel/SystemMenuNavigationBlockTest.php 0 → 100644
+ 300
− 0
View file @ b2de0262
<?php
declare(strict_types=1);
namespace Drupal\Tests\navigation\Kernel;
use Drupal\Core\Render\Element;
use Drupal\Core\Routing\RouteObjectInterface;
use Drupal\KernelTests\KernelTestBase;
use Drupal\navigation\Entity\NavigationBlock;
use Drupal\navigation\NavigationBlockRepositoryInterface;
use Drupal\navigation\Plugin\NavigationBlock\SystemMenuNavigationBlock;
use Drupal\system\Entity\Menu;
use Drupal\system\Tests\Routing\MockRouteProvider;
use Drupal\Tests\Core\Menu\MenuLinkMock;
use Drupal\user\Entity\User;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Session\Session;
use Symfony\Component\HttpFoundation\Session\Storage\MockArraySessionStorage;
use Symfony\Component\Routing\Route;
use Symfony\Component\Routing\RouteCollection;
/**
* Tests \Drupal\navigation\Plugin\NavigationBlock\SystemMenuNavigationBlock.
*
* @group navigation
* @todo Expand test coverage to all SystemMenuNavigationBlock functionality,
* including block_menu_delete().
*
* @see \Drupal\navigation\Plugin\Derivative\SystemMenuNavigationBlock
* @see \Drupal\navigation\Plugin\NavigationBlock\SystemMenuNavigationBlock
*/
class SystemMenuNavigationBlockTest extends KernelTestBase {
/**
* Modules to enable.
*
* @var array
*/
protected static $modules = [
'system',
'navigation',
'menu_test',
'menu_link_content',
'field',
'user',
'link',
];
/**
* The navigation block under test.
*
* @var \Drupal\navigation\Plugin\NavigationBlock\SystemMenuNavigationBlock
*/
protected $navigationBlock;
/**
* The menu for testing.
*
* @var \Drupal\system\MenuInterface
*/
protected $menu;
/**
* The menu link tree service.
*
* @var \Drupal\Core\Menu\MenuLinkTree
*/
protected $linkTree;
/**
* The menu link plugin manager service.
*
* @var \Drupal\Core\Menu\MenuLinkManagerInterface
*/
protected $menuLinkManager;
/**
* The navigation block manager service.
*
* @var \Drupal\navigation\NavigationBlockManagerInterface
*/
protected $navigationBlockManager;
/**
* {@inheritdoc}
*/
protected function setUp(): void {
parent::setUp();
$this->installEntitySchema('user');
$this->installEntitySchema('menu_link_content');
$account = User::create([
'name' => $this->randomMachineName(),
'status' => 1,
]);
$account->save();
$this->container->get('current_user')->setAccount($account);
$this->menuLinkManager = $this->container->get('plugin.manager.menu.link');
$this->linkTree = $this->container->get('menu.link_tree');
$this->navigationBlockManager = $this->container->get('plugin.manager.navigation_block_manager');
$routes = new RouteCollection();
$requirements = ['_access' => 'TRUE'];
$options = ['_access_checks' => ['access_check.default']];
$routes->add('example1', new Route('/example1', [], $requirements, $options));
$routes->add('example2', new Route('/example2', [], $requirements, $options));
$routes->add('example3', new Route('/example3', [], $requirements, $options));
$routes->add('example4', new Route('/example4', [], $requirements, $options));
$routes->add('example5', new Route('/example5', [], $requirements, $options));
$routes->add('example6', new Route('/example6', [], $requirements, $options));
$routes->add('example7', new Route('/example7', [], $requirements, $options));
$routes->add('example8', new Route('/example8', [], $requirements, $options));
$routes->add('example9', new Route('/example9', [], $requirements, $options));
$mock_route_provider = new MockRouteProvider($routes);
$this->container->set('router.route_provider', $mock_route_provider);
// Add a new custom menu.
$menu_name = 'mock';
$label = $this->randomMachineName(16);
$this->menu = Menu::create([
'id' => $menu_name,
'label' => $label,
'description' => 'Description text',
]);
$this->menu->save();
// This creates a tree with the following structure:
// - 1
// - 2
// - 3
// - 4
// - 9
// - 5
// - 7
// - 6
// - 8
// With link 6 being the only external link.
// phpcs:disable
$links = [
1 => MenuLinkMock::create(['id' => 'test.example1', 'route_name' => 'example1', 'title' => 'foo', 'parent' => '', 'weight' => 0]),
2 => MenuLinkMock::create(['id' => 'test.example2', 'route_name' => 'example2', 'title' => 'bar', 'parent' => '', 'route_parameters' => ['foo' => 'bar'], 'weight' => 1]),
3 => MenuLinkMock::create(['id' => 'test.example3', 'route_name' => 'example3', 'title' => 'baz', 'parent' => 'test.example2', 'weight' => 2]),
4 => MenuLinkMock::create(['id' => 'test.example4', 'route_name' => 'example4', 'title' => 'qux', 'parent' => 'test.example3', 'weight' => 3]),
5 => MenuLinkMock::create(['id' => 'test.example5', 'route_name' => 'example5', 'title' => 'foofoo', 'parent' => '', 'expanded' => TRUE, 'weight' => 4]),
6 => MenuLinkMock::create(['id' => 'test.example6', 'route_name' => '', 'url' => 'https://www.drupal.org/', 'title' => 'barbar', 'parent' => '', 'weight' => 5]),
7 => MenuLinkMock::create(['id' => 'test.example7', 'route_name' => 'example7', 'title' => 'bazbaz', 'parent' => 'test.example5', 'weight' => 6]),
8 => MenuLinkMock::create(['id' => 'test.example8', 'route_name' => 'example8', 'title' => 'quxqux', 'parent' => '', 'weight' => 7]),
9 => MenuLinkMock::create(['id' => 'test.example9', 'route_name' => 'example9', 'title' => 'foobar', 'parent' => 'test.example4', 'weight' => 7]),
];
// phpcs:enable
foreach ($links as $instance) {
$this->menuLinkManager->addDefinition($instance->getPluginId(), $instance->getPluginDefinition());
}
}
/**
* Tests calculation of a system navigation menu block's config dependencies.
*/
public function testSystemMenuBlockConfigDependencies() {
$block = NavigationBlock::create([
'plugin' => 'system_menu_navigation_block:' . $this->menu->id(),
'region' => NavigationBlockRepositoryInterface::REGION_CONTENT,
'id' => 'machine_name',
]);
$dependencies = $block->calculateDependencies()->getDependencies();
$expected = [
'config' => [
'system.menu.' . $this->menu->id(),
],
'module' => [
'system',
],
];
$this->assertSame($expected, $dependencies);
}
/**
* Tests the config start level and depth.
*/
public function testConfigLevelDepth() {
// Helper function to generate a configured navigation block instance.
$place_block = function ($level, $depth) {
return $this->navigationBlockManager->createInstance('system_menu_navigation_block:' . $this->menu->id(), [
'region' => NavigationBlockRepositoryInterface::REGION_FOOTER,
'id' => 'machine_name',
'level' => $level,
'depth' => $depth,
]);
};
// All the different navigation block instances we're going to test.
$blocks = [
'level_1_only' => $place_block(1, 0),
'level_2_only' => $place_block(2, 0),
'level_3_only' => $place_block(3, 0),
'level_1_and_beyond' => $place_block(1, SystemMenuNavigationBlock::NAVIGATION_MAX_DEPTH - 1),
'level_2_and_beyond' => $place_block(2, SystemMenuNavigationBlock::NAVIGATION_MAX_DEPTH - 1),
'level_3_and_beyond' => $place_block(3, SystemMenuNavigationBlock::NAVIGATION_MAX_DEPTH - 1),
];
// Expectations are independent of the active trail.
$expectations = [];
$expectations['level_1_only'] = [
'test.example1' => [],
'test.example2' => [],
'test.example5' => [],
'test.example6' => [],
'test.example8' => [],
];
$expectations['level_2_only'] = [
'test.example3' => [],
'test.example7' => [],
];
$expectations['level_3_only'] = [
'test.example4' => [],
];
$expectations['level_1_and_beyond'] = [
'test.example1' => [],
'test.example2' => [
'test.example3' => [
'test.example4' => [],
],
],
'test.example5' => [
'test.example7' => [],
],
'test.example6' => [],
'test.example8' => [],
];
$expectations['level_2_and_beyond'] = [
'test.example3' => [
'test.example4' => [
'test.example9' => [],
],
],
'test.example7' => [],
];
$expectations['level_3_and_beyond'] = [
'test.example4' => [
'test.example9' => [],
],
];
// Scenario 1: test all navigation block instances when there's no active
// trail.
foreach ($blocks as $id => $block) {
$block_build = $block->build();
$items = $block_build['#items'] ?? [];
$this->assertSame($expectations[$id], $this->convertBuiltMenuToIdTree($items), "Menu block $id with no active trail renders the expected tree.");
}
// Scenario 2: test all navigation block instances when there's an active
// trail.
$route = $this->container->get('router.route_provider')->getRouteByName('example3');
$request = new Request();
$request->attributes->set(RouteObjectInterface::ROUTE_NAME, 'example3');
$request->attributes->set(RouteObjectInterface::ROUTE_OBJECT, $route);
$request->setSession(new Session(new MockArraySessionStorage()));
$this->container->get('request_stack')->push($request);
// \Drupal\Core\Menu\MenuActiveTrail uses the cache collector pattern, which
// includes static caching. Since this second scenario simulates a second
// request, we must also simulate it for the MenuActiveTrail service, by
// clearing the cache collector's static cache.
\Drupal::service('menu.active_trail')->clear();
foreach ($blocks as $id => $block) {
$block_build = $block->build();
$items = $block_build['#items'] ?? [];
$this->assertSame($expectations[$id], $this->convertBuiltMenuToIdTree($items), "Menu navigation block $id with an active trail renders the expected tree.");
}
}
/**
* Helper method to allow for easy menu link tree structure assertions.
*
* Converts the result of MenuLinkTree::build() in a "menu link ID tree".
*
* @param array $build
* The return value of MenuLinkTree::build()
*
* @return array
* The "menu link ID tree" representation of the given render array.
*/
protected function convertBuiltMenuToIdTree(array $build) {
$level = [];
foreach (Element::children($build) as $id) {
$level[$id] = [];
if (isset($build[$id]['below'])) {
$level[$id] = $this->convertBuiltMenuToIdTree($build[$id]['below']);
}
}
return $level;
}
}
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please to comment