Adding CMSIS_PACK_ROOT handling by default for pyOCD (#120)

* adding cmsisPackRoot to the list of environment configuration interface

* setting default value for cmsisPackRoot if it's not set by user

* adding CMSIS_PACK_ROOT variable by default if it's not set

* editing for readability

Author: omarArm

src/debug-configuration/gdbtarget-configuration.ts

@@ -16,10 +16,8 @@
 
 import * as vscode from 'vscode';
 
-interface EnvironmentConfiguration {
-    additionalProperties?: string;
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    default?: any;
+interface TargetEnvironmentConfiguration {
+    CMSIS_PACK_ROOT?: string;
 };
 
 interface ImageAndSymbolsConfiguration {
@@ -46,8 +44,7 @@ export interface TargetConfiguration {
     host?: string;
     port?: string;
     cwd?: string;
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    environment?: any;
+    environment?: TargetEnvironmentConfiguration;
     server?: string;
     serverParameters?: string[];
     serverPortRegExp?: string;
@@ -64,7 +61,8 @@ export interface GDBTargetConfiguration extends vscode.DebugConfiguration {
     program?: string; // required as per 'gdbtarget' debugger contribution, but can be omitted anyway
     gdb?: string;
     cwd?: string;
-    environment?: EnvironmentConfiguration;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    environment?: any;
     gdbAsync?: boolean;
     gdbNonStop?: boolean;
     verbose?: boolean;

src/debug-configuration/subproviders/pyocd-configuration-provider.ts

@@ -18,6 +18,8 @@ import { logger } from '../../logger';
 import { GDBTargetConfiguration, TargetConfiguration } from '../gdbtarget-configuration';
 import { BuiltinToolPath } from '../../desktop/builtin-tool-path';
 import { BaseConfigurationProvider } from './base-configuration-provider';
+import * as os from 'os';
+import * as path from 'path';
 
 const PYOCD_BUILTIN_PATH = 'tools/pyocd/pyocd';
 const PYOCD_EXECUTABLE_ONLY_REGEXP = /^\s*pyocd(|.exe)\s*$/i;
@@ -39,6 +41,23 @@ export class PyocdConfigurationProvider extends BaseConfigurationProvider {
         }
     }
 
+    protected resolveCmsisPackRootPath(target: TargetConfiguration): void {
+        const environmentValue = process.env['CMSIS_PACK_ROOT'];
+        if (environmentValue) {
+            return;
+        }
+
+        if (target.environment?.CMSIS_PACK_ROOT) {
+            return;
+        }
+        const cmsisPackRootDefault = os.platform() === 'win32'
+            ? path.join(process.env['LOCALAPPDATA'] ?? os.homedir(), 'Arm', 'Packs')
+            : path.join(os.homedir(), '.cache', 'arm', 'packs');
+
+        target.environment ??= {};
+        target.environment.CMSIS_PACK_ROOT = cmsisPackRootDefault;
+    }
+
     protected async resolveServerParameters(debugConfiguration: GDBTargetConfiguration): Promise<GDBTargetConfiguration> {
         logger.debug('Resolving pyOCD server parameters');
         if (!debugConfiguration.target) {
@@ -64,6 +83,8 @@ export class PyocdConfigurationProvider extends BaseConfigurationProvider {
         if (cbuildRunFile && await this.shouldAppendParameter(parameters, PYOCD_CLI_ARG_CBUILDRUN)) {
             parameters.push(PYOCD_CLI_ARG_CBUILDRUN, `${cbuildRunFile}`);
         }
+        // CMSIS_PACK_ROOT
+        this.resolveCmsisPackRootPath(debugConfiguration.target);
         return debugConfiguration;
     }