[Discover 2.0 Testing] TestId-69: Filtering

changelogs/fragments/9047.yml

@@ -0,0 +1,2 @@
+test:
+- Add cypress integration test for the new Data Explorer UI's Filtering. ([#9047](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/9047))

cypress.config.ts

@@ -35,6 +35,7 @@ module.exports = defineConfig({
   },
   e2e: {
     baseUrl: 'http://localhost:5601',
+    supportFile: 'cypress/support/e2e.{js,jsx,ts,tsx}',
     specPattern: 'cypress/integration/**/*.spec.{js,jsx,ts,tsx}',
     testIsolation: false,
     setupNodeEvents,

cypress/integration/core-opensearch-dashboards/opensearch-dashboards/apps/query_enhancements/constants.js

@@ -3,5 +3,31 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-export const DATASOURCE_NAME = 'query-cluster';
-export const WORKSPACE_NAME = 'query-workspace';
+export const DATASOURCE_NAME = 'data-logs-1';
+export const INDEX_NAME = 'data_logs_small_time_1';
+export const DEFAULT_TIME_INDEX_PATTERN_NAME = 'data_logs_small_time_1*';
+export const DEFAULT_NO_TIME_INDEX_PATTERN_NAME = 'data_logs_small_no_time_1*';
+export const INDEX_PATTERN_NAME = `${DATASOURCE_NAME}::${DEFAULT_TIME_INDEX_PATTERN_NAME}`;
+export const SEARCH_ABSOLUTE_START_DATE = 'Jan 1, 2020 @ 00:00:00.000';
+export const SEARCH_ABSOLUTE_END_DATE = 'Jan 1, 2024 @ 00:00:00.000';
+
+export const DATASET_CONFIGS = {
+  index_pattern: {
+    type: 'index_pattern',
+    name: INDEX_PATTERN_NAME,
+    languages: [
+      { name: 'DQL', isEnabled: true },
+      { name: 'Lucene', isEnabled: true },
+      { name: 'OpenSearch SQL', isEnabled: false },
+      { name: 'PPL', isEnabled: false },
+    ],
+  },
+  index: {
+    type: 'index',
+    name: INDEX_NAME,
+    languages: [
+      { name: 'OpenSearch SQL', isEnabled: false },
+      { name: 'PPL', isEnabled: false },
+    ],
+  },
+};

cypress/integration/core-opensearch-dashboards/opensearch-dashboards/apps/query_enhancements/field_display_filtering.spec.js

@@ -0,0 +1,112 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { MiscUtils } from '@opensearch-dashboards-test/opensearch-dashboards-test-library';
+import {
+  DATASOURCE_NAME,
+  DATASET_CONFIGS,
+  INDEX_NAME,
+  INDEX_PATTERN_NAME,
+  SEARCH_ABSOLUTE_START_DATE,
+  SEARCH_ABSOLUTE_END_DATE,
+} from './constants.js';
+import * as dataExplorer from './helpers.js';
+
+const miscUtils = new MiscUtils(cy);
+
+function selectDataset(datasetType, language) {
+  switch (datasetType) {
+    case 'index':
+      dataExplorer.selectIndexDataset(DATASOURCE_NAME, INDEX_NAME, language);
+      break;
+    case 'index_pattern':
+      dataExplorer.selectIndexPatternDataset(INDEX_PATTERN_NAME, language);
+      break;
+  }
+}
+
+function setDateRange(datasetType, language) {
+  switch (datasetType) {
+    case 'index_pattern':
+      if (language !== 'OpenSearch SQL') {
+        cy.setSearchAbsoluteDateRange(SEARCH_ABSOLUTE_START_DATE, SEARCH_ABSOLUTE_END_DATE);
+      }
+      break;
+  }
+}
+
+function verifyTableFieldFilterActions(datasetType, language, shouldExist) {
+  selectDataset(datasetType, language);
+  setDateRange(datasetType, language);
+
+  cy.getElementByTestId('discoverQueryHits').should('not.exist'); // To ensure it waits until a full table is loaded into the DOM, instead of a bug where table only has 1 hit.
+
+  dataExplorer.verifyDocTableRowFilterForAndOutButton(0, shouldExist);
+
+  if (shouldExist) {
+    dataExplorer.verifyDocTableFilterAction(0, 'filterForValue', '10,000', '1', true);
+    dataExplorer.verifyDocTableFilterAction(0, 'filterOutValue', '10,000', '9,999', false);
+  }
+}
+
+function verifyExpandedTableFilterActions(datasetType, language, isEnabled) {
+  selectDataset(datasetType, language);
+  setDateRange(datasetType, language);
+
+  cy.getElementByTestId('discoverQueryHits').should('not.exist'); // To ensure it waits until a full table is loaded into the DOM, instead of a bug where table only has 1 hit.
+  dataExplorer.toggleDocTableRow(0);
+  dataExplorer.verifyDocTableFirstExpandedFieldFirstRowFilterForFilterOutExistsFilterButtons(
+    isEnabled
+  );
+  dataExplorer.verifyDocTableFirstExpandedFieldFirstRowToggleColumnButtonHasIntendedBehavior();
+
+  if (isEnabled) {
+    dataExplorer.verifyDocTableFirstExpandedFieldFirstRowFilterForButtonFiltersCorrectField(
+      0,
+      0,
+      '10,000',
+      '1'
+    );
+    dataExplorer.verifyDocTableFirstExpandedFieldFirstRowFilterOutButtonFiltersCorrectField(
+      0,
+      0,
+      '10,000',
+      '9,999'
+    );
+    dataExplorer.verifyDocTableFirstExpandedFieldFirstRowExistsFilterButtonFiltersCorrectField(
+      0,
+      0,
+      '10,000',
+      '10,000'
+    );
+  }
+}
+
+describe('filter for value spec', () => {
+  beforeEach(() => {
+    cy.localLogin(Cypress.env('username'), Cypress.env('password'));
+    miscUtils.visitPage('app/data-explorer/discover');
+    cy.getNewSearchButton().click();
+  });
+
+  const testCases = [
+    { name: 'table field', verifyFn: verifyTableFieldFilterActions },
+    { name: 'expanded table', verifyFn: verifyExpandedTableFilterActions },
+  ];
+
+  testCases.forEach(({ name, verifyFn }) => {
+    describe(`filter actions in ${name}`, () => {
+      Object.entries(DATASET_CONFIGS).forEach(([type, config]) => {
+        describe(`${type} dataset`, () => {
+          config.languages.forEach(({ name: language, isEnabled }) => {
+            it(`${language}`, () => {
+              verifyFn(type, language, isEnabled);
+            });
+          });
+        });
+      });
+    });
+  });
+});