enable debugging of pytests

Author: DonJayamanne

pythonFiles/PythonTools/testlauncher.py

@@ -0,0 +1,35 @@
+def main():
+    import os
+    import sys
+    
+    sys.path[0] = os.getcwd()
+    os.chdir(sys.argv[1])
+    secret = sys.argv[2]
+    port = int(sys.argv[3])
+    testFx = sys.argv[4]
+    args = sys.argv[5:]    
+    from ptvsd.visualstudio_py_debugger import DONT_DEBUG, DEBUG_ENTRYPOINTS, get_code
+    from ptvsd.attach_server import DEFAULT_PORT, enable_attach, wait_for_attach
+
+    DONT_DEBUG.append(os.path.normcase(__file__))
+    DEBUG_ENTRYPOINTS.add(get_code(main))
+
+    enable_attach(secret, ('127.0.0.1', port), redirect_output = False)
+    sys.stdout.flush()
+    print('READY')
+    sys.stdout.flush()
+    wait_for_attach()
+
+    try:
+        if testFx == 'pytest':
+            import pytest
+            pytest.main(args)
+        else:
+            import nose
+            nose.run(argv=args)
+        sys.exit()
+    finally:
+        pass
+
+if __name__ == '__main__':
+    main()

src/client/unittests/pytest/main.ts

@@ -1,10 +1,10 @@
 'use strict';
-import {PythonSettings} from '../../common/configSettings';
-import {TestsToRun, Tests} from '../common/contracts';
-import {runTest} from './runner';
+import { PythonSettings } from '../../common/configSettings';
+import { TestsToRun, Tests } from '../common/contracts';
+import { runTest } from './runner';
 import * as vscode from 'vscode';
-import {discoverTests} from './collector';
-import {BaseTestManager} from '../common/baseTestManager';
+import { discoverTests } from './collector';
+import { BaseTestManager } from '../common/baseTestManager';
 import { Product } from '../../common/installer';
 
 const settings = PythonSettings.getInstance();
@@ -21,6 +21,6 @@ export class TestManager extends BaseTestManager {
         if (runFailedTests === true && args.indexOf('--lf') === -1 && args.indexOf('--last-failed') === -1) {
             args.push('--last-failed');
         }
-        return runTest(this.rootDirectory, tests, args, testsToRun, this.cancellationToken, this.outputChannel);
+        return runTest(this.rootDirectory, tests, args, testsToRun, this.cancellationToken, this.outputChannel, debug);
     }
 }

src/client/unittests/pytest/runner.ts

@@ -8,10 +8,15 @@ import { CancellationToken, OutputChannel } from 'vscode';
 import { updateResultsFromXmlLogFile, PassCalculationFormulae } from '../common/xUnitParser';
 import { run } from '../common/runner';
 import { PythonSettings } from '../../common/configSettings';
+import * as vscode from 'vscode';
+import { execPythonFile } from './../../common/utils';
+import { createDeferred } from './../../common/helpers';
+import * as os from 'os';
+import * as path from 'path';
 
 const pythonSettings = PythonSettings.getInstance();
 
-export function runTest(rootDirectory: string, tests: Tests, args: string[], testsToRun?: TestsToRun, token?: CancellationToken, outChannel?: OutputChannel): Promise<Tests> {
+export function runTest(rootDirectory: string, tests: Tests, args: string[], testsToRun?: TestsToRun, token?: CancellationToken, outChannel?: OutputChannel, debug?: boolean): Promise<Tests> {
     let testPaths = [];
     if (testsToRun && testsToRun.testFolder) {
         testPaths = testPaths.concat(testsToRun.testFolder.map(f => f.nameToRun));
@@ -32,12 +37,68 @@ export function runTest(rootDirectory: string, tests: Tests, args: string[], tes
     return createTemporaryFile('.xml').then(xmlLogResult => {
         xmlLogFile = xmlLogResult.filePath;
         xmlLogFileCleanup = xmlLogResult.cleanupCallback;
-        if (testPaths.length > 0){
+        if (testPaths.length > 0) {
             // Ignore the test directories, as we're running a specific test
             args = args.filter(arg => arg.trim().startsWith('-'));
         }
         const testArgs = testPaths.concat(args, [`--junitxml=${xmlLogFile}`]);
-        return run(pythonSettings.unitTest.pyTestPath, testArgs, rootDirectory, token, outChannel);
+        if (debug) {
+            const def = createDeferred<any>();
+            const launchDef = createDeferred<any>();
+            const testLauncherFile = path.join(__dirname, '..', '..', '..', '..', 'pythonFiles', 'PythonTools', 'testlauncher.py');
+
+            // start the debug adapter only once we have started the debug process
+            // pytestlauncherargs
+            const pytestlauncherargs = [rootDirectory, 'my_secret', pythonSettings.unitTest.debugPort.toString(), 'pytest'];
+            let outputChannelShown = false;
+            execPythonFile(pythonSettings.pythonPath, [testLauncherFile].concat(pytestlauncherargs).concat(testArgs), rootDirectory, true, (data: string) => {
+                if (data === 'READY' + os.EOL) {
+                    // debug socket server has started
+                    launchDef.resolve();
+                }
+                else {
+                    if (!outputChannelShown){
+                        outputChannelShown = true;
+                        outChannel.show();
+                    }
+                    outChannel.append(data);
+                }
+            }, token).catch(reason => {
+                if (!def.rejected && !def.resolved) {
+                    def.reject(reason);
+                }
+            }).then(() => {
+                if (!def.rejected && !def.resolved) {
+                    def.resolve();
+                }
+            }).catch(reason => {
+                if (!def.rejected && !def.resolved) {
+                    def.reject(reason);
+                }
+            });
+
+            launchDef.promise.then(() => {
+                return vscode.commands.executeCommand('vscode.startDebug', {
+                    "name": "Debug Unit Test",
+                    "type": "python",
+                    "request": "attach",
+                    "localRoot": rootDirectory,
+                    "remoteRoot": rootDirectory,
+                    "port": pythonSettings.unitTest.debugPort,
+                    "secret": "my_secret",
+                    "host": "localhost"
+                });
+            }).catch(reason => {
+                if (!def.rejected && !def.resolved) {
+                    def.reject(reason);
+                }
+            });
+
+            return def.promise;
+        }
+        else {
+            return run(pythonSettings.unitTest.pyTestPath, testArgs, rootDirectory, token, outChannel);
+        }
     }).then(() => {
         return updateResultsFromLogFiles(tests, xmlLogFile);
     }).then(result => {