View source
<?php
namespace Drupal\Tests\Core\Utility;
use Drupal\Component\Render\MarkupInterface;
use Drupal\Core\GeneratedButton;
use Drupal\Core\GeneratedNoLink;
use Drupal\Core\GeneratedUrl;
use Drupal\Core\Language\Language;
use Drupal\Core\Link;
use Drupal\Core\Render\Markup;
use Drupal\Core\Url;
use Drupal\Core\Utility\LinkGenerator;
use Drupal\Tests\UnitTestCase;
use Drupal\Core\DependencyInjection\ContainerBuilder;
class LinkGeneratorTest extends UnitTestCase {
protected $linkGenerator;
protected $urlGenerator;
protected $moduleHandler;
protected $renderer;
protected $urlAssembler;
protected $defaultOptions = [
'query' => [],
'language' => NULL,
'set_active_class' => FALSE,
'absolute' => FALSE,
];
protected function setUp() {
parent::setUp();
$this->urlGenerator = $this
->getMockBuilder('\\Drupal\\Core\\Routing\\UrlGenerator')
->disableOriginalConstructor()
->getMock();
$this->moduleHandler = $this
->createMock('Drupal\\Core\\Extension\\ModuleHandlerInterface');
$this->renderer = $this
->createMock('\\Drupal\\Core\\Render\\RendererInterface');
$this->linkGenerator = new LinkGenerator($this->urlGenerator, $this->moduleHandler, $this->renderer);
$this->urlAssembler = $this
->createMock('\\Drupal\\Core\\Utility\\UnroutedUrlAssemblerInterface');
}
public function providerTestGenerateHrefs() {
return [
[
'test_route_1',
[],
FALSE,
'/test-route-1',
],
[
'test_route_2',
[
'value' => 'example',
],
FALSE,
'/test-route-2/example',
],
[
'test_route_3',
[],
TRUE,
'http://example.com/test-route-3',
],
];
}
public function testGenerateHrefs($route_name, array $parameters, $absolute, $expected_url) {
$this->urlGenerator
->expects($this
->once())
->method('generateFromRoute')
->with($route_name, $parameters, [
'absolute' => $absolute,
] + $this->defaultOptions)
->willReturn((new GeneratedUrl())
->setGeneratedUrl($expected_url));
$this->moduleHandler
->expects($this
->once())
->method('alter');
$url = new Url($route_name, $parameters, [
'absolute' => $absolute,
]);
$url
->setUrlGenerator($this->urlGenerator);
$result = $this->linkGenerator
->generate('Test', $url);
$this
->assertLink([
'attributes' => [
'href' => $expected_url,
],
], $result);
}
public function testGenerate() {
$this->urlGenerator
->expects($this
->once())
->method('generateFromRoute')
->with('test_route_1', [], [
'fragment' => 'the-fragment',
] + $this->defaultOptions)
->willReturn((new GeneratedUrl())
->setGeneratedUrl('/test-route-1#the-fragment'));
$this->moduleHandler
->expects($this
->once())
->method('alter')
->with('link', $this
->isType('array'));
$url = new Url('test_route_1', [], [
'fragment' => 'the-fragment',
]);
$url
->setUrlGenerator($this->urlGenerator);
$result = $this->linkGenerator
->generate('Test', $url);
$this
->assertLink([
'attributes' => [
'href' => '/test-route-1#the-fragment',
],
'content' => 'Test',
], $result);
}
public function testGenerateNoLink() {
$this->urlGenerator
->expects($this
->never())
->method('generateFromRoute');
$this->moduleHandler
->expects($this
->once())
->method('alter')
->with('link', $this
->isType('array'));
$url = Url::fromRoute('<nolink>');
$url
->setUrlGenerator($this->urlGenerator);
$url
->setOption('set_active_class', TRUE);
$result = $this->linkGenerator
->generate('Test', $url);
$this
->assertInstanceOf(GeneratedNoLink::class, $result);
$this
->assertSame('<span>Test</span>', (string) $result);
}
public function testGenerateNone() {
$this->urlGenerator
->expects($this
->once())
->method('generateFromRoute')
->with('<none>', [], [
'set_active_class' => TRUE,
] + $this->defaultOptions)
->willReturn((new GeneratedUrl())
->setGeneratedUrl(''));
$this->moduleHandler
->expects($this
->once())
->method('alter')
->with('link', $this
->isType('array'));
$url = Url::fromRoute('<none>');
$url
->setUrlGenerator($this->urlGenerator);
$url
->setOption('set_active_class', TRUE);
$result = $this->linkGenerator
->generate('Test', $url);
$this
->assertSame('<a href="">Test</a>', (string) $result);
}
public function testGenerateButton() {
$this->urlGenerator
->expects($this
->never())
->method('generateFromRoute');
$this->moduleHandler
->expects($this
->once())
->method('alter')
->with('link', $this
->isType('array'));
$url = Url::fromRoute('<button>');
$url
->setUrlGenerator($this->urlGenerator);
$result = $this->linkGenerator
->generate('Test', $url);
$this
->assertInstanceOf(GeneratedButton::class, $result);
$this
->assertSame('<button type="button">Test</button>', (string) $result);
}
public function testGenerateExternal() {
$this->urlAssembler
->expects($this
->once())
->method('assemble')
->with('https://www.drupal.org', [
'set_active_class' => TRUE,
'external' => TRUE,
] + $this->defaultOptions)
->will($this
->returnArgument(0));
$this->moduleHandler
->expects($this
->once())
->method('alter')
->with('link', $this
->isType('array'));
$this->urlAssembler
->expects($this
->once())
->method('assemble')
->with('https://www.drupal.org', [
'set_active_class' => TRUE,
'external' => TRUE,
] + $this->defaultOptions)
->willReturnArgument(0);
$url = Url::fromUri('https://www.drupal.org');
$url
->setUrlGenerator($this->urlGenerator);
$url
->setUnroutedUrlAssembler($this->urlAssembler);
$url
->setOption('set_active_class', TRUE);
$result = $this->linkGenerator
->generate('Drupal', $url);
$this
->assertLink([
'attributes' => [
'href' => 'https://www.drupal.org',
],
'content' => 'Drupal',
], $result);
}
public function testGenerateUrlWithQuotes() {
$this->urlAssembler
->expects($this
->once())
->method('assemble')
->with('base:example', [
'query' => [
'foo' => '"bar"',
'zoo' => 'baz',
],
] + $this->defaultOptions)
->willReturn((new GeneratedUrl())
->setGeneratedUrl('/example?foo=%22bar%22&zoo=baz'));
$path_validator = $this
->createMock('Drupal\\Core\\Path\\PathValidatorInterface');
$container_builder = new ContainerBuilder();
$container_builder
->set('path.validator', $path_validator);
\Drupal::setContainer($container_builder);
$path = '/example?foo="bar"&zoo=baz';
$url = Url::fromUserInput($path);
$url
->setUrlGenerator($this->urlGenerator);
$url
->setUnroutedUrlAssembler($this->urlAssembler);
$result = $this->linkGenerator
->generate('Drupal', $url);
$this
->assertLink([
'attributes' => [
'href' => '/example?foo=%22bar%22&zoo=baz',
],
'content' => 'Drupal',
], $result, 1);
}
public function testGenerateAttributes() {
$this->urlGenerator
->expects($this
->once())
->method('generateFromRoute')
->with('test_route_1', [], $this->defaultOptions)
->willReturn((new GeneratedUrl())
->setGeneratedUrl('/test-route-1'));
$url = new Url('test_route_1', [], [
'attributes' => [
'title' => 'Tooltip',
],
]);
$url
->setUrlGenerator($this->urlGenerator);
$result = $this->linkGenerator
->generate('Test', $url);
$this
->assertLink([
'attributes' => [
'href' => '/test-route-1',
'title' => 'Tooltip',
],
], $result);
}
public function testGenerateQuery() {
$this->urlGenerator
->expects($this
->once())
->method('generateFromRoute')
->with('test_route_1', [], [
'query' => [
'test' => 'value',
],
] + $this->defaultOptions)
->willReturn((new GeneratedUrl())
->setGeneratedUrl('/test-route-1?test=value'));
$url = new Url('test_route_1', [], [
'query' => [
'test' => 'value',
],
]);
$url
->setUrlGenerator($this->urlGenerator);
$result = $this->linkGenerator
->generate('Test', $url);
$this
->assertLink([
'attributes' => [
'href' => '/test-route-1?test=value',
],
], $result);
}
public function testGenerateParametersAsQuery() {
$this->urlGenerator
->expects($this
->once())
->method('generateFromRoute')
->with('test_route_1', [
'test' => 'value',
], $this->defaultOptions)
->willReturn((new GeneratedUrl())
->setGeneratedUrl('/test-route-1?test=value'));
$url = new Url('test_route_1', [
'test' => 'value',
], []);
$url
->setUrlGenerator($this->urlGenerator);
$result = $this->linkGenerator
->generate('Test', $url);
$this
->assertLink([
'attributes' => [
'href' => '/test-route-1?test=value',
],
], $result);
}
public function testGenerateOptions() {
$this->urlGenerator
->expects($this
->once())
->method('generateFromRoute')
->with('test_route_1', [], [
'key' => 'value',
] + $this->defaultOptions)
->willReturn((new GeneratedUrl())
->setGeneratedUrl('/test-route-1?test=value'));
$url = new Url('test_route_1', [], [
'key' => 'value',
]);
$url
->setUrlGenerator($this->urlGenerator);
$result = $this->linkGenerator
->generate('Test', $url);
$this
->assertLink([
'attributes' => [
'href' => '/test-route-1?test=value',
],
], $result);
}
public function testGenerateXss() {
$this->urlGenerator
->expects($this
->once())
->method('generateFromRoute')
->with('test_route_4', [], $this->defaultOptions)
->willReturn((new GeneratedUrl())
->setGeneratedUrl('/test-route-4'));
$url = new Url('test_route_4');
$url
->setUrlGenerator($this->urlGenerator);
$result = $this->linkGenerator
->generate("<script>alert('XSS!')</script>", $url);
$this
->assertNoXPathResults('//a[@href="/test-route-4"]/script', $result);
}
public function testGenerateWithHtml() {
$this->urlGenerator
->expects($this
->at(0))
->method('generateFromRoute')
->with('test_route_5', [], $this->defaultOptions)
->willReturn((new GeneratedUrl())
->setGeneratedUrl('/test-route-5'));
$this->urlGenerator
->expects($this
->at(1))
->method('generateFromRoute')
->with('test_route_5', [], $this->defaultOptions)
->willReturn((new GeneratedUrl())
->setGeneratedUrl('/test-route-5'));
$url = new Url('test_route_5', [], [
'attributes' => [
'title' => '<em>HTML Tooltip</em>',
],
]);
$url
->setUrlGenerator($this->urlGenerator);
$result = $this->linkGenerator
->generate('Test', $url);
$this
->assertLink([
'attributes' => [
'href' => '/test-route-5',
'title' => 'HTML Tooltip',
],
], $result);
$url = new Url('test_route_5', []);
$url
->setUrlGenerator($this->urlGenerator);
$result = $this->linkGenerator
->generate(Markup::create('<em>HTML output</em>'), $url);
$this
->assertLink([
'attributes' => [
'href' => '/test-route-5',
],
'child' => [
'tag' => 'em',
],
], $result);
$this
->assertStringContainsString('<em>HTML output</em>', $result);
}
public function testGenerateActive() {
$this->urlGenerator
->expects($this
->exactly(5))
->method('generateFromRoute')
->willReturnCallback(function ($name, $parameters = [], $options = [], $collect_bubbleable_metadata = FALSE) {
switch ($name) {
case 'test_route_1':
return (new GeneratedUrl())
->setGeneratedUrl('/test-route-1');
case 'test_route_3':
return (new GeneratedUrl())
->setGeneratedUrl('/test-route-3');
case 'test_route_4':
if ($parameters['object'] == '1') {
return (new GeneratedUrl())
->setGeneratedUrl('/test-route-4/1');
}
}
});
$this->urlGenerator
->expects($this
->exactly(4))
->method('getPathFromRoute')
->will($this
->returnValueMap([
[
'test_route_1',
[],
'test-route-1',
],
[
'test_route_3',
[],
'test-route-3',
],
[
'test_route_4',
[
'object' => '1',
],
'test-route-4/1',
],
]));
$this->moduleHandler
->expects($this
->exactly(5))
->method('alter');
$url = new Url('test_route_1', [], [
'set_active_class' => TRUE,
]);
$url
->setUrlGenerator($this->urlGenerator);
$result = $this->linkGenerator
->generate('Test', $url);
$this
->assertLink([
'attributes' => [
'data-drupal-link-system-path' => 'test-route-1',
],
], $result);
$url = new Url('test_route_1', [], [
'set_active_class' => FALSE,
]);
$url
->setUrlGenerator($this->urlGenerator);
$result = $this->linkGenerator
->generate('Test', $url);
$this
->assertNoXPathResults('//a[@data-drupal-link-system-path="test-route-1"]', $result);
$url = new Url('test_route_1', [], [
'language' => new Language([
'id' => 'de',
]),
'set_active_class' => TRUE,
]);
$url
->setUrlGenerator($this->urlGenerator);
$result = $this->linkGenerator
->generate('Test', $url);
$this
->assertLink([
'attributes' => [
'data-drupal-link-system-path' => 'test-route-1',
'hreflang' => 'de',
],
], $result);
$url = new Url('test_route_3', [], [
'query' => [
'value' => 'example_1',
],
'set_active_class' => TRUE,
]);
$url
->setUrlGenerator($this->urlGenerator);
$result = $this->linkGenerator
->generate('Test', $url);
$this
->assertLink([
'attributes' => [
'data-drupal-link-system-path' => 'test-route-3',
'data-drupal-link-query' => '{"value":"example_1"}',
],
], $result);
$url = new Url('test_route_4', [
'object' => '1',
], [
'query' => [
'value' => 'example_1',
],
'set_active_class' => TRUE,
]);
$url
->setUrlGenerator($this->urlGenerator);
$result = $this->linkGenerator
->generate('Test', $url);
$this
->assertLink([
'attributes' => [
'data-drupal-link-system-path' => 'test-route-4/1',
'data-drupal-link-query' => '{"value":"example_1"}',
],
], $result);
}
public function testGenerateBubbleableMetadata() {
$options = [
'query' => [],
'language' => NULL,
'set_active_class' => FALSE,
'absolute' => FALSE,
];
$this->urlGenerator
->expects($this
->any())
->method('generateFromRoute')
->will($this
->returnValueMap([
[
'test_route_1',
[],
$options,
TRUE,
(new GeneratedUrl())
->setGeneratedUrl('/test-route-1'),
],
]));
$url = new Url('test_route_1');
$url
->setUrlGenerator($this->urlGenerator);
$expected_link_markup = '<a href="/test-route-1">Test</a>';
$this
->assertSame($expected_link_markup, (string) $this->linkGenerator
->generate('Test', $url));
$generated_link = $this->linkGenerator
->generate('Test', $url);
$this
->assertSame($expected_link_markup, (string) $generated_link
->getGeneratedLink());
$this
->assertInstanceOf('\\Drupal\\Core\\Render\\BubbleableMetadata', $generated_link);
$link = new Link('Test', $url);
$this
->assertSame($expected_link_markup, (string) $this->linkGenerator
->generateFromLink($link));
$generated_link = $this->linkGenerator
->generateFromLink($link);
$this
->assertSame($expected_link_markup, (string) $generated_link
->getGeneratedLink());
$this
->assertInstanceOf('\\Drupal\\Core\\Render\\BubbleableMetadata', $generated_link);
}
public function testGenerateWithAlterHook() {
$options = [
'query' => [],
'language' => NULL,
'set_active_class' => FALSE,
'absolute' => FALSE,
];
$this->urlGenerator
->expects($this
->any())
->method('generateFromRoute')
->will($this
->returnValueMap([
[
'test_route_1',
[],
$options,
TRUE,
(new GeneratedUrl())
->setGeneratedUrl('/test-route-1'),
],
[
'test_route_2',
[],
$options,
TRUE,
(new GeneratedUrl())
->setGeneratedUrl('/test-route-2'),
],
]));
$url = new Url('test_route_2');
$url
->setUrlGenerator($this->urlGenerator);
$this->moduleHandler
->expects($this
->atLeastOnce())
->method('alter')
->willReturnCallback(function ($hook, &$options) {
$options['url'] = (new Url('test_route_1'))
->setUrlGenerator($this->urlGenerator);
});
$expected_link_markup = '<a href="/test-route-1">Test</a>';
$this
->assertEquals($expected_link_markup, (string) $this->linkGenerator
->generate('Test', $url)
->getGeneratedLink());
}
public function testGenerateTwice() {
$this->urlGenerator
->expects($this
->any())
->method('generateFromRoute')
->will($this
->returnValue((new GeneratedUrl())
->setGeneratedUrl('/')));
$url = Url::fromRoute('<front>', [], [
'attributes' => [
'class' => [
'foo',
'bar',
],
],
]);
$url
->setUrlGenerator($this->urlGenerator);
$link = Link::fromTextAndUrl('text', $url);
$link
->setLinkGenerator($this->linkGenerator);
$output = $link
->toString() . $link
->toString();
$this
->assertEquals('<a href="/" class="foo bar">text</a><a href="/" class="foo bar">text</a>', $output);
}
public static function assertLink(array $properties, MarkupInterface $html, $count = 1) {
$properties += [
'attributes' => [],
];
$query = '//a';
$predicates = [];
foreach ($properties['attributes'] as $attribute => $value) {
$predicates[] = "@{$attribute}='{$value}'";
}
if (!empty($properties['content'])) {
$predicates[] = "contains(.,'{$properties['content']}')";
}
if (!empty($predicates)) {
$query .= '[' . implode(' and ', $predicates) . ']';
}
$document = new \DOMDocument();
$document
->loadHTML($html);
$xpath = new \DOMXPath($document);
self::assertEquals($count, $xpath
->query($query)->length);
}
protected function assertNoXPathResults($query, $html) {
$document = new \DOMDocument();
$document
->loadHTML($html);
$xpath = new \DOMXPath($document);
self::assertFalse((bool) $xpath
->query($query)->length);
}
}