Always quote Python executable path (#964)

* Always quote Python executable path

On Windows, this would cause pahts like "C:\Program Files\" to fail launching the Python command as the blank space was not escaped properly.

Add also a unit test to validate this change.

Signed-off-by: Francesco Giancane <me@fgiancane8.dev>

* stringUtils.ts: remove call to .replace() method for paths

There is no need anymore to replace backslashes with forward slashes
for paths on Windows, as the Python extension's
`toCommandArgumentForPythonExt` function already handles this correctly.

Signed-off-by: Francesco Giancane <me@fgiancane8.dev>

* stringUtils.ts: restore replace call when normalizing string

* remoteLaunchers: ensure test is normalizing paths

Explicitly call `fileToCommandArgumentForPythonExt` when computing a path with spaces and check results are as expected.

* stringUtils.ts: replace backslashes with forward-slashes only on non-Windows platforms.

* Revert "remoteLaunchers: ensure test is normalizing paths"

This reverts commit 32822e0.

* remoteLaunchers.ts: feed platform-specific data to tests

Use backward slashes on Windows and forward slashes on Unix-like OSes when testing correct behavior of path strings quotation.

* Copy-paste error in comment.

* remoteLaunchers.unit.test.ts: fix formatting issues

---------

Signed-off-by: Francesco Giancane <me@fgiancane8.dev>

Author: fgiancane8

src/extension/common/stringUtils.ts

@@ -1,6 +1,8 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
+import { getOSType, OSType } from './platform';
+
 /**
  * Replaces all instances of a substring with a new substring.
  */
@@ -58,5 +60,12 @@ export function fileToCommandArgumentForPythonExt(source: string): string {
     if (!source) {
         return source;
     }
-    return toCommandArgumentForPythonExt(source).replace(/\\/g, '/');
+
+    let result = toCommandArgumentForPythonExt(source);
+
+    if (getOSType() !== OSType.Windows) {
+        result = result.replace(/\\/g, '/');
+    }
+
+    return result;
 }

src/extension/debugger/adapter/factory.ts

@@ -80,14 +80,20 @@ export class DebugAdapterDescriptorFactory implements IDebugAdapterDescriptorFac
 
             let executable = command.shift() ?? 'python';
 
+            // Always ensure interpreter/command is quoted if necessary. Previously this was
+            // only done in the debugAdapterPath branch which meant that in the common case
+            // (using the built‑in adapter path) an interpreter path containing spaces would
+            // be passed unquoted, resulting in a fork/spawn failure on Windows. See bug
+            // report for details.
+            executable = fileToCommandArgumentForPythonExt(executable);
+
             // "logToFile" is not handled directly by the adapter - instead, we need to pass
             // the corresponding CLI switch when spawning it.
             const logArgs = configuration.logToFile ? ['--log-dir', EXTENSION_ROOT_DIR] : [];
 
             if (configuration.debugAdapterPath !== undefined) {
                 const args = command.concat([configuration.debugAdapterPath, ...logArgs]);
                 traceLog(`DAP Server launched with command: ${executable} ${args.join(' ')}`);
-                executable = fileToCommandArgumentForPythonExt(executable);
                 return new DebugAdapterExecutable(executable, args);
             }
 

src/test/unittest/adapter/factory.unit.test.ts

@@ -304,7 +304,23 @@ suite('Debugging - Adapter Factory', () => {
 
         assert.deepStrictEqual(descriptor, debugExecutable);
     });
-    test('Add quotes to interpreter path with spaces', async () => {
+    test('Add quotes to interpreter path with spaces (default adapter path)', async () => {
+        const session = createSession({});
+        const interpreterPathSpaces = 'path/to/python interpreter with spaces';
+        const interpreterPathSpacesQuoted = `"${interpreterPathSpaces}"`;
+        const debugExecutable = new DebugAdapterExecutable(interpreterPathSpacesQuoted, [debugAdapterPath]);
+
+        getInterpreterDetailsStub.resolves({ path: [interpreterPathSpaces] });
+        const interpreterSpacePath: PythonEnvironment = createInterpreter(interpreterPathSpaces, '3.7.4-test');
+        // Add architecture for completeness.
+        (interpreterSpacePath as any).architecture = Architecture.Unknown;
+        resolveEnvironmentStub.withArgs(interpreterPathSpaces).resolves(interpreterSpacePath);
+        const descriptor = await factory.createDebugAdapterDescriptor(session, nodeExecutable);
+
+        assert.deepStrictEqual(descriptor, debugExecutable);
+    });
+
+    test('Add quotes to interpreter path with spaces when debugAdapterPath is specified', async () => {
         const customAdapterPath = 'custom/debug/adapter/customAdapterPath';
         const session = createSession({ debugAdapterPath: customAdapterPath });
         const interpreterPathSpaces = 'path/to/python interpreter with spaces';

src/test/unittest/adapter/remoteLaunchers.unit.test.ts

@@ -8,18 +8,23 @@ import * as path from 'path';
 import { EXTENSION_ROOT_DIR } from '../../../extension/common/constants';
 import '../../../extension/common/promiseUtils';
 import * as launchers from '../../../extension/debugger/adapter/remoteLaunchers';
+import { getOSType, OSType } from '../../../extension/common/platform';
+
+function osExpectedPath(windowsPath: string, unixPath: string): string {
+    return getOSType() === OSType.Windows ? windowsPath : unixPath;
+}
 
 suite('External debugpy Debugger Launcher', () => {
     [
         {
             testName: 'When path to debugpy does not contains spaces',
             path: path.join('path', 'to', 'debugpy'),
-            expectedPath: 'path/to/debugpy',
+            expectedPath: osExpectedPath('path\\to\\debugpy', 'path/to/debugpy'),
         },
         {
             testName: 'When path to debugpy contains spaces',
             path: path.join('path', 'to', 'debugpy', 'with spaces'),
-            expectedPath: '"path/to/debugpy/with spaces"',
+            expectedPath: osExpectedPath('"path\\to\\debugpy\\with spaces"', '"path/to/debugpy/with spaces"'),
         },
     ].forEach((testParams) => {
         suite(testParams.testName, async () => {