--- /dev/null
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\Tests\views\Unit\Plugin\display\PathPluginBaseTest.
+ */
+
+namespace Drupal\Tests\views\Unit\Plugin\display;
+
+use Drupal\Core\DependencyInjection\ContainerBuilder;
+use Drupal\Tests\UnitTestCase;
+use Symfony\Component\Routing\Route;
+use Symfony\Component\Routing\RouteCollection;
+
+/**
+ * @coversDefaultClass \Drupal\views\Plugin\views\display\PathPluginBase
+ * @group views
+ */
+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([[], 'path_base', [], $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 = [
+ 'views.settings' => [
+ 'skip_cache' => TRUE,
+ 'display_extenders' => [],
+ ],
+ ];
+
+ $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 = [];
+ $display['display_plugin'] = 'page';
+ $display['id'] = 'page_1';
+ $display['display_options'] = [
+ 'path' => 'test_route',
+ ];
+ $this->pathPlugin->initDisplay($view, $display);
+
+ $collection = new RouteCollection();
+ $result = $this->pathPlugin->collectRoutes($collection);
+ $this->assertEquals(['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 = [];
+ $display['display_plugin'] = 'page';
+ $display['id'] = 'page_1';
+ $display['display_options'] = [
+ 'path' => 'test_route',
+ ];
+ $this->pathPlugin = $this->getMockBuilder('Drupal\views\Plugin\views\display\PathPluginBase')
+ ->setConstructorArgs([[], 'path_base', ['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 = [];
+ $display['display_plugin'] = 'page';
+ $display['id'] = 'page_1';
+ $display['display_options'] = [
+ 'path' => 'test_route/%/example',
+ ];
+ $this->pathPlugin->initDisplay($view, $display);
+
+ $collection = new RouteCollection();
+ $result = $this->pathPlugin->collectRoutes($collection);
+ $this->assertEquals(['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(['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 = [];
+ $display['display_plugin'] = 'page';
+ $display['id'] = 'page_1';
+ $display['display_options'] = [
+ 'path' => 'test_with_arguments',
+ ];
+ $display['display_options']['arguments'] = [
+ 'test_id' => [],
+ ];
+ $this->pathPlugin->initDisplay($view, $display);
+
+ $collection = new RouteCollection();
+ $result = $this->pathPlugin->collectRoutes($collection);
+ $this->assertEquals(['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(['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 = [];
+ $display['display_plugin'] = 'page';
+ $display['id'] = 'page_1';
+ $display['display_options'] = [
+ 'path' => 'test_route',
+ 'route_name' => 'test_route',
+ ];
+ $this->pathPlugin->initDisplay($view, $display);
+
+ $collection = new RouteCollection();
+ $result = $this->pathPlugin->collectRoutes($collection);
+ $this->assertEquals(['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', ['_controller' => 'Drupal\Tests\Core\Controller\TestController::content']));
+ $route_2 = new Route('test_route/example', ['_controller' => 'Drupal\Tests\Core\Controller\TestController::content']);
+ $collection->add('test_route_2', $route_2);
+
+ list($view) = $this->setupViewExecutableAccessPlugin();
+
+ $display = [];
+ $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->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 altering of a REST route.
+ */
+ public function testAlterPostRestRoute() {
+ $collection = new RouteCollection();
+ $route = new Route('test_route', ['_controller' => 'Drupal\Tests\Core\Controller\TestController::content']);
+ $route->setMethods(['POST']);
+ $collection->add('test_route', $route);
+
+ list($view) = $this->setupViewExecutableAccessPlugin();
+
+ $display = [];
+ $display['display_plugin'] = 'page';
+ $display['id'] = 'page_1';
+ $display['display_options'] = [
+ 'path' => 'test_route',
+ ];
+ $this->pathPlugin->initDisplay($view, $display);
+
+ $this->pathPlugin->collectRoutes($collection);
+ $view_route_names = $this->pathPlugin->alterRoutes($collection);
+ $this->assertEquals([], $view_route_names);
+
+ // Ensure that the test_route is not overridden.
+ $this->assertCount(2, $collection);
+ $route = $collection->get('test_route');
+ $this->assertTrue($route instanceof Route);
+ $this->assertFalse($route->hasDefault('view_id'));
+ $this->assertFalse($route->hasDefault('display_id'));
+ $this->assertSame($collection->get('test_route'), $route);
+
+ $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('my views title', $route->getDefault('_title'));
+ }
+
+ /**
+ * Tests the altering of a REST route.
+ */
+ public function testGetRestRoute() {
+ $collection = new RouteCollection();
+ $route = new Route('test_route', ['_controller' => 'Drupal\Tests\Core\Controller\TestController::content']);
+ $route->setMethods(['GET']);
+ $route->setRequirement('_format', 'json');
+ $collection->add('test_route', $route);
+
+ list($view) = $this->setupViewExecutableAccessPlugin();
+
+ $display = [];
+ $display['display_plugin'] = 'page';
+ $display['id'] = 'page_1';
+ $display['display_options'] = [
+ 'path' => 'test_route',
+ ];
+ $this->pathPlugin->initDisplay($view, $display);
+
+ $this->pathPlugin->collectRoutes($collection);
+ $view_route_names = $this->pathPlugin->alterRoutes($collection);
+ $this->assertEquals([], $view_route_names);
+
+ // Ensure that the test_route is not overridden.
+ $this->assertCount(2, $collection);
+ $route = $collection->get('test_route');
+ $this->assertTrue($route instanceof Route);
+ $this->assertFalse($route->hasDefault('view_id'));
+ $this->assertFalse($route->hasDefault('display_id'));
+ $this->assertSame($collection->get('test_route'), $route);
+
+ $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('my views title', $route->getDefault('_title'));
+ }
+
+ /**
+ * Tests the alter route method with preexisting title callback.
+ */
+ public function testAlterRouteWithAlterCallback() {
+ $collection = new RouteCollection();
+ $collection->add('test_route', new Route('test_route', ['_controller' => 'Drupal\Tests\Core\Controller\TestController::content', '_title_callback' => '\Drupal\Tests\views\Unit\Plugin\display\TestController::testTitle']));
+ $route_2 = new Route('test_route/example', ['_controller' => 'Drupal\Tests\Core\Controller\TestController::content']);
+ $collection->add('test_route_2', $route_2);
+
+ list($view) = $this->setupViewExecutableAccessPlugin();
+
+ $display = [];
+ $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->assertTrue($route instanceof Route);
+ $this->assertEquals('test_id', $route->getDefault('view_id'));
+ $this->assertEquals('\Drupal\Tests\views\Unit\Plugin\display\TestController::testTitle', $route->getDefault('_title_callback'));
+ $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 = [];
+ $view->argument['nid'] = $this->getMockBuilder('Drupal\views\Plugin\views\argument\ArgumentPluginBase')
+ ->disableOriginalConstructor()
+ ->getMock();
+
+ $display = [];
+ $display['display_plugin'] = 'page';
+ $display['id'] = 'page_1';
+ $display['display_options'] = [
+ 'path' => 'test_route/%node/example',
+ ];
+ $this->pathPlugin->initDisplay($view, $display);
+
+ $collection = new RouteCollection();
+ $result = $this->pathPlugin->collectRoutes($collection);
+ $this->assertEquals(['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(['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}', ['_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 = [];
+ $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'));
+ // Ensure that the path did not changed and placeholders are respected.
+ $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 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 = [];
+ $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}', ['_controller' => 'Drupal\Tests\Core\Controller\TestController::content']));
+
+ list($view) = $this->setupViewExecutableAccessPlugin();
+
+ $display = [];
+ $display['display_plugin'] = 'page';
+ $display['id'] = 'page_1';
+ $display['display_options'] = [
+ 'path' => 'test_route/%',
+ ];
+ $display['display_options']['arguments'] = [
+ 'test_id' => [],
+ 'test_id2' => [],
+ ];
+ $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'));
+ // Ensure that the path did not changed and placeholders are respected.
+ $this->assertEquals('/test_route/{parameter}/{arg_1}', $route->getPath());
+ $this->assertEquals(['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 = [];
+ $display['display_plugin'] = 'page';
+ $display['id'] = 'page_1';
+ $display['display_options'] = [
+ '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 [$view, $view_entity, $access_plugin];
+ }
+
+}
+
+/**
+ * A page controller for use by tests in this file.
+ */
+class TestController {
+
+ /**
+ * A page title callback.
+ *
+ * @return string
+ * The page title.
+ */
+ public function testTitle() {
+ return 'Test title';
+ }
+
+}
projects / yaffs-website / blobdiff