PathBasedBreadcrumbBuilderTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\system\Unit\Breadcrumbs;

use Drupal\Core\Access\AccessResult;
use Drupal\Core\Access\AccessResultAllowed;
use Drupal\Core\Cache\Cache;
use Drupal\Core\Link;
use Drupal\Core\Path\PathMatcherInterface;
use Drupal\Core\Routing\RouteObjectInterface;
use Drupal\Core\StringTranslation\TranslationInterface;
use Drupal\Core\Url;
use Drupal\Core\Utility\LinkGeneratorInterface;
use Drupal\system\PathBasedBreadcrumbBuilder;
use Drupal\Tests\UnitTestCase;
use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Group;
use Symfony\Component\DependencyInjection\Container;
use Symfony\Component\HttpFoundation\InputBag;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Routing\Route;

/**
 * Tests Drupal\system\PathBasedBreadcrumbBuilder.
 */
class PathBasedBreadcrumbBuilderTest extends UnitTestCase {
  
  /**
   * The path based breadcrumb builder object to test.
   *
   * @var \Drupal\system\PathBasedBreadcrumbBuilder
   */
  protected $builder;
  
  /**
   * The mocked title resolver.
   *
   * @var \Drupal\Core\Controller\TitleResolverInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $titleResolver;
  
  /**
   * The mocked access manager.
   *
   * @var \Drupal\Core\Access\AccessManagerInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $accessManager;
  
  /**
   * The request matching mock object.
   *
   * @var \Symfony\Component\Routing\Matcher\RequestMatcherInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $requestMatcher;
  
  /**
   * The mocked route request context.
   *
   * @var \Drupal\Core\Routing\RequestContext|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $context;
  
  /**
   * The mocked current user.
   *
   * @var \Drupal\Core\Session\AccountInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $currentUser;
  
  /**
   * The mocked path processor.
   *
   * @var \Drupal\Core\PathProcessor\InboundPathProcessorInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $pathProcessor;
  
  /**
   * The mocked current path.
   *
   * @var \Drupal\Core\Path\CurrentPathStack|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $currentPath;
  
  /**
   * The mocked path matcher service.
   *
   * @var \Drupal\Core\Path\PathMatcherInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $pathMatcher;
  
  /**
   * {@inheritdoc}
   *
   * @legacy-covers ::__construct
   */
  protected function setUp() : void {
    parent::setUp();
    $this->requestMatcher = $this->createMock('\\Symfony\\Component\\Routing\\Matcher\\RequestMatcherInterface');
    $config_factory = $this->getConfigFactoryStub([
      'system.site' => [
        'front' => 'test_frontpage',
      ],
    ]);
    $this->pathProcessor = $this->createMock('\\Drupal\\Core\\PathProcessor\\InboundPathProcessorInterface');
    $this->context = $this->createMock('\\Drupal\\Core\\Routing\\RequestContext');
    $this->accessManager = $this->createMock('\\Drupal\\Core\\Access\\AccessManagerInterface');
    $this->titleResolver = $this->createMock('\\Drupal\\Core\\Controller\\TitleResolverInterface');
    $this->titleResolver
      ->expects($this->any())
      ->method('getTitle')
      ->willReturnCallback(function (Request $request, Route $route) {
      return $route->getDefault('_title');
    });
    $this->currentUser = $this->createMock('Drupal\\Core\\Session\\AccountInterface');
    $this->currentPath = $this->getMockBuilder('Drupal\\Core\\Path\\CurrentPathStack')
      ->disableOriginalConstructor()
      ->getMock();
    $this->pathMatcher = $this->createMock(PathMatcherInterface::class);
    $this->builder = new TestPathBasedBreadcrumbBuilder($this->context, $this->accessManager, $this->requestMatcher, $this->pathProcessor, $config_factory, $this->titleResolver, $this->currentUser, $this->currentPath, $this->pathMatcher);
    $this->builder
      ->setStringTranslation($this->getStringTranslationStub());
    $cache_contexts_manager = $this->getMockBuilder('Drupal\\Core\\Cache\\Context\\CacheContextsManager')
      ->disableOriginalConstructor()
      ->getMock();
    $cache_contexts_manager->method('assertValidTokens')
      ->willReturn(TRUE);
    $container = new Container();
    $container->set('cache_contexts_manager', $cache_contexts_manager);
    \Drupal::setContainer($container);
  }
  
