You are here

Home » API reference » Drupal 9 » RouteSubscriberTest.php

class RouteSubscriberTest in Drupal 9

Same name and namespace in other branches
  1. 8 core/modules/views/tests/src/Unit/EventSubscriber/RouteSubscriberTest.php \Drupal\Tests\views\Unit\EventSubscriber\RouteSubscriberTest

@coversDefaultClass \Drupal\views\EventSubscriber\RouteSubscriber @group views

Hierarchy

Expanded class hierarchy of RouteSubscriberTest

File

core/modules/views/tests/src/Unit/EventSubscriber/RouteSubscriberTest.php, line 21
Contains \Drupal\Tests\views\Unit\EventSubscriber\RouteSubscriberTest.

Namespace

Drupal\Tests\views\Unit\EventSubscriber
View source 
class RouteSubscriberTest extends UnitTestCase {

  /**
   * The mocked entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $entityTypeManager;

  /**
   * The mocked view storage.
   *
   * @var \Drupal\views\ViewStorage|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $viewStorage;

  /**
   * The tested views route subscriber.
   *
   * @var \Drupal\views\EventSubscriber\RouteSubscriber|\Drupal\Tests\views\Unit\EventSubscriber\TestRouteSubscriber
   */
  protected $routeSubscriber;

  /**
   * The mocked key value storage.
   *
   * @var \Drupal\Core\State\StateInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $state;
  protected function setUp() : void {
    $this->entityTypeManager = $this
      ->createMock(EntityTypeManagerInterface::class);
    $this->viewStorage = $this
      ->getMockBuilder('Drupal\\Core\\Config\\Entity\\ConfigEntityStorage')
      ->disableOriginalConstructor()
      ->getMock();
    $this->entityTypeManager
      ->expects($this
      ->any())
      ->method('getStorage')
      ->with('view')
      ->will($this
      ->returnValue($this->viewStorage));
    $this->state = $this
      ->createMock('\\Drupal\\Core\\State\\StateInterface');
    $this->routeSubscriber = new TestRouteSubscriber($this->entityTypeManager, $this->state);
  }

  /**
   * @covers ::routeRebuildFinished
   */
  public function testRouteRebuildFinished() {
    list($display_1, $display_2) = $this
      ->setupMocks();
    $display_1
      ->expects($this
      ->once())
      ->method('collectRoutes')
      ->will($this
      ->returnValue([
      'test_id.page_1' => 'views.test_id.page_1',
    ]));
    $display_2
      ->expects($this
      ->once())
      ->method('collectRoutes')
      ->will($this
      ->returnValue([
      'test_id.page_2' => 'views.test_id.page_2',
    ]));
    $this->routeSubscriber
      ->routes();
    $this->state
      ->expects($this
      ->once())
      ->method('set')
      ->with('views.view_route_names', [
      'test_id.page_1' => 'views.test_id.page_1',
      'test_id.page_2' => 'views.test_id.page_2',
    ]);
    $this->routeSubscriber
      ->routeRebuildFinished();
  }

  /**
   * Tests the onAlterRoutes method.
   *
   * @see \Drupal\views\EventSubscriber\RouteSubscriber::onAlterRoutes()
   */
  public function testOnAlterRoutes() {
    $collection = new RouteCollection();

    // The first route will be overridden later.
    $collection
      ->add('test_route', new Route('test_route', [
      '_controller' => 'Drupal\\Tests\\Core\\Controller\\TestController',
    ]));
    $route_2 = new Route('test_route/example', [
      '_controller' => 'Drupal\\Tests\\Core\\Controller\\TestController',
    ]);
    $collection
      ->add('test_route_2', $route_2);
    $route_event = new RouteBuildEvent($collection, 'views');
    list($display_1, $display_2) = $this
      ->setupMocks();

    // The page_1 display overrides an existing route, so the dynamicRoutes
    // should only call the second display.
    $display_1
      ->expects($this
      ->once())
      ->method('collectRoutes')
      ->willReturnCallback(function () use ($collection) {
      $collection
        ->add('views.test_id.page_1', new Route('test_route', [
        '_controller' => 'Drupal\\views\\Routing\\ViewPageController',
      ]));
      return [
        'test_id.page_1' => 'views.test_id.page_1',
      ];
    });
    $display_1
      ->expects($this
      ->once())
      ->method('alterRoutes')
      ->willReturn([
      'test_id.page_1' => 'test_route',
    ]);
    $display_2
      ->expects($this
      ->once())
      ->method('collectRoutes')
      ->willReturnCallback(function () use ($collection) {
      $collection
        ->add('views.test_id.page_2', new Route('test_route', [
        '_controller' => 'Drupal\\views\\Routing\\ViewPageController',
      ]));
      return [
        'test_id.page_2' => 'views.test_id.page_2',
      ];
    });
    $display_2
      ->expects($this
      ->once())
      ->method('alterRoutes')
      ->willReturn([]);

    // Ensure that even both the collectRoutes() and alterRoutes() methods
    // are called on the displays, we ensure that the route first defined by
    // views is dropped.
    $this->routeSubscriber
      ->routes();
    $this
      ->assertNull($this->routeSubscriber
      ->onAlterRoutes($route_event));
    $this->state
      ->expects($this
      ->once())
      ->method('set')
      ->with('views.view_route_names', [
      'test_id.page_1' => 'test_route',
      'test_id.page_2' => 'views.test_id.page_2',
    ]);
    $collection = $route_event
      ->getRouteCollection();
    $this
      ->assertEquals([
      'test_route',
      'test_route_2',
      'views.test_id.page_2',
    ], array_keys($collection
      ->all()));
    $this->routeSubscriber
      ->routeRebuildFinished();
  }

