[Backport main]Comply with the root agent id config change in dashboards-assistant (#1053)

.github/workflows/assistant-release-e2e-workflow.yml

@@ -15,11 +15,21 @@ jobs:
             tests:
               - 'cypress/**/dashboards-assistant/**'
 
-  tests:
+  tests-with-security:
     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_DASHBOARDS_ASSISTANT_ENABLED=true yarn cypress:run-with-security --browser chromium --spec 'cypress/integration/plugins/dashboards-assistant/*'
-      osd-serve-args: --assistant.chat.enabled=true --assistant.chat.rootAgentName="Cypress test agent"
+      osd-serve-args: --assistant.chat.enabled=true
+
+  tests-without-security:
+    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_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

cypress/fixtures/plugins/dashboards-assistant/cluster_settings.json

@@ -2,6 +2,7 @@
   "persistent": {
     "plugins.ml_commons.only_run_on_ml_node": false,
     "plugins.ml_commons.memory_feature_enabled": true,
+    "plugins.ml_commons.agent_framework_enabled": true,
     "plugins.ml_commons.trusted_connector_endpoints_regex": [
       "^http://127.0.0.1:3000$"
     ]

cypress/fixtures/plugins/dashboards-assistant/security-cert.js

@@ -0,0 +1,70 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * This file should be somewhere else like plugins/security but as assistant is the only consumer of the content
+ * Would be better to keep within the directory of dashboards-assistant.
+ */
+
+export const certPublicKeyContent = `
+-----BEGIN CERTIFICATE-----
+MIIEmDCCA4CgAwIBAgIUZjrlDPP8azRDPZchA/XEsx0X2iYwDQYJKoZIhvcNAQEL
+BQAwgY8xEzARBgoJkiaJk/IsZAEZFgNjb20xFzAVBgoJkiaJk/IsZAEZFgdleGFt
+cGxlMRkwFwYDVQQKDBBFeGFtcGxlIENvbSBJbmMuMSEwHwYDVQQLDBhFeGFtcGxl
+IENvbSBJbmMuIFJvb3QgQ0ExITAfBgNVBAMMGEV4YW1wbGUgQ29tIEluYy4gUm9v
+dCBDQTAeFw0yMzA4MjkyMDA2MzdaFw0zMzA4MjYyMDA2MzdaME0xCzAJBgNVBAYT
+AmRlMQ0wCwYDVQQHDAR0ZXN0MQ8wDQYDVQQKDAZjbGllbnQxDzANBgNVBAsMBmNs
+aWVudDENMAsGA1UEAwwEa2lyazCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC
+ggEBAJVcOAQlCiuB9emCljROAXnlsPbG7PE3kNz2sN+BbGuw686Wgyl3uToVHvVs
+paMmLUqm1KYz9wMSWTIBZgpJ9hYaIbGxD4RBb7qTAJ8Q4ddCV2f7T4lxao/6ixI+
+O0l/BG9E3mRGo/r0w+jtTQ3aR2p6eoxaOYbVyEMYtFI4QZTkcgGIPGxm05y8xonx
+vV5pbSW9L7qAVDzQC8EYGQMMI4ccu0NcHKWtmTYJA/wDPE2JwhngHwbcIbc4cDz6
+cG0S3FmgiKGuuSqUy35v/k3y7zMHQSdx7DSR2tzhH/bBL/9qGvpT71KKrxPtaxS0
+bAqPcEkKWDo7IMlGGW7LaAWfGg8CAwEAAaOCASswggEnMAwGA1UdEwEB/wQCMAAw
+DgYDVR0PAQH/BAQDAgXgMBYGA1UdJQEB/wQMMAoGCCsGAQUFBwMCMIHPBgNVHSME
+gccwgcSAFBeH36Ba62YSp9XQ+LoSRTy3KwCcoYGVpIGSMIGPMRMwEQYKCZImiZPy
+LGQBGRYDY29tMRcwFQYKCZImiZPyLGQBGRYHZXhhbXBsZTEZMBcGA1UECgwQRXhh
+bXBsZSBDb20gSW5jLjEhMB8GA1UECwwYRXhhbXBsZSBDb20gSW5jLiBSb290IENB
+MSEwHwYDVQQDDBhFeGFtcGxlIENvbSBJbmMuIFJvb3QgQ0GCFHfkrz782p+T9k0G
+xGeM4+BrehWKMB0GA1UdDgQWBBSjMS8tgguX/V7KSGLoGg7K6XMzIDANBgkqhkiG
+9w0BAQsFAAOCAQEANMwD1JYlwAh82yG1gU3WSdh/tb6gqaSzZK7R6I0L7slaXN9m
+y2ErUljpTyaHrdiBFmPhU/2Kj2r+fIUXtXdDXzizx/JdmueT0nG9hOixLqzfoC9p
+fAhZxM62RgtyZoaczQN82k1/geMSwRpEndFe3OH7arkS/HSbIFxQhAIy229eWe5d
+1bUzP59iu7f3r567I4ob8Vy7PP+Ov35p7Vv4oDHHwgsdRzX6pvL6mmwVrQ3BfVec
+h9Dqprr+ukYmjho76g6k5cQuRaB6MxqldzUg+2E7IHQP8MCF+co51uZq2nl33mtp
+RGr6JbdHXc96zsLTL3saJQ8AWEfu1gbTVrwyRA==
+-----END CERTIFICATE-----
+`;
+
+export const certPrivateKeyContent = `
+-----BEGIN PRIVATE KEY-----
+MIIEvAIBADANBgkqhkiG9w0BAQEFAASCBKYwggSiAgEAAoIBAQCVXDgEJQorgfXp
+gpY0TgF55bD2xuzxN5Dc9rDfgWxrsOvOloMpd7k6FR71bKWjJi1KptSmM/cDElky
+AWYKSfYWGiGxsQ+EQW+6kwCfEOHXQldn+0+JcWqP+osSPjtJfwRvRN5kRqP69MPo
+7U0N2kdqenqMWjmG1chDGLRSOEGU5HIBiDxsZtOcvMaJ8b1eaW0lvS+6gFQ80AvB
+GBkDDCOHHLtDXBylrZk2CQP8AzxNicIZ4B8G3CG3OHA8+nBtEtxZoIihrrkqlMt+
+b/5N8u8zB0Encew0kdrc4R/2wS//ahr6U+9Siq8T7WsUtGwKj3BJClg6OyDJRhlu
+y2gFnxoPAgMBAAECggEAP5TOycDkx+megAWVoHV2fmgvgZXkBrlzQwUG/VZQi7V4
+ZGzBMBVltdqI38wc5MtbK3TCgHANnnKgor9iq02Z4wXDwytPIiti/ycV9CDRKvv0
+TnD2hllQFjN/IUh5n4thHWbRTxmdM7cfcNgX3aZGkYbLBVVhOMtn4VwyYu/Mxy8j
+xClZT2xKOHkxqwmWPmdDTbAeZIbSv7RkIGfrKuQyUGUaWhrPslvYzFkYZ0umaDgQ
+OAthZew5Bz3OfUGOMPLH61SVPuJZh9zN1hTWOvT65WFWfsPd2yStI+WD/5PU1Doo
+1RyeHJO7s3ug8JPbtNJmaJwHe9nXBb/HXFdqb976yQKBgQDNYhpu+MYSYupaYqjs
+9YFmHQNKpNZqgZ4ceRFZ6cMJoqpI5dpEMqToFH7tpor72Lturct2U9nc2WR0HeEs
+/6tiptyMPTFEiMFb1opQlXF2ae7LeJllntDGN0Q6vxKnQV+7VMcXA0Y8F7tvGDy3
+qJu5lfvB1mNM2I6y/eMxjBuQhwKBgQC6K41DXMFro0UnoO879pOQYMydCErJRmjG
+/tZSy3Wj4KA/QJsDSViwGfvdPuHZRaG9WtxdL6kn0w1exM9Rb0bBKl36lvi7o7xv
+M+Lw9eyXMkww8/F5d7YYH77gIhGo+RITkKI3+5BxeBaUnrGvmHrpmpgRXWmINqr0
+0jsnN3u0OQKBgCf45vIgItSjQb8zonLz2SpZjTFy4XQ7I92gxnq8X0Q5z3B+o7tQ
+K/4rNwTju/sGFHyXAJlX+nfcK4vZ4OBUJjP+C8CTjEotX4yTNbo3S6zjMyGQqDI5
+9aIOUY4pb+TzeUFJX7If5gR+DfGyQubvvtcg1K3GHu9u2l8FwLj87sRzAoGAflQF
+RHuRiG+/AngTPnZAhc0Zq0kwLkpH2Rid6IrFZhGLy8AUL/O6aa0IGoaMDLpSWUJp
+nBY2S57MSM11/MVslrEgGmYNnI4r1K25xlaqV6K6ztEJv6n69327MS4NG8L/gCU5
+3pEm38hkUi8pVYU7in7rx4TCkrq94OkzWJYurAkCgYATQCL/rJLQAlJIGulp8s6h
+mQGwy8vIqMjAdHGLrCS35sVYBXG13knS52LJHvbVee39AbD5/LlWvjJGlQMzCLrw
+F7oILW5kXxhb8S73GWcuMbuQMFVHFONbZAZgn+C9FW4l7XyRdkrbR1MRZ2km8YMs
+/AHmo368d4PSNRMMzLHw8Q==
+-----END PRIVATE KEY-----
+`;

cypress/integration/plugins/dashboards-assistant/chatbot_agent_framework_spec.js

@@ -26,11 +26,14 @@ if (Cypress.env('DASHBOARDS_ASSISTANT_ENABLED')) {
 
     describe('Interact with Agent framework', () => {
       it('toggle Chatbot and enable to interact', () => {
-        // input question
-        cy.wait(1000);
-        cy.get(`input[placeholder="Ask question"]`)
-          .click()
-          .type('What are the indices in my cluster?{enter}');
+        // The header may render multiple times, wait for UI to be stable
+        cy.wait(5000);
+
+        // enable to toggle and show Chatbot
+        cy.get(`img[aria-label="toggle chat flyout icon"]`).click();
+
+        // click suggestions to generate response
+        cy.contains('What are the indices in my cluster?').click();
 
         // should have a LLM Response
         cy.contains(
@@ -39,6 +42,7 @@ if (Cypress.env('DASHBOARDS_ASSISTANT_ENABLED')) {
 
         // should have a suggestion section
         cy.get(`[aria-label="chat suggestions"]`).should('be.length', 1);
+        cy.contains('suggestion1');
 
         // Click regenerate button
         cy.get(`button[title="regenerate message"]`).click();
@@ -56,6 +60,7 @@ if (Cypress.env('DASHBOARDS_ASSISTANT_ENABLED')) {
 
         // should have a suggestion section
         cy.get(`[aria-label="chat suggestions"]`).should('be.length', 1);
+        cy.contains('suggestion2');
       });
     });
   });

cypress/support/index.js

@@ -65,7 +65,7 @@ if (Cypress.env('ENDPOINT_WITH_PROXY')) {
 if (Cypress.env('DASHBOARDS_ASSISTANT_ENABLED')) {
   before(() => {
     cy.addAssistantRequiredSettings();
-    cy.registerRootAgent();
+    cy.readOrRegisterRootAgent();
     cy.startDummyServer();
   });
   after(() => {

cypress/utils/plugins/dashboards-assistant/commands.js

@@ -3,11 +3,16 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import { get } from 'lodash';
 import FlowTemplateJSON from '../../../fixtures/plugins/dashboards-assistant/flow-template.json';
 import { BACKEND_BASE_PATH, BASE_PATH } from '../../constants';
 import { ML_COMMONS_API, ASSISTANT_API } from './constants';
 import clusterSettings from '../../../fixtures/plugins/dashboards-assistant/cluster_settings.json';
 import { apiRequest } from '../../helpers';
+import {
+  certPrivateKeyContent,
+  certPublicKeyContent,
+} from '../../../fixtures/plugins/dashboards-assistant/security-cert';
 
 Cypress.Commands.add('addAssistantRequiredSettings', () => {
   cy.request('PUT', `${BACKEND_BASE_PATH}/_cluster/settings`, clusterSettings);
@@ -20,10 +25,23 @@ const agentParameters = {
   rootAgentId: '',
 };
 
+Cypress.Commands.add('readOrRegisterRootAgent', () => {
+  cy.request({
+    url: `${BACKEND_BASE_PATH}${ML_COMMONS_API.AGENT_CONFIG}`,
+    method: 'GET',
+    failOnStatusCode: false,
+  }).then((resp) => {
+    const agentId = get(resp, 'body.configuration.agent_id');
+    if (agentId) {
+      cy.log(`Already initialized agent: ${agentId}, skip the initialize step`);
+    } else {
+      cy.log(`Agent id not initialized yet, set up agent`);
+      return cy.registerRootAgent();
+    }
+  });
+});
+
 Cypress.Commands.add('registerRootAgent', () => {
-  // ML needs 10 seconds to initialize its master key
-  // The ML encryption master key has not been initialized yet. Please retry after waiting for 10 seconds.
-  cy.wait(10000);
   /**
    * TODO use flow framework if the plugin get integrate in the future.
    */
@@ -112,9 +130,30 @@ Cypress.Commands.add('registerRootAgent', () => {
     })
     .then((resp) => {
       agentParameters.rootAgentId = resp.body.agent_id;
+      return cy.putRootAgentId(agentParameters.rootAgentId);
     });
 });
 
+Cypress.Commands.add('putRootAgentId', (agentId) => {
+  if (Cypress.env('SECURITY_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}"}}'`
+    );
+  } else {
+    return cy.request(
+      'PUT',
+      `${BACKEND_BASE_PATH}${ML_COMMONS_API.UPDATE_ROOT_AGENT_CONFIG}`,
+      {
+        type: 'os_chat_root_agent',
+        configuration: {
+          agent_id: agentId,
+        },
+      }
+    );
+  }
+});
+
 Cypress.Commands.add('cleanRootAgent', () => {
   return;
   /**

cypress/utils/plugins/dashboards-assistant/constants.js

@@ -14,6 +14,8 @@ export const ML_COMMONS_API = {
   CREATE_CONNECTOR: `${ML_COMMONS_API_PREFIX}/connectors/_create`,
   CREATE_MODEL: `${ML_COMMONS_API_PREFIX}/models/_register`,
   CREATE_AGENT: `${ML_COMMONS_API_PREFIX}/agents/_register`,
+  UPDATE_ROOT_AGENT_CONFIG: `/.plugins-ml-config/_doc/os_chat`,
+  AGENT_CONFIG: `${ML_COMMONS_API_PREFIX}/config/os_chat`,
 };
 
 export const ASSISTANT_API_BASE = '/api/assistant';