Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\system\Tests\Pager;
Chris@0: 
Chris@0: use Drupal\simpletest\WebTestBase;
Chris@0: 
Chris@0: /**
Chris@0:  * Tests pager functionality.
Chris@0:  *
Chris@0:  * @group Pager
Chris@0:  */
Chris@0: class PagerTest extends WebTestBase {
Chris@0: 
Chris@0:   /**
Chris@0:    * Modules to enable.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   public static $modules = ['dblog', 'pager_test'];
Chris@0: 
Chris@0:   /**
Chris@0:    * A user with permission to access site reports.
Chris@0:    *
Chris@0:    * @var \Drupal\user\UserInterface
Chris@0:    */
Chris@0:   protected $adminUser;
Chris@0: 
Chris@0:   protected $profile = 'testing';
Chris@0: 
Chris@0:   protected function setUp() {
Chris@0:     parent::setUp();
Chris@0: 
Chris@0:     // Insert 300 log messages.
Chris@0:     $logger = $this->container->get('logger.factory')->get('pager_test');
Chris@0:     for ($i = 0; $i < 300; $i++) {
Chris@0:       $logger->debug($this->randomString());
Chris@0:     }
Chris@0: 
Chris@0:     $this->adminUser = $this->drupalCreateUser([
Chris@0:       'access site reports',
Chris@0:     ]);
Chris@0:     $this->drupalLogin($this->adminUser);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests markup and CSS classes of pager links.
Chris@0:    */
Chris@0:   public function testActiveClass() {
Chris@0:     // Verify first page.
Chris@0:     $this->drupalGet('admin/reports/dblog');
Chris@0:     $current_page = 0;
Chris@0:     $this->assertPagerItems($current_page);
Chris@0: 
Chris@0:     // Verify any page but first/last.
Chris@0:     $current_page++;
Chris@0:     $this->drupalGet('admin/reports/dblog', ['query' => ['page' => $current_page]]);
Chris@0:     $this->assertPagerItems($current_page);
Chris@0: 
Chris@0:     // Verify last page.
Chris@0:     $elements = $this->xpath('//li[contains(@class, :class)]/a', [':class' => 'pager__item--last']);
Chris@0:     preg_match('@page=(\d+)@', $elements[0]['href'], $matches);
Chris@0:     $current_page = (int) $matches[1];
Chris@0:     $this->drupalGet($GLOBALS['base_root'] . parse_url($this->getUrl())['path'] . $elements[0]['href'], ['external' => TRUE]);
Chris@0:     $this->assertPagerItems($current_page);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Test proper functioning of the query parameters and the pager cache context.
Chris@0:    */
Chris@0:   public function testPagerQueryParametersAndCacheContext() {
Chris@0:     // First page.
Chris@0:     $this->drupalGet('pager-test/query-parameters');
Chris@0:     $this->assertText(t('Pager calls: 0'), 'Initial call to pager shows 0 calls.');
Chris@0:     $this->assertText('[url.query_args.pagers:0]=0.0');
Chris@0:     $this->assertCacheContext('url.query_args');
Chris@0: 
Chris@0:     // Go to last page, the count of pager calls need to go to 1.
Chris@0:     $elements = $this->xpath('//li[contains(@class, :class)]/a', [':class' => 'pager__item--last']);
Chris@0:     $this->drupalGet($this->getAbsoluteUrl($elements[0]['href']));
Chris@0:     $this->assertText(t('Pager calls: 1'), 'First link call to pager shows 1 calls.');
Chris@0:     $this->assertText('[url.query_args.pagers:0]=0.60');
Chris@0:     $this->assertCacheContext('url.query_args');
Chris@0: 
Chris@0:     // Go back to first page, the count of pager calls need to go to 2.
Chris@0:     $elements = $this->xpath('//li[contains(@class, :class)]/a', [':class' => 'pager__item--first']);
Chris@0:     $this->drupalGet($this->getAbsoluteUrl($elements[0]['href']));
Chris@0:     $this->drupalGet($GLOBALS['base_root'] . parse_url($this->getUrl())['path'] . $elements[0]['href'], ['external' => TRUE]);
Chris@0:     $this->assertText(t('Pager calls: 2'), 'Second link call to pager shows 2 calls.');
Chris@0:     $this->assertText('[url.query_args.pagers:0]=0.0');
Chris@0:     $this->assertCacheContext('url.query_args');
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Test proper functioning of multiple pagers.
Chris@0:    */
Chris@0:   public function testMultiplePagers() {
Chris@0:     // First page.
Chris@0:     $this->drupalGet('pager-test/multiple-pagers');
Chris@0: 
Chris@0:     // Test data.
Chris@0:     // Expected URL query string param is 0-indexed.
Chris@0:     // Expected page per pager is 1-indexed.
Chris@0:     $test_data = [
Chris@0:       // With no query, all pagers set to first page.
Chris@0:       [
Chris@0:         'input_query' => NULL,
Chris@0:         'expected_page' => [0 => '1', 1 => '1', 4 => '1'],
Chris@0:         'expected_query' => '?page=0,0,,,0',
Chris@0:       ],
Chris@0:       // Blanks around page numbers should not be relevant.
Chris@0:       [
Chris@0:         'input_query' => '?page=2  ,    10,,,   5     ,,',
Chris@0:         'expected_page' => [0 => '3', 1 => '11', 4 => '6'],
Chris@0:         'expected_query' => '?page=2,10,,,5',
Chris@0:       ],
Chris@0:       // Blanks within page numbers should lead to only the first integer
Chris@0:       // to be considered.
Chris@0:       [
Chris@0:         'input_query' => '?page=2  ,   3 0,,,   4  13    ,,',
Chris@0:         'expected_page' => [0 => '3', 1 => '4', 4 => '5'],
Chris@0:         'expected_query' => '?page=2,3,,,4',
Chris@0:       ],
Chris@0:       // If floats are passed as page numbers, only the integer part is
Chris@0:       // returned.
Chris@0:       [
Chris@0:         'input_query' => '?page=2.1,6.999,,,5.',
Chris@0:         'expected_page' => [0 => '3', 1 => '7', 4 => '6'],
Chris@0:         'expected_query' => '?page=2,6,,,5',
Chris@0:       ],
Chris@0:       // Partial page fragment, undefined pagers set to first page.
Chris@0:       [
Chris@0:         'input_query' => '?page=5,2',
Chris@0:         'expected_page' => [0 => '6', 1 => '3', 4 => '1'],
Chris@0:         'expected_query' => '?page=5,2,,,0',
Chris@0:       ],
Chris@0:       // Partial page fragment, undefined pagers set to first page.
Chris@0:       [
Chris@0:         'input_query' => '?page=,2',
Chris@0:         'expected_page' => [0 => '1', 1 => '3', 4 => '1'],
Chris@0:         'expected_query' => '?page=0,2,,,0',
Chris@0:       ],
Chris@0:       // Partial page fragment, undefined pagers set to first page.
Chris@0:       [
Chris@0:         'input_query' => '?page=,',
Chris@0:         'expected_page' => [0 => '1', 1 => '1', 4 => '1'],
Chris@0:         'expected_query' => '?page=0,0,,,0',
Chris@0:       ],
Chris@0:       // With overflow pages, all pagers set to max page.
Chris@0:       [
Chris@0:         'input_query' => '?page=99,99,,,99',
Chris@0:         'expected_page' => [0 => '16', 1 => '16', 4 => '16'],
Chris@0:         'expected_query' => '?page=15,15,,,15',
Chris@0:       ],
Chris@0:       // Wrong value for the page resets pager to first page.
Chris@0:       [
Chris@0:         'input_query' => '?page=bar,5,foo,qux,bet',
Chris@0:         'expected_page' => [0 => '1', 1 => '6', 4 => '1'],
Chris@0:         'expected_query' => '?page=0,5,,,0',
Chris@0:       ],
Chris@0:     ];
Chris@0: 
Chris@0:     // We loop through the page with the test data query parameters, and check
Chris@0:     // that the active page for each pager element has the expected page
Chris@0:     // (1-indexed) and resulting query parameter
Chris@0:     foreach ($test_data as $data) {
Chris@0:       $input_query = str_replace(' ', '%20', $data['input_query']);
Chris@0:       $this->drupalGet($GLOBALS['base_root'] . parse_url($this->getUrl())['path'] . $input_query, ['external' => TRUE]);
Chris@0:       foreach ([0, 1, 4] as $pager_element) {
Chris@0:         $active_page = $this->cssSelect("div.test-pager-{$pager_element} ul.pager__items li.is-active:contains('{$data['expected_page'][$pager_element]}')");
Chris@0:         $destination = str_replace('%2C', ',', $active_page[0]->a['href'][0]->__toString());
Chris@0:         $this->assertEqual($destination, $data['expected_query']);
Chris@0:       }
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Test proper functioning of the ellipsis.
Chris@0:    */
Chris@0:   public function testPagerEllipsis() {
Chris@0:     // Insert 100 extra log messages to get 9 pages.
Chris@0:     $logger = $this->container->get('logger.factory')->get('pager_test');
Chris@0:     for ($i = 0; $i < 100; $i++) {
Chris@0:       $logger->debug($this->randomString());
Chris@0:     }
Chris@0:     $this->drupalGet('admin/reports/dblog');
Chris@0:     $elements = $this->cssSelect(".pager__item--ellipsis:contains('…')");
Chris@0:     $this->assertEqual(count($elements), 0, 'No ellipsis has been set.');
Chris@0: 
Chris@0:     // Insert an extra 50 log messages to get 10 pages.
Chris@0:     $logger = $this->container->get('logger.factory')->get('pager_test');
Chris@0:     for ($i = 0; $i < 50; $i++) {
Chris@0:       $logger->debug($this->randomString());
Chris@0:     }
Chris@0:     $this->drupalGet('admin/reports/dblog');
Chris@0:     $elements = $this->cssSelect(".pager__item--ellipsis:contains('…')");
Chris@0:     $this->assertEqual(count($elements), 1, 'Found the ellipsis.');
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Asserts pager items and links.
Chris@0:    *
Chris@0:    * @param int $current_page
Chris@0:    *   The current pager page the internal browser is on.
Chris@0:    */
Chris@0:   protected function assertPagerItems($current_page) {
Chris@0:     $elements = $this->xpath('//ul[contains(@class, :class)]/li', [':class' => 'pager__items']);
Chris@0:     $this->assertTrue(!empty($elements), 'Pager found.');
Chris@0: 
Chris@0:     // Make current page 1-based.
Chris@0:     $current_page++;
Chris@0: 
Chris@0:     // Extract first/previous and next/last items.
Chris@0:     // first/previous only exist, if the current page is not the first.
Chris@0:     if ($current_page > 1) {
Chris@0:       $first = array_shift($elements);
Chris@0:       $previous = array_shift($elements);
Chris@0:     }
Chris@0:     // next/last always exist, unless the current page is the last.
Chris@0:     if ($current_page != count($elements)) {
Chris@0:       $last = array_pop($elements);
Chris@0:       $next = array_pop($elements);
Chris@0:     }
Chris@0: 
Chris@0:     // We remove elements from the $elements array in the following code, so
Chris@0:     // we store the total number of pages for verifying the "last" link.
Chris@0:     $total_pages = count($elements);
Chris@0: 
Chris@0:     // Verify items and links to pages.
Chris@0:     foreach ($elements as $page => $element) {
Chris@0:       // Make item/page index 1-based.
Chris@0:       $page++;
Chris@0: 
Chris@0:       if ($current_page == $page) {
Chris@0:         $this->assertClass($element, 'is-active', 'Element for current page has .is-active class.');
Chris@0:         $this->assertTrue($element->a, 'Element for current page has link.');
Chris@0:         $destination = $element->a['href'][0]->__toString();
Chris@0:         // URL query string param is 0-indexed.
Chris@0:         $this->assertEqual($destination, '?page=' . ($page - 1));
Chris@0:       }
Chris@0:       else {
Chris@0:         $this->assertNoClass($element, 'is-active', "Element for page $page has no .is-active class.");
Chris@0:         $this->assertClass($element, 'pager__item', "Element for page $page has .pager__item class.");
Chris@0:         $this->assertTrue($element->a, "Link to page $page found.");
Chris@0:         $destination = $element->a['href'][0]->__toString();
Chris@0:         $this->assertEqual($destination, '?page=' . ($page - 1));
Chris@0:       }
Chris@0:       unset($elements[--$page]);
Chris@0:     }
Chris@0:     // Verify that no other items remain untested.
Chris@0:     $this->assertTrue(empty($elements), 'All expected items found.');
Chris@0: 
Chris@0:     // Verify first/previous and next/last items and links.
Chris@0:     if (isset($first)) {
Chris@0:       $this->assertClass($first, 'pager__item--first', 'Element for first page has .pager__item--first class.');
Chris@0:       $this->assertTrue($first->a, 'Link to first page found.');
Chris@0:       $this->assertNoClass($first->a, 'is-active', 'Link to first page is not active.');
Chris@0:       $destination = $first->a['href'][0]->__toString();
Chris@0:       $this->assertEqual($destination, '?page=0');
Chris@0:     }
Chris@0:     if (isset($previous)) {
Chris@0:       $this->assertClass($previous, 'pager__item--previous', 'Element for first page has .pager__item--previous class.');
Chris@0:       $this->assertTrue($previous->a, 'Link to previous page found.');
Chris@0:       $this->assertNoClass($previous->a, 'is-active', 'Link to previous page is not active.');
Chris@0:       $destination = $previous->a['href'][0]->__toString();
Chris@0:       // URL query string param is 0-indexed, $current_page is 1-indexed.
Chris@0:       $this->assertEqual($destination, '?page=' . ($current_page - 2));
Chris@0:     }
Chris@0:     if (isset($next)) {
Chris@0:       $this->assertClass($next, 'pager__item--next', 'Element for next page has .pager__item--next class.');
Chris@0:       $this->assertTrue($next->a, 'Link to next page found.');
Chris@0:       $this->assertNoClass($next->a, 'is-active', 'Link to next page is not active.');
Chris@0:       $destination = $next->a['href'][0]->__toString();
Chris@0:       // URL query string param is 0-indexed, $current_page is 1-indexed.
Chris@0:       $this->assertEqual($destination, '?page=' . $current_page);
Chris@0:     }
Chris@0:     if (isset($last)) {
Chris@0:       $this->assertClass($last, 'pager__item--last', 'Element for last page has .pager__item--last class.');
Chris@0:       $this->assertTrue($last->a, 'Link to last page found.');
Chris@0:       $this->assertNoClass($last->a, 'is-active', 'Link to last page is not active.');
Chris@0:       $destination = $last->a['href'][0]->__toString();
Chris@0:       // URL query string param is 0-indexed.
Chris@0:       $this->assertEqual($destination, '?page=' . ($total_pages - 1));
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Asserts that an element has a given class.
Chris@0:    *
Chris@0:    * @param \SimpleXMLElement $element
Chris@0:    *   The element to test.
Chris@0:    * @param string $class
Chris@0:    *   The class to assert.
Chris@0:    * @param string $message
Chris@0:    *   (optional) A verbose message to output.
Chris@0:    */
Chris@0:   protected function assertClass(\SimpleXMLElement $element, $class, $message = NULL) {
Chris@0:     if (!isset($message)) {
Chris@0:       $message = "Class .$class found.";
Chris@0:     }
Chris@0:     $this->assertTrue(strpos($element['class'], $class) !== FALSE, $message);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Asserts that an element does not have a given class.
Chris@0:    *
Chris@0:    * @param \SimpleXMLElement $element
Chris@0:    *   The element to test.
Chris@0:    * @param string $class
Chris@0:    *   The class to assert.
Chris@0:    * @param string $message
Chris@0:    *   (optional) A verbose message to output.
Chris@0:    */
Chris@0:   protected function assertNoClass(\SimpleXMLElement $element, $class, $message = NULL) {
Chris@0:     if (!isset($message)) {
Chris@0:       $message = "Class .$class not found.";
Chris@0:     }
Chris@0:     $this->assertTrue(strpos($element['class'], $class) === FALSE, $message);
Chris@0:   }
Chris@0: 
Chris@0: }