www.aleph1.co.uk Git - yaffs-website/blob - web/core/modules/views_ui/src/Tests/PreviewTest.php

   1 <?php
   2
   3 namespace Drupal\views_ui\Tests;
   4
   5 use Drupal\Component\Serialization\Json;
   6 use Drupal\Core\EventSubscriber\MainContentViewSubscriber;
   7
   8 /**
   9  * Tests the UI preview functionality.
  10  *
  11  * @group views_ui
  12  */
  13 class PreviewTest extends UITestBase {
  14
  15   /**
  16    * Views used by this test.
  17    *
  18    * @var array
  19    */
  20   public static $testViews = ['test_preview', 'test_preview_error', 'test_pager_full', 'test_mini_pager', 'test_click_sort'];
  21
  22   /**
  23    * Tests contextual links in the preview form.
  24    */
  25   public function testPreviewContextual() {
  26     \Drupal::service('module_installer')->install(['contextual']);
  27     $this->resetAll();
  28
  29     $this->drupalGet('admin/structure/views/view/test_preview/edit');
  30     $this->assertResponse(200);
  31     $this->drupalPostForm(NULL, $edit = [], t('Update preview'));
  32
  33     $elements = $this->xpath('//div[@id="views-live-preview"]//ul[contains(@class, :ul-class)]/li[contains(@class, :li-class)]', [':ul-class' => 'contextual-links', ':li-class' => 'filter-add']);
  34     $this->assertEqual(count($elements), 1, 'The contextual link to add a new field is shown.');
  35
  36     $this->drupalPostForm(NULL, $edit = ['view_args' => '100'], t('Update preview'));
  37
  38     // Test that area text and exposed filters are present and rendered.
  39     $this->assertFieldByName('id', NULL, 'ID exposed filter field found.');
  40     $this->assertText('Test header text', 'Rendered header text found');
  41     $this->assertText('Test footer text', 'Rendered footer text found.');
  42     $this->assertText('Test empty text', 'Rendered empty text found.');
  43   }
  44
  45   /**
  46    * Tests arguments in the preview form.
  47    */
  48   public function testPreviewUI() {
  49     $this->drupalGet('admin/structure/views/view/test_preview/edit');
  50     $this->assertResponse(200);
  51
  52     $this->drupalPostForm(NULL, $edit = [], t('Update preview'));
  53
  54     $elements = $this->xpath('//div[@class = "view-content"]/div[contains(@class, views-row)]');
  55     $this->assertEqual(count($elements), 5);
  56
  57     // Filter just the first result.
  58     $this->drupalPostForm(NULL, $edit = ['view_args' => '1'], t('Update preview'));
  59
  60     $elements = $this->xpath('//div[@class = "view-content"]/div[contains(@class, views-row)]');
  61     $this->assertEqual(count($elements), 1);
  62
  63     // Filter for no results.
  64     $this->drupalPostForm(NULL, $edit = ['view_args' => '100'], t('Update preview'));
  65
  66     $elements = $this->xpath('//div[@class = "view-content"]/div[contains(@class, views-row)]');
  67     $this->assertEqual(count($elements), 0);
  68
  69     // Test that area text and exposed filters are present and rendered.
  70     $this->assertFieldByName('id', NULL, 'ID exposed filter field found.');
  71     $this->assertText('Test header text', 'Rendered header text found');
  72     $this->assertText('Test footer text', 'Rendered footer text found.');
  73     $this->assertText('Test empty text', 'Rendered empty text found.');
  74
  75     // Test feed preview.
  76     $view = [];
  77     $view['label'] = $this->randomMachineName(16);
  78     $view['id'] = strtolower($this->randomMachineName(16));
  79     $view['page[create]'] = 1;
  80     $view['page[title]'] = $this->randomMachineName(16);
  81     $view['page[path]'] = $this->randomMachineName(16);
  82     $view['page[feed]'] = 1;
  83     $view['page[feed_properties][path]'] = $this->randomMachineName(16);
  84     $this->drupalPostForm('admin/structure/views/add', $view, t('Save and edit'));
  85     $this->clickLink(t('Feed'));
  86     $this->drupalPostForm(NULL, [], t('Update preview'));
  87     $result = $this->xpath('//div[@id="views-live-preview"]/pre');
  88     $this->assertTrue(strpos($result[0], '<title>' . $view['page[title]'] . '</title>'), 'The Feed RSS preview was rendered.');
  89
  90     // Test the non-default UI display options.
  91     // Statistics only, no query.
  92     $settings = \Drupal::configFactory()->getEditable('views.settings');
  93     $settings->set('ui.show.performance_statistics', TRUE)->save();
  94     $this->drupalGet('admin/structure/views/view/test_preview/edit');
  95     $this->drupalPostForm(NULL, $edit = ['view_args' => '100'], t('Update preview'));
  96     $this->assertText(t('Query build time'));
  97     $this->assertText(t('Query execute time'));
  98     $this->assertText(t('View render time'));
  99     $this->assertNoRaw('<strong>Query</strong>');
 100
 101     // Statistics and query.
 102     $settings->set('ui.show.sql_query.enabled', TRUE)->save();
 103     $this->drupalPostForm(NULL, $edit = ['view_args' => '100'], t('Update preview'));
 104     $this->assertText(t('Query build time'));
 105     $this->assertText(t('Query execute time'));
 106     $this->assertText(t('View render time'));
 107     $this->assertRaw('<strong>Query</strong>');
 108     $query_string = <<<SQL
 109 SELECT views_test_data.name AS views_test_data_name
 110 FROM
 111 {views_test_data} views_test_data
 112 WHERE (views_test_data.id = '100')
 113 SQL;
 114     $this->assertEscaped($query_string);
 115
 116     // Test that the statistics and query are rendered above the preview.
 117     $this->assertTrue(strpos($this->getRawContent(), 'views-query-info') < strpos($this->getRawContent(), 'view-test-preview'), 'Statistics shown above the preview.');
 118
 119     // Test that statistics and query rendered below the preview.
 120     $settings->set('ui.show.sql_query.where', 'below')->save();
 121     $this->drupalPostForm(NULL, $edit = ['view_args' => '100'], t('Update preview'));
 122     $this->assertTrue(strpos($this->getRawContent(), 'view-test-preview') < strpos($this->getRawContent(), 'views-query-info'), 'Statistics shown below the preview.');
 123
 124     // Test that the preview title isn't double escaped.
 125     $this->drupalPostForm("admin/structure/views/nojs/display/test_preview/default/title", $edit = ['title' => 'Double & escaped'], t('Apply'));
 126     $this->drupalPostForm(NULL, [], t('Update preview'));
 127     $elements = $this->xpath('//div[@id="views-live-preview"]/div[contains(@class, views-query-info)]//td[text()=:text]', [':text' => t('Double & escaped')]);
 128     $this->assertEqual(1, count($elements));
 129   }
 130
 131   /**
 132    * Tests the taxonomy term preview AJAX.
 133    *
 134    * This tests a specific regression in the taxonomy term view preview.
 135    *
 136    * @see https://www.drupal.org/node/2452659
 137    */
 138   public function testTaxonomyAJAX() {
 139     \Drupal::service('module_installer')->install(['taxonomy']);
 140     $this->getPreviewAJAX('taxonomy_term', 'page_1', 0);
 141   }
 142
 143   /**
 144    * Tests pagers in the preview form.
 145    */
 146   public function testPreviewWithPagersUI() {
 147
 148     // Create 11 nodes and make sure that everyone is returned.
 149     $this->drupalCreateContentType(['type' => 'page']);
 150     for ($i = 0; $i < 11; $i++) {
 151       $this->drupalCreateNode();
 152     }
 153
 154     // Test Full Pager.
 155     $this->getPreviewAJAX('test_pager_full', 'default', 5);
 156
 157     // Test that the pager is present and rendered.
 158     $elements = $this->xpath('//ul[contains(@class, :class)]/li', [':class' => 'pager__items']);
 159     $this->assertTrue(!empty($elements), 'Full pager found.');
 160
 161     // Verify elements and links to pages.
 162     // We expect to find 5 elements: current page == 1, links to pages 2 and
 163     // and 3, links to 'next >' and 'last >>' pages.
 164     $this->assertClass($elements[0], 'is-active', 'Element for current page has .is-active class.');
 165     $this->assertTrue($elements[0]->a, 'Element for current page has link.');
 166
 167     $this->assertClass($elements[1], 'pager__item', 'Element for page 2 has .pager__item class.');
 168     $this->assertTrue($elements[1]->a, 'Link to page 2 found.');
 169
 170     $this->assertClass($elements[2], 'pager__item', 'Element for page 3 has .pager__item class.');
 171     $this->assertTrue($elements[2]->a, 'Link to page 3 found.');
 172
 173     $this->assertClass($elements[3], 'pager__item--next', 'Element for next page has .pager__item--next class.');
 174     $this->assertTrue($elements[3]->a, 'Link to next page found.');
 175
 176     $this->assertClass($elements[4], 'pager__item--last', 'Element for last page has .pager__item--last class.');
 177     $this->assertTrue($elements[4]->a, 'Link to last page found.');
 178
 179     // Navigate to next page.
 180     $elements = $this->xpath('//li[contains(@class, :class)]/a', [':class' => 'pager__item--next']);
 181     $this->clickPreviewLinkAJAX($elements[0]['href'], 5);
 182
 183     // Test that the pager is present and rendered.
 184     $elements = $this->xpath('//ul[contains(@class, :class)]/li', [':class' => 'pager__items']);
 185     $this->assertTrue(!empty($elements), 'Full pager found.');
 186
 187     // Verify elements and links to pages.
 188     // We expect to find 7 elements: links to '<< first' and '< previous'
 189     // pages, link to page 1, current page == 2, link to page 3 and links
 190     // to 'next >' and 'last >>' pages.
 191     $this->assertClass($elements[0], 'pager__item--first', 'Element for first page has .pager__item--first class.');
 192     $this->assertTrue($elements[0]->a, 'Link to first page found.');
 193
 194     $this->assertClass($elements[1], 'pager__item--previous', 'Element for previous page has .pager__item--previous class.');
 195     $this->assertTrue($elements[1]->a, 'Link to previous page found.');
 196
 197     $this->assertClass($elements[2], 'pager__item', 'Element for page 1 has .pager__item class.');
 198     $this->assertTrue($elements[2]->a, 'Link to page 1 found.');
 199
 200     $this->assertClass($elements[3], 'is-active', 'Element for current page has .is-active class.');
 201     $this->assertTrue($elements[3]->a, 'Element for current page has link.');
 202
 203     $this->assertClass($elements[4], 'pager__item', 'Element for page 3 has .pager__item class.');
 204     $this->assertTrue($elements[4]->a, 'Link to page 3 found.');
 205
 206     $this->assertClass($elements[5], 'pager__item--next', 'Element for next page has .pager__item--next class.');
 207     $this->assertTrue($elements[5]->a, 'Link to next page found.');
 208
 209     $this->assertClass($elements[6], 'pager__item--last', 'Element for last page has .pager__item--last class.');
 210     $this->assertTrue($elements[6]->a, 'Link to last page found.');
 211
 212     // Test Mini Pager.
 213     $this->getPreviewAJAX('test_mini_pager', 'default', 3);
 214
 215     // Test that the pager is present and rendered.
 216     $elements = $this->xpath('//ul[contains(@class, :class)]/li', [':class' => 'pager__items']);
 217     $this->assertTrue(!empty($elements), 'Mini pager found.');
 218
 219     // Verify elements and links to pages.
 220     // We expect to find current pages element with no link, next page element
 221     // with a link, and not to find previous page element.
 222     $this->assertClass($elements[0], 'is-active', 'Element for current page has .is-active class.');
 223
 224     $this->assertClass($elements[1], 'pager__item--next', 'Element for next page has .pager__item--next class.');
 225     $this->assertTrue($elements[1]->a, 'Link to next page found.');
 226
 227     // Navigate to next page.
 228     $elements = $this->xpath('//li[contains(@class, :class)]/a', [':class' => 'pager__item--next']);
 229     $this->clickPreviewLinkAJAX($elements[0]['href'], 3);
 230
 231     // Test that the pager is present and rendered.
 232     $elements = $this->xpath('//ul[contains(@class, :class)]/li', [':class' => 'pager__items']);
 233     $this->assertTrue(!empty($elements), 'Mini pager found.');
 234
 235     // Verify elements and links to pages.
 236     // We expect to find 3 elements: previous page with a link, current
 237     // page with no link, and next page with a link.
 238     $this->assertClass($elements[0], 'pager__item--previous', 'Element for previous page has .pager__item--previous class.');
 239     $this->assertTrue($elements[0]->a, 'Link to previous page found.');
 240
 241     $this->assertClass($elements[1], 'is-active', 'Element for current page has .is-active class.');
 242     $this->assertFalse(isset($elements[1]->a), 'Element for current page has no link.');
 243
 244     $this->assertClass($elements[2], 'pager__item--next', 'Element for next page has .pager__item--next class.');
 245     $this->assertTrue($elements[2]->a, 'Link to next page found.');
 246   }
 247
 248   /**
 249    * Tests the additional information query info area.
 250    */
 251   public function testPreviewAdditionalInfo() {
 252     \Drupal::service('module_installer')->install(['views_ui_test']);
 253     $this->resetAll();
 254
 255     $this->drupalGet('admin/structure/views/view/test_preview/edit');
 256     $this->assertResponse(200);
 257
 258     $this->drupalPostForm(NULL, $edit = [], t('Update preview'));
 259
 260     // Check for implementation of hook_views_preview_info_alter().
 261     // @see views_ui_test.module
 262     $elements = $this->xpath('//div[@id="views-live-preview"]/div[contains(@class, views-query-info)]//td[text()=:text]', [':text' => t('Test row count')]);
 263     $this->assertEqual(count($elements), 1, 'Views Query Preview Info area altered.');
 264     // Check that additional assets are attached.
 265     $this->assertTrue(strpos($this->getDrupalSettings()['ajaxPageState']['libraries'], 'views_ui_test/views_ui_test.test') !== FALSE, 'Attached library found.');
 266     $this->assertRaw('css/views_ui_test.test.css', 'Attached CSS asset found.');
 267   }
 268
 269   /**
 270    * Tests view validation error messages in the preview.
 271    */
 272   public function testPreviewError() {
 273     $this->drupalGet('admin/structure/views/view/test_preview_error/edit');
 274     $this->assertResponse(200);
 275
 276     $this->drupalPostForm(NULL, $edit = [], t('Update preview'));
 277
 278     $this->assertText('Unable to preview due to validation errors.', 'Preview error text found.');
 279   }
 280
 281   /**
 282    * Tests the link to sort in the preview form.
 283    */
 284   public function testPreviewSortLink() {
 285
 286     // Get the preview.
 287     $this->getPreviewAJAX('test_click_sort', 'page_1', 0);
 288
 289     // Test that the header label is present.
 290     $elements = $this->xpath('//th[contains(@class, :class)]/a', [':class' => 'views-field views-field-name']);
 291     $this->assertTrue(!empty($elements), 'The header label is present.');
 292
 293     // Verify link.
 294     $this->assertLinkByHref('preview/page_1?_wrapper_format=drupal_ajax&order=name&sort=desc', 0, 'The output URL is as expected.');
 295
 296     // Click link to sort.
 297     $this->clickPreviewLinkAJAX($elements[0]['href'], 0);
 298
 299     // Test that the header label is present.
 300     $elements = $this->xpath('//th[contains(@class, :class)]/a', [':class' => 'views-field views-field-name is-active']);
 301     $this->assertTrue(!empty($elements), 'The header label is present.');
 302
 303     // Verify link.
 304     $this->assertLinkByHref('preview/page_1?_wrapper_format=drupal_ajax&order=name&sort=asc', 0, 'The output URL is as expected.');
 305   }
 306
 307   /**
 308    * Get the preview form and force an AJAX preview update.
 309    *
 310    * @param string $view_name
 311    *   The view to test.
 312    * @param string $panel_id
 313    *   The view panel to test.
 314    * @param int $row_count
 315    *   The expected number of rows in the preview.
 316    */
 317   protected function getPreviewAJAX($view_name, $panel_id, $row_count) {
 318     $this->drupalGet('admin/structure/views/view/' . $view_name . '/preview/' . $panel_id);
 319     $result = $this->drupalPostAjaxForm(NULL, [], ['op' => t('Update preview')]);
 320     $this->assertPreviewAJAX($result, $row_count);
 321   }
 322
 323   /**
 324    * Mimic clicking on a preview link.
 325    *
 326    * @param string $url
 327    *   The url to navigate to.
 328    * @param int $row_count
 329    *   The expected number of rows in the preview.
 330    */
 331   protected function clickPreviewLinkAJAX($url, $row_count) {
 332     $content = $this->content;
 333     $drupal_settings = $this->drupalSettings;
 334     $ajax_settings = [
 335       'wrapper' => 'views-preview-wrapper',
 336       'method' => 'replaceWith',
 337     ];
 338     $url = $this->getAbsoluteUrl($url);
 339     $post = ['js' => 'true'] + $this->getAjaxPageStatePostData();
 340     $result = Json::decode($this->drupalPost($url, '', $post, ['query' => [MainContentViewSubscriber::WRAPPER_FORMAT => 'drupal_ajax']]));
 341     if (!empty($result)) {
 342       $this->drupalProcessAjaxResponse($content, $result, $ajax_settings, $drupal_settings);
 343     }
 344     $this->assertPreviewAJAX($result, $row_count);
 345   }
 346
 347   /**
 348    * Assert that the AJAX response contains expected data.
 349    *
 350    * @param array $result
 351    *   An array of AJAX commands.
 352    * @param int $row_count
 353    *   The expected number of rows in the preview.
 354    */
 355   protected function assertPreviewAJAX($result, $row_count) {
 356     // Has AJAX callback replied with an insert command? If so, we can
 357     // assume that the page content was updated with AJAX returned data.
 358     $result_commands = [];
 359     foreach ($result as $command) {
 360       $result_commands[$command['command']] = $command;
 361     }
 362     $this->assertTrue(isset($result_commands['insert']), 'AJAX insert command received.');
 363
 364     // Test if preview contains the expected number of rows.
 365     $elements = $this->xpath('//div[@class = "view-content"]/div[contains(@class, views-row)]');
 366     $this->assertEqual(count($elements), $row_count, 'Expected items found on page.');
 367   }
 368
 369   /**
 370    * Asserts that an element has a given class.
 371    *
 372    * @param \SimpleXMLElement $element
 373    *   The element to test.
 374    * @param string $class
 375    *   The class to assert.
 376    * @param string $message
 377    *   (optional) A verbose message to output.
 378    */
 379   protected function assertClass(\SimpleXMLElement $element, $class, $message = NULL) {
 380     if (!isset($message)) {
 381       $message = "Class .$class found.";
 382     }
 383     $this->assertTrue(strpos($element['class'], $class) !== FALSE, $message);
 384   }
 385
 386 }