@itwin/reports-config-widget-react 0.1.0 → 0.2.1

package/reports-config-widget-react.build.log

@@ -1,55 +1,60 @@
 Invoking: npm test -- --coverage 
 
 
-> @itwin/reports-config-widget-react@0.0.8 test /home/vsts/work/1/s/packages/itwin/reports-config-widget
+> @itwin/reports-config-widget-react@0.2.0 test /home/vsts/work/1/s/packages/itwin/reports-config-widget
 > jest "--coverage"
 
-PASS src/test/ReportMappings.test.tsx (44.264 s)
-PASS src/test/Reports.test.tsx (10.883 s)
-PASS src/test/ReportAction.test.tsx (6.943 s)
+PASS src/test/ReportMappings.test.tsx (9.915 s)
+PASS src/test/ReportMappingHorizontalTile.test.tsx
+PASS src/test/Reports.test.tsx (7.469 s)
+PASS src/test/BulkExtractor.test.ts
+PASS src/test/AddMappingModal.test.tsx
+PASS src/test/ReportAction.test.tsx
+PASS src/test/DeleteModal.test.tsx
 PASS src/test/WidgetHeader.test.tsx
-----------------------------------------|---------|----------|---------|---------|-------------------------------
-File                                    | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s             
-----------------------------------------|---------|----------|---------|---------|-------------------------------
-All files                               |   77.63 |    62.45 |   70.73 |   77.55 |                               
- src                                    |     100 |       75 |     100 |     100 |                               
-  ReportsConfigWidget.ts                |     100 |       75 |     100 |     100 | 21                            
- src/test                               |     100 |    66.66 |     100 |     100 |                               
-  test-utils.tsx                        |     100 |    66.66 |     100 |     100 | 56                            
- src/widget                             |      40 |        0 |       0 |      40 |                               
-  ReportsConfigUiProvider.tsx           |      40 |        0 |       0 |      40 | 23-65                         
- src/widget/components                  |   76.48 |    64.31 |   71.94 |    76.6 |                               
-  ActionPanel.tsx                       |     100 |    77.77 |     100 |     100 | 25-26                         
-  AddMappingsModal.tsx                  |   91.66 |    83.33 |   88.88 |   93.47 | 40,120,134                    
-  BulkExtractor.ts                      |   16.45 |        0 |    6.66 |   16.66 | 36-154                        
-  Constants.ts                          |     100 |      100 |     100 |     100 |                               
-  DeleteModal.tsx                       |      85 |      100 |      50 |   84.21 | 42,56-87                      
-  Extraction.tsx                        |   85.41 |    79.48 |   85.71 |   85.71 | 51-53,138,200-203,226-229,295 
-  ExtractionStatus.tsx                  |   51.42 |       20 |   16.66 |   53.12 | 33-68                         
-  HorizontalTile.tsx                    |     100 |      100 |     100 |     100 |                               
-  LocalizedTablePaginator.tsx           |     100 |       50 |     100 |     100 | 25                            
-  ReportAction.tsx                      |   94.28 |    81.48 |     100 |   94.28 | 59-60                         
-  ReportHorizontalTile.tsx              |   70.73 |       56 |   72.72 |   69.23 | 43-45,57-63,124-125           
-  ReportMappings.tsx                    |   96.34 |    73.68 |   94.44 |   96.29 | 98,120,265                    
-  Reports.tsx                           |   92.04 |    78.84 |   83.33 |   95.18 | 124,131-133                   
-  ReportsContainer.tsx                  |   57.14 |        0 |       0 |   61.53 | 19,25-37                      
-  SearchBar.tsx                         |   70.58 |    71.42 |      60 |   68.75 | 31-45                         
-  SelectIModel.tsx                      |   97.05 |    81.81 |   85.71 |   96.87 | 92                            
-  utils.tsx                             |    64.7 |    30.76 |     100 |   58.13 | 51-94                         
- src/widget/components/ExtractionStates |   84.37 |        0 |       0 |   81.48 |                               
-  FailedExtractionState.tsx             |   85.71 |        0 |       0 |   83.33 | 16                            
-  QueuedExtractionState.tsx             |   83.33 |      100 |       0 |      80 | 10                            
-  RunningExtractionState.tsx            |   83.33 |      100 |       0 |      80 | 10                            
-  StartingExtractionState.tsx           |   83.33 |      100 |       0 |      80 | 10                            
-  SucceededExtractionState.tsx          |   85.71 |        0 |       0 |   83.33 | 16                            
- src/widget/context                     |      80 |        0 |      50 |   77.77 |                               
-  ReportsApiConfigContext.tsx           |      80 |        0 |      50 |   77.77 | 15,22                         
- src/widget/hooks                       |     100 |      100 |     100 |     100 |                               
-  useValidator.ts                       |     100 |      100 |     100 |     100 |                               
-----------------------------------------|---------|----------|---------|---------|-------------------------------
+----------------------------------------|---------|----------|---------|---------|-------------------------------------
+File                                    | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s                   
+----------------------------------------|---------|----------|---------|---------|-------------------------------------
+All files                               |   86.69 |    65.94 |   79.76 |   86.79 |                                     
+ src                                    |     100 |       75 |     100 |     100 |                                     
+  ReportsConfigWidget.ts                |     100 |       75 |     100 |     100 | 21                                  
+ src/test                               |     100 |    66.66 |     100 |     100 |                                     
+  test-utils.tsx                        |     100 |    66.66 |     100 |     100 | 56                                  
+ src/widget                             |      40 |        0 |       0 |      40 |                                     
+  ReportsConfigUiProvider.tsx           |      40 |        0 |       0 |      40 | 23-65                               
+ src/widget/components                  |   86.37 |    67.81 |   79.72 |   86.64 |                                     
+  ActionPanel.tsx                       |     100 |    77.77 |     100 |     100 | 25-26                               
+  AddMappingsModal.tsx                  |   91.66 |    83.33 |   88.88 |   93.33 | 40,120,134                          
+  BulkExtractor.ts                      |      85 |    76.19 |   86.66 |   85.41 | 108,117-119,124-132,159-161,169-171 
+  Constants.ts                          |     100 |      100 |     100 |     100 |                                     
+  DeleteModal.tsx                       |      90 |      100 |      75 |   89.47 | 42,56                               
+  ExtractionStatus.tsx                  |   94.28 |       90 |   83.33 |   96.87 | 63                                  
+  ExtractionToast.tsx                   |   58.33 |      100 |       0 |      50 | 18-22,36                            
+  HorizontalTile.tsx                    |     100 |      100 |     100 |     100 |                                     
+  LocalizedTablePaginator.tsx           |     100 |       50 |     100 |     100 | 25                                  
+  ReportAction.tsx                      |   94.28 |    81.48 |     100 |   94.28 | 59-60                               
+  ReportHorizontalTile.tsx              |    72.5 |       56 |   72.72 |   71.05 | 43-45,57-63,124                     
+  ReportMappingHorizontalTile.tsx       |   93.87 |      100 |   91.66 |   93.61 | 66-69                               
+  ReportMappings.tsx                    |   92.13 |    56.75 |      85 |   91.86 | 97,251,267-292                      
+  Reports.tsx                           |   90.21 |    78.84 |      76 |   93.18 | 73,77,134,141-143                   
+  ReportsContainer.tsx                  |   57.14 |        0 |       0 |   61.53 | 19,25-37                            
+  SearchBar.tsx                         |   70.58 |    71.42 |      60 |   68.75 | 31-45                               
+  SelectIModel.tsx                      |   97.05 |    81.81 |   85.71 |   96.87 | 92                                  
+  utils.tsx                             |   62.74 |    30.76 |    87.5 |   55.81 | 51-94,150                           
+ src/widget/components/ExtractionStates |   96.87 |       25 |      80 |   96.29 |                                     
+  FailedExtractionState.tsx             |   85.71 |        0 |       0 |   83.33 | 16                                  
+  QueuedExtractionState.tsx             |     100 |      100 |     100 |     100 |                                     
+  RunningExtractionState.tsx            |     100 |      100 |     100 |     100 |                                     
+  StartingExtractionState.tsx           |     100 |      100 |     100 |     100 |                                     
+  SucceededExtractionState.tsx          |     100 |       50 |     100 |     100 | 26                                  
+ src/widget/context                     |      80 |        0 |      50 |   77.77 |                                     
+  ReportsApiConfigContext.tsx           |      80 |        0 |      50 |   77.77 | 15,22                               
+ src/widget/hooks                       |     100 |      100 |     100 |     100 |                                     
+  useValidator.ts                       |     100 |      100 |     100 |     100 |                                     
+----------------------------------------|---------|----------|---------|---------|-------------------------------------
 
