Merge pull request #6110 from dibarbet/unit_test_debug_options

Support unit test debugging options when attaching to unit test process

Author: dibarbet

package.json

@@ -393,7 +393,7 @@ export default class TestManager extends AbstractProvider {
         environmentVariables: Map<string, string>,
         debuggerEventsPipeName: string
     ) {
-        const debugOptions = vscode.workspace.getConfiguration('csharp').get('unitTestDebuggingOptions');
+        const debugOptions = this.optionProvider.GetLatestOptions().commonOptions.unitTestDebuggingOptions;
 
         // Get the initial set of options from the workspace setting
         let result: any;

src/features/dotnetTest.ts

@@ -577,7 +577,9 @@ export class RoslynLanguageServer {
         client.onRequest<RoslynProtocol.DebugAttachParams, RoslynProtocol.DebugAttachResult, void>(
             RoslynProtocol.DebugAttachRequest.type,
             async (request) => {
+                const debugOptions = this.optionProvider.GetLatestOptions().commonOptions.unitTestDebuggingOptions;
                 const debugConfiguration: vscode.DebugConfiguration = {
+                    ...debugOptions,
                     name: '.NET Core Attach',
                     type: 'coreclr',
                     request: 'attach',

src/lsptoolshost/roslynLanguageServer.ts

@@ -3,6 +3,7 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
+import { types } from 'util';
 import { ConfigurationTarget, vscode, WorkspaceConfiguration } from '../vscodeAdapter';
 
 // Option in the array should be identical to each other, except the name.
@@ -65,6 +66,10 @@ export const migrateOptions = [
         omnisharpOption: 'csharp.testsCodeLens.enabled',
         roslynOption: 'dotnet.codeLens.enableTestsCodeLens',
     },
+    {
+        omnisharpOption: 'csharp.unitTestDebuggingOptions',
+        roslynOption: 'dotnet.unitTestDebuggingOptions',
+    },
 ];
 
 export async function MigrateOptions(vscode: vscode): Promise<void> {
@@ -84,12 +89,25 @@ export async function MigrateOptions(vscode: vscode): Promise<void> {
             continue;
         }
 
-        if (roslynOptionValue == inspectionValueOfRoslynOption.defaultValue) {
+        if (shouldMove(roslynOptionValue, inspectionValueOfRoslynOption.defaultValue)) {
             await MoveOptionsValue(omnisharpOption, roslynOption, configuration);
         }
     }
 }
 
+function shouldMove(roslynOptionValue: unknown, defaultInspectValueOfRoslynOption: unknown): boolean {
+    if (roslynOptionValue == defaultInspectValueOfRoslynOption) {
+        return true;
+    }
+
+    // For certain kinds of complex object options, vscode will return a proxy object which isn't comparable to the default empty object {}.
+    if (types.isProxy(roslynOptionValue)) {
+        return JSON.stringify(roslynOptionValue) === JSON.stringify(defaultInspectValueOfRoslynOption);
+    }
+
+    return false;
+}
+
 async function MoveOptionsValue(
     fromOption: string,
     toOption: string,

src/shared/migrateOptions.ts

@@ -92,6 +92,13 @@ export class Options {
             }
         }
 
+        const unitTestDebuggingOptions = Options.readOption<object>(
+            config,
+            'dotnet.unitTestDebuggingOptions',
+            {},
+            'csharp.unitTestDebuggingOptions'
+        );
+
         // Omnisharp Server Options
 
         const monoPath = Options.readOption<string>(config, 'omnisharp.monoPath', '');
@@ -305,6 +312,7 @@ export class Options {
                 useOmnisharpServer: useOmnisharpServer,
                 excludePaths: excludePaths,
                 defaultSolution: defaultSolution,
+                unitTestDebuggingOptions: unitTestDebuggingOptions,
             },
             {
                 useModernNet: useModernNet,
@@ -437,6 +445,7 @@ export interface CommonOptions {
 
     /** The default solution; this has been normalized to a full file path from the workspace folder it was configured in, or the string "disable" if that has been disabled */
     defaultSolution: string;
+    unitTestDebuggingOptions: object;
 }
 
 const CommonOptionsThatTriggerReload: ReadonlyArray<keyof CommonOptions> = [

src/shared/options.ts

@@ -339,7 +339,7 @@ export function GenerateOptionsSchema() {
             'For debug extension development only: if a port is specified VS Code tries to connect to a debug adapter running in server mode',
         default: 4711,
     };
-    packageJSON.contributes.configuration[0].properties['csharp.unitTestDebuggingOptions'].properties =
+    packageJSON.contributes.configuration[1].properties['dotnet.unitTestDebuggingOptions'].properties =
         unitTestDebuggingOptions;
 
     // #region Generate package.json settings

src/tools/generateOptionsSchema.ts

@@ -14,6 +14,7 @@ export function getEmptyOptions(): Options {
             useOmnisharpServer: true,
             excludePaths: [],
             defaultSolution: '',
+            unitTestDebuggingOptions: {},
         },
         {
             useModernNet: false,