enable debugging nosetests

Author: DonJayamanne

src/client/unittests/nosetest/main.ts

@@ -26,6 +26,6 @@ export class TestManager extends BaseTestManager {
         if (!runFailedTests && args.indexOf('--with-id') === -1) {
             args.push('--with-id');
         }
-        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/nosetest/runner.ts

@@ -6,12 +6,17 @@ import { updateResults } from '../common/testUtils';
 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();
 const WITH_XUNIT = '--with-xunit';
 const XUNIT_FILE = '--xunit-file';
 
-export function runTest(rootDirectory: string, tests: Tests, args: string[], testsToRun?: TestsToRun, token?: CancellationToken, outChannel?: OutputChannel): Promise<any> {
+export function runTest(rootDirectory: string, tests: Tests, args: string[], testsToRun?: TestsToRun, token?: CancellationToken, outChannel?: OutputChannel, debug?: boolean): Promise<any> {
     let testPaths = [];
     if (testsToRun && testsToRun.testFolder) {
         testPaths = testPaths.concat(testsToRun.testFolder.map(f => f.nameToRun));
@@ -59,7 +64,63 @@ export function runTest(rootDirectory: string, tests: Tests, args: string[], tes
     }
 
     return promiseToGetXmlLogFile.then(() => {
-        return run(pythonSettings.unitTest.nosetestPath, noseTestArgs.concat(testPaths), rootDirectory, token, outChannel);
+        if (debug === true) {
+            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 nosetestlauncherargs = [rootDirectory, 'my_secret', pythonSettings.unitTest.debugPort.toString(), 'nose'];
+            let outputChannelShown = false;
+            execPythonFile(pythonSettings.pythonPath, [testLauncherFile].concat(nosetestlauncherargs).concat(noseTestArgs.concat(testPaths)), 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.nosetestPath, noseTestArgs.concat(testPaths), rootDirectory, token, outChannel);
+        }
     }).then(() => {
         return updateResultsFromLogFiles(tests, xmlLogFile);
     }).then(result => {