[MDS] Add dashboard assistant tests with multiple data source enabled (…

…#1374) (#1391) * Add dashboard assistant tests with multiple data source enabled Signed-off-by: yubonluo <[email protected]> * optimize the code Signed-off-by: yubonluo <[email protected]> * optimize the code Signed-off-by: yubonluo <[email protected]> * add some annotation Signed-off-by: yubonluo <[email protected]> --------- Signed-off-by: yubonluo <[email protected]> (cherry picked from commit 8e7cf64) Co-authored-by: yuboluo <[email protected]>
opensearch-project · Jun 12, 2024 · f311921 · f311921
1 parent 8792318
commit f311921
Show file tree

Hide file tree

Showing 9 changed files with 114 additions and 19 deletions.
diff --git a/.github/workflows/assistant-release-e2e-workflow.yml b/.github/workflows/assistant-release-e2e-workflow.yml
@@ -34,3 +34,13 @@ jobs:
       test-command: env CYPRESS_DASHBOARDS_ASSISTANT_ENABLED=true yarn cypress:run-without-security --browser chromium --spec 'cypress/integration/plugins/dashboards-assistant/*'
       osd-serve-args: --assistant.chat.enabled=true
       security-enabled: false
+  tests-with-multiple-data-source-and-disabled-local-cluster:
+    needs: changes
+    if: ${{ needs.changes.outputs.tests == 'true' }}
+    uses: ./.github/workflows/release-e2e-workflow-template.yml
+    with:
+      test-name: dashboards assistant
+      test-command: env CYPRESS_DISABLE_LOCAL_CLUSTER=true CYPRESS_DATASOURCE_MANAGEMENT_ENABLED=true CYPRESS_DASHBOARDS_ASSISTANT_ENABLED=true yarn cypress:run-with-security --browser chromium --spec 'cypress/integration/plugins/dashboards-assistant/mds*.js'
+      osd-serve-args: --data_source.enabled=true --data_source.ssl.verificationMode=none --data_source.hideLocalCluster=true --assistant.chat.enabled=true
+      security-enabled: true
+
diff --git a/...assistant/chatbot_agent_framework_spec.js → ...stant/mds_chatbot_agent_framework_spec.js b/...assistant/chatbot_agent_framework_spec.js → ...stant/mds_chatbot_agent_framework_spec.js
@@ -7,12 +7,17 @@ import { BASE_PATH } from '../../../utils/constants';
 if (Cypress.env('DASHBOARDS_ASSISTANT_ENABLED')) {
   describe('Assistant basic spec', () => {
     before(() => {
+      cy.setDefaultDataSourceForAssistant();
       // Set welcome screen tracking to false
       localStorage.setItem('home:welcome:show', 'false');
       // Set new theme modal to false
       localStorage.setItem('home:newThemeModal:show', 'false');
     });
 
+    after(() => {
+      cy.clearDataSourceForAssistant();
+    });
+
     beforeEach(() => {
       // Visit ISM OSD
       cy.visit(`${BASE_PATH}/app/home`);

diff --git a/...sistant/chatbot_interaction_trace_spec.js → ...ant/mds_chatbot_interaction_trace_spec.js b/...sistant/chatbot_interaction_trace_spec.js → ...ant/mds_chatbot_interaction_trace_spec.js
@@ -8,6 +8,7 @@ import { BASE_PATH } from '../../../utils/constants';
 if (Cypress.env('DASHBOARDS_ASSISTANT_ENABLED')) {
   describe('Interaction trace spec', () => {
     before(() => {
+      cy.setDefaultDataSourceForAssistant();
       // Set welcome screen tracking to false
       localStorage.setItem('home:welcome:show', 'false');
       // Set new theme modal to false
@@ -36,6 +37,7 @@ if (Cypress.env('DASHBOARDS_ASSISTANT_ENABLED')) {
 
     // clean up localStorage items
     after(() => {
+      cy.clearDataSourceForAssistant();
       localStorage.removeItem('home:welcome:show');
       localStorage.removeItem('home:newThemeModal:show');
     });

diff --git a/...hboards-assistant/chatbot_sidecar_spec.js → ...rds-assistant/mds_chatbot_sidecar_spec.js b/...hboards-assistant/chatbot_sidecar_spec.js → ...rds-assistant/mds_chatbot_sidecar_spec.js
diff --git a/...ds-assistant/conversation_history_spec.js → ...ssistant/mds_conversation_history_spec.js b/...ds-assistant/conversation_history_spec.js → ...ssistant/mds_conversation_history_spec.js
@@ -9,8 +9,12 @@ if (Cypress.env('DASHBOARDS_ASSISTANT_ENABLED')) {
   describe('Assistant conversation history spec', () => {
     let restoreShowHome;
     let restoreNewThemeModal;
+    let dataSourceId;
 
     before(() => {
+      cy.setDefaultDataSourceForAssistant().then((id) => {
+        dataSourceId = id;
+      });
       // Set welcome screen tracking to false
       restoreShowHome = setStorageItem(
         localStorage,
@@ -37,6 +41,7 @@ if (Cypress.env('DASHBOARDS_ASSISTANT_ENABLED')) {
       cy.get('img[aria-label="toggle chat flyout icon"]').click();
     });
     after(() => {
+      cy.clearDataSourceForAssistant();
       if (restoreShowHome) {
         restoreShowHome();
       }
@@ -106,13 +111,16 @@ if (Cypress.env('DASHBOARDS_ASSISTANT_ENABLED')) {
 
       before(() => {
         // Create conversations data
-        cy.sendAssistantMessage({
-          input: {
-            type: 'input',
-            content: 'What are the indices in my cluster?',
-            contentType: 'text',
+        cy.sendAssistantMessage(
+          {
+            input: {
+              type: 'input',
+              content: 'What are the indices in my cluster?',
+              contentType: 'text',
+            },
           },
-        }).then((result) => {
+          dataSourceId
+        ).then((result) => {
           if (result.status !== 200) {
             throw result.body;
           }
@@ -123,7 +131,7 @@ if (Cypress.env('DASHBOARDS_ASSISTANT_ENABLED')) {
       after(() => {
         // Clear created conversations in tests
         conversations.map(({ conversationId }) =>
-          cy.deleteConversation(conversationId)
+          cy.deleteConversation(conversationId, dataSourceId)
         );
       });
 

diff --git a/...ins/dashboards-assistant/feedback_spec.js → ...dashboards-assistant/mds_feedback_spec.js b/...ins/dashboards-assistant/feedback_spec.js → ...dashboards-assistant/mds_feedback_spec.js
@@ -7,6 +7,7 @@ import { BASE_PATH } from '../../../utils/constants';
 if (Cypress.env('DASHBOARDS_ASSISTANT_ENABLED')) {
   describe('Assistant feedback spec', () => {
     before(() => {
+      cy.setDefaultDataSourceForAssistant();
       // Set welcome screen tracking to false
       localStorage.setItem('home:welcome:show', 'false');
       // Set new theme modal to false
@@ -26,6 +27,7 @@ if (Cypress.env('DASHBOARDS_ASSISTANT_ENABLED')) {
 
     // clean up localStorage items
     after(() => {
+      cy.clearDataSourceForAssistant();
       localStorage.removeItem('home:welcome:show');
       localStorage.removeItem('home:newThemeModal:show');
     });

diff --git a/cypress/support/index.js b/cypress/support/index.js
@@ -27,12 +27,13 @@ import '../utils/plugins/anomaly-detection-dashboards-plugin/commands';
 import '../utils/plugins/security/commands';
 import '../utils/plugins/security-dashboards-plugin/commands';
 import '../utils/plugins/alerting-dashboards-plugin/commands';
-import '../utils/plugins/security-analytics-dashboards-plugin/commands';
 import '../utils/plugins/ml-commons-dashboards/commands';
+import '../utils/plugins/security-analytics-dashboards-plugin/commands';
 import '../utils/plugins/notifications-dashboards/commands';
 import '../utils/plugins/dashboards-assistant/commands';
 import '../utils/dashboards/console/commands';
 import '../utils/dashboards/workspace-plugin/commands';
+import { currentBackendEndpoint } from '../utils/commands';
 
 import 'cypress-real-events';
 
@@ -64,14 +65,42 @@ if (Cypress.env('ENDPOINT_WITH_PROXY')) {
  * Make setup step in here so that all the test files in dashboards-assistant
  * won't need to call these commands.
  */
-if (Cypress.env('DASHBOARDS_ASSISTANT_ENABLED')) {
+if (
+  Cypress.env('DASHBOARDS_ASSISTANT_ENABLED') &&
+  !Cypress.env('DATASOURCE_MANAGEMENT_ENABLED')
+) {
+  before(() => {
+    cy.addAssistantRequiredSettings();
+    cy.readOrRegisterRootAgent();
+    cy.startDummyServer();
+  });
+  after(() => {
+    cy.cleanRootAgent();
+    cy.stopDummyServer();
+  });
+}
+
+/**
+ * Make setup step in here so that all the test with MDS files in dashboards-assistant
+ * won't need to call these commands.
+ */
+if (
+  Cypress.env('DASHBOARDS_ASSISTANT_ENABLED') &&
+  Cypress.env('DATASOURCE_MANAGEMENT_ENABLED')
+) {
   before(() => {
+    const originalBackendEndpoint = currentBackendEndpoint.get();
+    currentBackendEndpoint.set(currentBackendEndpoint.REMOTE_NO_AUTH);
     cy.addAssistantRequiredSettings();
     cy.readOrRegisterRootAgent();
+    currentBackendEndpoint.set(originalBackendEndpoint, false);
     cy.startDummyServer();
   });
   after(() => {
+    const originalBackendEndpoint = currentBackendEndpoint.get();
+    currentBackendEndpoint.set(currentBackendEndpoint.REMOTE_NO_AUTH);
     cy.cleanRootAgent();
+    currentBackendEndpoint.set(originalBackendEndpoint, false);
     cy.stopDummyServer();
   });
 }
diff --git a/cypress/utils/dashboards/datasource-management-dashboards-plugin/commands.js b/cypress/utils/dashboards/datasource-management-dashboards-plugin/commands.js
@@ -348,3 +348,18 @@ Cypress.Commands.add('ifElementExists', (selector, callback) => {
     }
   });
 });
+
+Cypress.Commands.add('setDefaultDataSource', (dataSourceId) => {
+  cy.request({
+    method: 'POST',
+    url: `${BASE_PATH}/api/opensearch-dashboards/settings`,
+    headers: {
+      'osd-xsrf': true,
+    },
+    body: {
+      changes: {
+        defaultDataSource: dataSourceId,
+      },
+    },
+  });
+});
diff --git a/cypress/utils/plugins/dashboards-assistant/commands.js b/cypress/utils/plugins/dashboards-assistant/commands.js
@@ -135,7 +135,11 @@ Cypress.Commands.add('registerRootAgent', () => {
 });
 
 Cypress.Commands.add('putRootAgentId', (agentId) => {
-  if (Cypress.env('SECURITY_ENABLED')) {
+  // When enabling the DATASOURCE-MANAGEment-ENABLED flag, we need to config the root agent ID in a no auth data source.
+  if (
+    Cypress.env('SECURITY_ENABLED') &&
+    !Cypress.env('DATASOURCE_MANAGEMENT_ENABLED')
+  ) {
     // The .plugins-ml-config index is a system index and need to call the API by using certificate file
     return cy.exec(
       `curl -k --cert <(cat <<EOF \n${certPublicKeyContent}\nEOF\n) --key <(cat <<EOF\n${certPrivateKeyContent}\nEOF\n) -XPUT '${BACKEND_BASE_PATH}${ML_COMMONS_API.UPDATE_ROOT_AGENT_CONFIG}'  -H 'Content-Type: application/json' -d '{"type":"os_chat_root_agent","configuration":{"agent_id":"${agentId}"}}'`
@@ -193,13 +197,33 @@ Cypress.Commands.add('stopDummyServer', () => {
   });
 });
 
-Cypress.Commands.add('sendAssistantMessage', (body) =>
-  apiRequest(`${BASE_PATH}${ASSISTANT_API.SEND_MESSAGE}`, 'POST', body)
-);
+Cypress.Commands.add('sendAssistantMessage', (body, dataSourceId) => {
+  const url = `${BASE_PATH}${ASSISTANT_API.SEND_MESSAGE}`;
+  const qs = { dataSourceId: dataSourceId };
+  apiRequest(url, 'POST', body, qs);
+});
 
-Cypress.Commands.add('deleteConversation', (conversationId) =>
-  apiRequest(
-    `${BASE_PATH}${ASSISTANT_API.CONVERSATION}/${conversationId}`,
-    'DELETE'
-  )
-);
+Cypress.Commands.add('deleteConversation', (conversationId, dataSourceId) => {
+  const url = `${BASE_PATH}${ASSISTANT_API.CONVERSATION}/${conversationId}`;
+  const qs = { dataSourceId: dataSourceId };
+  apiRequest(url, 'DELETE', undefined, qs);
+});
+
+Cypress.Commands.add('setDefaultDataSourceForAssistant', () => {
+  if (Cypress.env('DATASOURCE_MANAGEMENT_ENABLED')) {
+    cy.deleteAllDataSources();
+    // create data source
+    cy.createDataSourceNoAuth().then((result) => {
+      const dataSourceId = result[0];
+      // set default data source
+      cy.setDefaultDataSource(dataSourceId);
+      return cy.wrap(dataSourceId);
+    });
+  }
+});
+
+Cypress.Commands.add('clearDataSourceForAssistant', () => {
+  if (Cypress.env('DATASOURCE_MANAGEMENT_ENABLED')) {
+    cy.deleteAllDataSources();
+  }
+});