  /**
   * Tests the build method on the frontpage.
   *
   * @legacy-covers ::build
   */
  public function testBuildOnFrontpage() : void {
    $this->pathMatcher
      ->expects($this->once())
      ->method('isFrontPage')
      ->willReturn(TRUE);
    $breadcrumb = $this->builder
      ->build($this->createMock('Drupal\\Core\\Routing\\RouteMatchInterface'));
    $this->assertEquals([], $breadcrumb->getLinks());
    $this->assertEqualsCanonicalizing([
      'url.path.is_front',
      'url.path.parent',
    ], $breadcrumb->getCacheContexts());
    $this->assertEqualsCanonicalizing([], $breadcrumb->getCacheTags());
    $this->assertEquals(Cache::PERMANENT, $breadcrumb->getCacheMaxAge());
  }
  
  /**
   * Tests the build method with one path element.
   *
   * @legacy-covers ::build
   */
  public function testBuildWithOnePathElement() : void {
    $this->context
      ->expects($this->once())
      ->method('getPathInfo')
      ->willReturn('/example');
    $breadcrumb = $this->builder
      ->build($this->createMock('Drupal\\Core\\Routing\\RouteMatchInterface'));
    $this->assertEquals([
      0 => new Link('Home', new Url('<front>')),
    ], $breadcrumb->getLinks());
    $this->assertEqualsCanonicalizing([
      'url.path.is_front',
      'url.path.parent',
    ], $breadcrumb->getCacheContexts());
    $this->assertEqualsCanonicalizing([], $breadcrumb->getCacheTags());
    $this->assertEquals(Cache::PERMANENT, $breadcrumb->getCacheMaxAge());
  }
  
  /**
   * Tests the build method with two path elements.
   *
   * @legacy-covers ::build
   * @legacy-covers ::getRequestForPath
   */
  public function testBuildWithTwoPathElements() : void {
    $this->context
      ->expects($this->once())
      ->method('getPathInfo')
      ->willReturn('/example/baz');
    $this->setupStubPathProcessor();
    $route_1 = new Route('/example', [
      '_title' => 'Example',
    ]);
    $this->requestMatcher
      ->expects($this->exactly(1))
      ->method('matchRequest')
      ->willReturnCallback(function (Request $request) use ($route_1) {
      if ($request->getPathInfo() == '/example') {
        return [
          RouteObjectInterface::ROUTE_NAME => 'example',
          RouteObjectInterface::ROUTE_OBJECT => $route_1,
          '_raw_variables' => new InputBag([]),
        ];
      }
    });
    $this->setupAccessManagerToAllow();
    $breadcrumb = $this->builder
      ->build($this->createMock('Drupal\\Core\\Routing\\RouteMatchInterface'));
    $this->assertEquals([
      0 => new Link('Home', new Url('<front>')),
      1 => new Link('Example', new Url('example')),
    ], $breadcrumb->getLinks());
    $this->assertEqualsCanonicalizing([
      'url.path.is_front',
      'url.path.parent',
      'user.permissions',
    ], $breadcrumb->getCacheContexts());
    $this->assertEqualsCanonicalizing([], $breadcrumb->getCacheTags());
    $this->assertEquals(Cache::PERMANENT, $breadcrumb->getCacheMaxAge());
  }
  
