DisplayPageTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\views\Kernel\Plugin;

use Drupal\Core\Url;
use Drupal\Core\Menu\MenuTreeParameters;
use Drupal\Core\Session\AnonymousUserSession;
use Drupal\views\Entity\View;
use Drupal\views\Views;
use Drupal\Tests\views\Kernel\ViewsKernelTestBase;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\HttpKernelInterface;

/**
 * Tests the page display plugin.
 *
 * @group views
 * @see \Drupal\views\Plugin\display\Page
 */
class DisplayPageTest extends ViewsKernelTestBase {

  /**
   * Views used by this test.
   *
   * @var array
   */
  public static $testViews = [
    'test_page_display',
    'test_page_display_route',
    'test_page_display_menu',
    'test_display_more',
  ];

  /**
   * Modules to enable.
   *
   * @var array
   */
  protected static $modules = [
    'system',
    'user',
    'field',
    'views_test_data',
  ];

  /**
   * The router dumper to get all routes.
   *
   * @var \Drupal\Core\Routing\MatcherDumper
   */
  protected $routerDumper;

  /**
   * Checks the behavior of the page for access denied/not found behaviors.
   */
  public function testPageResponses() {
    \Drupal::currentUser()
      ->setAccount(new AnonymousUserSession());
    $subrequest = Request::create('/test_page_display_403', 'GET');
    $response = $this->container
      ->get('http_kernel')
      ->handle($subrequest, HttpKernelInterface::SUB_REQUEST);
    $this
      ->assertEquals(403, $response
      ->getStatusCode());
    $subrequest = Request::create('/test_page_display_404', 'GET');
    $response = $this->container
      ->get('http_kernel')
      ->handle($subrequest, HttpKernelInterface::SUB_REQUEST);
    $this
      ->assertEquals(404, $response
      ->getStatusCode());
    $subrequest = Request::create('/test_page_display_200', 'GET');
    $response = $this->container
      ->get('http_kernel')
      ->handle($subrequest, HttpKernelInterface::SUB_REQUEST);
    $this
      ->assertEquals(200, $response
      ->getStatusCode());
    $subrequest = Request::create('/test_page_display_200', 'GET');
    \Drupal::getContainer()
      ->get('request_stack')
      ->push($subrequest);

    // Test accessing a disabled page for a view.
    $view = Views::getView('test_page_display');

    // Disable the view, rebuild menu, and request the page again.
    $view->storage
      ->disable()
      ->save();

    // Router rebuild would occur in a kernel terminate event so we need to
    // simulate that here.
    \Drupal::service('router.builder')
      ->rebuild();
    $response = $this->container
      ->get('http_kernel')
      ->handle($subrequest, HttpKernelInterface::SUB_REQUEST);
    $this
      ->assertEquals(404, $response
      ->getStatusCode());
  }

