Merge pull request #2112 from opossum-tool/introduce-qa-mode

Introduce QA mode

USER_GUIDE.md

@@ -375,3 +375,12 @@ In the audit view, an attributions can be marked as preferred, to indicate that
 Only signals with a source marked as `isRelevantForPreference` can be preferred over. If no signal source has this flag set, then the feature is disabled.
 
 To mark an attribution as preferred, choose an attribution in the audit view, and open the `...` context menu. From there, you can mark or unmark an attribution as preferred. When an attribution is marked as preferred, `preferred = true` is written to the .opossum file, and the origin IDs of all visible signals relevant for preference are written in the field `preferredOverOriginIds`. Preferred attributions are displayed with a star icon.
+
+Note that you are only able to mark an attribution as preferred (or unmark if it was preferred beforehand) if you are in
+"QA Mode". To enable this mode click the item "QA Mode" in the `View` submenu.
+
+![disabled_qa_mode](./docs/user_guide_screenshots/disabled_qa_mode.png)
+
+If "QA Mode" is enabled the icon will change as in the screenshot below.
+
+![enabled_qa_mode](./docs/user_guide_screenshots/enabled_qa_mode.png)

src/ElectronBackend/main/__tests__/iconHelpers.test.ts

@@ -0,0 +1,40 @@
+// SPDX-FileCopyrightText: Meta Platforms, Inc. and its affiliates
+// SPDX-FileCopyrightText: TNG Technology Consulting GmbH <https://www.tngtech.com>
+//
+// SPDX-License-Identifier: Apache-2.0
+
+import { Menu, MenuItem } from 'electron';
+import { makeFirstIconVisibleAndSecondHidden } from '../iconHelpers';
+
+jest.mock('electron', () => ({
+  Menu: {
+    setApplicationMenu: jest.fn(),
+    buildFromTemplate: jest.fn(),
+    getApplicationMenu: jest.fn(),
+  },
+}));
+jest.mock('electron-is-dev', () => false);
+
+describe('makeFirstIconVisibleAndSecondHidden', () => {
+  let toBeVisibleMenuItem: Partial<MenuItem>;
+  let toBeHiddenMenuItem: Partial<MenuItem>;
+
+  it('should make the first item visible and the second item hidden', () => {
+    toBeVisibleMenuItem = { visible: false };
+    toBeHiddenMenuItem = { visible: true };
+    (Menu.getApplicationMenu as jest.Mock).mockImplementation(() => ({
+      getMenuItemById: jest.fn().mockImplementation((id) => {
+        if (id === 'toBeVisibleMenuItem') return toBeVisibleMenuItem;
+        if (id === 'toBeHiddenMenuItem') return toBeHiddenMenuItem;
+      }),
+    }));
+
+    makeFirstIconVisibleAndSecondHidden(
+      'toBeVisibleMenuItem',
+      'toBeHiddenMenuItem',
+    );
+
+    expect(toBeVisibleMenuItem.visible).toBe(true);
+    expect(toBeHiddenMenuItem.visible).toBe(false);
+  });
+});

src/ElectronBackend/main/iconHelpers.ts

@@ -7,7 +7,7 @@ import isDev from 'electron-is-dev';
 import path from 'path';
 import upath from 'upath';
 import { getBasePathOfAssets } from './getPath';
