FilterCriteriaTest.php in Drupal 10

Namespace

Drupal\Tests\views_ui\FunctionalJavascript

File

core/modules/views_ui/tests/src/FunctionalJavascript/FilterCriteriaTest.php

<?php

namespace Drupal\Tests\views_ui\FunctionalJavascript;

use Drupal\FunctionalJavascriptTests\WebDriverTestBase;

/**
 * Tests the View UI filter criteria group dialog.
 *
 * @group views_ui
 */
class FilterCriteriaTest extends WebDriverTestBase {

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'node',
    'views',
    'views_ui',
  ];

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

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $admin_user = $this
      ->drupalCreateUser([
      'administer site configuration',
      'administer views',
      'administer nodes',
      'access content overview',
    ]);

    // Disable automatic live preview to make the sequence of calls clearer.
    \Drupal::configFactory()
      ->getEditable('views.settings')
      ->set('ui.always_live_preview', FALSE)
      ->save();
    $this
      ->drupalLogin($admin_user);
  }

  /**
   * Tests dialog for filter criteria.
   */
  public function testFilterCriteriaDialog() {

    // Checks that the admin summary is not double escaped.
    $this
      ->drupalGet('admin/structure/views/view/who_s_online');
    $page = $this
      ->getSession()
      ->getPage();
    $this
      ->assertNotNull($page
      ->findLink('User: Last access (>= -15 minutes)'));
    $this
      ->drupalGet('admin/structure/views/view/content_recent');
    $assert_session = $this
      ->assertSession();
    $session = $this
      ->getSession();
    $page = $session
      ->getPage();
    $this
      ->openFilterDialog();

    // Add a new filter group.
    $create_new_filter_group = $page
      ->findById('views-add-group-link');
    $this
      ->assertTrue($create_new_filter_group
      ->isVisible(), 'Add group link found.');
    $create_new_filter_group
      ->click();
    $assert_session
      ->assertWaitOnAjaxRequest();

    // Assert the existence of the new filter group by checking the remove group
    // link.
    $remove_link = $page
      ->findLink('Remove group');
    $this
      ->assertTrue($remove_link
      ->isVisible(), 'New group found.');

    // Remove the group again and assert the group is not present anymore.
    $remove_link
      ->click();
    $assert_session
      ->assertWaitOnAjaxRequest();
    $remove_link = $page
      ->findLink('Remove group');
    $this
      ->assertEmpty($remove_link, 'Remove button not available');

    // Add group again to test drag-n-drop.
    $create_new_filter_group = $page
      ->findById('views-add-group-link');
    $this
      ->assertTrue($create_new_filter_group
      ->isVisible(), 'Add group link found.');
    $create_new_filter_group
      ->click();
    $assert_session
      ->assertWaitOnAjaxRequest();

    // Validate dragging behaviors.
    // First get relevant elements and the current values.
    $status_extra_row = $page
      ->findById("views-row-status_extra");
    $langcode_row = $page
      ->findById("views-row-langcode");
    $status_extra_group_field = $status_extra_row
      ->findField('filters[status_extra][group]');
    $langcode_group_field = $langcode_row
      ->findField('filters[langcode][group]');
    $status_extra_original_value = $status_extra_group_field
      ->getValue();
    $langcode_original_value = $langcode_group_field
      ->getValue();

    // Validate dragging the first filter works correctly but checking the
    // remove group link is not visible anymore.
    $drag_handle = $status_extra_row
      ->find('css', '.tabledrag-handle');
    $target = $page
      ->find('css', '.filter-group-operator-row');
    $drag_handle
      ->dragTo($target);

    // Assert dragging a filter works.
    $remove_link = $page
      ->findLink('Remove group');
    $this
      ->assertFalse($remove_link
      ->isVisible(), 'Remove group should be invisible after drag.');

    // Drag another filter to the end of the last filter group to verify the
    // group is set correctly.
    $drag_handle = $langcode_row
      ->find('css', '.tabledrag-handle');
    $drag_handle
      ->dragTo($status_extra_row);

    // Both rows must be in the same group.
    $this
      ->assertNotEquals($status_extra_original_value, $status_extra_group_field
      ->getValue(), 'Status extra group should be changed');
    $this
      ->assertNotEquals($langcode_original_value, $langcode_group_field
      ->getValue(), 'Langcode group should be changed');
    $this
      ->assertSession()
      ->waitForLink('Create new filter group', 20000);
    $create_new_filter_group = $page
      ->findLink('Create new filter group');
    $this
      ->assertTrue($create_new_filter_group
      ->isVisible(), 'Add group link found.');
    $create_new_filter_group
      ->click();
    $assert_session
      ->assertWaitOnAjaxRequest();

    // Validate dragging works correctly and the new group will contain the new
    // filter.
    $dragged = $page
      ->find('css', ".tabledrag-handle");
    $target = $page
      ->find('css', '.filter-group-operator-row');
    $dragged
      ->dragTo($target);
    $remove_link = $page
      ->findLink('Remove group');
    $this
      ->assertFalse($remove_link
      ->isVisible(), 'Remove group should be invisible after drag.');
  }

  /**
   * Tests operator labels.
   */
  public function testOperatorLabels() {

    // Open the "Frontpage" view.
    $this
      ->drupalGet('admin/structure/views/view/frontpage');
    $session = $this
      ->getSession();
    $page = $session
      ->getPage();

    // Open the "Rearrange filter criteria" dialog.
    $this
      ->openFilterDialog();

    // Get the last filter on the list.
    $row = $page
      ->findAll('css', '.draggable');
    $row_count = count($row);
    $last_row = array_pop($row);
    $penultimate_row = array_pop($row);

    // Drag the last row before the penultimate row.
    $drag_handle = $last_row
      ->find('css', '.tabledrag-handle');
    $drag_handle
      ->dragTo($penultimate_row);

    // Assert there are valid number of visible operator labels.
    $operator_label = $page
      ->findAll('css', '.views-operator-label');
    $this
      ->assertEquals($row_count - 1, count($operator_label), 'There are valid number of operator labels after drag.');

    // Get the last filter on the rearranged list.
    $row = $page
      ->findAll('css', '.draggable');
    $last_row = array_pop($row);
    $penultimate_row = array_pop($row);

    // Assert the operator label in the penultimate row is shown.
    $operator_label = $penultimate_row
      ->find('css', '.views-operator-label');
    $this
      ->assertTrue($operator_label
      ->isVisible(), 'Operator label in the penultimate row is not visible after drag.');

    // Assert the operator label in the last row is not shown.
    $operator_label = $last_row
      ->find('css', '.views-operator-label');
    $this
      ->assertNull($operator_label, 'Operator label in the last row is not visible after drag.');

    // Remove the last filter.
    $remove_link = $last_row
      ->find('css', '.views-remove-link');
    $remove_link
      ->click();

    // The current last filter shouldn't have the operator label.
    $operator_label = $penultimate_row
      ->find('css', '.views-operator-label');
    $this
      ->assertNull($operator_label, 'The penultimate filter has no operator label after the last filter is removed.');
  }

  /**
   * Uses the 'And/Or Rearrange' link for filters to open a dialog.
   */
  protected function openFilterDialog() {
    $assert_session = $this
      ->assertSession();
    $page = $this
      ->getSession()
      ->getPage();
    $dropbutton = $page
      ->find('css', '.views-ui-display-tab-bucket.filter .dropbutton-toggle button');
    $dropbutton
      ->click();
    $add_link = $page
      ->findById('views-rearrange-filter');
    $this
      ->assertTrue($add_link
      ->isVisible(), 'And/Or Rearrange button found.');
    $add_link
      ->click();
    $assert_session
      ->assertWaitOnAjaxRequest();
  }

}

Classes

Name	Description
FilterCriteriaTest	Tests the View UI filter criteria group dialog.