debugLauncher.ts

import { inject, injectable, named } from 'inversify';
import * as path from 'path';
import { DebugConfiguration, l10n, Uri, WorkspaceFolder } from 'vscode';
import { IApplicationShell, IDebugService } from '../../common/application/types';
import { EXTENSION_ROOT_DIR } from '../../common/constants';
import * as internalScripts from '../../common/process/internal/scripts';
import { IConfigurationService, IPythonSettings } from '../../common/types';
import { DebuggerTypeName, PythonDebuggerTypeName } from '../../debugger/constants';
import { IDebugConfigurationResolver } from '../../debugger/extension/configuration/types';
import { DebugPurpose, LaunchRequestArguments } from '../../debugger/types';
import { IServiceContainer } from '../../ioc/types';
import { traceError } from '../../logging';
import { TestProvider } from '../types';
import { ITestDebugLauncher, LaunchOptions } from './types';
import { getConfigurationsForWorkspace } from '../../debugger/extension/configuration/launch.json/launchJsonReader';
import { getWorkspaceFolder, getWorkspaceFolders } from '../../common/vscodeApis/workspaceApis';
import { showErrorMessage } from '../../common/vscodeApis/windowApis';
import { createDeferred } from '../../common/utils/async';
import { pythonTestAdapterRewriteEnabled } from '../testController/common/utils';
import { addPathToPythonpath } from './helpers';

@injectable()
export class DebugLauncher implements ITestDebugLauncher {
    private readonly configService: IConfigurationService;

    constructor(
        @inject(IServiceContainer) private serviceContainer: IServiceContainer,
        @inject(IDebugConfigurationResolver)
        @named('launch')
        private readonly launchResolver: IDebugConfigurationResolver<LaunchRequestArguments>,
    ) {
        this.configService = this.serviceContainer.get<IConfigurationService>(IConfigurationService);
    }

    public async launchDebugger(options: LaunchOptions, callback?: () => void): Promise<void> {
        const deferred = createDeferred<void>();
        if (options.token && options.token.isCancellationRequested) {
            return undefined;
            deferred.resolve();
            callback?.();
        }

        const workspaceFolder = DebugLauncher.resolveWorkspaceFolder(options.cwd);
        const launchArgs = await this.getLaunchArgs(
            options,
            workspaceFolder,
            this.configService.getSettings(workspaceFolder.uri),
        );
        const debugManager = this.serviceContainer.get<IDebugService>(IDebugService);

        debugManager.onDidTerminateDebugSession(() => {
            deferred.resolve();
            callback?.();
        });
        debugManager.startDebugging(workspaceFolder, launchArgs);
        return deferred.promise;
    }

    private static resolveWorkspaceFolder(cwd: string): WorkspaceFolder {
        const hasWorkspaceFolders = (getWorkspaceFolders()?.length || 0) > 0;
        if (!hasWorkspaceFolders) {
            throw new Error('Please open a workspace');
        }

        const cwdUri = cwd ? Uri.file(cwd) : undefined;
        let workspaceFolder = getWorkspaceFolder(cwdUri);
        if (!workspaceFolder) {
            const [first] = getWorkspaceFolders()!;
            workspaceFolder = first;
        }
        return workspaceFolder;
    }

    private async getLaunchArgs(
        options: LaunchOptions,
        workspaceFolder: WorkspaceFolder,
        configSettings: IPythonSettings,
    ): Promise<LaunchRequestArguments> {
        let debugConfig = await DebugLauncher.readDebugConfig(workspaceFolder);
        if (!debugConfig) {
            debugConfig = {
                name: 'Debug Unit Test',
                type: 'debugpy',
                request: 'test',
                subProcess: true,
            };
        }
        if (!debugConfig.rules) {
            debugConfig.rules = [];
        }
        debugConfig.rules.push({
            path: path.join(EXTENSION_ROOT_DIR, 'python_files'),
            include: false,
        });

        DebugLauncher.applyDefaults(debugConfig!, workspaceFolder, configSettings);

        return this.convertConfigToArgs(debugConfig!, workspaceFolder, options);
    }

    public async readAllDebugConfigs(workspace: WorkspaceFolder): Promise<DebugConfiguration[]> {
        try {
            const configs = await getConfigurationsForWorkspace(workspace);
            return configs;
        } catch (exc) {
            traceError('could not get debug config', exc);
            const appShell = this.serviceContainer.get<IApplicationShell>(IApplicationShell);
            await appShell.showErrorMessage(
                l10n.t('Could not load unit test config from launch.json as it is missing a field'),
            );
            return [];
        }
    }

