[Multiple Datasource] Test connection schema validation for registere…

…d auth types (opensearch-project#6109) * [Token Exchange Unification] Test connextion router schema validation support for registered auth type Signed-off-by: Xinrui Bai <[email protected]> * Update changefile Signed-off-by: Xinrui Bai <[email protected]> * [UT] Add test cases for registered auth type, test connection failure case Signed-off-by: Xinrui Bai <[email protected]> * [UT] Update testing URL value to avoid linkchecker failure Signed-off-by: Xinrui Bai <[email protected]> * [UT] Update testing URL value to avoid linkchecker failure round2 Signed-off-by: Xinrui Bai <[email protected]> * [UT] Update testing URL value to avoid linkchecker failure round 3 Signed-off-by: Xinrui Bai <[email protected]> --------- Signed-off-by: Xinrui Bai <[email protected]>
SuZhou-Joe · Mar 12, 2024 · 362ab1e · 362ab1e
1 parent 3aa0e5a
commit 362ab1e
Show file tree

Hide file tree

Showing 3 changed files with 142 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -29,6 +29,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - [Multiple Datasource] Handle form values(request payload) if the selected type is available in the authentication registry ([#6049](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/6049))
 - [Multiple Datasource] Adds a session token to AWS credentials ([#6103](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/6103))
 - [Multiple Datasource] Add Vega support to MDS by specifying a data source name in the Vega spec ([#5975](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/5975))
+- [Multiple Datasource] Test connection schema validation for registered auth types ([#6109](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/6109))
 - [Workspace] Consume workspace id in saved object client ([#6014](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/6014))
 - [Multiple Datasource] Export DataSourcePluginRequestContext at top level for plugins to use ([#6108](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/6108))
 

diff --git a/src/plugins/data_source/server/routes/test_connection.test.ts b/src/plugins/data_source/server/routes/test_connection.test.ts
@@ -100,6 +100,58 @@ describe(`Test connection ${URL}`, () => {
     },
   };
 
+  const dataSourceAttrForRegisteredAuthWithCredentials = {
+    endpoint: 'https://test.com',
+    auth: {
+      type: 'Some Registered Type',
+      credentials: {
+        firstField: 'some value',
+        secondField: 'some value',
+      },
+    },
+  };
+
+  const dataSourceAttrForRegisteredAuthWithEmptyCredentials = {
+    endpoint: 'https://test.com',
+    auth: {
+      type: 'Some Registered Type',
+      credentials: {},
+    },
+  };
+
+  const dataSourceAttrForRegisteredAuthWithoutCredentials = {
+    endpoint: 'https://test.com',
+    auth: {
+      type: 'Some Registered Type',
+    },
+  };
+
+  const dataSourceAttrForRegisteredAuthWithNoAuthType = {
+    endpoint: 'https://test.com',
+    auth: {
+      type: AuthType.NoAuth,
+      credentials: {
+        field: 'some value',
+      },
+    },
+  };
+
+  const dataSourceAttrForRegisteredAuthWithBasicAuthType = {
+    endpoint: 'https://test.com',
+    auth: {
+      type: AuthType.UsernamePasswordType,
+      credentials: {},
+    },
+  };
+
+  const dataSourceAttrForRegisteredAuthWithSigV4AuthType = {
+    endpoint: 'https://test.com',
+    auth: {
+      type: AuthType.SigV4,
+      credentials: {},
+    },
+  };
+
   beforeEach(async () => {
     ({ server, httpSetup, handlerContext } = await setupServer());
     customApiSchemaRegistryPromise = Promise.resolve(customApiSchemaRegistry);
@@ -205,6 +257,48 @@ describe(`Test connection ${URL}`, () => {
     expect(result.body.error).toEqual('Bad Request');
   });
 
+  it('registered Auth with NoAuthType should fail', async () => {
+    const result = await supertest(httpSetup.server.listener)
+      .post(URL)
+      .send({
+        id: 'testId',
+        dataSourceAttr: dataSourceAttrForRegisteredAuthWithNoAuthType,
+      })
+      .expect(400);
+    expect(result.body.error).toEqual('Bad Request');
+    expect(result.body.message).toContain(
+      `Must not be no_auth or username_password or sigv4 for registered auth types`
+    );
+  });
+
+  it('registered Auth with Basic AuthType should fail', async () => {
+    const result = await supertest(httpSetup.server.listener)
+      .post(URL)
+      .send({
+        id: 'testId',
+        dataSourceAttr: dataSourceAttrForRegisteredAuthWithBasicAuthType,
+      })
+      .expect(400);
+    expect(result.body.error).toEqual('Bad Request');
+    expect(result.body.message).toContain(
+      `Must not be no_auth or username_password or sigv4 for registered auth types`
+    );
+  });
+
+  it('registered Auth with sigV4 AuthType should fail', async () => {
+    const result = await supertest(httpSetup.server.listener)
+      .post(URL)
+      .send({
+        id: 'testId',
+        dataSourceAttr: dataSourceAttrForRegisteredAuthWithSigV4AuthType,
+      })
+      .expect(400);
+    expect(result.body.error).toEqual('Bad Request');
+    expect(result.body.message).toContain(
+      `Must not be no_auth or username_password or sigv4 for registered auth types`
+    );
+  });
+
   it('full credential with sigV4 auth should success', async () => {
     const result = await supertest(httpSetup.server.listener)
       .post(URL)
@@ -215,4 +309,37 @@ describe(`Test connection ${URL}`, () => {
       .expect(200);
     expect(result.body).toEqual({ success: true });
   });
+
+  it('credential with registered auth type should success', async () => {
+    const result = await supertest(httpSetup.server.listener)
+      .post(URL)
+      .send({
+        id: 'testId',
+        dataSourceAttr: dataSourceAttrForRegisteredAuthWithCredentials,
+      })
+      .expect(200);
+    expect(result.body).toEqual({ success: true });
+  });
+
+  it('empty credential with registered auth type should success', async () => {
+    const result = await supertest(httpSetup.server.listener)
+      .post(URL)
+      .send({
+        id: 'testId',
+        dataSourceAttr: dataSourceAttrForRegisteredAuthWithEmptyCredentials,
+      })
+      .expect(200);
+    expect(result.body).toEqual({ success: true });
+  });
+
+  it('no credential with registered auth type should success', async () => {
+    const result = await supertest(httpSetup.server.listener)
+      .post(URL)
+      .send({
+        id: 'testId',
+        dataSourceAttr: dataSourceAttrForRegisteredAuthWithoutCredentials,
+      })
+      .expect(200);
+    expect(result.body).toEqual({ success: true });
+  });
 });
diff --git a/src/plugins/data_source/server/routes/test_connection.ts b/src/plugins/data_source/server/routes/test_connection.ts
@@ -53,6 +53,20 @@ export const registerTestConnectionRoute = async (
                     ]),
                   }),
                 }),
+                schema.object({
+                  type: schema.string({
+                    validate: (value) => {
+                      if (
+                        value === AuthType.NoAuth ||
+                        value === AuthType.UsernamePasswordType ||
+                        value === AuthType.SigV4
+                      ) {
+                        return `Must not be no_auth or username_password or sigv4 for registered auth types`;
+                      }
+                    },
+                  }),
+                  credentials: schema.nullable(schema.any()),
+                }),
               ])
             ),
           }),