Unit test for QueryUtils, application, plugin

common/utils/QueryUtils.test.ts

@@ -0,0 +1,57 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { retrieveQueryById } from './QueryUtils'; // Update with the correct path
+const mockHttpGet = jest.fn();
+const mockCore = { http: { get: mockHttpGet } };
+
+describe('retrieveQueryById', () => {
+  const dataSourceId = 'test-ds';
+  const start = '2025-01-01T00:00:00Z';
+  const end = '2025-01-31T23:59:59Z';
+  const id = '1e5fde5b-c85f-419e-b8b6-3f43b3da4d59';
+
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it('should return the top query', async () => {
+    mockHttpGet.mockImplementation((endpoint) => {
+      if (endpoint.includes('latency')) {
+        return Promise.resolve({
+          response: {
+            top_queries: [
+              {
+                id: '1e5fde5b-c85f-419e-b8b6-3f43b3da4d59',
+                query: JSON.stringify({ match: { user_action: 'login_attempt' } }),
+              },
+            ],
+          },
+        });
+      }
+      return Promise.resolve({ response: { top_queries: [] } });
+    });
+
+    const result = await retrieveQueryById(mockCore, dataSourceId, start, end, id);
+    expect(result).toEqual({
+      id: '1e5fde5b-c85f-419e-b8b6-3f43b3da4d59',
+      query: JSON.stringify({ match: { user_action: 'login_attempt' } }),
+    });
+  });
+
+  it('should return null if no top queries are found', async () => {
+    mockHttpGet.mockResolvedValue({ response: { top_queries: [] } });
+
+    const result = await retrieveQueryById(mockCore, dataSourceId, start, end, id);
+    expect(result).toBeNull();
+  });
+
+  it('should handle API errors gracefully and return null', async () => {
+    mockHttpGet.mockRejectedValue(new Error('API error'));
+
+    const result = await retrieveQueryById(mockCore, dataSourceId, start, end, id);
+    expect(result).toBeNull();
+  });
+});

public/application.test.tsx

@@ -0,0 +1,54 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import React from 'react';
+import { HashRouter as Router } from 'react-router-dom';
+import * as ReactDOM from 'react-dom';
+import { renderApp } from './application';
+import { QueryInsightsDashboardsApp } from './components/app';
+
+jest.mock('react-dom', () => {
+  const actualReactDOM = jest.requireActual('react-dom');
+  return {
+    ...actualReactDOM,
+    render: jest.fn(),
+    unmountComponentAtNode: jest.fn(),
+  };
+});
+describe('renderApp', () => {
+  const coreMock = {};
+  const depsStartMock = {};
+  const paramsMock = { element: document.createElement('div') };
+  const dataSourceManagementMock = {};
+
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it('should render the QueryInsightsDashboardsApp component inside Router', () => {
+    const unmount = renderApp(coreMock, depsStartMock, paramsMock, dataSourceManagementMock);
+
+    expect(ReactDOM.render).toHaveBeenCalledWith(
+      <Router>
+        <QueryInsightsDashboardsApp
+          core={coreMock}
+          depsStart={depsStartMock}
+          params={paramsMock}
+          dataSourceManagement={dataSourceManagementMock}
+        />
+      </Router>,
+      paramsMock.element
+    );
+
+    expect(typeof unmount).toBe('function');
+  });
+
+  it('should unmount the component when the returned function is called', () => {
+    const unmount = renderApp(coreMock, depsStartMock, paramsMock, dataSourceManagementMock);
+    unmount();
+
+    expect(ReactDOM.unmountComponentAtNode).toHaveBeenCalledWith(paramsMock.element);
+  });
+});

public/plugin.test.tsx

@@ -0,0 +1,76 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { CoreSetup, CoreStart } from '../../../src/core/public';
+import { QueryInsightsDashboardsPlugin } from './plugin';
+import { PLUGIN_NAME } from '../common';
+import { renderApp } from './application';
+
+jest.mock('./application', () => ({
+  renderApp: jest.fn(),
+}));
+
+describe('QueryInsightsDashboardsPlugin', () => {
+  let plugin: QueryInsightsDashboardsPlugin;
+  let coreSetupMock: jest.Mocked<CoreSetup>;
+  let coreStartMock: jest.Mocked<CoreStart>;
+  let registerMock: jest.Mock;
+  let addNavLinksMock: jest.Mock;
+
+  beforeEach(() => {
+    coreSetupMock = ({
+      application: {
+        register: jest.fn(),
+      },
+      chrome: {
+        navGroup: {
+          addNavLinksToGroup: jest.fn(),
+        },
+      },
+      getStartServices: jest.fn().mockResolvedValue([coreStartMock, {}]),
+    } as unknown) as jest.Mocked<CoreSetup>;
+
+    coreStartMock = {} as jest.Mocked<CoreStart>;
+
+    plugin = new QueryInsightsDashboardsPlugin();
+    registerMock = coreSetupMock.application.register;
+    addNavLinksMock = coreSetupMock.chrome.navGroup.addNavLinksToGroup;
+  });
+
+  it('should register the application in setup', () => {
+    plugin.setup(coreSetupMock, {} as any);
+
+    expect(registerMock).toHaveBeenCalledWith(
+      expect.objectContaining({
+        id: PLUGIN_NAME,
+        title: 'Query Insights',
+      })
+    );
+  });
+
+  it('should mount the application correctly', async () => {
+    plugin.setup(coreSetupMock, {} as any);
+
+    const appRegistration = registerMock.mock.calls[0][0];
+    expect(appRegistration).toBeDefined();
+
+    const paramsMock = { element: document.createElement('div') };
+    const mountFunction = appRegistration.mount;
+
+    await mountFunction(paramsMock);
+
+    expect(renderApp).toHaveBeenCalled();
+  });
+
+  it('should add the navigation link to nav group', () => {
+    plugin.setup(coreSetupMock, {} as any);
+    expect(addNavLinksMock).toHaveBeenCalled();
+  });
+
+  it('should return empty start and stop methods', () => {
+    expect(plugin.start(coreStartMock)).toEqual({});
+    expect(plugin.stop()).toBeUndefined();
+  });
+});