-import electron from 'electron';
+import electron, { Menu } from 'electron';
 
 export function getIconPath(): string {
   const basePath = isDev
@@ -24,3 +24,14 @@ export function getIconBasedOnTheme(
     ? path.join(getBasePathOfAssets(), white_icon)
     : path.join(getBasePathOfAssets(), black_icon);
 }
+
+export function makeFirstIconVisibleAndSecondHidden(
+  firstItemId: string,
+  secondItemId: string,
+): void {
+  const itemToMakeVisible =
+    Menu.getApplicationMenu()?.getMenuItemById(firstItemId);
+  if (itemToMakeVisible) itemToMakeVisible.visible = true;
+  const itemToHide = Menu.getApplicationMenu()?.getMenuItemById(secondItemId);
+  if (itemToHide) itemToHide.visible = false;
+}

src/ElectronBackend/main/menu.ts

@@ -18,9 +18,13 @@ import {
 } from './notice-document-helpers';
 import { ExportType } from '../../shared/shared-types';
 import { isFileLoaded } from '../utils/getLoadedFile';
-import { getIconBasedOnTheme } from './iconHelpers';
+import {
+  getIconBasedOnTheme,
+  makeFirstIconVisibleAndSecondHidden,
+} from './iconHelpers';
 export function createMenu(mainWindow: BrowserWindow): Menu {
   const webContents = mainWindow.webContents;
+
   return Menu.buildFromTemplate([
     {
       label: 'File',
@@ -311,6 +315,42 @@ export function createMenu(mainWindow: BrowserWindow): Menu {
           label: 'Zoom Out',
           role: 'zoomOut',
         },
+        {
+          icon: getIconBasedOnTheme(
+            'icons/check-box-blank-white.png',
+            'icons/check-box-blank-black.png',
+          ),
+          label: 'QA Mode',
+          id: 'disabled-qa-mode',
+          click(): void {
+            makeFirstIconVisibleAndSecondHidden(
+              'enabled-qa-mode',
+              'disabled-qa-mode',
+            );
+            webContents.send(AllowedFrontendChannels.SetQAMode, {
+              qaMode: true,
+            });
+          },
+          visible: true,
+        },
+        {
+          icon: getIconBasedOnTheme(
+            'icons/check-box-white.png',
+            'icons/check-box-black.png',
+          ),
+          label: 'QA Mode',
+          id: 'enabled-qa-mode',
+          click(): void {
+            makeFirstIconVisibleAndSecondHidden(
+              'disabled-qa-mode',
+              'enabled-qa-mode',
+            );
+            webContents.send(AllowedFrontendChannels.SetQAMode, {
+              qaMode: false,
+            });
+          },
+          visible: false,
+        },
       ],
     },
     {

src/Frontend/Components/AttributionColumn/AttributionColumn.tsx

@@ -17,7 +17,10 @@ import {
   getTemporaryDisplayPackageInfo,
   wereTemporaryDisplayPackageInfoModified,
 } from '../../state/selectors/all-views-resource-selectors';
-import { getSelectedView } from '../../state/selectors/view-selector';
+import {
+  getQAMode,
+  getSelectedView,
+} from '../../state/selectors/view-selector';
 import {
   getDisplayedPackage,
   getResolvedExternalAttributions,
@@ -114,6 +117,7 @@ export function AttributionColumn(props: AttributionColumnProps): ReactElement {
   const wasPreferredFieldChanged: boolean =
     initialManualDisplayPackageInfo.preferred !==
     temporaryDisplayPackageInfo.preferred;
+  const qaMode = useAppSelector(getQAMode);
 
   const {
     isLicenseTextShown,
@@ -150,7 +154,7 @@ export function AttributionColumn(props: AttributionColumnProps): ReactElement {
       temporaryDisplayPackageInfo.preSelected,
     ),
     targetAttributionIsExternalAttribution: false,
-    isPreferenceFeatureEnabled,
+    isPreferenceFeatureEnabled: isPreferenceFeatureEnabled && qaMode,
     attributionIsPreferred: temporaryDisplayPackageInfo.preferred ?? false,
     view,
   });

src/Frontend/Components/AttributionColumn/__tests__/attribution-column-helpers.test.ts

@@ -216,7 +216,7 @@ describe('getMergeButtonsDisplayState', () => {
     });
   });
 
-  it('activates UnmarkAsPreferredButton when attribution is not preferred', () => {
+  it('deactivates UnmarkAsPreferredButton when attribution is not preferred in QA mode', () => {
     expect(
       getMergeButtonsDisplayState({
         attributionIdMarkedForReplacement: 'attr2',
@@ -239,7 +239,7 @@ describe('getMergeButtonsDisplayState', () => {
     });
   });
 
-  it('activates UnmarkAsPreferredButton when attribution is preferred', () => {
+  it('activates UnmarkAsPreferredButton when attribution is preferred in QA mode', () => {
     expect(
       getMergeButtonsDisplayState({
         attributionIdMarkedForReplacement: 'attr2',
@@ -284,6 +284,29 @@ describe('getMergeButtonsDisplayState', () => {
       hideUnmarkAsPreferredButton: true,
     });
   });
+
+  it('hides MarkAsPreferredButton & UnmarkAsPreferredButton when preference feature is disabled', () => {
+    expect(
+      getMergeButtonsDisplayState({
+        attributionIdMarkedForReplacement: 'attr2',
+        targetAttributionId: 'attr',
+        selectedAttributionId: 'attr',
+        packageInfoWereModified: false,
+        targetAttributionIsPreSelected: true,
+        targetAttributionIsExternalAttribution: false,
+        attributionIsPreferred: true,
+        view: View.Audit,
+        isPreferenceFeatureEnabled: false,
+      }),
+    ).toStrictEqual({
+      hideMarkForReplacementButton: false,
+      hideUnmarkForReplacementButton: true,
+      hideReplaceMarkedByButton: false,
+      deactivateReplaceMarkedByButton: true,
+      hideMarkAsPreferredButton: true,
+      hideUnmarkAsPreferredButton: true,
+    });
+  });
 });
 
 describe('getSelectedManualAttributionIdForAuditView', () => {

src/Frontend/Components/BackendCommunication/BackendCommunication.tsx

@@ -18,6 +18,7 @@ import {
   FileSupportPopupArgs,
   IsLoadingArgs,
   ParsedFileContent,
+  QAModeArgs,
 } from '../../../shared/shared-types';
 import { PopupType } from '../../enums/enums';
 import {
@@ -44,6 +45,7 @@ import { getFileWithChildrenCheck } from '../../util/is-file-with-children';
 import {
   openPopup,
   setIsLoading,
+  setQAMode,
 } from '../../state/actions/view-actions/view-actions';
 
 export function BackendCommunication(): ReactElement | null {
@@ -280,6 +282,15 @@ export function BackendCommunication(): ReactElement | null {
     }
   }
 
+  function setQAModeListener(
+    event: IpcRendererEvent,
+    qaModeArgs: QAModeArgs,
+  ): void {
+    if (qaModeArgs) {
+      dispatch(setQAMode(qaModeArgs.qaMode));
+    }
+  }
+
   useIpcRenderer(AllowedFrontendChannels.FileLoaded, fileLoadedListener, [
     dispatch,
   ]);
@@ -342,6 +353,9 @@ export function BackendCommunication(): ReactElement | null {
     showUpdateAppPopupListener,
     [dispatch],
   );
+  useIpcRenderer(AllowedFrontendChannels.SetQAMode, setQAModeListener, [
+    dispatch,
+  ]);
 
   return null;
 }

src/Frontend/Components/BackendCommunication/__tests__/BackendCommunication.test.tsx

@@ -16,7 +16,7 @@ import { Attributions, ExportType } from '../../../../shared/shared-types';
 describe('BackendCommunication', () => {
   it('renders an Open file icon', () => {
     renderComponentWithStore(<BackendCommunication />);
-    const expectedNumberOfCalls = 13;
+    const expectedNumberOfCalls = 14;
     expect(window.electronAPI.on).toHaveBeenCalledTimes(expectedNumberOfCalls);
     expect(window.electronAPI.on).toHaveBeenCalledWith(
       AllowedFrontendChannels.FileLoaded,
@@ -62,6 +62,10 @@ describe('BackendCommunication', () => {
       AllowedFrontendChannels.ShowLocatorPopup,
       expect.anything(),
     );
+    expect(window.electronAPI.on).toHaveBeenCalledWith(
+      AllowedFrontendChannels.SetQAMode,
+      expect.anything(),
+    );
   });
 
   it('filters the correct BOM attributions', () => {

src/Frontend/Components/TopBar/__tests__/TopBar.test.tsx

@@ -23,7 +23,7 @@ import { setResources } from '../../../state/actions/resource-actions/all-views-
 describe('TopBar', () => {
   it('renders an Open file icon', () => {
     const { store } = renderComponentWithStore(<TopBar />);
-    const totalNumberOfCalls = 13;
+    const totalNumberOfCalls = 14;
     expect(window.electronAPI.on).toHaveBeenCalledTimes(totalNumberOfCalls);
     expect(window.electronAPI.on).toHaveBeenCalledWith(
       AllowedFrontendChannels.FileLoaded,
@@ -69,6 +69,10 @@ describe('TopBar', () => {
       AllowedFrontendChannels.ShowLocatorPopup,
       expect.anything(),
     );
+    expect(window.electronAPI.on).toHaveBeenCalledWith(
+      AllowedFrontendChannels.SetQAMode,
+      expect.anything(),
+    );
 
     fireEvent.click(screen.queryByLabelText('open file') as Element);
     expect(store.getState().resourceState).toMatchObject(initialResourceState);

src/Frontend/integration-tests/audit-view-tests/__tests__/audit-view.test.tsx

@@ -25,7 +25,10 @@ import {
   ResourcesToAttributions,
   SaveFileArgs,
 } from '../../../../shared/shared-types';
-import { renderComponentWithStore } from '../../../test-helpers/render-component-with-store';
+import {
+  createTestAppStore,
+  renderComponentWithStore,
+} from '../../../test-helpers/render-component-with-store';
 import { ButtonText, PackagePanelTitle } from '../../../enums/enums';
 import {
   clickAddIconOnCardInAttributionList,
@@ -59,6 +62,7 @@ import {
   expectReplaceAttributionPopupIsNotShown,
   expectReplaceAttributionPopupIsShown,
 } from '../../../test-helpers/popup-test-helpers';
+import { setQAMode } from '../../../state/actions/view-actions/view-actions';
 
 describe('The App in Audit View', () => {
   it('renders TopBar and no ResourceBrowser when no resource file has been loaded', () => {
@@ -575,7 +579,7 @@ describe('The App in Audit View', () => {
     );
   });
 
-  it('preferred button is shown and sets an attribution as preferred', () => {
+  it('preferred button is shown and sets an attribution as preferred if QA mode is enabled', () => {
     function getExpectedSaveFileArgs(
       preferred: boolean,
       preferredOverOriginIds?: Array<string>,
@@ -644,7 +648,9 @@ describe('The App in Audit View', () => {
         resourcesToExternalAttributions: testResourcesToExternalAttributions,
       }),
     );
-    renderComponentWithStore(<App />);
+    const testStore = createTestAppStore();
+    renderComponentWithStore(<App />, { store: testStore });
+    testStore.dispatch(setQAMode(true));
     clickOnButton(screen, ButtonText.Close);
 
     clickOnElementInResourceBrowser(screen, 'file');
@@ -673,7 +679,7 @@ describe('The App in Audit View', () => {
     expect(window.electronAPI.saveFile).toHaveBeenCalledTimes(2);
   });
 
-  it('after setting an attribution to preferred, global save is disabled', () => {
+  it('after setting an attribution to preferred in QA mode, global save is disabled', () => {
     const testResources: Resources = {
       file: 1,
       other_file: 1,
@@ -705,7 +711,9 @@ describe('The App in Audit View', () => {
         },
       }),
     );
-    renderComponentWithStore(<App />);
+    const testStore = createTestAppStore();
+    renderComponentWithStore(<App />, { store: testStore });
+    testStore.dispatch(setQAMode(true));
     clickOnButton(screen, ButtonText.Close);
 
     clickOnElementInResourceBrowser(screen, 'file');

src/Frontend/state/actions/view-actions/__tests__/view-actions.test.ts

@@ -11,6 +11,7 @@ import {
   getIsLoading,
   getOpenPopup,
   getPopupAttributionId,
+  getQAMode,
   getSelectedView,
   getTargetView,
   isAttributionViewSelected,
@@ -23,6 +24,7 @@ import {
   openPopup,
   resetViewState,
   setIsLoading,
+  setQAMode,
   setTargetView,
   updateActiveFilters,
 } from '../view-actions';
@@ -159,6 +161,15 @@ describe('view actions', () => {
     testStore.dispatch(setIsLoading(false));
     expect(getIsLoading(testStore.getState())).toBe(false);
   });
+
+  it('sets and gets QA mode state', () => {
+    const testStore = createTestAppStore();
+    expect(getQAMode(testStore.getState())).toBe(false);
+    testStore.dispatch(setQAMode(true));
+    expect(getQAMode(testStore.getState())).toBe(true);
+    testStore.dispatch(setQAMode(false));
+    expect(getQAMode(testStore.getState())).toBe(false);
+  });
 });
 
 describe('popup actions', () => {