  /**
   * Tests the build method with three path elements.
   *
   * @legacy-covers ::build
   * @legacy-covers ::getRequestForPath
   */
  public function testBuildWithThreePathElements() : void {
    $this->context
      ->expects($this->once())
      ->method('getPathInfo')
      ->willReturn('/example/bar/baz');
    $this->setupStubPathProcessor();
    $route_1 = new Route('/example/bar', [
      '_title' => 'Bar',
    ]);
    $route_2 = new Route('/example', [
      '_title' => 'Example',
    ]);
    $this->requestMatcher
      ->expects($this->exactly(2))
      ->method('matchRequest')
      ->willReturnCallback(function (Request $request) use ($route_1, $route_2) {
      if ($request->getPathInfo() == '/example/bar') {
        return [
          RouteObjectInterface::ROUTE_NAME => 'example_bar',
          RouteObjectInterface::ROUTE_OBJECT => $route_1,
          '_raw_variables' => new InputBag([]),
        ];
      }
      elseif ($request->getPathInfo() == '/example') {
        return [
          RouteObjectInterface::ROUTE_NAME => 'example',
          RouteObjectInterface::ROUTE_OBJECT => $route_2,
          '_raw_variables' => new InputBag([]),
        ];
      }
    });
    $this->accessManager
      ->expects($this->any())
      ->method('check')
      ->willReturnOnConsecutiveCalls(AccessResult::allowed()->cachePerPermissions(), AccessResult::allowed()->addCacheContexts([
      'bar',
    ])
      ->addCacheTags([
      'example',
    ]));
    $breadcrumb = $this->builder
      ->build($this->createMock('Drupal\\Core\\Routing\\RouteMatchInterface'));
    $this->assertEquals([
      new Link('Home', new Url('<front>')),
      new Link('Example', new Url('example')),
      new Link('Bar', new Url('example_bar')),
    ], $breadcrumb->getLinks());
    $this->assertEqualsCanonicalizing([
      'bar',
      'url.path.is_front',
      'url.path.parent',
      'user.permissions',
    ], $breadcrumb->getCacheContexts());
    $this->assertEqualsCanonicalizing([
      'example',
    ], $breadcrumb->getCacheTags());
    $this->assertEquals(Cache::PERMANENT, $breadcrumb->getCacheMaxAge());
  }
  
  /**
   * Tests the build method with a NULL title route.
   *
   * @legacy-covers ::build
   * @legacy-covers ::getRequestForPath
   */
  public function testBuildWithNullTitle() : void {
    $this->context
      ->expects($this->once())
      ->method('getPathInfo')
      ->willReturn('/example/bar/baz');
    $this->setupStubPathProcessor();
    $route_1 = new Route('/example/bar', [
      '_title' => 'Bar',
    ]);
    $route_2 = new Route('/example', [
      '_title' => NULL,
    ]);
    $this->requestMatcher
      ->expects($this->exactly(2))
      ->method('matchRequest')
      ->willReturnCallback(function (Request $request) use ($route_1, $route_2) {
      if ($request->getPathInfo() == '/example/bar') {
        return [
          RouteObjectInterface::ROUTE_NAME => 'example_bar',
          RouteObjectInterface::ROUTE_OBJECT => $route_1,
          '_raw_variables' => new InputBag([]),
        ];
      }
      elseif ($request->getPathInfo() == '/example') {
        return [
          RouteObjectInterface::ROUTE_NAME => 'example',
          RouteObjectInterface::ROUTE_OBJECT => $route_2,
          '_raw_variables' => new InputBag([]),
        ];
      }
    });
    $this->accessManager
      ->expects($this->any())
      ->method('check')
      ->willReturnOnConsecutiveCalls(AccessResult::allowed()->cachePerPermissions(), AccessResult::allowed()->addCacheContexts([
      'bar',
    ])
      ->addCacheTags([
      'example',
    ]));
    $breadcrumb = $this->builder
      ->build($this->createMock('Drupal\\Core\\Routing\\RouteMatchInterface'));
    $this->assertEquals([
      new Link('Home', new Url('<front>')),
      new Link('Bar', new Url('example_bar')),
    ], $breadcrumb->getLinks());
    $this->assertEqualsCanonicalizing([
      'bar',
      'url.path.is_front',
      'url.path.parent',
      'user.permissions',
    ], $breadcrumb->getCacheContexts());
    $this->assertEqualsCanonicalizing([
      'example',
    ], $breadcrumb->getCacheTags());
    $this->assertEquals(Cache::PERMANENT, $breadcrumb->getCacheMaxAge());
  }
  