  /**
   * Checks that the router items are properly registered.
   */
  public function testPageRouterItems() {
    $collection = \Drupal::service('views.route_subscriber')
      ->routes();

    // Check the controller defaults.
    foreach ($collection as $id => $route) {
      $this
        ->assertEquals('Drupal\\views\\Routing\\ViewPageController::handle', $route
        ->getDefault('_controller'));
      $id_parts = explode('.', $id);
      $this
        ->assertEquals($id_parts[1], $route
        ->getDefault('view_id'));
      $this
        ->assertEquals($id_parts[2], $route
        ->getDefault('display_id'));
    }

    // Check the generated patterns and default values.
    $route = $collection
      ->get('view.test_page_display_route.page_1');
    $this
      ->assertEquals('/test_route_without_arguments', $route
      ->getPath());
    $route = $collection
      ->get('view.test_page_display_route.page_2');
    $this
      ->assertEquals('/test_route_with_argument/{arg_0}', $route
      ->getPath());
    $this
      ->assertTrue($route
      ->hasDefault('arg_0'), 'A default value is set for the optional argument id.');
    $route = $collection
      ->get('view.test_page_display_route.page_3');
    $this
      ->assertEquals('/test_route_with_argument/{arg_0}/suffix', $route
      ->getPath());
    $this
      ->assertFalse($route
      ->hasDefault('arg_0'), 'No default value is set for the required argument id.');
    $route = $collection
      ->get('view.test_page_display_route.page_4');
    $this
      ->assertEquals('/test_route_with_argument/{arg_0}/suffix/{arg_1}', $route
      ->getPath());
    $this
      ->assertFalse($route
      ->hasDefault('arg_0'), 'No default value is set for the required argument id.');
    $this
      ->assertTrue($route
      ->hasDefault('arg_1'), 'A default value is set for the optional argument id_2.');
    $route = $collection
      ->get('view.test_page_display_route.page_5');
    $this
      ->assertEquals('/test_route_with_argument/{arg_0}/{arg_1}', $route
      ->getPath());
    $this
      ->assertTrue($route
      ->hasDefault('arg_0'), 'A default value is set for the optional argument id.');
    $this
      ->assertTrue($route
      ->hasDefault('arg_1'), 'A default value is set for the optional argument id_2.');
    $route = $collection
      ->get('view.test_page_display_route.page_6');
    $this
      ->assertEquals('/test_route_with_argument/{arg_0}/{arg_1}', $route
      ->getPath());
    $this
      ->assertFalse($route
      ->hasDefault('arg_0'), 'No default value is set for the required argument id.');
    $this
      ->assertFalse($route
      ->hasDefault('arg_1'), 'No default value is set for the required argument id_2.');
  }

  /**
   * Tests the generated menu links of views.
   */
  public function testMenuLinks() {
    \Drupal::service('plugin.manager.menu.link')
      ->rebuild();
    $tree = \Drupal::menuTree()
      ->load('admin', new MenuTreeParameters());
    $this
      ->assertTrue(isset($tree['system.admin']->subtree['views_view:views.test_page_display_menu.page_4']));
    $menu_link = $tree['system.admin']->subtree['views_view:views.test_page_display_menu.page_4']->link;
    $this
      ->assertEquals('Test child (with parent)', $menu_link
      ->getTitle());
    $this
      ->assertEquals(TRUE, $menu_link
      ->isExpanded());
    $this
      ->assertEquals('Sample description.', $menu_link
      ->getDescription());
  }

  /**
   * Tests the calculated dependencies for various views using Page displays.
   */
  public function testDependencies() {
    $view = Views::getView('test_page_display');
    $this
      ->assertSame([
      'module' => [
        'views_test_data',
      ],
    ], $view
      ->getDependencies());
    $view = Views::getView('test_page_display_route');
    $expected = [
      'content' => [
        'StaticTest',
      ],
      'module' => [
        'views_test_data',
      ],
    ];
    $this
      ->assertSame($expected, $view
      ->getDependencies());
    $view = Views::getView('test_page_display_menu');
    $expected = [
      'config' => [
        'system.menu.admin',
        'system.menu.tools',
      ],
      'module' => [
        'views_test_data',
      ],
    ];
    $this
      ->assertSame($expected, $view
      ->getDependencies());
  }

