add integration tests for workspace ui settings wrapper

Signed-off-by: Yulong Ruan <ruanyl@amazon.com>

src/plugins/workspace/server/saved_objects/integration_tests/workspace_ui_settings_wrapper.test.ts

@@ -0,0 +1,88 @@
+import { IUiSettingsClient, WorkspaceAttribute } from 'src/core/server';
+
+import * as osdTestServer from '../../../../../core/test_helpers/osd_server';
+import { httpServerMock } from '../../../../../core/server/http/http_server.mocks';
+
+describe('workspace ui settings saved object client wrapper', () => {
+  let opensearchServer: osdTestServer.TestOpenSearchUtils;
+  let osd: osdTestServer.TestOpenSearchDashboardsUtils;
+  let globalUiSettingsClient: IUiSettingsClient;
+  let testWorkspace: WorkspaceAttribute = {
+    id: '',
+    name: '',
+  };
+
+  beforeAll(async () => {
+    const servers = osdTestServer.createTestServers({
+      adjustTimeout: (t: number) => jest.setTimeout(t),
+      settings: {
+        osd: {
+          workspace: {
+            enabled: true,
+          },
+          savedObjects: {
+            permission: {
+              enabled: true,
+            },
+          },
+          migrations: {
+            skip: false,
+          },
+        },
+      },
+    });
+    opensearchServer = await servers.startOpenSearch();
+    osd = await servers.startOpenSearchDashboards();
+
+    const savedObjectsClient = osd.coreStart.savedObjects.getScopedClient(
+      httpServerMock.createOpenSearchDashboardsRequest()
+    );
+    globalUiSettingsClient = osd.coreStart.uiSettings.asScopedToClient(savedObjectsClient);
+
+    const res = await osdTestServer.request.post(osd.root, '/api/workspaces').send({
+      attributes: { name: 'test workspace' },
+    });
+    testWorkspace = res.body.result;
+  }, 30000);
+
+  afterAll(async () => {
+    await opensearchServer.stop();
+    await osd.stop();
+  }, 30000);
+
+  beforeEach(async () => {
+    await globalUiSettingsClient.set('defaultIndex', 'global-index');
+  });
+
+  it('should get and update workspace ui settings when currently in a workspace', async () => {
+    const workspaceScopedSavedObjectsClient = osd.coreStart.savedObjects.getScopedClient(
+      httpServerMock.createOpenSearchDashboardsRequest({
+        opensearchDashboardsRequestState: { requestWorkspaceId: testWorkspace.id },
+      })
+    );
+    const workspaceScopedUiSettingsClient = osd.coreStart.uiSettings.asScopedToClient(
+      workspaceScopedSavedObjectsClient
+    );
+
+    expect(await globalUiSettingsClient.get('defaultIndex')).toBe('global-index');
+
+    // workspace defaultIndex is not set, it will use the global value
+    expect(await workspaceScopedUiSettingsClient.get('defaultIndex')).toBe('global-index');
+
+    // update ui settings in a workspace
+    await workspaceScopedUiSettingsClient.set('defaultIndex', 'workspace-index');
+
+    // global ui settings remain unchanged
+    expect(await globalUiSettingsClient.get('defaultIndex')).toBe('global-index');
+
+    // workspace ui settings updated to the new value
+    expect(await workspaceScopedUiSettingsClient.get('defaultIndex')).toBe('workspace-index');
+  });
+
+  it('should get and update global ui settings when currently not in a workspace', async () => {
+    expect(await globalUiSettingsClient.get('defaultIndex')).toBe('global-index');
+
+    await globalUiSettingsClient.set('defaultIndex', 'global-index-new');
+    expect(await globalUiSettingsClient.get('defaultIndex')).toBe('global-index-new');
+  });
+});