class StyleTableTest in Drupal 10

Tests the table style views plugin.

@group views

Hierarchy

• class \Drupal\Tests\views\Functional\Plugin\StyleTableTest extends \Drupal\Tests\views\Functional\ViewTestBase

File

core/modules/views/tests/src/Functional/Plugin/StyleTableTest.php, line 15

Namespace

Drupal\Tests\views\Functional\Plugin

class StyleTableTest extends ViewTestBase {

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

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';

  /**
   * {@inheritdoc}
   */
  protected function setUp($import_test_views = TRUE, $modules = [
    'views_test_config',
  ]) : void {
    parent::setUp($import_test_views, $modules);
    $this
      ->enableViewsTestModule();
  }

  /**
   * Tests table caption/summary/description.
   */
  public function testAccessibilitySettings() {
    $this
      ->drupalGet('test-table');
    $result = $this
      ->xpath('//caption/child::text()');
    $this
      ->assertNotEmpty($result, 'The caption appears on the table.');
    $this
      ->assertEquals('caption-text', trim($result[0]
      ->getText()));
    $result = $this
      ->xpath('//summary/child::text()');
    $this
      ->assertNotEmpty($result, 'The summary appears on the table.');
    $this
      ->assertEquals('summary-text', trim($result[0]
      ->getText()));

    // Check that the summary has the right accessibility settings.
    $summary = $this
      ->xpath('//summary')[0];
    $this
      ->assertTrue($summary
      ->hasAttribute('role'));
    $this
      ->assertTrue($summary
      ->hasAttribute('aria-expanded'));
    $result = $this
      ->xpath('//caption/details/child::text()[normalize-space()]');
    $this
      ->assertNotEmpty($result, 'The table description appears on the table.');
    $this
      ->assertEquals('description-text', trim($result[0]
      ->getText()));

    // Remove the caption and ensure the caption is not displayed anymore.
    $view = View::load('test_table');
    $display =& $view
      ->getDisplay('default');
    $display['display_options']['style']['options']['caption'] = '';
    $view
      ->save();
    $this
      ->drupalGet('test-table');
    $result = $this
      ->xpath('//caption/child::text()');
    $this
      ->assertEmpty(trim($result[0]
      ->getText()), 'Ensure that the caption disappears.');

    // Remove the table summary.
    $display =& $view
      ->getDisplay('default');
    $display['display_options']['style']['options']['summary'] = '';
    $view
      ->save();
    $this
      ->drupalGet('test-table');
    $result = $this
      ->xpath('//summary/child::text()');
    $this
      ->assertEmpty($result, 'Ensure that the summary disappears.');

    // Remove the table description.
    $display =& $view
      ->getDisplay('default');
    $display['display_options']['style']['options']['description'] = '';
    $view
      ->save();
    $this
      ->drupalGet('test-table');
    $result = $this
      ->xpath('//caption/details/child::text()[normalize-space()]');
    $this
      ->assertEmpty($result, 'Ensure that the description disappears.');
  }

  /**
   * Tests table fields in columns.
   */
  public function testFieldInColumns() {
    $this
      ->drupalGet('test-table');

    // Ensure that both columns are in separate tds.
    // Check for class " views-field-job ", because just "views-field-job" won't
    // do: "views-field-job-1" would also contain "views-field-job".
    // @see Drupal\system\Tests\Form\ElementTest::testButtonClasses().
    $result = $this
      ->xpath('//tbody/tr/td[contains(concat(" ", @class, " "), " views-field-job ")]');
    $this
      ->assertGreaterThan(0, count($result), 'Ensure there is a td with the class views-field-job');
    $result = $this
      ->xpath('//tbody/tr/td[contains(concat(" ", @class, " "), " views-field-job-1 ")]');
    $this
      ->assertGreaterThan(0, count($result), 'Ensure there is a td with the class views-field-job-1');

    // Combine the second job-column with the first one, with ', ' as separator.
    $view = View::load('test_table');
    $display =& $view
      ->getDisplay('default');
    $display['display_options']['style']['options']['columns']['job_1'] = 'job';
    $display['display_options']['style']['options']['info']['job']['separator'] = ', ';
    $view
      ->save();

    // Ensure that both columns are properly combined.
    $this
      ->drupalGet('test-table');
    $result = $this
      ->xpath('//tbody/tr/td[contains(concat(" ", @class, " "), " views-field-job views-field-job-1 ")]');
    $this
      ->assertGreaterThan(0, count($result), 'Ensure that the job column class names are joined into a single column');
    $result = $this
      ->xpath('//tbody/tr/td[contains(., "Drummer, Drummer")]');
    $this
      ->assertGreaterThan(0, count($result), 'Ensure the job column values are joined into a single column');
  }