  /**
   * Tests the readmore functionality.
   */
  public function testReadMore() {

    /** @var \Drupal\Core\Render\RendererInterface $renderer */
    $renderer = $this->container
      ->get('renderer');
    $expected_more_text = 'custom more text';
    $view = Views::getView('test_display_more');
    $this
      ->executeView($view);
    $output = $view
      ->preview();
    $output = $renderer
      ->renderRoot($output);
    $this
      ->setRawContent($output);
    $result = $this
      ->xpath('//div[@class=:class]/a', [
      ':class' => 'more-link',
    ]);
    $this
      ->assertEquals(Url::fromRoute('view.test_display_more.page_1')
      ->toString(), $result[0]
      ->attributes()->href, 'The right more link is shown.');
    $this
      ->assertEquals($expected_more_text, trim((string) $result[0][0]), 'The right link text is shown.');

    // Test the renderMoreLink method directly. This could be directly unit
    // tested.
    $more_link = $view->display_handler
      ->renderMoreLink();
    $more_link = $renderer
      ->renderRoot($more_link);
    $this
      ->setRawContent($more_link);
    $result = $this
      ->xpath('//div[@class=:class]/a', [
      ':class' => 'more-link',
    ]);
    $this
      ->assertEquals(Url::fromRoute('view.test_display_more.page_1')
      ->toString(), $result[0]
      ->attributes()->href, 'The right more link is shown.');
    $this
      ->assertEquals($expected_more_text, trim((string) $result[0][0]), 'The right link text is shown.');

    // Test the useMoreText method directly. This could be directly unit
    // tested.
    $more_text = $view->display_handler
      ->useMoreText();
    $this
      ->assertEquals($expected_more_text, $more_text, 'The right more text is chosen.');
    $view = Views::getView('test_display_more');
    $view
      ->setDisplay();
    $view->display_handler
      ->setOption('use_more', 0);
    $this
      ->executeView($view);
    $output = $view
      ->preview();
    $output = $renderer
      ->renderRoot($output);
    $this
      ->setRawContent($output);
    $result = $this
      ->xpath('//div[@class=:class]/a', [
      ':class' => 'more-link',
    ]);
    $this
      ->assertEmpty($result, 'The more link is not shown.');
    $view = Views::getView('test_display_more');
    $view
      ->setDisplay();
    $view->display_handler
      ->setOption('use_more', 0);
    $view->display_handler
      ->setOption('use_more_always', 0);
    $view->display_handler
      ->setOption('pager', [
      'type' => 'some',
      'options' => [
        'items_per_page' => 1,
        'offset' => 0,
      ],
    ]);
    $this
      ->executeView($view);
    $output = $view
      ->preview();
    $output = $renderer
      ->renderRoot($output);
    $this
      ->setRawContent($output);
    $result = $this
      ->xpath('//div[@class=:class]/a', [
      ':class' => 'more-link',
    ]);
    $this
      ->assertEmpty($result, 'The more link is not shown when view has more records.');

    // Test the default value of use_more_always.
    $view = View::create()
      ->getExecutable();
    $this
      ->assertTrue($view
      ->getDisplay()
      ->getOption('use_more_always'), 'Always display the more link by default.');
  }

  /**
   * Tests the templates with empty rows.
   */
  public function testEmptyRow() {
    $view = Views::getView('test_page_display');
    $view
      ->initDisplay();
    $view
      ->newDisplay('page', 'Page', 'empty_row');
    $view
      ->save();
    $styles = [
      'default' => '//div[@class="views-row"]',
      // Olivero does not use the 'views-col' class.
      'grid' => '//div[contains(@class, "views-col") or contains(@class, "views-view-grid__item-inner")]',
      'html_list' => '//div[@class="item-list"]//li',
    ];
    $themes = [
      'olivero',
      'stable9',
      'stark',
      'claro',
    ];
    foreach ($themes as $theme) {
      \Drupal::service('theme_installer')
        ->install([
        $theme,
      ]);
      \Drupal::theme()
        ->setActiveTheme(\Drupal::service('theme.initialization')
        ->initTheme($theme));
      foreach ($styles as $type => $xpath) {
        $view = Views::getView('test_page_display');
        $view->storage
          ->invalidateCaches();
        $view
          ->initDisplay();
        $view
          ->setDisplay('empty_row');
        $view->displayHandlers
          ->get('empty_row')->default_display->options['style']['type'] = $type;
        $view
          ->initStyle();
        $this
          ->executeView($view);
        $output = $view
          ->preview();
        $output = \Drupal::service('renderer')
          ->renderRoot($output);
        $this
          ->setRawContent($output);
        $this
          ->assertCount(5, $this
          ->xpath("{$xpath}[not(text()) and not(node())]"), "Empty rows in theme '{$theme}', type '{$type}'.");
      }
    }
  }

}