Refactoring addPyocdToPath to make it useable for adding more built-in tools to the PATH variable (#359)

* Added a function to add built-in GDB to PATH of extension host
* refactoring addPyocdToPath and addGdbToPath into one function

Author: omarArm

src/desktop/add-to-path.test.ts

@@ -15,7 +15,7 @@
  */
 
 import * as vscode from 'vscode';
-import { addPyocdToPath } from './add-to-path';
+import { addToolToPath } from './add-to-path';
 import { BuiltinToolPath } from './builtin-tool-path';
 import { extensionContextFactory } from '../__test__/vscode.factory';
 import { isWindows } from '../utils';
@@ -24,7 +24,7 @@ jest.mock('./builtin-tool-path');
 const pathPyOCD = 'tools/pyocd/pyocd';
 const BuiltinToolPathMock = BuiltinToolPath as jest.MockedClass<typeof BuiltinToolPath>;
 
-describe('addPyocdToPath', () => {
+describe('addToolToPath', () => {
     let extensionMock: vscode.ExtensionContext;
     beforeEach(() => {
         extensionMock = extensionContextFactory();
@@ -46,7 +46,7 @@ describe('addPyocdToPath', () => {
             value: 'pathPyOCD'
         });
 
-        addPyocdToPath(extensionMock);
+        addToolToPath(extensionMock, pathPyOCD);
 
         expect(extensionMock.environmentVariableCollection.prepend).toHaveBeenCalledWith('PATH', expect.stringContaining(pathPyOCD));
     });
@@ -58,7 +58,7 @@ describe('addPyocdToPath', () => {
 
         BuiltinToolPathMock.mockImplementation(() => mockInstance);
 
-        addPyocdToPath(extensionMock);
+        addToolToPath(extensionMock, pathPyOCD);
 
         expect(extensionMock.environmentVariableCollection.prepend).not.toHaveBeenCalled();
     });
@@ -75,7 +75,7 @@ describe('addPyocdToPath', () => {
             value: `/already/included/path${isWindows ? ';' : ':'}`
         });
 
-        addPyocdToPath(extensionMock);
+        addToolToPath(extensionMock, pathPyOCD);
 
         expect(extensionMock.environmentVariableCollection.prepend).not.toHaveBeenCalled();
     });

src/desktop/add-to-path.ts

@@ -20,19 +20,19 @@ import { logger } from '../logger';
 import { isWindows } from '../utils';
 import { BuiltinToolPath } from './builtin-tool-path';
 
-const PYOCD_BUILTIN_PATH = 'tools/pyocd/pyocd';
-
-export function addPyocdToPath(context: vscode.ExtensionContext): void {
-    //get pyOCD path from tools folder
-    const builtinPyocd = new BuiltinToolPath(PYOCD_BUILTIN_PATH);
-    const pathPyOCD = builtinPyocd.getAbsolutePathDir();
-    if (!pathPyOCD) {
-        logger.debug('pyOCD is not available');
+export function addToolToPath(context: vscode.ExtensionContext, toolToAdd: string): void {
+    // get gdb path from tools folder
+    const builtinTool = new BuiltinToolPath(toolToAdd);
+    const pathTool = builtinTool.getAbsolutePathDir();
+    // check if path exists
+    if (!pathTool) {
+        logger.debug(`${toolToAdd} is not available`);
         return;
     }
+    // add a delimiter and prepare gdb path to be added to PATH variable
     const delimiter = isWindows ? ';' : ':';
-    const updatePath = `${pathPyOCD}${delimiter}`;
-    //get current environment variable collection
+    const updatePath = `${pathTool}${delimiter}`;
+    // get current environment variable collection
     const mutator = context.environmentVariableCollection.get('PATH');
     // Path included and previously used type was 'Prepend'. Change mutator
     // if other type (we previously used 'Replace' which caused trouble).
@@ -43,3 +43,4 @@ export function addPyocdToPath(context: vscode.ExtensionContext): void {
     //add updated path to PATH variable, but only for the terminal inside of vscode
     context.environmentVariableCollection.prepend('PATH', updatePath);
 }
+

src/desktop/extension.ts

@@ -18,13 +18,15 @@ import * as vscode from 'vscode';
 import { GDBTargetDebugTracker } from '../debug-configuration/gdbtarget-debug-tracker';
 import { GDBTargetConfigurationProvider } from '../debug-configuration';
 import { logger } from '../logger';
-import { addPyocdToPath } from './add-to-path';
+import { addToolToPath } from './add-to-path';
+
+const PYOCD_BUILTIN_PATH = 'tools/pyocd/pyocd';
 
 export const activate = async (context: vscode.ExtensionContext): Promise<void> => {
     const gdbtargetDebugTracker = new GDBTargetDebugTracker();
     const gdbtargetConfigurationProvider = new GDBTargetConfigurationProvider();
 
-    addPyocdToPath(context);
+    addToolToPath(context, PYOCD_BUILTIN_PATH);
     // Activate components
     gdbtargetDebugTracker.activate(context);
     gdbtargetConfigurationProvider.activate(context);