  /**
   * Tests that a number with the value of "0" is displayed in the table.
   */
  public function testNumericFieldVisible() {

    // Adds a new data point in the views_test_data table to have a person with
    // an age of zero.
    $data_set = $this
      ->dataSet();
    $query = Database::getConnection()
      ->insert('views_test_data')
      ->fields(array_keys($data_set[0]));
    $query
      ->values([
      'name' => 'James McCartney',
      'age' => 0,
      'job' => 'Baby',
      'created' => gmmktime(6, 30, 10, 1, 1, 2000),
      'status' => 1,
    ]);
    $query
      ->execute();
    $this
      ->drupalGet('test-table');
    $result = $this
      ->xpath('//tbody/tr/td[contains(., "Baby")]');
    $this
      ->assertGreaterThan(0, count($result), 'Ensure that the baby is found.');
    $result = $this
      ->xpath('//tbody/tr/td[text()=0]');
    $this
      ->assertGreaterThan(0, count($result), 'Ensure that the baby\'s age is shown');
  }

  /**
   * Tests that empty columns are hidden when empty_column is set.
   */
  public function testEmptyColumn() {

    // Empty the 'job' data.
    \Drupal::database()
      ->update('views_test_data')
      ->fields([
      'job' => '',
    ])
      ->execute();
    $this
      ->drupalGet('test-table');

    // Test that only one of the job columns still shows.
    // Ensure that empty column header is hidden.
    $this
      ->assertSession()
      ->elementsCount('xpath', '//thead/tr/th/a[text()="Job"]', 1);
    $result = $this
      ->xpath('//tbody/tr/td[contains(concat(" ", @class, " "), " views-field-job-1 ")]');
    $this
      ->assertCount(0, $result, 'Ensure the empty table cells are hidden.');
  }

  /**
   * Tests grouping by a field.
   */
  public function testGrouping() {

    /** @var \Drupal\views\ViewEntityInterface $view */
    $view = \Drupal::entityTypeManager()
      ->getStorage('view')
      ->load('test_table');

    // Get a reference to the display configuration so we can alter some
    // specific style options.
    $display =& $view
      ->getDisplay('default');

    // Set job as the grouping field.
    $display['display_options']['style']['options']['grouping'][0] = [
      'field' => 'job',
      'rendered' => TRUE,
      'rendered_strip' => FALSE,
    ];

    // Clear the caption text, the rendered job field will be used as a caption.
    $display['display_options']['style']['options']['caption'] = '';
    $display['display_options']['style']['options']['summary'] = '';
    $display['display_options']['style']['options']['description'] = '';
    $view
      ->save();

    // Add a record containing unsafe markup to be sure it's filtered out.
    $unsafe_markup = '<script>alert("Rapper");</script>';
    $unsafe_markup_data = [
      'name' => 'Marshall',
      'age' => 42,
      'job' => $unsafe_markup,
      'created' => gmmktime(0, 0, 0, 2, 15, 2001),
      'status' => 1,
    ];
    $database = $this->container
      ->get('database');
    $database
      ->insert('views_test_data')
      ->fields(array_keys($unsafe_markup_data))
      ->values($unsafe_markup_data)
      ->execute();
    $this
      ->drupalGet('test-table');
    $expected_captions = [
      'Job: Speaker',
      'Job: Songwriter',
      'Job: Drummer',
      'Job: Singer',
      'Job: ' . $unsafe_markup,
    ];

    // Ensure that we don't find the caption containing unsafe markup.
    $this
      ->assertSession()
      ->responseNotContains($unsafe_markup);

    // Ensure that the summary isn't shown.
    $this
      ->assertEmpty($this
      ->xpath('//caption/details'));

    // Ensure that all expected captions are found.
    foreach ($expected_captions as $raw_caption) {
      $this
        ->assertSession()
        ->assertEscaped($raw_caption);
    }
    $display =& $view
      ->getDisplay('default');

    // Remove the label from the grouping field.
    $display['display_options']['fields']['job']['label'] = '';
    $view
      ->save();
    $this
      ->drupalGet('test-table');
    $expected_captions = [
      'Speaker',
      'Songwriter',
      'Drummer',
      'Singer',
      $unsafe_markup,
    ];

    // Ensure that we don't find the caption containing unsafe markup.
    $this
      ->assertSession()
      ->responseNotContains($unsafe_markup);

    // Ensure that all expected captions are found.
    foreach ($expected_captions as $raw_caption) {
      $this
        ->assertSession()
        ->assertEscaped($raw_caption);
    }
  }

  /**
   * Tests the cacheability of the table display.
   */
  public function testTableCacheability() {
    \Drupal::service('module_installer')
      ->uninstall([
      'page_cache',
    ]);
    $url = 'test-table';
    $this
      ->drupalGet($url);
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->responseHeaderEquals(DynamicPageCacheSubscriber::HEADER, 'MISS');
    $this
      ->drupalGet($url);
    $this
      ->assertSession()
      ->responseHeaderEquals(DynamicPageCacheSubscriber::HEADER, 'HIT');
  }

}