You are here

Home » API reference » Zircon Profile 8 » PathPluginBaseTest.php

class PathPluginBaseTest in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/modules/views/tests/src/Unit/Plugin/display/PathPluginBaseTest.php \Drupal\Tests\views\Unit\Plugin\display\PathPluginBaseTest

@coversDefaultClass \Drupal\views\Plugin\views\display\PathPluginBase @group views

Hierarchy

Expanded class hierarchy of PathPluginBaseTest

File

core/modules/views/tests/src/Unit/Plugin/display/PathPluginBaseTest.php, line 19
Contains \Drupal\Tests\views\Unit\Plugin\display\PathPluginBaseTest.

Namespace

Drupal\Tests\views\Unit\Plugin\display
View source 
class PathPluginBaseTest extends UnitTestCase {

  /**
   * The route provider that should be used.
   *
   * @var \Drupal\Core\Routing\RouteProviderInterface|\PHPUnit_Framework_MockObject_MockObject
   */
  protected $routeProvider;

  /**
   * The tested path plugin base.
   *
   * @var \Drupal\views\Plugin\views\display\PathPluginBase|\PHPUnit_Framework_MockObject_MockObject
   */
  protected $pathPlugin;

  /**
   * The mocked views access plugin manager.
   *
   * @var \Drupal\views\Plugin\ViewsPluginManager|\PHPUnit_Framework_MockObject_MockObject
   */
  protected $accessPluginManager;

