You are here

Home » API reference » Drupal 8 » DisplayPageTest.php

class DisplayPageTest in Drupal 8

Same name and namespace in other branches
  1. 9 core/modules/views/tests/src/Kernel/Plugin/DisplayPageTest.php \Drupal\Tests\views\Kernel\Plugin\DisplayPageTest
  2. 10 core/modules/views/tests/src/Kernel/Plugin/DisplayPageTest.php \Drupal\Tests\views\Kernel\Plugin\DisplayPageTest

Tests the page display plugin.

@group views

Hierarchy

Expanded class hierarchy of DisplayPageTest

See also

\Drupal\views\Plugin\display\Page

File

core/modules/views/tests/src/Kernel/Plugin/DisplayPageTest.php, line 20

Namespace

Drupal\Tests\views\Kernel\Plugin
View source 
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
   */
  public 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
      ->assertEqual($response
      ->getStatusCode(), 403);
    $subrequest = Request::create('/test_page_display_404', 'GET');
    $response = $this->container
      ->get('http_kernel')
      ->handle($subrequest, HttpKernelInterface::SUB_REQUEST);
    $this
      ->assertEqual($response
      ->getStatusCode(), 404);
    $subrequest = Request::create('/test_page_display_200', 'GET');
    $response = $this->container
      ->get('http_kernel')
      ->handle($subrequest, HttpKernelInterface::SUB_REQUEST);
    $this
      ->assertEqual($response
      ->getStatusCode(), 200);
    $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
      ->assertEqual($response
      ->getStatusCode(), 404);
  }

  /**
   * 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
        ->assertEqual($route
        ->getDefault('_controller'), 'Drupal\\views\\Routing\\ViewPageController::handle');
      $id_parts = explode('.', $id);
      $this
        ->assertEqual($route
        ->getDefault('view_id'), $id_parts[1]);
      $this
        ->assertEqual($route
        ->getDefault('display_id'), $id_parts[2]);
    }

    // Check the generated patterns and default values.
    $route = $collection
      ->get('view.test_page_display_route.page_1');
    $this
      ->assertEqual($route
      ->getPath(), '/test_route_without_arguments');
    $route = $collection
      ->get('view.test_page_display_route.page_2');
    $this
      ->assertEqual($route
      ->getPath(), '/test_route_with_argument/{arg_0}');
    $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
      ->assertEqual($route
      ->getPath(), '/test_route_with_argument/{arg_0}/suffix');
    $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
      ->assertEqual($route
      ->getPath(), '/test_route_with_argument/{arg_0}/suffix/{arg_1}');
    $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
      ->assertEqual($route
      ->getPath(), '/test_route_with_argument/{arg_0}/{arg_1}');
    $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
      ->assertEqual($route
      ->getPath(), '/test_route_with_argument/{arg_0}/{arg_1}');
    $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
      ->assertEqual($menu_link
      ->getTitle(), 'Test child (with parent)');
    $this
      ->assertEqual($menu_link
      ->isExpanded(), TRUE);
    $this
      ->assertEqual($menu_link
      ->getDescription(), 'Sample description.');
  }

  /**
   * Tests the calculated dependencies for various views using Page displays.
   */
  public function testDependencies() {
    $view = Views::getView('test_page_display');
    $this
      ->assertIdentical([
      'module' => [
        'views_test_data',
      ],
    ], $view
      ->getDependencies());
    $view = Views::getView('test_page_display_route');
    $expected = [
      'content' => [
        'StaticTest',
      ],
      'module' => [
        'views_test_data',
      ],
    ];
    $this
      ->assertIdentical($expected, $view
      ->getDependencies());
    $view = Views::getView('test_page_display_menu');
    $expected = [
      'config' => [
        'system.menu.admin',
        'system.menu.tools',
      ],
      'module' => [
        'views_test_data',
      ],
    ];
    $this
      ->assertIdentical($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
      ->assertEqual($result[0]
      ->attributes()->href, Url::fromRoute('view.test_display_more.page_1')
      ->toString(), 'The right more link is shown.');
    $this
      ->assertEqual(trim($result[0][0]), $expected_more_text, '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
      ->assertEqual($result[0]
      ->attributes()->href, Url::fromRoute('view.test_display_more.page_1')
      ->toString(), 'The right more link is shown.');
    $this
      ->assertEqual(trim($result[0][0]), $expected_more_text, 'The right link text is shown.');

    // Test the useMoreText method directly. This could be directly unit
    // tested.
    $more_text = $view->display_handler
      ->useMoreText();
    $this
      ->assertEqual($more_text, $expected_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
      ->assertTrue(empty($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
      ->assertTrue(empty($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"]',
      'grid' => '//div[contains(@class, "views-col")]',
      'html_list' => '//div[@class="item-list"]//li',
    ];
    $themes = [
      'bartik',
      'classy',
      'seven',
      'stable',
      'stark',
    ];
    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}'.");
      }
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
DisplayPageTest::$modules public static property Modules to enable. Overrides ViewsKernelTestBase::$modules
DisplayPageTest::$routerDumper protected property The router dumper to get all routes.
DisplayPageTest::$testViews public static property Views used by this test. Overrides ViewsKernelTestBase::$testViews
DisplayPageTest::testDependencies public function Tests the calculated dependencies for various views using Page displays.
DisplayPageTest::testEmptyRow public function Tests the templates with empty rows.
DisplayPageTest::testMenuLinks public function Tests the generated menu links of views.
DisplayPageTest::testPageResponses public function Checks the behavior of the page for access denied/not found behaviors.
DisplayPageTest::testPageRouterItems public function Checks that the router items are properly registered
DisplayPageTest::testReadMore public function Tests the readmore functionality.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 7
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 6
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel private function Bootstraps a kernel for a test.
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 1
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::isTestInIsolation Deprecated protected function Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 26
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get Deprecated public function BC: Automatically resolve former KernelTestBase class properties.
KernelTestBase::__sleep public function Prevents serializing any properties.
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
ViewResultAssertionTrait::assertIdenticalResultset protected function Verifies that a result set returned by a View matches expected values.
ViewResultAssertionTrait::assertIdenticalResultsetHelper protected function Performs View result assertions.
ViewResultAssertionTrait::assertNotIdenticalResultset protected function Verifies that a result set returned by a View differs from certain values.
ViewsKernelTestBase::dataSet protected function Returns a very simple test dataset. 8
ViewsKernelTestBase::executeView protected function Executes a view with debugging.
ViewsKernelTestBase::orderResultSet protected function Orders a nested array containing a result set based on a given column.
ViewsKernelTestBase::schemaDefinition protected function Returns the schema definition. 6
ViewsKernelTestBase::setUp protected function Overrides KernelTestBase::setUp 65
ViewsKernelTestBase::setUpFixtures protected function Sets up the configuration and schema of views and views_test_data modules. 7
ViewsKernelTestBase::viewsData protected function Returns the views data definition. 22