  /**
   * Tests that exceptions during request matching are caught.
   *
   * @legacy-covers ::build
   * @legacy-covers ::getRequestForPath
   */
  public function testBuildWithException($exception_class, $exception_argument) : void {
    $this->context
      ->expects($this->once())
      ->method('getPathInfo')
      ->willReturn('/example/bar');
    $this->setupStubPathProcessor();
    $this->requestMatcher
      ->expects($this->any())
      ->method('matchRequest')
      ->will($this->throwException(new $exception_class($exception_argument)));
    $breadcrumb = $this->builder
      ->build($this->createMock('Drupal\\Core\\Routing\\RouteMatchInterface'));
    // No path matched, though at least the frontpage is displayed.
    $this->assertEquals([
      0 => new Link('Home', new Url('<front>')),
    ], $breadcrumb->getLinks());
    $this->assertEqualsCanonicalizing([
      'url.path.is_front',
      'url.path.parent',
    ], $breadcrumb->getCacheContexts());
    $this->assertEqualsCanonicalizing([], $breadcrumb->getCacheTags());
    $this->assertEquals(Cache::PERMANENT, $breadcrumb->getCacheMaxAge());
  }
  
  /**
   * Provides exception types for testBuildWithException.
   *
   * @return array
   *   The list of exception test cases.
   *
   * @see \Drupal\Tests\system\Unit\Breadcrumbs\PathBasedBreadcrumbBuilderTest::testBuildWithException()
   */
  public static function providerTestBuildWithException() {
    return [
      [
        'Drupal\\Core\\ParamConverter\\ParamNotConvertedException',
        '',
      ],
      [
        'Symfony\\Component\\Routing\\Exception\\MethodNotAllowedException',
        [],
      ],
      [
        'Symfony\\Component\\Routing\\Exception\\ResourceNotFoundException',
        '',
      ],
    ];
  }
  
  /**
   * Tests the build method with a non processed path.
   *
   * @legacy-covers ::build
   * @legacy-covers ::getRequestForPath
   */
  public function testBuildWithNonProcessedPath() : void {
    $this->context
      ->expects($this->once())
      ->method('getPathInfo')
      ->willReturn('/example/bar');
    $this->pathProcessor
      ->expects($this->once())
      ->method('processInbound')
      ->willReturn(FALSE);
    $this->requestMatcher
      ->expects($this->any())
      ->method('matchRequest')
      ->willReturn([]);
    $breadcrumb = $this->builder
      ->build($this->createMock('Drupal\\Core\\Routing\\RouteMatchInterface'));
    // No path matched, though at least the frontpage is displayed.
    $this->assertEquals([
      0 => new Link('Home', new Url('<front>')),
    ], $breadcrumb->getLinks());
    $this->assertEqualsCanonicalizing([
      'url.path.is_front',
      'url.path.parent',
    ], $breadcrumb->getCacheContexts());
    $this->assertEqualsCanonicalizing([], $breadcrumb->getCacheTags());
    $this->assertEquals(Cache::PERMANENT, $breadcrumb->getCacheMaxAge());
  }
  
