aleph1.co.uk Git - yaffs-website/blob - PagerTest.php

   1 <?php
   2
   3 namespace Drupal\Tests\system\Functional\Pager;
   4
   5 use Behat\Mink\Element\NodeElement;
   6 use Drupal\Tests\BrowserTestBase;
   7 use Drupal\Tests\system\Functional\Cache\AssertPageCacheContextsAndTagsTrait;
   8
   9 /**
  10  * Tests pager functionality.
  11  *
  12  * @group Pager
  13  */
  14 class PagerTest extends BrowserTestBase {
  15
  16   use AssertPageCacheContextsAndTagsTrait;
  17
  18   /**
  19    * Modules to enable.
  20    *
  21    * @var array
  22    */
  23   public static $modules = ['dblog', 'pager_test'];
  24
  25   /**
  26    * A user with permission to access site reports.
  27    *
  28    * @var \Drupal\user\UserInterface
  29    */
  30   protected $adminUser;
  31
  32   protected $profile = 'testing';
  33
  34   protected function setUp() {
  35     parent::setUp();
  36
  37     // Insert 300 log messages.
  38     $logger = $this->container->get('logger.factory')->get('pager_test');
  39     for ($i = 0; $i < 300; $i++) {
  40       $logger->debug($this->randomString());
  41     }
  42
  43     $this->adminUser = $this->drupalCreateUser([
  44       'access site reports',
  45     ]);
  46     $this->drupalLogin($this->adminUser);
  47   }
  48
  49   /**
  50    * Tests markup and CSS classes of pager links.
  51    */
  52   public function testActiveClass() {
  53     // Verify first page.
  54     $this->drupalGet('admin/reports/dblog');
  55     $current_page = 0;
  56     $this->assertPagerItems($current_page);
  57
  58     // Verify any page but first/last.
  59     $current_page++;
  60     $this->drupalGet('admin/reports/dblog', ['query' => ['page' => $current_page]]);
  61     $this->assertPagerItems($current_page);
  62
  63     // Verify last page.
  64     $elements = $this->xpath('//li[contains(@class, :class)]/a', [':class' => 'pager__item--last']);
  65     preg_match('@page=(\d+)@', $elements[0]->getAttribute('href'), $matches);
  66     $current_page = (int) $matches[1];
  67     $this->drupalGet($GLOBALS['base_root'] . parse_url($this->getUrl())['path'] . $elements[0]->getAttribute('href'), ['external' => TRUE]);
  68     $this->assertPagerItems($current_page);
  69   }
  70
  71   /**
  72    * Test proper functioning of the query parameters and the pager cache context.
  73    */
  74   public function testPagerQueryParametersAndCacheContext() {
  75     // First page.
  76     $this->drupalGet('pager-test/query-parameters');
  77     $this->assertText(t('Pager calls: 0'), 'Initial call to pager shows 0 calls.');
  78     $this->assertText('[url.query_args.pagers:0]=0.0');
  79     $this->assertCacheContext('url.query_args');
  80
  81     // Go to last page, the count of pager calls need to go to 1.
  82     $elements = $this->xpath('//li[contains(@class, :class)]/a', [':class' => 'pager__item--last']);
  83     $elements[0]->click();
  84     $this->assertText(t('Pager calls: 1'), 'First link call to pager shows 1 calls.');
  85     $this->assertText('[url.query_args.pagers:0]=0.60');
  86     $this->assertCacheContext('url.query_args');
  87
  88     // Reset counter to 0.
  89     $this->drupalGet('pager-test/query-parameters');
  90     // Go back to first page, the count of pager calls need to go to 2.
  91     $elements = $this->xpath('//li[contains(@class, :class)]/a', [':class' => 'pager__item--last']);
  92     $elements[0]->click();
  93     $elements = $this->xpath('//li[contains(@class, :class)]/a', [':class' => 'pager__item--first']);
  94     $elements[0]->click();
  95     $this->assertText(t('Pager calls: 2'), 'Second link call to pager shows 2 calls.');
  96     $this->assertText('[url.query_args.pagers:0]=0.0');
  97     $this->assertCacheContext('url.query_args');
  98   }
  99
 100   /**
 101    * Test proper functioning of multiple pagers.
 102    */
 103   public function testMultiplePagers() {
 104     // First page.
 105     $this->drupalGet('pager-test/multiple-pagers');
 106
 107     // Test data.
 108     // Expected URL query string param is 0-indexed.
 109     // Expected page per pager is 1-indexed.
 110     $test_data = [
 111       // With no query, all pagers set to first page.
 112       [
 113         'input_query' => NULL,
 114         'expected_page' => [0 => '1', 1 => '1', 4 => '1'],
 115         'expected_query' => '?page=0,0,,,0',
 116       ],
 117       // Blanks around page numbers should not be relevant.
 118       [
 119         'input_query' => '?page=2  ,    10,,,   5     ,,',
 120         'expected_page' => [0 => '3', 1 => '11', 4 => '6'],
 121         'expected_query' => '?page=2,10,,,5',
 122       ],
 123       // Blanks within page numbers should lead to only the first integer
 124       // to be considered.
 125       [
 126         'input_query' => '?page=2  ,   3 0,,,   4  13    ,,',
 127         'expected_page' => [0 => '3', 1 => '4', 4 => '5'],
 128         'expected_query' => '?page=2,3,,,4',
 129       ],
 130       // If floats are passed as page numbers, only the integer part is
 131       // returned.
 132       [
 133         'input_query' => '?page=2.1,6.999,,,5.',
 134         'expected_page' => [0 => '3', 1 => '7', 4 => '6'],
 135         'expected_query' => '?page=2,6,,,5',
 136       ],
 137       // Partial page fragment, undefined pagers set to first page.
 138       [
 139         'input_query' => '?page=5,2',
 140         'expected_page' => [0 => '6', 1 => '3', 4 => '1'],
 141         'expected_query' => '?page=5,2,,,0',
 142       ],
 143       // Partial page fragment, undefined pagers set to first page.
 144       [
 145         'input_query' => '?page=,2',
 146         'expected_page' => [0 => '1', 1 => '3', 4 => '1'],
 147         'expected_query' => '?page=0,2,,,0',
 148       ],
 149       // Partial page fragment, undefined pagers set to first page.
 150       [
 151         'input_query' => '?page=,',
 152         'expected_page' => [0 => '1', 1 => '1', 4 => '1'],
 153         'expected_query' => '?page=0,0,,,0',
 154       ],
 155       // With overflow pages, all pagers set to max page.
 156       [
 157         'input_query' => '?page=99,99,,,99',
 158         'expected_page' => [0 => '16', 1 => '16', 4 => '16'],
 159         'expected_query' => '?page=15,15,,,15',
 160       ],
 161       // Wrong value for the page resets pager to first page.
 162       [
 163         'input_query' => '?page=bar,5,foo,qux,bet',
 164         'expected_page' => [0 => '1', 1 => '6', 4 => '1'],
 165         'expected_query' => '?page=0,5,,,0',
 166       ],
 167     ];
 168
 169     // We loop through the page with the test data query parameters, and check
 170     // that the active page for each pager element has the expected page
 171     // (1-indexed) and resulting query parameter
 172     foreach ($test_data as $data) {
 173       $input_query = str_replace(' ', '%20', $data['input_query']);
 174       $this->drupalGet($GLOBALS['base_root'] . parse_url($this->getUrl())['path'] . $input_query, ['external' => TRUE]);
 175       foreach ([0, 1, 4] as $pager_element) {
 176         $active_page = $this->cssSelect("div.test-pager-{$pager_element} ul.pager__items li.is-active:contains('{$data['expected_page'][$pager_element]}')");
 177         $destination = str_replace('%2C', ',', $active_page[0]->find('css', 'a')->getAttribute('href'));
 178         $this->assertEqual($destination, $data['expected_query']);
 179       }
 180     }
 181   }
 182
 183   /**
 184    * Test proper functioning of the ellipsis.
 185    */
 186   public function testPagerEllipsis() {
 187     // Insert 100 extra log messages to get 9 pages.
 188     $logger = $this->container->get('logger.factory')->get('pager_test');
 189     for ($i = 0; $i < 100; $i++) {
 190       $logger->debug($this->randomString());
 191     }
 192     $this->drupalGet('admin/reports/dblog');
 193     $elements = $this->cssSelect(".pager__item--ellipsis:contains('…')");
 194     $this->assertEqual(count($elements), 0, 'No ellipsis has been set.');
 195
 196     // Insert an extra 50 log messages to get 10 pages.
 197     $logger = $this->container->get('logger.factory')->get('pager_test');
 198     for ($i = 0; $i < 50; $i++) {
 199       $logger->debug($this->randomString());
 200     }
 201     $this->drupalGet('admin/reports/dblog');
 202     $elements = $this->cssSelect(".pager__item--ellipsis:contains('…')");
 203     $this->assertEqual(count($elements), 1, 'Found the ellipsis.');
 204   }
 205
 206   /**
 207    * Asserts pager items and links.
 208    *
 209    * @param int $current_page
 210    *   The current pager page the internal browser is on.
 211    */
 212   protected function assertPagerItems($current_page) {
 213     $elements = $this->xpath('//ul[contains(@class, :class)]/li', [':class' => 'pager__items']);
 214     $this->assertTrue(!empty($elements), 'Pager found.');
 215
 216     // Make current page 1-based.
 217     $current_page++;
 218
 219     // Extract first/previous and next/last items.
 220     // first/previous only exist, if the current page is not the first.
 221     if ($current_page > 1) {
 222       $first = array_shift($elements);
 223       $previous = array_shift($elements);
 224     }
 225     // next/last always exist, unless the current page is the last.
 226     if ($current_page != count($elements)) {
 227       $last = array_pop($elements);
 228       $next = array_pop($elements);
 229     }
 230
 231     // We remove elements from the $elements array in the following code, so
 232     // we store the total number of pages for verifying the "last" link.
 233     $total_pages = count($elements);
 234
 235     // Verify items and links to pages.
 236     foreach ($elements as $page => $element) {
 237       // Make item/page index 1-based.
 238       $page++;
 239
 240       if ($current_page == $page) {
 241         $this->assertClass($element, 'is-active', 'Element for current page has .is-active class.');
 242         $link = $element->find('css', 'a');
 243         $this->assertTrue($link, 'Element for current page has link.');
 244         $destination = $link->getAttribute('href');
 245         // URL query string param is 0-indexed.
 246         $this->assertEqual($destination, '?page=' . ($page - 1));
 247       }
 248       else {
 249         $this->assertNoClass($element, 'is-active', "Element for page $page has no .is-active class.");
 250         $this->assertClass($element, 'pager__item', "Element for page $page has .pager__item class.");
 251         $link = $element->find('css', 'a');
 252         $this->assertTrue($link, "Link to page $page found.");
 253         $destination = $link->getAttribute('href');
 254         $this->assertEqual($destination, '?page=' . ($page - 1));
 255       }
 256       unset($elements[--$page]);
 257     }
 258     // Verify that no other items remain untested.
 259     $this->assertTrue(empty($elements), 'All expected items found.');
 260
 261     // Verify first/previous and next/last items and links.
 262     if (isset($first)) {
 263       $this->assertClass($first, 'pager__item--first', 'Element for first page has .pager__item--first class.');
 264       $link = $first->find('css', 'a');
 265       $this->assertTrue($link, 'Link to first page found.');
 266       $this->assertNoClass($link, 'is-active', 'Link to first page is not active.');
 267       $destination = $link->getAttribute('href');
 268       $this->assertEqual($destination, '?page=0');
 269     }
 270     if (isset($previous)) {
 271       $this->assertClass($previous, 'pager__item--previous', 'Element for first page has .pager__item--previous class.');
 272       $link = $previous->find('css', 'a');
 273       $this->assertTrue($link, 'Link to previous page found.');
 274       $this->assertNoClass($link, 'is-active', 'Link to previous page is not active.');
 275       $destination = $link->getAttribute('href');
 276       // URL query string param is 0-indexed, $current_page is 1-indexed.
 277       $this->assertEqual($destination, '?page=' . ($current_page - 2));
 278     }
 279     if (isset($next)) {
 280       $this->assertClass($next, 'pager__item--next', 'Element for next page has .pager__item--next class.');
 281       $link = $next->find('css', 'a');
 282       $this->assertTrue($link, 'Link to next page found.');
 283       $this->assertNoClass($link, 'is-active', 'Link to next page is not active.');
 284       $destination = $link->getAttribute('href');
 285       // URL query string param is 0-indexed, $current_page is 1-indexed.
 286       $this->assertEqual($destination, '?page=' . $current_page);
 287     }
 288     if (isset($last)) {
 289       $link = $last->find('css', 'a');
 290       $this->assertClass($last, 'pager__item--last', 'Element for last page has .pager__item--last class.');
 291       $this->assertTrue($link, 'Link to last page found.');
 292       $this->assertNoClass($link, 'is-active', 'Link to last page is not active.');
 293       $destination = $link->getAttribute('href');
 294       // URL query string param is 0-indexed.
 295       $this->assertEqual($destination, '?page=' . ($total_pages - 1));
 296     }
 297   }
 298
 299   /**
 300    * Asserts that an element has a given class.
 301    *
 302    * @param \Behat\Mink\Element\NodeElement $element
 303    *   The element to test.
 304    * @param string $class
 305    *   The class to assert.
 306    * @param string $message
 307    *   (optional) A verbose message to output.
 308    */
 309   protected function assertClass(NodeElement $element, $class, $message = NULL) {
 310     if (!isset($message)) {
 311       $message = "Class .$class found.";
 312     }
 313     $this->assertTrue($element->hasClass($class) !== FALSE, $message);
 314   }
 315
 316   /**
 317    * Asserts that an element does not have a given class.
 318    *
 319    * @param \Behat\Mink\Element\NodeElement $element
 320    *   The element to test.
 321    * @param string $class
 322    *   The class to assert.
 323    * @param string $message
 324    *   (optional) A verbose message to output.
 325    */
 326   protected function assertNoClass(NodeElement $element, $class, $message = NULL) {
 327     if (!isset($message)) {
 328       $message = "Class .$class not found.";
 329     }
 330     $this->assertTrue($element->hasClass($class) === FALSE, $message);
 331   }
 332
 333 }