Fix nightly debugging test failures (#1388)

* change "swift-lldb" debug configs to "swift" in tests

* add option to disable CodeLLDB settings prompt

* don't use liblldb on Swift versions <5.10

* disable flaky dependency tests until they can be fixed

* bump timeout for package resolve v2 test

Author: matthewbastien

assets/test/.vscode/launch.json

@@ -1,7 +1,7 @@
 {
     "configurations": [
         {
-            "type": "swift-lldb",
+            "type": "swift",
             "request": "launch",
             "name": "Debug PackageExe (defaultPackage)",
             "program": "${workspaceFolder:test}/defaultPackage/.build/debug/PackageExe",
@@ -12,7 +12,7 @@
             "initCommands": ["settings set target.disable-aslr false"],
         },
         {
-            "type": "swift-lldb",
+            "type": "swift",
             "request": "launch",
             "name": "Release PackageExe (defaultPackage)",
             "program": "${workspaceFolder:test}/defaultPackage/.build/release/PackageExe",

assets/test/.vscode/settings.json

@@ -1,7 +1,8 @@
 {
     "swift.disableAutoResolve": true,
     "swift.autoGenerateLaunchConfigurations": false,
-    "swift.debugger.useDebugAdapterFromToolchain": true,
+    "swift.debugger.debugAdapter": "lldb-dap",
+    "swift.debugger.setupCodeLLDB": "alwaysUpdateGlobal",
     "swift.additionalTestArguments": [
         "-Xswiftc",
         "-DTEST_ARGUMENT_SET_VIA_TEST_BUILD_ARGUMENTS_SETTING"

assets/test/defaultPackage/.vscode/launch.json

@@ -1,7 +1,7 @@
 {
     "configurations": [
         {
-            "type": "swift-lldb",
+            "type": "swift",
             "request": "launch",
             "name": "Debug package1",
             "program": "${workspaceFolder:defaultPackage}/.build/debug/package1",
@@ -10,7 +10,7 @@
             "preLaunchTask": "swift: Build Debug package1"
         },
         {
-            "type": "swift-lldb",
+            "type": "swift",
             "request": "launch",
             "name": "Release package1",
             "program": "${workspaceFolder:defaultPackage}/.build/release/package1",

assets/test/diagnostics/.vscode/launch.json

@@ -1,7 +1,7 @@
 {
     "configurations": [
         {
-            "type": "swift-lldb",
+            "type": "swift",
             "request": "launch",
             "args": [],
             "cwd": "${workspaceFolder:diagnostics}",
@@ -10,7 +10,7 @@
             "preLaunchTask": "swift: Build Debug diagnostics"
         },
         {
-            "type": "swift-lldb",
+            "type": "swift",
             "request": "launch",
             "args": [],
             "cwd": "${workspaceFolder:diagnostics}",
@@ -19,7 +19,7 @@
             "preLaunchTask": "swift: Build Release diagnostics"
         },
         {
-            "type": "swift-lldb",
+            "type": "swift",
             "request": "launch",
             "args": [],
             "cwd": "${workspaceFolder:diagnostics}",
@@ -28,7 +28,7 @@
             "preLaunchTask": "swift: Build Debug diagnostics"
         },
         {
-            "type": "swift-lldb",
+            "type": "swift",
             "request": "launch",
             "args": [],
             "cwd": "${workspaceFolder:diagnostics}",

package.json

@@ -673,20 +673,39 @@
               "Use the `lldb-dap` executable from the toolchain. Requires Swift 6 or later.",
               "Use the CodeLLDB extension's debug adapter."
             ],
-            "order": 1
-          },
-          "swift.debugger.useDebugAdapterFromToolchain": {
-            "type": "boolean",
-            "default": false,
-            "markdownDeprecationMessage": "**Deprecated**: Use the `swift.debugger.debugAdapter` setting instead. This will be removed in future versions of the Swift extension.",
-            "markdownDescription": "Use the LLDB debug adapter packaged with the Swift toolchain as your debug adapter. Note: this is only available starting with Swift 6. The CodeLLDB extension will be used if your Swift toolchain does not contain lldb-dap.",
+            "markdownDescription": "Select which debug adapter to use to debus Swift executables.",
             "order": 1
           },
           "swift.debugger.path": {
             "type": "string",
             "default": "",
             "markdownDescription": "Path to lldb debug adapter.",
             "order": 2
+          },
+          "swift.debugger.setupCodeLLDB": {
+            "type": "string",
+            "default": "prompt",
+            "enum": [
+              "prompt",
+              "alwaysUpdateGlobal",
+              "alwaysUpdateWorkspace",
+              "never"
+            ],
+            "enumDescriptions": [
+              "Prompt to update CodeLLDB settings when they are incorrect.",
+              "Always automatically update CodeLLDB settings globally when they are incorrect.",
+              "Always automatically update CodeLLDB settings in the workspace when they are incorrect.",
+              "Never automatically update CodeLLDB settings when they are incorrect."
+            ],
+            "markdownDescription": "Choose how CodeLLDB settings are updated when debugging Swift executables.",
+            "order": 3
+          },
+          "swift.debugger.useDebugAdapterFromToolchain": {
+            "type": "boolean",
+            "default": false,
+            "markdownDeprecationMessage": "**Deprecated**: Use the `swift.debugger.debugAdapter` setting instead. This will be removed in future versions of the Swift extension.",
+            "markdownDescription": "Use the LLDB debug adapter packaged with the Swift toolchain as your debug adapter. Note: this is only available starting with Swift 6. The CodeLLDB extension will be used if your Swift toolchain does not contain lldb-dap.",
+            "order": 4
           }
         }
       },

src/configuration.ts

@@ -15,6 +15,11 @@
 import * as vscode from "vscode";
 
 export type DebugAdapters = "auto" | "lldb-dap" | "CodeLLDB";
+export type SetupCodeLLDBOptions =
+    | "prompt"
+    | "alwaysUpdateGlobal"
+    | "alwaysUpdateWorkspace"
+    | "never";
 export type CFamilySupportOptions = "enable" | "disable" | "cpptools-inactive";
 export type ActionAfterBuildError = "Focus Problems" | "Focus Terminal" | "Do Nothing";
 export type OpenAfterCreateNewProjectOptions =
@@ -54,6 +59,8 @@ export interface DebuggerConfiguration {
     readonly customDebugAdapterPath: string;
     /** Whether or not to disable setting up the debugger */
     readonly disable: boolean;
+    /** User choices for updating CodeLLDB settings */
+    readonly setupCodeLLDB: SetupCodeLLDBOptions;
 }
 
 /** workspace folder configuration */
@@ -219,6 +226,11 @@ const configuration = {
                     .getConfiguration("swift.debugger")
                     .get<boolean>("disable", false);
             },
+            get setupCodeLLDB(): SetupCodeLLDBOptions {
+                return vscode.workspace
+                    .getConfiguration("swift.debugger")
+                    .get<SetupCodeLLDBOptions>("setupCodeLLDB", "prompt");
+            },
         };
     },
     /** Files and directories to exclude from the code coverage. */

src/debugger/debugAdapterFactory.ts

@@ -22,6 +22,7 @@ import { SwiftOutputChannel } from "../ui/SwiftOutputChannel";
 import { fileExists } from "../utilities/filesystem";
 import { getLLDBLibPath } from "./lldb";
 import { getErrorDescription } from "../utilities/utilities";
+import configuration from "../configuration";
 
 /**
  * Registers the active debugger with the extension, and reregisters it
@@ -172,13 +173,27 @@ export class LLDBDebugConfigurationProvider implements vscode.DebugConfiguration
         ) {
             return;
         }
-        const userSelection = await vscode.window.showInformationMessage(
-            "The Swift extension needs to update some CodeLLDB settings to enable debugging features. Do you want to set this up in your global settings or workspace settings?",
-            { modal: true },
-            "Global",
-            "Workspace",
-            "Run Anyway"
-        );
+        let userSelection: "Global" | "Workspace" | "Run Anyway" | undefined = undefined;
+        switch (configuration.debugger.setupCodeLLDB) {
+            case "prompt":
+                userSelection = await vscode.window.showInformationMessage(
+                    "The Swift extension needs to update some CodeLLDB settings to enable debugging features. Do you want to set this up in your global settings or workspace settings?",
+                    { modal: true },
+                    "Global",
+                    "Workspace",
+                    "Run Anyway"
+                );
+                break;
+            case "alwaysUpdateGlobal":
+                userSelection = "Global";
+                break;
+            case "alwaysUpdateWorkspace":
+                userSelection = "Workspace";
+                break;
+            case "never":
+                userSelection = "Run Anyway";
+                break;
+        }
         switch (userSelection) {
             case "Global":
                 lldbConfig.update("library", libLldbPath, vscode.ConfigurationTarget.Global);

test/integration-tests/SwiftPackage.test.ts

@@ -59,7 +59,7 @@ suite("SwiftPackage Test Suite", () => {
         const spmPackage = await SwiftPackage.create(testAssetUri("package5.6"), toolchain);
         assert.strictEqual(spmPackage.isValid, true);
         assert(spmPackage.resolved !== undefined);
-    }).timeout(15000);
+    }).timeout(20000);
 
     test("Identity case-insensitivity", async () => {
         const spmPackage = await SwiftPackage.create(testAssetUri("identity-case"), toolchain);

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

@@ -106,6 +106,7 @@ suite("Dependency Commmands Test Suite", function () {
         }
 
         test("Swift: Reset Package Dependencies", async function () {
+            this.skip(); // https://github.com/swiftlang/vscode-swift/issues/1316
             // spm reset after using local dependency is broken on windows
             if (process.platform === "win32") {
                 this.skip();
@@ -121,7 +122,8 @@ suite("Dependency Commmands Test Suite", function () {
             expect(dep?.type).to.equal("remote");
         });
 
-        test("Swift: Revert To Original Version", async () => {
+        test("Swift: Revert To Original Version", async function () {
+            this.skip(); // https://github.com/swiftlang/vscode-swift/issues/1316
             await useLocalDependencyTest();
 
             const result = await vscode.commands.executeCommand(

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

@@ -46,7 +46,6 @@ import {
     updateSettings,
 } from "../utilities/testutilities";
 import { Commands } from "../../../src/commands";
-import { SwiftToolchain } from "../../../src/toolchain/toolchain";
 
 suite("Test Explorer Suite", function () {
     const MAX_TEST_RUN_TIME_MINUTES = 5;
@@ -129,36 +128,15 @@ suite("Test Explorer Suite", function () {
         });
 
         suite("CodeLLDB", () => {
-            async function getLLDBDebugAdapterPath() {
-                switch (process.platform) {
-                    case "linux":
-                        return "/usr/lib/liblldb.so";
-                    case "darwin":
-                    case "win32":
-                        return await (await SwiftToolchain.create()).getLLDBDebugAdapter();
-                    default:
-                        throw new Error("Please provide the path to lldb for this platform");
-                }
-            }
-
             let resetSettings: (() => Promise<void>) | undefined;
             beforeEach(async function () {
                 // CodeLLDB on windows doesn't print output and so cannot be parsed
                 if (process.platform === "win32") {
                     this.skip();
                 }
 
-                const lldbPath =
-                    process.env["CI"] === "1"
-                        ? {
-                              "lldb.library": await getLLDBDebugAdapterPath(),
-                              "lldb.launch.expressions": "native",
-                          }
-                        : {};
-
                 resetSettings = await updateSettings({
-                    "swift.debugger.useDebugAdapterFromToolchain": false,
-                    ...lldbPath,
+                    "swift.debugger.debugAdapter": "CodeLLDB",
                 });
             });
 

test/integration-tests/utilities/testutilities.ts

@@ -73,6 +73,7 @@ const extensionBootstrapper = (() => {
     ) {
         let workspaceContext: WorkspaceContext | undefined;
         let autoTeardown: void | (() => Promise<void>);
+        let restoreSettings: (() => Promise<void>) | undefined;
         before(async function () {
             // Always activate the extension. If no test assets are provided,
             // default to adding `defaultPackage` to the workspace.
@@ -92,6 +93,12 @@ const extensionBootstrapper = (() => {
             if (requiresDebugger && configuration.debugger.disable) {
                 this.skip();
             }
+            // CodeLLDB does not work with libllbd in Swift toolchains prior to 5.10
+            if (workspaceContext.swiftVersion.isLessThan(new Version(5, 10, 0))) {
+                restoreSettings = await updateSettings({
+                    "swift.debugger.setupCodeLLDB": "never",
+                });
+            }
             if (!setup) {
                 return;
             }
@@ -121,6 +128,9 @@ const extensionBootstrapper = (() => {
                 if (autoTeardown) {
                     await autoTeardown();
                 }
+                if (restoreSettings) {
+                    await restoreSettings();
+                }
             } catch (error) {
                 if (workspaceContext) {
                     console.error(`Error during test/suite teardown, captured logs are:`);

test/unit-tests/debugger/debugAdapterFactory.test.ts

@@ -38,6 +38,7 @@ import { SwiftToolchain } from "../../../src/toolchain/toolchain";
 import { SwiftOutputChannel } from "../../../src/ui/SwiftOutputChannel";
 import * as debugAdapter from "../../../src/debugger/debugAdapter";
 import { Result } from "../../../src/utilities/result";
+import configuration from "../../../src/configuration";
 
 suite("LLDBDebugAdapterExecutableFactory Tests", () => {
     const mockDebugAdapter = mockGlobalModule(DebugAdapter);
@@ -83,6 +84,7 @@ suite("LLDBDebugConfigurationProvider Tests", () => {
     suite("CodeLLDB selected in settings", () => {
         let mockLldbConfiguration: MockedObject<vscode.WorkspaceConfiguration>;
         const mockLLDB = mockGlobalModule(lldb);
+        const mockDebuggerConfig = mockGlobalObject(configuration, "debugger");
         const mockWorkspace = mockGlobalObject(vscode, "workspace");
 
         setup(() => {
@@ -95,6 +97,7 @@ suite("LLDBDebugConfigurationProvider Tests", () => {
             });
             mockWorkspace.getConfiguration.returns(instance(mockLldbConfiguration));
             mockLLDB.getLLDBLibPath.resolves(Result.makeSuccess("/path/to/liblldb.dyLib"));
+            mockDebuggerConfig.setupCodeLLDB = "prompt";
             mockDebugAdapter.getLaunchConfigType.returns(LaunchConfigType.CODE_LLDB);
         });
 
@@ -135,6 +138,29 @@ suite("LLDBDebugConfigurationProvider Tests", () => {
                 "/path/to/liblldb.dyLib"
             );
         });
+
+        test("avoids prompting the user about CodeLLDB if requested in settings", async () => {
+            mockDebuggerConfig.setupCodeLLDB = "alwaysUpdateGlobal";
+            mockLldbConfiguration.get.withArgs("library").returns(undefined);
+            const configProvider = new LLDBDebugConfigurationProvider(
+                "darwin",
+                instance(mockToolchain),
+                instance(mockOutputChannel)
+            );
+            await expect(
+                configProvider.resolveDebugConfiguration(undefined, {
+                    name: "Test Launch Config",
+                    type: SWIFT_LAUNCH_CONFIG_TYPE,
+                    request: "launch",
+                    program: "${workspaceFolder}/.build/debug/executable",
+                })
+            ).to.eventually.be.an("object");
+            expect(mockWindow.showInformationMessage).to.not.have.been.called;
+            expect(mockLldbConfiguration.update).to.have.been.calledWith(
+                "library",
+                "/path/to/liblldb.dyLib"
+            );
+        });
     });
 
     suite("lldb-dap selected in settings", () => {