  /**
   * Tests the build method with an invalid path.
   *
   * @legacy-covers ::build
   * @legacy-covers ::getRequestForPath
   */
  public function testBuildWithInvalidPath() : void {
    // The parse_url() function returns FALSE for '/:123/foo' so the
    // Request::create() method therefore considers it to be an invalid URI.
    $this->context
      ->expects($this->once())
      ->method('getPathInfo')
      ->willReturn('/:123/foo/bar');
    $breadcrumb = $this->builder
      ->build($this->createMock('Drupal\\Core\\Routing\\RouteMatchInterface'));
    // No path matched, though at least the frontpage is displayed.
    $this->assertEquals([
      0 => new Link('Home', new Url('<front>')),
    ], $breadcrumb->getLinks());
    $this->assertEqualsCanonicalizing([
      'url.path.is_front',
      'url.path.parent',
    ], $breadcrumb->getCacheContexts());
    $this->assertEqualsCanonicalizing([], $breadcrumb->getCacheTags());
    $this->assertEquals(Cache::PERMANENT, $breadcrumb->getCacheMaxAge());
  }
  
  /**
   * Tests the applied method.
   *
   * @legacy-covers ::applies
   */
  public function testApplies() : void {
    $this->assertTrue($this->builder
      ->applies($this->createMock('Drupal\\Core\\Routing\\RouteMatchInterface')));
  }
  
  /**
   * Tests the breadcrumb for a user path.
   *
   * @legacy-covers ::build
   * @legacy-covers ::getRequestForPath
   */
  public function testBuildWithUserPath() : void {
    $this->context
      ->expects($this->once())
      ->method('getPathInfo')
      ->willReturn('/user/1/edit');
    $this->setupStubPathProcessor();
    $route_1 = new Route('/user/1', [
      '_title' => 'Admin',
    ]);
    $this->requestMatcher
      ->expects($this->exactly(1))
      ->method('matchRequest')
      ->willReturnCallback(function (Request $request) use ($route_1) {
      if ($request->getPathInfo() == '/user/1') {
        return [
          RouteObjectInterface::ROUTE_NAME => 'user_page',
          RouteObjectInterface::ROUTE_OBJECT => $route_1,
          '_raw_variables' => new InputBag([]),
        ];
      }
    });
    $this->setupAccessManagerToAllow();
    $breadcrumb = $this->builder
      ->build($this->createMock('Drupal\\Core\\Routing\\RouteMatchInterface'));
    $this->assertEquals([
      0 => new Link('Home', new Url('<front>')),
      1 => new Link('Admin', new Url('user_page')),
    ], $breadcrumb->getLinks());
    $this->assertEqualsCanonicalizing([
      'url.path.is_front',
      'url.path.parent',
      'user.permissions',
    ], $breadcrumb->getCacheContexts());
    $this->assertEqualsCanonicalizing([], $breadcrumb->getCacheTags());
    $this->assertEquals(Cache::PERMANENT, $breadcrumb->getCacheMaxAge());
  }
  
  /**
   * Setup the access manager to always allow access to routes.
   */
  public function setupAccessManagerToAllow() : void {
    $this->accessManager
      ->expects($this->any())
      ->method('check')
      ->willReturn((new AccessResultAllowed())->cachePerPermissions());
  }
  
  /**
   * Prepares the mock processInbound() method.
   */
  protected function setupStubPathProcessor() : void {
    $this->pathProcessor
      ->expects($this->any())
      ->method('processInbound')
      ->willReturnArgument(0);
  }

}

/**
 * Helper class for testing purposes only.
 */
class TestPathBasedBreadcrumbBuilder extends PathBasedBreadcrumbBuilder {
  
  /**
   * The test link generator.
   */
  protected LinkGeneratorInterface $linkGenerator;
  
  /**
   * {@inheritdoc}
   */
  public function setStringTranslation(TranslationInterface $string_translation) {
    $this->stringTranslation = $string_translation;
    return $this;
  }
  
  /**
   * Sets the link generator.
   */
  public function setLinkGenerator(LinkGeneratorInterface $link_generator) : void {
    $this->linkGenerator = $link_generator;
  }

}