showing lock status on component viewer instances (#836)

* showing lock status on component viewer instances

* removing redundant behaviour

Author: omarArm

src/views/component-viewer/component-viewer-tree-view.ts

@@ -37,7 +37,14 @@ export class ComponentViewerTreeDataProvider implements vscode.TreeDataProvider<
             : vscode.TreeItemCollapsibleState.None;
         // Needs fixing, getGuiValue() for ScvdNode returns 0 when undefined
         treeItem.description = element.getGuiValue() ?? '';
-        const intermediateContextValue = element.isRootInstance ? 'parentInstance' : 'child';
+        let intermediateContextValue = '';
+        if (element.isRootInstance) {
+            intermediateContextValue = 'parentInstance';
+            if (element.isLocked) {
+                treeItem.iconPath = new vscode.ThemeIcon('lock');
+            }
+        }
+
         treeItem.contextValue = element.isLocked ? `locked.${intermediateContextValue}` : intermediateContextValue;
         const guiId = element.getGuiId();
         if (guiId !== undefined) {

src/views/component-viewer/test/unit/component-viewer-tree-view.test.ts

@@ -30,6 +30,13 @@ jest.mock('vscode', () => {
         public event = jest.fn();
     }
 
+    class ThemeIcon {
+        public id: string;
+
+        constructor(id: string) {
+            this.id = id;
+        }
+    }
     class MarkdownString {
         public value: string;
         public supportHtml = false;
@@ -46,6 +53,7 @@ jest.mock('vscode', () => {
         public tooltip: string | MarkdownString | undefined;
         public id: string | undefined;
         public contextValue: string | undefined;
+        public iconPath: vscode.ThemeIcon | undefined;
 
         constructor(label: string) {
             this.label = label;
@@ -56,6 +64,7 @@ jest.mock('vscode', () => {
         EventEmitter,
         MarkdownString,
         TreeItem,
+        ThemeIcon,
         TreeItemCollapsibleState: {
             Collapsed: 1,
             None: 0,
@@ -173,7 +182,21 @@ describe('ComponentViewerTreeDataProvider', () => {
         expect(rootItem.contextValue).toBe('locked.parentInstance');
 
         const childItem = provider.getTreeItem(childUnlocked);
-        expect(childItem.contextValue).toBe('child');
+        expect(childItem.contextValue).toBe('');
+    });
+
+    it('assigns lock icon for locked root nodes', () => {
+        const provider = new ComponentViewerTreeDataProvider();
+        const rootLocked = makeGui({ isRootInstance: true, isLocked: true });
+        const rootUnLocked = makeGui({ isRootInstance: true, isLocked: false });
+
+        const rootItem = provider.getTreeItem(rootLocked);
+        expect(rootItem.iconPath).toBeInstanceOf(vscode.ThemeIcon);
+        const rootIcon = rootItem.iconPath as { id: string };
+        expect(rootIcon.id).toBe('lock');
+
+        const rootUnLockedItem = provider.getTreeItem(rootUnLocked);
+        expect(rootUnLockedItem.iconPath).toBeUndefined();
     });
 
     it('returns root children when no element is provided', async () => {

tsconfig.json

@@ -15,6 +15,9 @@
         "noImplicitAny": true,
         "noFallthroughCasesInSwitch": true,
         "exactOptionalPropertyTypes": true,
+        "types": [
+            "jest"
+        ]
     },
     "include": [
         "src"