  /**
   * The mocked key value storage.
   *
   * @var \Drupal\Core\State\StateInterface|\PHPUnit_Framework_MockObject_MockObject
   */
  protected $state;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this->routeProvider = $this
      ->getMock('Drupal\\Core\\Routing\\RouteProviderInterface');
    $this->state = $this
      ->getMock('\\Drupal\\Core\\State\\StateInterface');
    $this->pathPlugin = $this
      ->getMockBuilder('Drupal\\views\\Plugin\\views\\display\\PathPluginBase')
      ->setConstructorArgs(array(
      array(),
      'path_base',
      array(),
      $this->routeProvider,
      $this->state,
    ))
      ->setMethods(NULL)
      ->getMock();
    $this
      ->setupContainer();
  }

  /**
   * Setup access plugin manager and config factory in the Drupal class.
   */
  public function setupContainer() {
    $this->accessPluginManager = $this
      ->getMockBuilder('\\Drupal\\views\\Plugin\\ViewsPluginManager')
      ->disableOriginalConstructor()
      ->getMock();
    $container = new ContainerBuilder();
    $container
      ->set('plugin.manager.views.access', $this->accessPluginManager);
    $config = array(
      'views.settings' => array(
        'skip_cache' => TRUE,
        'display_extenders' => array(),
      ),
    );
    $container
      ->set('config.factory', $this
      ->getConfigFactoryStub($config));
    \Drupal::setContainer($container);
  }

  /**
   * Tests the collectRoutes method.
   *
   * @see \Drupal\views\Plugin\views\display\PathPluginBase::collectRoutes()
   */
  public function testCollectRoutes() {
    list($view) = $this
      ->setupViewExecutableAccessPlugin();
    $display = array();
    $display['display_plugin'] = 'page';
    $display['id'] = 'page_1';
    $display['display_options'] = array(
      'path' => 'test_route',
    );
    $this->pathPlugin
      ->initDisplay($view, $display);
    $collection = new RouteCollection();
    $result = $this->pathPlugin
      ->collectRoutes($collection);
    $this
      ->assertEquals(array(
      'test_id.page_1' => 'view.test_id.page_1',
    ), $result);
    $route = $collection
      ->get('view.test_id.page_1');
    $this
      ->assertTrue($route instanceof Route);
    $this
      ->assertEquals('test_id', $route
      ->getDefault('view_id'));
    $this
      ->assertEquals('page_1', $route
      ->getDefault('display_id'));
    $this
      ->assertSame(FALSE, $route
      ->getOption('returns_response'));
    $this
      ->assertEquals('my views title', $route
      ->getDefault('_title'));
  }

  /**
   * Tests the collectRoutes method with a display returning a response.
   *
   * @see \Drupal\views\Plugin\views\display\PathPluginBase::collectRoutes()
   */
  public function testCollectRoutesWithDisplayReturnResponse() {
    list($view) = $this
      ->setupViewExecutableAccessPlugin();
    $display = array();
    $display['display_plugin'] = 'page';
    $display['id'] = 'page_1';
    $display['display_options'] = array(
      'path' => 'test_route',
    );
    $this->pathPlugin = $this
      ->getMockBuilder('Drupal\\views\\Plugin\\views\\display\\PathPluginBase')
      ->setConstructorArgs(array(
      array(),
      'path_base',
      array(
        'returns_response' => TRUE,
      ),
      $this->routeProvider,
      $this->state,
    ))
      ->setMethods(NULL)
      ->getMock();
    $this->pathPlugin
      ->initDisplay($view, $display);
    $collection = new RouteCollection();
    $this->pathPlugin
      ->collectRoutes($collection);
    $route = $collection
      ->get('view.test_id.page_1');
    $this
      ->assertSame(TRUE, $route
      ->getOption('returns_response'));
    $this
      ->assertEquals('my views title', $route
      ->getDefault('_title'));
  }

  /**
   * Tests the collectRoutes method with arguments.
   *
   * @see \Drupal\views\Plugin\views\display\PathPluginBase::collectRoutes()
   */
  public function testCollectRoutesWithArguments() {
    list($view) = $this
      ->setupViewExecutableAccessPlugin();
    $display = array();
    $display['display_plugin'] = 'page';
    $display['id'] = 'page_1';
    $display['display_options'] = array(
      'path' => 'test_route/%/example',
    );
    $this->pathPlugin
      ->initDisplay($view, $display);
    $collection = new RouteCollection();
    $result = $this->pathPlugin
      ->collectRoutes($collection);
    $this
      ->assertEquals(array(
      'test_id.page_1' => 'view.test_id.page_1',
    ), $result);
    $route = $collection
      ->get('view.test_id.page_1');
    $this
      ->assertTrue($route instanceof Route);
    $this
      ->assertEquals('test_id', $route
      ->getDefault('view_id'));
    $this
      ->assertEquals('page_1', $route
      ->getDefault('display_id'));
    $this
      ->assertEquals(array(
      'arg_0' => 'arg_0',
    ), $route
      ->getOption('_view_argument_map'));
    $this
      ->assertEquals('my views title', $route
      ->getDefault('_title'));
  }

  /**
   * Tests the collectRoutes method with arguments not specified in the path.
   *
   * @see \Drupal\views\Plugin\views\display\PathPluginBase::collectRoutes()
   */
  public function testCollectRoutesWithArgumentsNotSpecifiedInPath() {
    list($view) = $this
      ->setupViewExecutableAccessPlugin();
    $display = array();
    $display['display_plugin'] = 'page';
    $display['id'] = 'page_1';
    $display['display_options'] = array(
      'path' => 'test_with_arguments',
    );
    $display['display_options']['arguments'] = array(
      'test_id' => array(),
    );
    $this->pathPlugin
      ->initDisplay($view, $display);
    $collection = new RouteCollection();
    $result = $this->pathPlugin
      ->collectRoutes($collection);
    $this
      ->assertEquals(array(
      'test_id.page_1' => 'view.test_id.page_1',
    ), $result);
    $route = $collection
      ->get('view.test_id.page_1');
    $this
      ->assertTrue($route instanceof Route);
    $this
      ->assertEquals('test_id', $route
      ->getDefault('view_id'));
    $this
      ->assertEquals('page_1', $route
      ->getDefault('display_id'));
    $this
      ->assertEquals(array(
      'arg_0' => 'arg_0',
    ), $route
      ->getOption('_view_argument_map'));
    $this
      ->assertEquals('my views title', $route
      ->getDefault('_title'));
  }

  /**
   * Tests the collect routes method with an alternative route name in the UI.
   */
  public function testCollectRoutesWithSpecialRouteName() {
    list($view) = $this
      ->setupViewExecutableAccessPlugin();
    $display = array();
    $display['display_plugin'] = 'page';
    $display['id'] = 'page_1';
    $display['display_options'] = array(
      'path' => 'test_route',
      'route_name' => 'test_route',
    );
    $this->pathPlugin
      ->initDisplay($view, $display);
    $collection = new RouteCollection();
    $result = $this->pathPlugin
      ->collectRoutes($collection);
    $this
      ->assertEquals(array(
      'test_id.page_1' => 'test_route',
    ), $result);
    $route = $collection
      ->get('test_route');
    $this
      ->assertTrue($route instanceof Route);
    $this
      ->assertEquals('test_id', $route
      ->getDefault('view_id'));
    $this
      ->assertEquals('page_1', $route
      ->getDefault('display_id'));
    $this
      ->assertEquals('my views title', $route
      ->getDefault('_title'));
  }

  /**
   * Tests the alter route method.
   */
  public function testAlterRoute() {
    $collection = new RouteCollection();
    $collection
      ->add('test_route', new Route('test_route', array(
      '_controller' => 'Drupal\\Tests\\Core\\Controller\\TestController::content',
    )));
    $route_2 = new Route('test_route/example', array(
      '_controller' => 'Drupal\\Tests\\Core\\Controller\\TestController::content',
    ));
    $collection
      ->add('test_route_2', $route_2);
    list($view) = $this
      ->setupViewExecutableAccessPlugin();
    $display = array();
    $display['display_plugin'] = 'page';
    $display['id'] = 'page_1';
    $display['display_options'] = array(
      'path' => 'test_route',
    );
    $this->pathPlugin
      ->initDisplay($view, $display);
    $view_route_names = $this->pathPlugin
      ->alterRoutes($collection);
    $this
      ->assertEquals(array(
      'test_id.page_1' => 'test_route',
    ), $view_route_names);

    // Ensure that the test_route is overridden.
    $route = $collection
      ->get('test_route');
    $this
      ->assertTrue($route instanceof Route);
    $this
      ->assertEquals('test_id', $route
      ->getDefault('view_id'));
    $this
      ->assertEquals('page_1', $route
      ->getDefault('display_id'));
    $this
      ->assertEquals('my views title', $route
      ->getDefault('_title'));

    // Ensure that the test_route_2 is not overridden.
    $route = $collection
      ->get('test_route_2');
    $this
      ->assertTrue($route instanceof Route);
    $this
      ->assertFalse($route
      ->hasDefault('view_id'));
    $this
      ->assertFalse($route
      ->hasDefault('display_id'));
    $this
      ->assertSame($collection
      ->get('test_route_2'), $route_2);
  }

  /**
   * Tests the collectRoutes method with a path containing named parameters.
   *
   * @see \Drupal\views\Plugin\views\display\PathPluginBase::collectRoutes()
   */
  public function testCollectRoutesWithNamedParameters() {

    /** @var \Drupal\views\ViewExecutable|\PHPUnit_Framework_MockObject_MockObject $view */
    list($view) = $this
      ->setupViewExecutableAccessPlugin();
    $view->argument = array();
    $view->argument['nid'] = $this
      ->getMockBuilder('Drupal\\views\\Plugin\\views\\argument\\ArgumentPluginBase')
      ->disableOriginalConstructor()
      ->getMock();
    $display = array();
    $display['display_plugin'] = 'page';
    $display['id'] = 'page_1';
    $display['display_options'] = array(
      'path' => 'test_route/%node/example',
    );
    $this->pathPlugin
      ->initDisplay($view, $display);
    $collection = new RouteCollection();
    $result = $this->pathPlugin
      ->collectRoutes($collection);
    $this
      ->assertEquals(array(
      'test_id.page_1' => 'view.test_id.page_1',
    ), $result);
    $route = $collection
      ->get('view.test_id.page_1');
    $this
      ->assertTrue($route instanceof Route);
    $this
      ->assertEquals('/test_route/{node}/example', $route
      ->getPath());
    $this
      ->assertEquals('test_id', $route
      ->getDefault('view_id'));
    $this
      ->assertEquals('page_1', $route
      ->getDefault('display_id'));
    $this
      ->assertEquals('my views title', $route
      ->getDefault('_title'));
    $this
      ->assertEquals(array(
      'arg_0' => 'node',
    ), $route
      ->getOption('_view_argument_map'));
  }

  /**
   * Tests altering routes with parameters in the overridden route.
   */
  public function testAlterRoutesWithParameters() {
    $collection = new RouteCollection();
    $collection
      ->add('test_route', new Route('test_route/{parameter}', array(
      '_controller' => 'Drupal\\Tests\\Core\\Controller\\TestController::content',
    )));
    list($view) = $this
      ->setupViewExecutableAccessPlugin();

    // Manually set up an argument handler.
    $argument = $this
      ->getMockBuilder('Drupal\\views\\Plugin\\views\\argument\\ArgumentPluginBase')
      ->disableOriginalConstructor()
      ->getMock();
    $view->argument['test_id'] = $argument;
    $display = array();
    $display['display_plugin'] = 'page';
    $display['id'] = 'page_1';
    $display['display_options'] = array(
      'path' => 'test_route/%',
    );
    $this->pathPlugin
      ->initDisplay($view, $display);
    $view_route_names = $this->pathPlugin
      ->alterRoutes($collection);
    $this
      ->assertEquals(array(
      'test_id.page_1' => 'test_route',
    ), $view_route_names);

    // Ensure that the test_route is overridden.
    $route = $collection
      ->get('test_route');
    $this
      ->assertInstanceOf('\\Symfony\\Component\\Routing\\Route', $route);
    $this
      ->assertEquals('test_id', $route
      ->getDefault('view_id'));
    $this
      ->assertEquals('page_1', $route
      ->getDefault('display_id'));

    // Ensure that the path did not changed and placeholders are respected.
    $this
      ->assertEquals('/test_route/{parameter}', $route
      ->getPath());
    $this
      ->assertEquals(array(
      'arg_0' => 'parameter',
    ), $route
      ->getOption('_view_argument_map'));
    $this
      ->assertEquals('my views title', $route
      ->getDefault('_title'));
  }

  /**
   * Tests altering routes with parameters and upcasting information
   */
  public function testAlterRoutesWithParametersAndUpcasting() {
    $collection = new RouteCollection();
    $collection
      ->add('test_route', new Route('test_route/{parameter}', [
      '_controller' => 'Drupal\\Tests\\Core\\Controller\\TestController::content',
    ], [], [
      'parameters' => [
        'taxonomy_term' => 'entity:entity_test',
      ],
    ]));
    list($view) = $this
      ->setupViewExecutableAccessPlugin();

    // Manually set up an argument handler.
    $argument = $this
      ->getMockBuilder('Drupal\\views\\Plugin\\views\\argument\\ArgumentPluginBase')
      ->disableOriginalConstructor()
      ->getMock();
    $view->argument['test_id'] = $argument;
    $display = array();
    $display['display_plugin'] = 'page';
    $display['id'] = 'page_1';
    $display['display_options'] = [
      'path' => 'test_route/%',
    ];
    $this->pathPlugin
      ->initDisplay($view, $display);
    $view_route_names = $this->pathPlugin
      ->alterRoutes($collection);
    $this
      ->assertEquals([
      'test_id.page_1' => 'test_route',
    ], $view_route_names);

    // Ensure that the test_route is overridden.
    $route = $collection
      ->get('test_route');
    $this
      ->assertInstanceOf('\\Symfony\\Component\\Routing\\Route', $route);
    $this
      ->assertEquals('test_id', $route
      ->getDefault('view_id'));
    $this
      ->assertEquals('page_1', $route
      ->getDefault('display_id'));
    $this
      ->assertEquals([
      'taxonomy_term' => 'entity:entity_test',
    ], $route
      ->getOption('parameters'));

    // Ensure that the path did not changed and placeholders are respected  kk.
    $this
      ->assertEquals('/test_route/{parameter}', $route
      ->getPath());
    $this
      ->assertEquals([
      'arg_0' => 'parameter',
    ], $route
      ->getOption('_view_argument_map'));
    $this
      ->assertEquals('my views title', $route
      ->getDefault('_title'));
  }

  /**
   * Tests altering routes with optional parameters in the overridden route.
   */
  public function testAlterRoutesWithOptionalParameters() {
    $collection = new RouteCollection();
    $collection
      ->add('test_route', new Route('test_route/{parameter}', array(
      '_controller' => 'Drupal\\Tests\\Core\\Controller\\TestController::content',
    )));
    list($view) = $this
      ->setupViewExecutableAccessPlugin();
    $display = array();
    $display['display_plugin'] = 'page';
    $display['id'] = 'page_1';
    $display['display_options'] = array(
      'path' => 'test_route/%',
    );
    $display['display_options']['arguments'] = array(
      'test_id' => array(),
      'test_id2' => array(),
    );
    $this->pathPlugin
      ->initDisplay($view, $display);
    $view_route_names = $this->pathPlugin
      ->alterRoutes($collection);
    $this
      ->assertEquals(array(
      'test_id.page_1' => 'test_route',
    ), $view_route_names);

    // Ensure that the test_route is overridden.
    $route = $collection
      ->get('test_route');
    $this
      ->assertInstanceOf('\\Symfony\\Component\\Routing\\Route', $route);
    $this
      ->assertEquals('test_id', $route
      ->getDefault('view_id'));
    $this
      ->assertEquals('page_1', $route
      ->getDefault('display_id'));

    // Ensure that the path did not changed and placeholders are respected.
    $this
      ->assertEquals('/test_route/{parameter}/{arg_1}', $route
      ->getPath());
    $this
      ->assertEquals(array(
      'arg_0' => 'parameter',
    ), $route
      ->getOption('_view_argument_map'));
    $this
      ->assertEquals('my views title', $route
      ->getDefault('_title'));
  }

  /**
   * Tests the getRouteName method.
   */
  public function testGetRouteName() {
    list($view) = $this
      ->setupViewExecutableAccessPlugin();
    $display = array();
    $display['display_plugin'] = 'page';
    $display['id'] = 'page_1';
    $display['display_options'] = array(
      'path' => 'test_route',
    );
    $this->pathPlugin
      ->initDisplay($view, $display);
    $route_name = $this->pathPlugin
      ->getRouteName();

    // Ensure that the expected routename is returned.
    $this
      ->assertEquals('view.test_id.page_1', $route_name);
  }

  /**
   * Returns some mocked view entity, view executable, and access plugin.
   */
  protected function setupViewExecutableAccessPlugin() {
    $view_entity = $this
      ->getMockBuilder('Drupal\\views\\Entity\\View')
      ->disableOriginalConstructor()
      ->getMock();
    $view_entity
      ->expects($this
      ->any())
      ->method('id')
      ->will($this
      ->returnValue('test_id'));
    $view = $this
      ->getMockBuilder('Drupal\\views\\ViewExecutable')
      ->disableOriginalConstructor()
      ->getMock();
    $view
      ->expects($this
      ->any())
      ->method('getTitle')
      ->willReturn('my views title');
    $view->storage = $view_entity;

    // Skip views options caching.
    $view->editing = TRUE;
    $access_plugin = $this
      ->getMockBuilder('Drupal\\views\\Plugin\\views\\access\\AccessPluginBase')
      ->disableOriginalConstructor()
      ->getMockForAbstractClass();
    $this->accessPluginManager
      ->expects($this
      ->any())
      ->method('createInstance')
      ->will($this
      ->returnValue($access_plugin));
    return array(
      $view,
      $view_entity,
      $access_plugin,
    );
  }

}