-Test Suites: 4 passed, 4 total
-Tests:       22 passed, 22 total
+Test Suites: 8 passed, 8 total
+Tests:       41 passed, 41 total
 Snapshots:   0 total
-Time:        67.274 s
+Time:        29.593 s
 Ran all test suites.

package/src/test/AddMappingModal.test.tsx

@@ -0,0 +1,315 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+import React from "react";
+import faker from "@faker-js/faker";
+import "@testing-library/jest-dom";
+import type {
+  IModelConnection,
+} from "@itwin/core-frontend";
+import { NoRenderApp } from "@itwin/core-frontend";
+import { ReportsConfigWidget } from "../ReportsConfigWidget";
+import {
+  render,
+  screen,
+  TestUtils,
+  waitFor,
+  within,
+} from "./test-utils";
+import * as moq from "typemoq";
+import type {
+  MappingSingle,
+  ReportMappingCollection,
+} from "@itwin/insights-client";
+import type { ReportMappingAndMapping } from "../widget/components/ReportMappings";
+import type { IModelOperations, OperationOptions } from "@itwin/imodels-client-management";
+import { IModelState } from "@itwin/imodels-client-management";
+import { AddMappingsModal } from "../widget/components/AddMappingsModal";
+import { EmptyLocalization } from "@itwin/core-common";
+
+const mockITwinId = faker.datatype.uuid();
+const mockIModelId1 = faker.datatype.uuid();
+const mockIModelId2 = faker.datatype.uuid();
+
+const mockReportId = faker.datatype.uuid();
+
+const mockIModelsResponse = [
+  {
+    iModel: {
+      id: mockIModelId1,
+      displayName: "rAnDoMdIsPlAynAmE1",
+      name: "rAnDomName1",
+      description: "rAnDoMDeScRiPtIoN1",
+      createdDateTime: "2021-10-04T22:13:50.397Z",
+      state: IModelState.Initialized,
+      projectId: mockITwinId,
+      extent: null,
+      _links: {
+        creator: {
+          href: "",
+        },
+        namedVersions: {
+          href: "",
+        },
+        changesets: {
+          href: "",
+        },
+      },
+    },
+  },
+  {
+    iModel: {
+      id: mockIModelId2,
+      displayName: "rAnDoMdIsPlAynAmE2",
+      name: "rAnDomName2",
+      description: "rAnDoMDeScRiPtIoN2",
+      createdDateTime: "2021-10-04T22:13:50.397Z",
+      state: IModelState.Initialized,
+      projectId: mockITwinId,
+      extent: null,
+      _links: {
+        creator: {
+          href: "",
+        },
+        namedVersions: {
+          href: "",
+        },
+        changesets: {
+          href: "",
+        },
+      },
+    },
+  },
+];
+
+const mockProjectIModels = {
+  iModels: mockIModelsResponse.map((iModel) => ({
+    id: iModel.iModel.id,
+    displayName: iModel.iModel.displayName,
+  })),
+  _links: {
+    self: {
+      href: "",
+    },
+    prev: null,
+    next: null,
+  },
+};
+
+const mockReportMappingsFactory = (): ReportMappingCollection => {
+  return {
+    mappings: [
+      {
+        reportId: mockReportId,
+        mappingId: faker.datatype.uuid(),
+        imodelId: mockIModelId1,
+        _links: {
+          report: {
+            href: "",
+          },
+          mapping: {
+            href: "",
+          },
+          imodel: {
+            href: "",
+          },
+        },
+      },
+      {
+        reportId: mockReportId,
+        mappingId: faker.datatype.uuid(),
+        imodelId: mockIModelId2,
+        _links: {
+          report: {
+            href: "",
+          },
+          mapping: {
+            href: "",
+          },
+          imodel: {
+            href: "",
+          },
+        },
+      },
+    ],
+    _links: {
+      next: undefined,
+      self: {
+        href: "",
+      },
+    },
+  };
+};
+
+const mockMappingsFactory = (
+  mockReportMappings: ReportMappingCollection
+): MappingSingle[] => {
+  const mockMappings: MappingSingle[] = mockReportMappings.mappings.map(
+    (mapping, index) => ({
+      mapping: {
+        id: mapping.mappingId,
+        mappingName: `mOcKMaPpIngNaMe${index}`,
+        description: `mOcKmApPInGDeScRiPtIoN${index}`,
+        extractionEnabled: false,
+        createdOn: "",
+        createdBy: "",
+        modifiedOn: "",
+        modifiedBy: "",
+        _links: {
+          imodel: {
+            // Tie the mapping to to the iModel Id
+            href: mapping.imodelId,
+          },
+        },
+      },
+    })
+  );
+
+  const extraMappingId = faker.datatype.uuid();
+  const extraMappingName = "mOcKNaMeExTrA";
+  const extraMappingDescription = "mOcKDeScRiPtIoNeXtRa";
+
+  mockMappings.push({
+    mapping: {
+      id: extraMappingId,
+      mappingName: extraMappingName,
+      description: extraMappingDescription,
+      extractionEnabled: false,
+      createdOn: "",
+      createdBy: "",
+      modifiedOn: "",
+      modifiedBy: "",
+      _links: {
+        imodel: {
+          href: "",
+        },
+      },
+    },
+  });
+
+  return mockMappings;
+};
+
+const mockReportMappingsAndMappingsFactory = (mockMappings: MappingSingle[], reportMappings: ReportMappingCollection): ReportMappingAndMapping[] => {
+  const reportMappingsAndMapping =
+    reportMappings.mappings.map((reportMapping) => {
+      const mapping = mockMappings.find((x) => x.mapping.id === reportMapping.mappingId)!.mapping;
+      const iModelName = mockProjectIModels.iModels.find((x) => x.id === reportMapping.imodelId)!.displayName;
+      const reportMappingAndMapping: ReportMappingAndMapping = {
+        ...reportMapping,
+        iModelName,
+        mappingName: mapping.mappingName,
+        mappingDescription: mapping.description ?? "",
+      };
+      return reportMappingAndMapping;
+    });
+  return reportMappingsAndMapping;
+};
+
+const connectionMock = moq.Mock.ofType<IModelConnection>();
+const mockIModelsClient = moq.Mock.ofType<IModelOperations<OperationOptions>>();
+
+jest.mock("@itwin/appui-react", () => ({
+  ...jest.requireActual("@itwin/appui-react"),
+  useActiveIModelConnection: () => connectionMock.object,
+}));
+
+jest.mock("@itwin/imodels-client-management", () => ({
+  ...jest.requireActual("@itwin/imodels-client-management"),
+  IModelsClient: jest.fn().mockImplementation(() => ({
+    iModels: mockIModelsClient.object,
+  })),
+  toArray: jest.fn().mockImplementation(async () => {
+    return mockProjectIModels.iModels;
+  }),
+}));
+
+const mockGetMappings = jest.fn();
+const mockCreateReportMapping = jest.fn();
+
+jest.mock("@itwin/insights-client", () => ({
+  ...jest.requireActual("@itwin/insights-client"),
+  MappingsClient: jest.fn().mockImplementation(() => ({
+    getMappings: mockGetMappings,
+  })),
+  ReportsClient: jest.fn().mockImplementation(() => ({
+    createReportMapping: mockCreateReportMapping,
+  })),
+}));
+
+beforeAll(async () => {
+  await NoRenderApp.startup({localization: new EmptyLocalization()});
+  connectionMock.setup((x) => x.iModelId).returns(() => mockIModelId1);
+  await ReportsConfigWidget.initialize();
+});
+
+afterAll(() => {
+  TestUtils.terminateUiFramework();
+});
+
+afterEach(() => {
+  mockGetMappings.mockReset();
+  mockIModelsClient.reset();
+});
+
+describe("Add Mapping Modal", () => {
+  it("Adding mapping sends create request", async () => {
+    const mockReportMappings = mockReportMappingsFactory();
+    const mockMappings = mockMappingsFactory(mockReportMappings);
+    const mockReportMappingsAndMappings = mockReportMappingsAndMappingsFactory(mockMappings, mockReportMappings);
+
+    mockGetMappings.mockReturnValueOnce(mockMappings.map((m: MappingSingle) => m.mapping));
+
+    const { user } = render(
+      <AddMappingsModal
+        show={true}
+        reportId={mockReportId}
+        existingMappings={mockReportMappingsAndMappings}
+        returnFn={jest.fn()}
+      />
+    );
+
+    expect(screen.getByRole("dialog")).toBeInTheDocument();
+    const modal = screen.getByRole("dialog");
+    const withinModal = within(modal);
+    expect(withinModal.getByText(/addmappings/i)).toBeInTheDocument();
+
+    const addButton = withinModal.getByRole("button", {
+      name: /add/i,
+    });
+    // Add button should be disabled
+    expect(addButton).toBeDisabled();
+
+    await waitFor(() => screen.getByRole("row"));
+
+    // Already mapped mappings are disabled
+    for (let i = 0; i < mockMappings.length - 1; i++) {
+      const row = screen.getByRole("row", {
+        name: new RegExp(
+          `${mockMappings[i].mapping.mappingName} ${mockMappings[i].mapping.description}`,
+          "i"
+        ),
+      });
+
+      const checkbox = within(row).getByRole("checkbox");
+      expect(checkbox).toBeDisabled();
+    }
+
+    // Click on checkbox on new mapping
+    const unmappedRow = screen.getByRole("row", {
+      name: new RegExp(
+        `${mockMappings[mockMappings.length - 1].mapping.mappingName
+        } ${mockMappings[mockMappings.length - 1].mapping.description}`,
+        "i"
+      ),
+    });
+
+    const enabledCheckbox = within(unmappedRow).getByRole("checkbox");
+
+    await user.click(enabledCheckbox);
+    await user.click(addButton);
+
+    expect(mockCreateReportMapping).toBeCalledTimes(1);
+  });
+});