Enable testing of the new debug adapter. (microsoft#11908)

For microsoft#11704, microsoft#11733, and microsoft#9383 (and microsoft#4758?). We had a bunch of tests for the old debug adapter, but they were all disabled due to flakiness. Pretty much none of them are valid now that we've removed the old debug adapter. So we've removed all the old tests and added some new ones that run against the VS Code API (rather than using a DAP client).

Author: Eric Snow

build/ci/vscode-python-pr-validation.yaml

@@ -7,7 +7,11 @@ name: '$(Year:yyyy).$(Month).0.$(BuildID)-pr'
 pr:
  autoCancel: true
  branches:
- include: ['master', 'release*', 'ds*']
+ include:
+ - 'master'
+ - 'release*'
+ - 'ds*'
+ - 'logging-changes-and-drop-old-debugger'
  paths:
  exclude: ['/news/1 Enhancements', '/news/2 Fixes', '/news/3 Code Health', '/.vscode']
 

src/test/.vscode/launch.json

@@ -0,0 +1,37 @@
+{
+ "version": "0.1.0",
+ "configurations": [
+ {
+ "name": "launch a file",
+ "type": "python",
+ "request": "launch",
+ "program": "${file}",
+ "console": "integratedTerminal"
+ },
+ {
+ "name": "attach to a local port",
+ "type": "python",
+ "request": "attach",
+ "port": 5678,
+ "host": "localhost",
+ "pathMappings": [
+ {
+ "localRoot": "${workspaceFolder}",
+ "remoteRoot": "."
+ }
+ ]
+ },
+ {
+ "name": "attach to a local PID",
+ "type": "python",
+ "request": "attach",
+ "processId": "${env:CI_DEBUGPY_PROCESS_ID}",
+ "pathMappings": [
+ {
+ "localRoot": "${workspaceFolder}",
+ "remoteRoot": "."
+ }
+ ]
+ }
+ ]
+}

src/test/.vscode/launch.json.README

@@ -0,0 +1,3 @@
+// These configs are used in full-stack integration tests.
+// They mostly borrow from the code in src/client/debugger/extension/configuration/providers.
+

src/test/common/platform/utils.ts

@@ -8,6 +8,7 @@ import * as fsextra from 'fs-extra';
 import * as net from 'net';
 import * as path from 'path';
 import * as tmpMod from 'tmp';
+import { CleanupFixture } from '../../fixtures';
 
 // Note: all functional tests that trigger the VS Code "fs" API are
 // found in filesystem.test.ts.
@@ -94,36 +95,6 @@ export class SystemError extends Error {
  }
 }
 