Members

Namesort descending Modifiers Type Description Overrides
PathPluginBaseTest::$accessPluginManager protected property The mocked views access plugin manager.
PathPluginBaseTest::$pathPlugin protected property The tested path plugin base.
PathPluginBaseTest::$routeProvider protected property The route provider that should be used.
PathPluginBaseTest::$state protected property The mocked key value storage.
PathPluginBaseTest::setUp protected function Overrides UnitTestCase::setUp
PathPluginBaseTest::setupContainer public function Setup access plugin manager and config factory in the Drupal class.
PathPluginBaseTest::setupViewExecutableAccessPlugin protected function Returns some mocked view entity, view executable, and access plugin.
PathPluginBaseTest::testAlterRoute public function Tests the alter route method.
PathPluginBaseTest::testAlterRoutesWithOptionalParameters public function Tests altering routes with optional parameters in the overridden route.
PathPluginBaseTest::testAlterRoutesWithParameters public function Tests altering routes with parameters in the overridden route.
PathPluginBaseTest::testAlterRoutesWithParametersAndUpcasting public function Tests altering routes with parameters and upcasting information
PathPluginBaseTest::testCollectRoutes public function Tests the collectRoutes method.
PathPluginBaseTest::testCollectRoutesWithArguments public function Tests the collectRoutes method with arguments.
PathPluginBaseTest::testCollectRoutesWithArgumentsNotSpecifiedInPath public function Tests the collectRoutes method with arguments not specified in the path.
PathPluginBaseTest::testCollectRoutesWithDisplayReturnResponse public function Tests the collectRoutes method with a display returning a response.
PathPluginBaseTest::testCollectRoutesWithNamedParameters public function Tests the collectRoutes method with a path containing named parameters.
PathPluginBaseTest::testCollectRoutesWithSpecialRouteName public function Tests the collect routes method with an alternative route name in the UI.
PathPluginBaseTest::testGetRouteName public function Tests the getRouteName method.
UnitTestCase::$randomGenerator protected property The random generator.
UnitTestCase::$root protected property The app root.
UnitTestCase::assertArrayEquals protected function Asserts if two arrays are equal by sorting them first.
UnitTestCase::getBlockMockWithMachineName protected function Mocks a block with a block plugin.
UnitTestCase::getClassResolverStub protected function Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub public function Returns a stub config factory that behaves according to the passed in 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.