  /**
   * Sets up mocks of Views objects needed for testing.
   *
   * @return \Drupal\views\Plugin\views\display\DisplayRouterInterface[]|\PHPUnit\Framework\MockObject\MockObject[]
   *   An array of two mocked view displays.
   */
  protected function setupMocks() {
    $executable = $this
      ->getMockBuilder('Drupal\\views\\ViewExecutable')
      ->disableOriginalConstructor()
      ->getMock();
    $view = $this
      ->getMockBuilder('Drupal\\views\\Entity\\View')
      ->disableOriginalConstructor()
      ->getMock();
    $this->viewStorage
      ->expects($this
      ->any())
      ->method('load')
      ->will($this
      ->returnValue($view));
    $view
      ->expects($this
      ->any())
      ->method('getExecutable')
      ->will($this
      ->returnValue($executable));
    $view
      ->expects($this
      ->any())
      ->method('id')
      ->will($this
      ->returnValue('test_id'));
    $executable->storage = $view;
    $executable
      ->expects($this
      ->any())
      ->method('setDisplay')
      ->willReturnMap([
      [
        'page_1',
        TRUE,
      ],
      [
        'page_2',
        TRUE,
      ],
      [
        'page_3',
        FALSE,
      ],
    ]);

    // Ensure that only the first two displays are actually called.
    $display_1 = $this
      ->createMock('Drupal\\views\\Plugin\\views\\display\\DisplayRouterInterface');
    $display_2 = $this
      ->createMock('Drupal\\views\\Plugin\\views\\display\\DisplayRouterInterface');
    $display_collection = $this
      ->getMockBuilder('Drupal\\views\\DisplayPluginCollection')
      ->disableOriginalConstructor()
      ->getMock();
    $display_collection
      ->expects($this
      ->any())
      ->method('get')
      ->willReturnMap([
      [
        'page_1',
        $display_1,
      ],
      [
        'page_2',
        $display_2,
      ],
    ]);
    $executable->displayHandlers = $display_collection;
    $this->routeSubscriber->applicableViews = [];
    $this->routeSubscriber->applicableViews[] = [
      'test_id',
      'page_1',
    ];
    $this->routeSubscriber->applicableViews[] = [
      'test_id',
      'page_2',
    ];
    $this->routeSubscriber->applicableViews[] = [
      'test_id',
      'page_3',
    ];
    return [
      $display_1,
      $display_2,
    ];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RouteSubscriberTest::$entityTypeManager protected property The mocked entity type manager.
RouteSubscriberTest::$routeSubscriber protected property The tested views route subscriber.
RouteSubscriberTest::$state protected property The mocked key value storage.
RouteSubscriberTest::$viewStorage protected property The mocked view storage.
RouteSubscriberTest::setUp protected function Overrides UnitTestCase::setUp
RouteSubscriberTest::setupMocks protected function Sets up mocks of Views objects needed for testing.
RouteSubscriberTest::testOnAlterRoutes public function Tests the onAlterRoutes method.
RouteSubscriberTest::testRouteRebuildFinished public function @covers ::routeRebuildFinished
UnitTestCase::$randomGenerator protected property The random generator.
UnitTestCase::$root protected property The app root. 1
UnitTestCase::assertArrayEquals Deprecated protected function Asserts if two arrays are equal by sorting them first.
UnitTestCase::getClassResolverStub protected function Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub public function Returns a stub config factory that behaves according to the passed array.
UnitTestCase::getConfigStorageStub public function Returns a stub config storage that returns the supplied configuration.
UnitTestCase::getContainerWithCacheTagsInvalidator protected function Sets up a container with a cache tags invalidator.
UnitTestCase::getRandomGenerator protected function Gets the random generator for the utility methods.
UnitTestCase::getStringTranslationStub public function Returns a stub translation manager that just returns the passed string.
UnitTestCase::randomMachineName public function Generates a unique random string containing letters and numbers.
UnitTestCase::setUpBeforeClass public static function