-export class CleanupFixture {
- private cleanups: (() => void | Promise<void>)[];
- constructor() {
- this.cleanups = [];
- }
-
- public addCleanup(cleanup: () => void | Promise<void>) {
- this.cleanups.push(cleanup);
- }
-
- public async cleanUp() {
- const cleanups = this.cleanups;
- this.cleanups = [];
-
- return Promise.all(
- cleanups.map(async (cleanup, i) => {
- try {
- const res = cleanup();
- if (res) {
- await res;
- }
- } catch (err) {
- console.log(`cleanup ${i + 1} failed: ${err}`);
- console.log('moving on...');
- }
- })
- );
- }
-}
-
 export class FSFixture extends CleanupFixture {
  private tempDir: string | undefined;
  private sockServer: net.Server | undefined;

src/test/debugger/attach.ptvsd.test.ts

@@ -0,0 +1,110 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+'use strict';
+
+import { expect } from 'chai';
+import * as fs from 'fs-extra';
+import * as path from 'path';
+import * as vscode from 'vscode';
+import { openFile } from '../../../common';
+import { EXTENSION_ROOT_DIR_FOR_TESTS } from '../../../constants';
+import { closeActiveWindows, initialize, initializeTest, IS_MULTI_ROOT_TEST, TEST_DEBUGGER } from '../../../initialize';
+import { DebuggerFixture } from '../../utils';
+
+const WS_ROOT = path.join(EXTENSION_ROOT_DIR_FOR_TESTS, 'src', 'test');
+
+function resolveWSFile(wsRoot: string, ...filePath: string[]): string {
+ return path.join(wsRoot, ...filePath);
+}
+
+suite('Debugger Integration', () => {
+ const file = resolveWSFile(WS_ROOT, 'pythonFiles', 'debugging', 'wait_for_file.py');
+ const doneFile = resolveWSFile(WS_ROOT, 'should-not-exist');
+ const outFile = resolveWSFile(WS_ROOT, 'output.txt');
+ const resource = vscode.Uri.file(file);
+ const defaultScriptArgs = [doneFile];
+ let workspaceRoot: vscode.WorkspaceFolder;
+ let fix: DebuggerFixture;
+ suiteSetup(async function () {
+ if (IS_MULTI_ROOT_TEST || !TEST_DEBUGGER) {
+ // tslint:disable-next-line:no-invalid-this
+ this.skip();
+ }
+ await initialize();
+ const ws = vscode.workspace.getWorkspaceFolder(resource);
+ workspaceRoot = ws!;
+ expect(workspaceRoot).to.not.equal(undefined, 'missing workspace root');
+ });
+ setup(async () => {
+ fix = new DebuggerFixture();
+ await initializeTest();
+ await openFile(file);
+ });
+ teardown(async () => {
+ await fix.cleanUp();
+ fix.addFSCleanup(outFile);
+ await closeActiveWindows();
+ });
+ async function setDone() {
+ await fs.writeFile(doneFile, '');
+ fix.addFSCleanup(doneFile);
+ }
+
+ type ConfigName = string;
+ type ScriptArgs = string[];
+ const tests: { [key: string]: [ConfigName, ScriptArgs] } = {
+ // prettier-ignore
+ 'launch': ['launch a file', [...defaultScriptArgs, outFile]],
+ // prettier-ignore
+ 'attach': ['attach to a local port', defaultScriptArgs],
+ 'attach to PID': ['attach to a local PID', defaultScriptArgs]
+ // For now we do not worry about "test" debugging.
+ };
+
+ suite('run to end', () => {
+ for (const kind of Object.keys(tests)) {
+ if (kind === 'attach to PID') {
+ // Attach-to-pid is still a little finicky
+ // so we're skipping it for now.
+ continue;
+ }
+ const [configName, scriptArgs] = tests[kind];
+ test(kind, async () => {
+ const session = fix.resolveDebugger(configName, file, scriptArgs, workspaceRoot);
+ await session.start();
+ // Any debugger ops would go here.
+ await new Promise((r) => setTimeout(r, 300)); // 0.3 seconds
+ await setDone();
+ const result = await session.waitUntilDone();
+
+ expect(result.exitCode).to.equal(0, 'bad exit code');
+ const output = result.stdout !== '' ? result.stdout : fs.readFileSync(outFile).toString();
+ expect(output.trim().endsWith('done!')).to.equal(true, `bad output\n${output}`);
+ });
+ }
+ });
+
+ suite('handles breakpoint', () => {
+ for (const kind of ['launch', 'attach']) {
+ if (kind === 'attach') {
+ // The test isn't working quite right for attach
+ // so we skip it for now.
+ continue;
+ }
+ const [configName, scriptArgs] = tests[kind];
+ test(kind, async () => {
+ const session = fix.resolveDebugger(configName, file, scriptArgs, workspaceRoot);
+ const bp = session.addBreakpoint(file, 21); // line: "time.sleep()"
+ await session.start();
+ await session.waitForBreakpoint(bp);
+ await setDone();
+ const result = await session.waitUntilDone();
+
+ expect(result.exitCode).to.equal(0, 'bad exit code');
+ const output = result.stdout !== '' ? result.stdout : fs.readFileSync(outFile).toString();
+ expect(output.trim().endsWith('done!')).to.equal(true, `bad output\n${output}`);
+ });
+ }
+ });
+});