page_manager-8.x-4.0-beta6/tests/src/Unit/RouteParamContextTest.php

<?php

namespace Drupal\Tests\page_manager\Unit;

use Drupal\Core\Plugin\Context\Context;
use Drupal\Core\Routing\RouteProviderInterface;
use Drupal\Core\TypedData\DataDefinition;
use Drupal\Core\TypedData\TypedDataInterface;
use Drupal\page_manager\EventSubscriber\RouteParamContext;
use Prophecy\Argument;
use Prophecy\PhpUnit\ProphecyTrait;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\Routing\Route;
use Symfony\Component\Routing\RouteCollection;

/**
 * Tests the route param context.
 *
 * @coversDefaultClass \Drupal\page_manager\EventSubscriber\RouteParamContext
 *
 * @group PageManager
 */
class RouteParamContextTest extends PageContextTestBase {

  use ProphecyTrait;

  /**
   * @covers ::onPageContext
   */
  public function testOnPageContext() {
    $collection = new RouteCollection();
    $route_provider = $this->prophesize(RouteProviderInterface::class);
    $route_provider->getRoutesByPattern('/test_route')->willReturn($collection);

    $request = new Request();
    $request_stack = new RequestStack();
    $request_stack->push($request);

    $data_definition = new DataDefinition(['type' => 'entity:user']);

    $typed_data = $this->prophesize(TypedDataInterface::class);
    $this->typedDataManager->getDefaultConstraints($data_definition)
      ->willReturn([]);

    $this->typedDataManager->create($data_definition, 'banana')
      ->willReturn($typed_data->reveal());

    $this->typedDataManager->createDataDefinition('bar')
      ->will(function () use ($data_definition) {
        return $data_definition;
      });

    $this->page->getPath()->willReturn('/test_route');
    $this->page->getParameter('foo')->willReturn(['machine_name' => 'foo', 'type' => 'integer', 'label' => 'Foo']);
    $this->page->hasParameter('foo')->willReturn(TRUE);
    $this->page->getParameter('bar')->willReturn(NULL);
    $this->page->hasParameter('bar')->willReturn(FALSE);
    $this->page->getParameter('baz')->willReturn(['machine_name' => 'baz', 'type' => 'integer', 'label' => '']);
    $this->page->hasParameter('baz')->willReturn(TRUE);
    $this->page->getParameter('page')->willReturn(['machine_name' => 'page', 'type' => 'entity:page', 'label' => '']);
    $this->page->hasParameter('page')->willReturn(TRUE);

    $this->page->addContext('foo', Argument::that(function ($context) {
      return $context instanceof Context && $context->getContextDefinition()->getLabel() == 'Foo';
    }))->shouldBeCalled();
    $this->page->addContext('baz', Argument::that(function ($context) {
      return $context instanceof Context && $context->getContextDefinition()->getLabel() == '{baz} from route';
    }))->shouldBeCalled();
    $this->page->addContext('page', Argument::that(function ($context) {
      return $context instanceof Context && $context->getContextDefinition()->getLabel() == '{page} from route';
    }))->shouldBeCalled();

    $collection->add('test_route', new Route('/test_route', [], [], [
      'parameters' => [
        'foo' => ['type' => 'bar'],
        'baz' => ['type' => 'bop'],
        'page' => ['type' => 'entity:page'],
      ],
    ]));

    // Set up a request with one of the expected parameters as an attribute.
    $request->attributes->add(['foo' => 'banana']);

    $route_param_context = new RouteParamContext($route_provider->reveal(), $request_stack);
    $route_param_context->onPageContext($this->event);
  }

  /**
   * @covers ::onPageContext
   */
  public function testOnPageContextEmpty() {
    $collection = new RouteCollection();
    $route_provider = $this->prophesize(RouteProviderInterface::class);
    $route_provider->getRoutesByPattern('/test_route')->willReturn($collection);

    $request = new Request();
    $request_stack = new RequestStack();
    $request_stack->push($request);

    $this->page->getPath()->willReturn('/test_route');

    $this->page->addContext(Argument::cetera())->shouldNotBeCalled();

    // Set up a request with one of the expected parameters as an attribute.
    $request->attributes->add(['foo' => 'banana']);

    $route_param_context = new RouteParamContext($route_provider->reveal(), $request_stack);
    $route_param_context->onPageContext($this->event);
  }

}