- Fix a bug in updateSettings where promise is not being exlicitly

returned, causing restore of setting being not awaitable
- Make makeDebugConfigurations to be awaitable
- Change launch to also update the key for ASLR disable settings
- Make the test properly set up and reset the settings that update the
launch config

Author: michael-weng

src/debugger/launch.ts

@@ -29,9 +29,13 @@ import { CI_DISABLE_ASLR } from "./lldb";
  * @param ctx folder context to create launch configurations for
  * @param yes automatically answer yes to dialogs
  */
-export async function makeDebugConfigurations(ctx: FolderContext, message?: string, yes = false) {
+export async function makeDebugConfigurations(
+    ctx: FolderContext,
+    message?: string,
+    yes = false
+): Promise<boolean> {
     if (!configuration.folder(ctx.workspaceFolder).autoGenerateLaunchConfigurations) {
-        return;
+        return false;
     }
     const wsLaunchSection = vscode.workspace.getConfiguration("launch", ctx.folder);
     const launchConfigs = wsLaunchSection.get<vscode.DebugConfiguration[]>("configurations") || [];
@@ -41,6 +45,8 @@ export async function makeDebugConfigurations(ctx: FolderContext, message?: stri
         "cwd",
         "preLaunchTask",
         "type",
+        "disableASLR",
+        "initCommands",
         `env.${swiftLibraryPathKey()}`,
     ];
     const configUpdates: { index: number; config: vscode.DebugConfiguration }[] = [];
@@ -96,6 +102,7 @@ export async function makeDebugConfigurations(ctx: FolderContext, message?: stri
             vscode.ConfigurationTarget.WorkspaceFolder
         );
     }
+    return true;
 }
 
 // Return debug launch configuration for an executable in the given folder

test/integration-tests/commands/build.test.ts

@@ -25,10 +25,12 @@ import { Commands } from "../../../src/commands";
 import { makeDebugConfigurations } from "../../../src/debugger/launch";
 import { Workbench } from "../../../src/utilities/commands";
 import { continueSession, waitForDebugAdapterCommand } from "../../utilities/debug";
+import { SettingsMap, updateSettings } from "../testexplorer/utilities";
 
 suite("Build Commands", function () {
     let folderContext: FolderContext;
     let workspaceContext: WorkspaceContext;
+    let settingsTeardown: () => Promise<SettingsMap>;
     const uri = testAssetUri("defaultPackage/Sources/PackageExe/main.swift");
     const breakpoints = [
         new vscode.SourceBreakpoint(new vscode.Location(uri, new vscode.Position(2, 0))),
@@ -40,10 +42,14 @@ suite("Build Commands", function () {
         folderContext = await folderContextPromise("defaultPackage");
         await workspaceContext.focusFolder(folderContext);
         await vscode.window.showTextDocument(uri);
-        makeDebugConfigurations(folderContext, undefined, true);
+        settingsTeardown = await updateSettings({
+            "swift.autoGenerateLaunchConfigurations": true,
+        });
+        await makeDebugConfigurations(folderContext, undefined, true);
     });
 
     suiteTeardown(async () => {
+        await settingsTeardown();
         await vscode.commands.executeCommand(Workbench.ACTION_CLOSEALLEDITORS);
     });
 

test/integration-tests/testexplorer/TestExplorerIntegration.test.ts

@@ -24,6 +24,7 @@ import {
     eventPromise,
     gatherTests,
     runTest,
+    SettingsMap,
     setupTestExplorerTest,
     waitForTestExplorerReady,
 } from "./utilities";
@@ -51,7 +52,7 @@ suite("Test Explorer Suite", function () {
     let testExplorer: TestExplorer;
 
     suite("Debugging", function () {
-        let settingsTeardown: () => void;
+        let settingsTeardown: () => Promise<SettingsMap>;
 
         async function runXCTest() {
             const suiteId = "PackageTests.PassingXCTestSuite";

test/integration-tests/testexplorer/utilities.ts

@@ -188,7 +188,7 @@ export type SettingsMap = { [key: string]: unknown };
  * "section.name" format, and the value is the new setting value.
  * @returns A function that, when called, resets the settings back to their original values.
  */
-export async function updateSettings(settings: SettingsMap): Promise<() => Promise<void>> {
+export async function updateSettings(settings: SettingsMap): Promise<() => Promise<SettingsMap>> {
     const applySettings = async (settings: SettingsMap) => {
         const savedOriginalSettings: SettingsMap = {};
         Object.keys(settings).forEach(async setting => {
@@ -224,9 +224,7 @@ export async function updateSettings(settings: SettingsMap): Promise<() => Promi
     const savedOriginalSettings = await applySettings(settings);
 
     // Clients call the callback to reset updated settings to their original value
-    return async () => {
-        await applySettings(savedOriginalSettings);
-    };
+    return async () => await applySettings(savedOriginalSettings);
 }
 
 /**