    private static async readDebugConfig(
        workspaceFolder: WorkspaceFolder,
    ): Promise<LaunchRequestArguments | undefined> {
        try {
            const configs = await getConfigurationsForWorkspace(workspaceFolder);
            for (const cfg of configs) {
                if (
                    cfg.name &&
                    (cfg.type === DebuggerTypeName || cfg.type === PythonDebuggerTypeName) &&
                    (cfg.request === 'test' ||
                        (cfg as LaunchRequestArguments).purpose?.includes(DebugPurpose.DebugTest))
                ) {
                    // Return the first one.
                    return cfg as LaunchRequestArguments;
                }
            }
            return undefined;
        } catch (exc) {
            traceError('could not get debug config', exc);
            await showErrorMessage(l10n.t('Could not load unit test config from launch.json as it is missing a field'));
            return undefined;
        }
    }

    private static applyDefaults(
        cfg: LaunchRequestArguments,
        workspaceFolder: WorkspaceFolder,
        configSettings: IPythonSettings,
    ) {
        // cfg.pythonPath is handled by LaunchConfigurationResolver.

        if (!cfg.console) {
            cfg.console = 'internalConsole';
        }
        if (!cfg.cwd) {
            cfg.cwd = configSettings.testing.cwd || workspaceFolder.uri.fsPath;
        }
        if (!cfg.env) {
            cfg.env = {};
        }
        if (!cfg.envFile) {
            cfg.envFile = configSettings.envFile;
        }
        if (cfg.stopOnEntry === undefined) {
            cfg.stopOnEntry = false;
        }
        cfg.showReturnValue = cfg.showReturnValue !== false;
        if (cfg.redirectOutput === undefined) {
            cfg.redirectOutput = true;
        }
        if (cfg.debugStdLib === undefined) {
            cfg.debugStdLib = false;
        }
        if (cfg.subProcess === undefined) {
            cfg.subProcess = true;
        }
    }

    private async convertConfigToArgs(
        debugConfig: LaunchRequestArguments,
        workspaceFolder: WorkspaceFolder,
        options: LaunchOptions,
    ): Promise<LaunchRequestArguments> {
        const pythonTestAdapterRewriteExperiment = pythonTestAdapterRewriteEnabled(this.serviceContainer);
        const configArgs = debugConfig as LaunchRequestArguments;
        const testArgs =
            options.testProvider === 'unittest' ? options.args.filter((item) => item !== '--debug') : options.args;
        const script = DebugLauncher.getTestLauncherScript(options.testProvider, pythonTestAdapterRewriteExperiment);
        const args = script(testArgs);
        const [program] = args;
        configArgs.program = program;

        configArgs.args = args.slice(1);
        // We leave configArgs.request as "test" so it will be sent in telemetry.

        let launchArgs = await this.launchResolver.resolveDebugConfiguration(
            workspaceFolder,
            configArgs,
            options.token,
        );
        if (!launchArgs) {
            throw Error(`Invalid debug config "${debugConfig.name}"`);
        }
        launchArgs = await this.launchResolver.resolveDebugConfigurationWithSubstitutedVariables(
            workspaceFolder,
            launchArgs,
            options.token,
        );
        if (!launchArgs) {
            throw Error(`Invalid debug config "${debugConfig.name}"`);
        }
        launchArgs.request = 'launch';

        if (pythonTestAdapterRewriteExperiment) {
            if (options.pytestPort && options.runTestIdsPort) {
                launchArgs.env = {
                    ...launchArgs.env,
                    TEST_RUN_PIPE: options.pytestPort,
                    RUN_TEST_IDS_PIPE: options.runTestIdsPort,
                };
            } else {
                throw Error(
                    `Missing value for debug setup, both port and uuid need to be defined. port: "${options.pytestPort}" uuid: "${options.pytestUUID}"`,
                );
            }
        }
        const pluginPath = path.join(EXTENSION_ROOT_DIR, 'python_files');
        // check if PYTHONPATH is already set in the environment variables
        if (launchArgs.env) {
            const additionalPythonPath = [pluginPath];
            if (launchArgs.cwd) {
                additionalPythonPath.push(launchArgs.cwd);
            } else if (options.cwd) {
                additionalPythonPath.push(options.cwd);
            }
            // add the plugin path or cwd to PYTHONPATH if it is not already there using the following function
            // this function will handle if PYTHONPATH is undefined
            addPathToPythonpath(additionalPythonPath, launchArgs.env.PYTHONPATH);
        }

        // Clear out purpose so we can detect if the configuration was used to
        // run via F5 style debugging.
        launchArgs.purpose = [];

        return launchArgs;
    }

    private static getTestLauncherScript(testProvider: TestProvider, pythonTestAdapterRewriteExperiment?: boolean) {
        switch (testProvider) {
            case 'unittest': {
                if (pythonTestAdapterRewriteExperiment) {
                    return internalScripts.execution_py_testlauncher; // this is the new way to run unittest execution, debugger
                }
                return internalScripts.visualstudio_py_testlauncher; // old way unittest execution, debugger
            }
            case 'pytest': {
                if (pythonTestAdapterRewriteExperiment) {
                    return internalScripts.pytestlauncher; // this is the new way to run pytest execution, debugger
                }
                return internalScripts.testlauncher; // old way pytest execution, debugger
            }
            default: {
                throw new Error(`Unknown test provider '${testProvider}'`);
            }
        }
    }
}