refactor query enhancement tests (#9208)

Signed-off-by: Justin Kim <[email protected]>
opensearch-project · Jan 17, 2025 · a2f3b15 · a2f3b15
1 parent ed9ef72
commit a2f3b15
Show file tree

Hide file tree

Showing 15 changed files with 412 additions and 612 deletions.
diff --git a/.../core_opensearch_dashboards/opensearch_dashboards/apps/query_enhancements/a_check.spec.js b/.../core_opensearch_dashboards/opensearch_dashboards/apps/query_enhancements/a_check.spec.js
@@ -3,11 +3,11 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { WORKSPACE_NAME, DATASOURCE_NAME } from '../../../../../utils/apps/constants';
+import { DATASOURCE_NAME } from '../../../../../utils/apps/constants';
 import { SECONDARY_ENGINE } from '../../../../../utils/constants';
+import { getRandomizedWorkspaceName } from '../../../../../utils/apps/query_enhancements/shared';
 
-const randomString = Math.random().toString(36).substring(7);
-const workspace = `${WORKSPACE_NAME}-${randomString}`;
+const workspace = getRandomizedWorkspaceName();
 
 describe('No Index Pattern Check Test', () => {
   before(() => {

diff --git a/...nsearch_dashboards/opensearch_dashboards/apps/query_enhancements/dataset_selector.spec.js b/...nsearch_dashboards/opensearch_dashboards/apps/query_enhancements/dataset_selector.spec.js
@@ -3,16 +3,11 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import {
-  WORKSPACE_NAME,
-  DATASOURCE_NAME,
-  START_TIME,
-  END_TIME,
-} from '../../../../../utils/apps/constants';
+import { DATASOURCE_NAME, START_TIME, END_TIME } from '../../../../../utils/apps/constants';
 import { SECONDARY_ENGINE } from '../../../../../utils/constants';
+import { getRandomizedWorkspaceName } from '../../../../../utils/apps/query_enhancements/shared';
 
-const randomString = Math.random().toString(36).substring(7);
-const workspace = `${WORKSPACE_NAME}-${randomString}`;
+const workspace = getRandomizedWorkspaceName();
 
 describe('dataset selector', { scrollBehavior: false }, () => {
   before(() => {

diff --git a/..._dashboards/opensearch_dashboards/apps/query_enhancements/field_display_filtering.spec.js b/..._dashboards/opensearch_dashboards/apps/query_enhancements/field_display_filtering.spec.js
diff --git a/.../core_opensearch_dashboards/opensearch_dashboards/apps/query_enhancements/queries.spec.js b/.../core_opensearch_dashboards/opensearch_dashboards/apps/query_enhancements/queries.spec.js
@@ -3,16 +3,11 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import {
-  WORKSPACE_NAME,
-  DATASOURCE_NAME,
-  START_TIME,
-  END_TIME,
-} from '../../../../../utils/apps/constants';
+import { DATASOURCE_NAME, START_TIME, END_TIME } from '../../../../../utils/apps/constants';
 import { SECONDARY_ENGINE } from '../../../../../utils/constants';
+import { getRandomizedWorkspaceName } from '../../../../../utils/apps/query_enhancements/shared';
 
-const randomString = Math.random().toString(36).substring(7);
-const workspace = `${WORKSPACE_NAME}-${randomString}`;
+const workspace = getRandomizedWorkspaceName();
 
 describe('query enhancement queries', { scrollBehavior: false }, () => {
   before(() => {

diff --git a/...re_opensearch_dashboards/opensearch_dashboards/apps/query_enhancements/s3_dataset.spec.js b/...re_opensearch_dashboards/opensearch_dashboards/apps/query_enhancements/s3_dataset.spec.js
@@ -8,7 +8,9 @@ import {
   DSM_API,
   S3_CLUSTER,
 } from '../../../../../utils/apps/query_enhancements/constants';
-import { WORKSPACE_NAME } from '../../../../../utils/apps/constants';
+import { getRandomizedWorkspaceName } from '../../../../../utils/apps/query_enhancements/shared';
+
+const workspace = getRandomizedWorkspaceName();
 
 let dataSourceId = '';
 const definedS3Variables = !S3_CLUSTER.url;
@@ -83,12 +85,12 @@ const definedS3Variables = !S3_CLUSTER.url;
     describe('Run S3 Query', () => {
       beforeEach(() => {
         // Create workspace
-        cy.deleteWorkspaceByName(WORKSPACE_NAME);
+        cy.deleteWorkspaceByName(workspace);
         cy.visit('/app/home');
-        cy.createInitialWorkspaceWithDataSource(S3_CLUSTER.name, WORKSPACE_NAME);
+        cy.createInitialWorkspaceWithDataSource(S3_CLUSTER.name, workspace);
       });
       afterEach(() => {
-        cy.deleteWorkspaceByName(WORKSPACE_NAME);
+        cy.deleteWorkspaceByName(workspace);
       });
 
       it('with SQL', function () {

diff --git a/...rch_dashboards/opensearch_dashboards/apps/query_enhancements/saved_queries_flyout.spec.js b/...rch_dashboards/opensearch_dashboards/apps/query_enhancements/saved_queries_flyout.spec.js
@@ -9,22 +9,25 @@ import {
   INDEX_WITH_TIME_2,
   SECONDARY_ENGINE,
 } from '../../../../../utils/constants';
-
 import {
-  workspaceName,
-  datasourceName,
-  setSearchConfigurations,
+  getRandomizedWorkspaceName,
+  getRandomizedDatasourceName,
   setDatePickerDatesAndSearchIfRelevant,
+  generateAllTestConfigurations,
+} from '../../../../../utils/apps/query_enhancements/shared';
+import {
+  generateSavedTestConfiguration,
+  setSearchConfigurations,
   verifyDiscoverPageState,
-} from '../../../../../utils/apps/query_enhancements/saved_search';
+} from '../../../../../utils/apps/query_enhancements/saved';
 
-import { generateAllTestConfigurations } from '../../../../../utils/apps/query_enhancements/saved_queries';
+const workspaceName = getRandomizedWorkspaceName();
+const datasourceName = getRandomizedDatasourceName();
 
 // This spec assumes data.savedQueriesNewUI.enabled is true.
-
 export const runSavedQueriesFlyoutUITests = () => {
   describe('saved queries flyout UI', () => {
-    before(() => {
+    beforeEach(() => {
       // Load test data
       cy.setupTestData(
         SECONDARY_ENGINE.url,
@@ -57,7 +60,7 @@ export const runSavedQueriesFlyoutUITests = () => {
       });
     });
 
-    after(() => {
+    afterEach(() => {
       // No need to explicitly delete all saved queries as deleting the workspace will delete associated saved queries
       cy.deleteWorkspaceByName(workspaceName);
       // // TODO: Modify deleteIndex to handle an array of index and remove hard code
@@ -66,8 +69,7 @@ export const runSavedQueriesFlyoutUITests = () => {
       cy.deleteIndex(INDEX_WITH_TIME_2);
     });
 
-    const testConfigurations = generateAllTestConfigurations();
-    testConfigurations.forEach((config) => {
+    generateAllTestConfigurations(generateSavedTestConfiguration).forEach((config) => {
       it(`should successfully create a saved query for ${config.testName}`, () => {
         cy.navigateToWorkSpaceSpecificPage({
           workspaceName,
@@ -83,15 +85,10 @@ export const runSavedQueriesFlyoutUITests = () => {
         setSearchConfigurations(config);
         verifyDiscoverPageState(config);
         cy.saveQuery(config.saveName);
-      });
-    });
-
-    it('should see all saved queries', () => {
-      cy.getElementByTestId('saved-query-management-popover-button').click();
-
-      cy.getElementByTestId('saved-query-management-open-button').click();
 
-      testConfigurations.forEach((config) => {
+        // verify that it has been saved
+        cy.getElementByTestId('saved-query-management-popover-button').click();
+        cy.getElementByTestId('saved-query-management-open-button').click();
         cy.getElementByTestId('euiFlyoutCloseButton')
           .parent()
           .contains(config.saveName)

diff --git a/...ch_dashboards/opensearch_dashboards/apps/query_enhancements/saved_queries_popover.spec.js b/...ch_dashboards/opensearch_dashboards/apps/query_enhancements/saved_queries_popover.spec.js
@@ -9,23 +9,26 @@ import {
   INDEX_WITH_TIME_2,
   SECONDARY_ENGINE,
 } from '../../../../../utils/constants';
-
 import {
-  workspaceName,
-  datasourceName,
-  setSearchConfigurations,
+  getRandomizedWorkspaceName,
+  getRandomizedDatasourceName,
   setDatePickerDatesAndSearchIfRelevant,
+  generateAllTestConfigurations,
+} from '../../../../../utils/apps/query_enhancements/shared';
+import {
+  generateSavedTestConfiguration,
+  setSearchConfigurations,
   verifyDiscoverPageState,
-} from '../../../../../utils/apps/query_enhancements/saved_search';
+} from '../../../../../utils/apps/query_enhancements/saved';
 
-import { generateAllTestConfigurations } from '../../../../../utils/apps/query_enhancements/saved_queries';
+const workspaceName = getRandomizedWorkspaceName();
+const datasourceName = getRandomizedDatasourceName();
 
 // This spec assumes data.savedQueriesNewUI.enabled is false.
 // These tests will not be run until the older legacy tests are migrated https://github.com/opensearch-project/OpenSearch-Dashboards/pull/9166#discussion_r1913687440
-
 export const runSavedQueriesPopoverUITests = () => {
   describe.skip('saved queries popover UI', () => {
-    before(() => {
+    beforeEach(() => {
       // Load test data
       cy.setupTestData(
         SECONDARY_ENGINE.url,
@@ -58,7 +61,7 @@ export const runSavedQueriesPopoverUITests = () => {
       });
     });
 
-    after(() => {
+    afterEach(() => {
       // No need to explicitly delete all saved queries as deleting the workspace will delete associated saved queries
       cy.deleteWorkspaceByName(workspaceName);
       // // TODO: Modify deleteIndex to handle an array of index and remove hard code
@@ -67,8 +70,7 @@ export const runSavedQueriesPopoverUITests = () => {
       cy.deleteIndex(INDEX_WITH_TIME_2);
     });
 
-    const testConfigurations = generateAllTestConfigurations();
-    testConfigurations.forEach((config) => {
+    generateAllTestConfigurations(generateSavedTestConfiguration).forEach((config) => {
       it(`should successfully create a saved query for ${config.testName}`, () => {
         cy.navigateToWorkSpaceSpecificPage({
           workspaceName,
@@ -83,14 +85,10 @@ export const runSavedQueriesPopoverUITests = () => {
 
         setSearchConfigurations(config);
         verifyDiscoverPageState(config);
-        cy.saveQuery(config.saveName, ' ', false);
-      });
-    });
-
-    it('should see all saved queries', () => {
-      cy.getElementByTestId('saved-query-management-popover-button').click();
+        cy.saveQuery(config.saveName);
 
-      testConfigurations.forEach((config) => {
+        // verify that it has been saved
+        cy.getElementByTestId('saved-query-management-popover-button').click();
         cy.getElementByTestId('saved-query-management-popover')
           .contains(config.saveName)
           .should('exist');

diff --git a/..._opensearch_dashboards/opensearch_dashboards/apps/query_enhancements/saved_search.spec.js b/..._opensearch_dashboards/opensearch_dashboards/apps/query_enhancements/saved_search.spec.js
@@ -11,16 +11,22 @@ import {
   SECONDARY_ENGINE,
 } from '../../../../../utils/constants';
 import {
-  workspaceName,
-  datasourceName,
   generateAllTestConfigurations,
+  getRandomizedWorkspaceName,
+  getRandomizedDatasourceName,
   setDatePickerDatesAndSearchIfRelevant,
+} from '../../../../../utils/apps/query_enhancements/shared';
+import {
   setSearchConfigurations,
   verifyDiscoverPageState,
   verifySavedSearchInAssetsPage,
   postRequestSaveSearch,
   updateSavedSearchAndSaveAndVerify,
-} from '../../../../../utils/apps/query_enhancements/saved_search';
+  generateSavedTestConfiguration,
+} from '../../../../../utils/apps/query_enhancements/saved';
+
+const workspaceName = getRandomizedWorkspaceName();
+const datasourceName = getRandomizedDatasourceName();
 
 export const runSavedSearchTests = () => {
   describe('saved search', () => {
@@ -65,7 +71,7 @@ export const runSavedSearchTests = () => {
       cy.deleteIndex(INDEX_WITH_TIME_2);
     });
 
-    generateAllTestConfigurations().forEach((config) => {
+    generateAllTestConfigurations(generateSavedTestConfiguration).forEach((config) => {
       it(`should successfully create a saved search for ${config.testName}`, () => {
         cy.navigateToWorkSpaceSpecificPage({
           workspaceName,
@@ -86,7 +92,7 @@ export const runSavedSearchTests = () => {
         // the saved search does not appear. So adding this wait
         cy.wait(2000);
 
-        verifySavedSearchInAssetsPage(config);
+        verifySavedSearchInAssetsPage(config, workspaceName);
       });
 
       // We are starting from various languages
@@ -126,13 +132,13 @@ export const runSavedSearchTests = () => {
       it(`should successfully update a saved search for ${config.testName}`, () => {
         // using a POST request to create a saved search to load
         postRequestSaveSearch(config);
-        updateSavedSearchAndSaveAndVerify(config, false);
+        updateSavedSearchAndSaveAndVerify(config, workspaceName, datasourceName, false);
       });
 
       it(`should successfully save a saved search as a new saved search for ${config.testName}`, () => {
         // using a POST request to create a saved search to load
         postRequestSaveSearch(config);
-        updateSavedSearchAndSaveAndVerify(config, true);
+        updateSavedSearchAndSaveAndVerify(config, workspaceName, datasourceName, true);
       });
     });
   });

diff --git a/cypress/utils/apps/data_explorer/commands.js b/cypress/utils/apps/data_explorer/commands.js
@@ -113,8 +113,7 @@ Cypress.Commands.add(
   }
 );
 
-// eslint-disable-next-line no-unused-vars
-Cypress.Commands.add('saveQuery', (name, description = ' ', savedQueriesNewUIEnabled = true) => {
+Cypress.Commands.add('saveQuery', (name, description = ' ') => {
   cy.whenTestIdNotFound('saved-query-management-popover', () => {
     cy.getElementByTestId('saved-query-management-popover-button').click();
   });
@@ -123,7 +122,8 @@ Cypress.Commands.add('saveQuery', (name, description = ' ', savedQueriesNewUIEna
   cy.getElementByTestId('saveQueryFormTitle').type(name);
   cy.getElementByTestId('saveQueryFormDescription').type(description);
 
-  cy.getElementByTestId('savedQueryFormSaveButton').click();
+  // putting force: true as this button is sometimes masked by a popup element
+  cy.getElementByTestId('savedQueryFormSaveButton').click({ force: true });
   cy.getElementByTestId('euiToastHeader').contains('was saved').should('be.visible');
 });
 

diff --git a/cypress/utils/apps/data_explorer/index.d.ts b/cypress/utils/apps/data_explorer/index.d.ts
@@ -19,7 +19,7 @@ declare namespace Cypress {
       value: string,
       isEnhancement?: boolean
     ): Chainable<any>;
-    saveQuery(name: string, description: string): Chainable<any>;
+    saveQuery(name: string, description?: string): Chainable<any>;
     loadSaveQuery(name: string): Chainable<any>;
     clearSaveQuery(): Chainable<any>;
     deleteSaveQuery(name: string): Chainable<any>;

diff --git a/cypress/utils/apps/query_enhancements/constants.js b/cypress/utils/apps/query_enhancements/constants.js
@@ -7,32 +7,6 @@ export const DATASOURCE_NAME = 'data-logs-1';
 export const WORKSPACE_NAME = 'query-ws';
 export const START_TIME = 'Jan 1, 2020 @ 00:00:00.000';
 export const END_TIME = 'Jan 1, 2024 @ 00:00:00.000';
-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 DATASET_CONFIGS = {
-  index_pattern: {
-    type: 'index_pattern',
-    name: INDEX_PATTERN_NAME,
-    languages: [
-      // isFilterButtonsEnabled signifies if the filter buttons are supposed to be enabled.
-      { name: 'DQL', isFilterButtonsEnabled: true },
-      { name: 'Lucene', isFilterButtonsEnabled: true },
-      { name: 'OpenSearch SQL', isFilterButtonsEnabled: false },
-      { name: 'PPL', isFilterButtonsEnabled: false },
-    ],
-  },
-  index: {
-    type: 'index',
-    name: INDEX_NAME,
-    languages: [
-      { name: 'OpenSearch SQL', isFilterButtonsEnabled: false },
-      { name: 'PPL', isFilterButtonsEnabled: false },
-    ],
-  },
-};
 
 export const clusterName = 'test_cluster';
 export const clusterConnection = 'http://localhost:9200';