Create cypress command namespacing util (#9150)

Author: d-buckner

changelogs/fragments/9150.yml

@@ -0,0 +1,2 @@
+chore:
+- Create cypress command namespacing util ([#9150](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/9150))

cypress/integration/core_opensearch_dashboards/opensearch_dashboards/apps/query_enhancements/a_check.spec.js

@@ -31,9 +31,9 @@ describe('No Index Pattern Check Test', () => {
       authType: 'no_auth',
     });
     // Create workspace
-    cy.deleteWorkspaceByName(`${workspace}`);
+    cy.deleteWorkspaceByName(workspace);
     cy.visit('/app/home');
-    cy.createInitialWorkspaceWithDataSource(`${DATASOURCE_NAME}`, `${workspace}`);
+    cy.osd.createInitialWorkspaceWithDataSource(DATASOURCE_NAME, workspace);
     cy.wait(2000);
   });
 

cypress/integration/core_opensearch_dashboards/opensearch_dashboards/apps/query_enhancements/dataset_selector.spec.js

@@ -30,9 +30,9 @@ describe('dataset selector', { scrollBehavior: false }, () => {
   });
   beforeEach(() => {
     // Create workspace
-    cy.deleteWorkspaceByName(`${workspace}`);
+    cy.deleteWorkspaceByName(workspace);
     cy.visit('/app/home');
-    cy.createInitialWorkspaceWithDataSource(`${DATASOURCE_NAME}`, `${workspace}`);
+    cy.osd.createInitialWorkspaceWithDataSource(DATASOURCE_NAME, workspace);
     cy.navigateToWorkSpaceSpecificPage({
       workspaceName: workspace,
       page: 'discover',

cypress/integration/core_opensearch_dashboards/opensearch_dashboards/apps/query_enhancements/field_display_filtering.spec.js

@@ -38,7 +38,7 @@ describe('filter for value spec', () => {
     // Create workspace
     cy.deleteWorkspaceByName(workspace);
     cy.visit('/app/home');
-    cy.createInitialWorkspaceWithDataSource(DATASOURCE_NAME, workspace);
+    cy.osd.createInitialWorkspaceWithDataSource(DATASOURCE_NAME, workspace);
     cy.wait(2000);
     cy.createWorkspaceIndexPatterns({
       workspaceName: workspace,

cypress/integration/core_opensearch_dashboards/opensearch_dashboards/apps/query_enhancements/queries.spec.js

@@ -26,9 +26,9 @@ describe('query enhancement queries', { scrollBehavior: false }, () => {
     });
 
     // Create workspace and set up index pattern
-    cy.deleteWorkspaceByName(`${workspace}`);
+    cy.deleteWorkspaceByName(workspace);
     cy.visit('/app/home');
-    cy.createInitialWorkspaceWithDataSource(`${DATASOURCE_NAME}`, `${workspace}`);
+    cy.osd.createInitialWorkspaceWithDataSource(DATASOURCE_NAME, workspace);
 
     // Create and select index pattern for data_logs_small_time_1*
     cy.createWorkspaceIndexPatterns({

cypress/integration/core_opensearch_dashboards/opensearch_dashboards/apps/query_enhancements/s3_dataset.spec.js

@@ -87,7 +87,7 @@ const definedS3Variables = !S3_CLUSTER.url;
         // Create workspace
         cy.deleteWorkspaceByName(workspace);
         cy.visit('/app/home');
-        cy.createInitialWorkspaceWithDataSource(S3_CLUSTER.name, workspace);
+        cy.osd.createInitialWorkspaceWithDataSource(S3_CLUSTER.name, WORKSPACE_NAME);
       });
       afterEach(() => {
         cy.deleteWorkspaceByName(workspace);

cypress/integration/core_opensearch_dashboards/opensearch_dashboards/apps/query_enhancements/saved_search.spec.js

@@ -53,7 +53,7 @@ export const runSavedSearchTests = () => {
       // Create workspace
       cy.deleteWorkspaceByName(workspaceName);
       cy.visit('/app/home');
-      cy.createInitialWorkspaceWithDataSource(datasourceName, workspaceName);
+      cy.osd.createInitialWorkspaceWithDataSource(datasourceName, workspaceName);
       cy.createWorkspaceIndexPatterns({
         workspaceName: workspaceName,
         indexPattern: INDEX_PATTERN_WITH_TIME.replace('*', ''),

cypress/integration/dashboard_sanity_test.spec.js cypress/integration/dashboard_sanity_test.spec.ts

@@ -9,7 +9,7 @@ Cypress.Commands.add(
   (workspaceName) => {
     // Selecting the correct workspace
     cy.visit('/app/workspace_list#');
-    cy.openWorkspaceDashboard(workspaceName);
+    cy.osd.openWorkspaceDashboard(workspaceName);
     // wait until page loads
     cy.getElementByTestId('headerAppActionMenu').should('be.visible');
   }

cypress/utils/apps/workspace/commands.js

@@ -0,0 +1,43 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * Initializes a command namespace on the cy object
+ *
+ * Ex usage:
+ *   initCommandNamespace(cy, 'osd'); // initializes osd namespace (only needed once per ns)
+ *   cy.osd.add('myNewCommand', (myArg) => ...); // register command to namespace
+ *   cy.osd.myNewCommand('someArg'); // executes command
+ *
+ */
+export default function initCommandNamespace(cy, namespace) {
+  /**
+   * this proxy is responsible for intercepting access to properties
+   * it's what allows us to dynamically define properties at runtime like cy.osd.myNewCommand
+   */
+  cy[namespace] = new Proxy(
+    {
+      // register a new namespaced command with cypress (ex. osd:myNewCommand)
+      add(commandName, callback) {
+        Cypress.Commands.add(namespaceCommand(commandName), callback);
+      },
+    },
+    {
+      get(target, property) {
+        if (target[property]) {
+          // return reserved property (add method)
+          return target[property];
+        }
+
+        // return the mapped namespace command (ex. myNewCommand returns the osd:myNewCommand command)
+        return cy[namespaceCommand(property)];
+      },
+    }
+  );
+
+  function namespaceCommand(commandName) {
+    return `${namespace}:${commandName}`;
+  }
+}

cypress/utils/command_namespace.js

@@ -9,6 +9,9 @@
 
 import { BASE_PATH } from './constants';
 import { TestFixtureHandler } from '../lib/test_fixture_handler';
+import initCommandNamespace from './command_namespace';
+
+initCommandNamespace(cy, 'osd');
 
 // This function does not delete all indices
 Cypress.Commands.add('deleteAllIndices', () => {
@@ -322,9 +325,8 @@ Cypress.Commands.add('deleteWorkspace', (workspaceName) => {
   cy.contains(/successfully/);
 });
 
-Cypress.Commands.add('createInitialWorkspaceWithDataSource', (dataSourceTitle, workspaceName) => {
+cy.osd.add('createInitialWorkspaceWithDataSource', (dataSourceTitle, workspaceName) => {
   cy.intercept('POST', '/api/workspaces').as('createWorkspaceInterception');
-
   cy.getElementByTestId('workspace-initial-card-createWorkspace-button')
     .should('be.visible')
     .click();
@@ -351,7 +353,7 @@ Cypress.Commands.add('createInitialWorkspaceWithDataSource', (dataSourceTitle, w
   cy.contains(/successfully/);
 });
 
-Cypress.Commands.add('openWorkspaceDashboard', (workspaceName) => {
+cy.osd.add('openWorkspaceDashboard', (workspaceName) => {
   cy.getElementByTestId('workspace-select-button').should('exist').click();
   cy.getElementByTestId('workspace-menu-manage-button').should('exist').click();
   cy.get('.euiBasicTable')

cypress/utils/commands.js

@@ -7,7 +7,7 @@ export function removeSampleDataAndWorkspace(url, workspaceName) {
   describe('removing workspace/sampledata', () => {
     it('remove workspace', () => {
       cy.visit(`${url}/app/workspace_list`);
-      cy.openWorkspaceDashboard(workspaceName);
+      cy.osd.openWorkspaceDashboard(workspaceName);
       cy.getElementByTestId('toggleNavButton').eq(0).should('exist').click();
       cy.wait(3000);
       cy.getElementByTestId('collapsibleNavAppLink-workspace_detail').should('exist').click();

cypress/utils/dashboards/remove_workspace.js

@@ -6,27 +6,29 @@
 const dataSourceTitle = Cypress.env('dataSourceTitle');
 
 export function createWorkspaceAndSampleData(url, workspaceName) {
-  describe('checking home page', () => {
-    it('checking workspace initial page', () => {
-      cy.visit(`${url}/app/home`);
-      cy.getElementByTestId('workspace-initial-card-createWorkspace-button').should('be.visible');
+  describe('setup workspace', () => {
+    describe('checking home page', () => {
+      it('checking workspace initial page', () => {
+        cy.visit(`${url}/app/home`);
+        cy.getElementByTestId('workspace-initial-card-createWorkspace-button').should('be.visible');
+      });
     });
-  });
 
-  describe('creating workspace', () => {
-    it('creating workspace with data source', () => {
-      cy.visit(`${url}/app/home`);
-      cy.createInitialWorkspaceWithDataSource(dataSourceTitle, workspaceName);
-      cy.wait(2000);
+    describe('creating workspace', () => {
+      it('creating workspace with data source', () => {
+        cy.visit(`${url}/app/home`);
+        cy.osd.createInitialWorkspaceWithDataSource(dataSourceTitle, workspaceName);
+        cy.wait(2000);
+      });
     });
-  });
 
-  describe('adding sample data to workspace', () => {
-    it('add sample data to data source', () => {
-      cy.visit(`${url}/app/workspace_list`);
-      cy.openWorkspaceDashboard(workspaceName);
-      cy.openSampleDataPage();
-      cy.addSampleDataToDataSource(dataSourceTitle);
+    describe('adding sample data to workspace', () => {
+      it('add sample data to data source', () => {
+        cy.visit(`${url}/app/workspace_list`);
+        cy.osd.openWorkspaceDashboard(workspaceName);
+        cy.openSampleDataPage();
+        cy.addSampleDataToDataSource(dataSourceTitle);
+      });
     });
   });
 }

cypress/utils/dashboards/setup_workspace.js

@@ -182,13 +182,21 @@ declare namespace Cypress {
      */
     drag<S = any>(targetSelector: string): Chainable<S>;
 
-    /**
-     * Creates workspace and attaches it to the provided data source
-     * It also saves the created workspace id as the alias @WORKSPACE_ID
-     */
-    createInitialWorkspaceWithDataSource<S = any>(
-      dataSourceTitle: string,
-      workspaceName: string
-    ): Chainable<S>;
+    // osd namespace
+    osd: {
+      /**
+       * Creates workspace and attaches it to the provided data source
+       * It also saves the created workspace id as the alias @WORKSPACE_ID
+       */
+      createInitialWorkspaceWithDataSource<S = any>(
+        dataSourceTitle: string,
+        workspaceName: string
+      ): Chainable<S>;
+
+      /**
+       * Opens workspace dashboard
+       */
+      openWorkspaceDashboard<S = any>(workspaceName: string): Chainable<S>;
+    };
   }
 }