Pass arguments to disable sandboxing when enabled

New disableSandbox setting (only intended for testing right now)

These particular commands (or subcommands) use sandboxing.

To get our tests to run in a sandbox, we need to disable sandboxing
because you cannot create a new sandbox when you're already running
under a sandbox

Author: award999

package.json

@@ -580,6 +580,12 @@
             "markdownDescription": "The path of the SDK to compile against (`--sdk` parameter). This is of use when supporting non-standard SDK layouts on Windows and using custom SDKs. The default SDK is determined by the environment on macOS and Windows.",
             "order": 3
           },
+          "swift.disableSandox": {
+            "type": "boolean",
+            "default": false,
+            "markdownDescription": "Disable sandboxing when running SwiftPM commands. You will almost always want this setting disabled.",
+            "order": 4
+          },
           "swift.diagnostics": {
             "type": "boolean",
             "default": false,

src/configuration.ts

@@ -291,6 +291,10 @@ const configuration = {
             .getConfiguration("swift")
             .get<boolean>("enableTerminalEnvironment", true);
     },
+    /** Whether or not to disable SwiftPM sandboxing */
+    get disableSandbox(): boolean {
+        return vscode.workspace.getConfiguration("swift").get<boolean>("disableSandbox", false);
+    },
 };
 
 export default configuration;

src/tasks/SwiftTaskProvider.ts

@@ -323,6 +323,7 @@ export function createSwiftTask(
 ): SwiftTask {
     const swift = toolchain.getToolchainExecutable("swift");
     args = toolchain.buildFlags.withSwiftSDKFlags(args);
+    args = toolchain.buildFlags.withDisableSandboxFlags(args);
 
     // Add relative path current working directory
     const cwd = config.cwd.fsPath;

src/toolchain/BuildFlags.ts

@@ -166,6 +166,38 @@ export class BuildFlags {
         return indirect ? args.flatMap(arg => ["-Xswiftc", arg]) : args;
     }
 
+    /**
+     * Get modified swift arguments with new arguments for disabling
+     * sandboxing if the `swift.disableSandbox` setting is enabled.
+     *
+     * @param args original commandline arguments
+     */
+    withDisableSandboxFlags(args: string[]): string[] {
+        if (!configuration.disableSandbox) {
+            return args;
+        }
+        switch (args[0]) {
+            case "package": {
+                return [args[0], ...BuildFlags.disableSandboxFlags(), ...args.slice(1)];
+            }
+            case "build":
+            case "run":
+            case "test": {
+                return [...args, ...BuildFlags.disableSandboxFlags()];
+            }
+            default:
+                // Do nothing for other commands
+                return args;
+        }
+    }
+
+    /**
+     * Get flags for disabling sandboxing when running SwiftPM
+     */
+    static disableSandboxFlags(): string[] {
+        return ["--disable-sandbox", "-Xswiftc", "-disable-sandbox"];
+    }
+
     /**
      *  Filter argument list
      * @param args argument list

src/toolchain/toolchain.ts

@@ -711,7 +711,10 @@ export class SwiftToolchain {
     private static async getSwiftTargetInfo(): Promise<SwiftTargetInfo> {
         try {
             try {
-                const { stdout } = await execSwift(["-print-target-info"], "default");
+                const { stdout } = await execSwift(
+                    ["-print-target-info", ...BuildFlags.disableSandboxFlags()],
+                    "default"
+                );
                 const targetInfo = JSON.parse(stdout.trimEnd()) as SwiftTargetInfo;
                 if (targetInfo.compilerVersion) {
                     return targetInfo;

src/utilities/utilities.ts

@@ -165,6 +165,7 @@ export async function execSwift(
     }
     if (toolchain !== "default") {
         args = toolchain.buildFlags.withSwiftSDKFlags(args);
+        args = toolchain.buildFlags.withDisableSandboxFlags(args);
     }
     if (Object.keys(configuration.swiftEnvironmentVariables).length > 0) {
         // when adding environment vars we either combine with vars passed

test/suite/tasks/SwiftTaskProvider.test.ts

@@ -51,8 +51,8 @@ suite("SwiftTaskProvider Test Suite", () => {
 
         test("Exit code on success", async () => {
             const task = createSwiftTask(
-                ["--help"],
-                "help",
+                ["build", "--show-bin-path"],
+                "show bin path",
                 { cwd: workspaceFolder.uri, scope: vscode.TaskScope.Workspace },
                 toolchain
             );
@@ -84,7 +84,12 @@ suite("SwiftTaskProvider Test Suite", () => {
                 new vscode.CancellationTokenSource().token
             );
             const task = tasks.find(t => t.name === "Build All (defaultPackage)");
-            assert.equal(task?.detail, "swift build --build-tests -Xswiftc -diagnostic-style=llvm");
+            assert.equal(
+                task?.detail?.startsWith(
+                    "swift build --build-tests -Xswiftc -diagnostic-style=llvm"
+                ),
+                true
+            );
         });
 
         test("includes product debug task", async () => {
@@ -94,8 +99,10 @@ suite("SwiftTaskProvider Test Suite", () => {
             );
             const task = tasks.find(t => t.name === "Build Debug PackageExe (defaultPackage)");
             assert.equal(
-                task?.detail,
-                "swift build --product PackageExe -Xswiftc -diagnostic-style=llvm"
+                task?.detail?.startsWith(
+                    "swift build --product PackageExe -Xswiftc -diagnostic-style=llvm"
+                ),
+                true
             );
         });
 
@@ -106,8 +113,10 @@ suite("SwiftTaskProvider Test Suite", () => {
             );
             const task = tasks.find(t => t.name === "Build Release PackageExe (defaultPackage)");
             assert.equal(
-                task?.detail,
-                "swift build -c release --product PackageExe -Xswiftc -diagnostic-style=llvm"
+                task?.detail?.startsWith(
+                    "swift build -c release --product PackageExe -Xswiftc -diagnostic-style=llvm"
+                ),
+                true
             );
         });
     });