Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Added unit test attaching a debugger #597

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 59 commits into from
Jan 19, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
59 commits
Select commit Hold shift + click to select a range
ecc1ca9
Fix Microsoft/vscode#37627 (#1368)
octref Nov 3, 2017
7c5778c
Version 0.7.0 of extension (#1381)
DonJayamanne Nov 9, 2017
9d1bf82
Update README.md
DonJayamanne Nov 9, 2017
ffba179
Update README.md
DonJayamanne Nov 9, 2017
905c713
sync fork with upstream
DonJayamanne Nov 10, 2017
acc2109
fix readme
DonJayamanne Nov 10, 2017
d470523
Merge branch 'master' of https://github.com/Microsoft/vscode-python
DonJayamanne Nov 16, 2017
d392e8b
merged upstream
DonJayamanne Nov 16, 2017
92f775f
Merge remote-tracking branch 'upstream/master'
DonJayamanne Nov 20, 2017
32a6e53
Merge remote-tracking branch 'upstream/master'
DonJayamanne Nov 21, 2017
4b30f2c
Merge remote-tracking branch 'upstream/master'
DonJayamanne Nov 22, 2017
e396752
Merge remote-tracking branch 'upstream/master'
DonJayamanne Nov 22, 2017
eff4792
Merge remote-tracking branch 'upstream/master'
DonJayamanne Nov 28, 2017
4553c28
Merge remote-tracking branch 'upstream/master'
DonJayamanne Nov 28, 2017
3c6520a
Merge remote-tracking branch 'upstream/master'
DonJayamanne Nov 28, 2017
966e516
Merge remote-tracking branch 'upstream/master'
DonJayamanne Nov 28, 2017
63d2d65
Merge remote-tracking branch 'upstream/master'
DonJayamanne Nov 28, 2017
f6d469e
Merge remote-tracking branch 'upstream/master'
DonJayamanne Nov 28, 2017
029e055
Merge remote-tracking branch 'upstream/master'
DonJayamanne Nov 30, 2017
e8c71c0
Merge remote-tracking branch 'upstream/master'
DonJayamanne Nov 30, 2017
51cf9d2
Merge remote-tracking branch 'upstream/master'
DonJayamanne Dec 1, 2017
7aadc43
Merge remote-tracking branch 'upstream/master'
DonJayamanne Dec 1, 2017
f0f5c59
Merge remote-tracking branch 'upstream/master'
DonJayamanne Dec 4, 2017
b2b9da9
Merge remote-tracking branch 'upstream/master'
DonJayamanne Dec 4, 2017
30a4091
Merge remote-tracking branch 'upstream/master'
DonJayamanne Dec 5, 2017
b16d2f9
Merge remote-tracking branch 'upstream/master'
DonJayamanne Dec 6, 2017
c8db345
Merge remote-tracking branch 'upstream/master'
DonJayamanne Dec 7, 2017
0df7f16
Merge remote-tracking branch 'upstream/master'
DonJayamanne Dec 8, 2017
3ccc881
Merge remote-tracking branch 'upstream/master'
DonJayamanne Dec 9, 2017
bb0709e
Merge remote-tracking branch 'upstream/master'
DonJayamanne Dec 11, 2017
2c19004
Merge remote-tracking branch 'upstream/master'
DonJayamanne Dec 11, 2017
8f224ab
Merge remote-tracking branch 'upstream/master'
DonJayamanne Dec 11, 2017
41b7080
Merge remote-tracking branch 'upstream/master'
DonJayamanne Dec 12, 2017
dab38dc
Merge remote-tracking branch 'upstream/master'
DonJayamanne Dec 12, 2017
ae22dd4
Merge remote-tracking branch 'upstream/master'
DonJayamanne Dec 12, 2017
d2340d2
Merge remote-tracking branch 'upstream/master'
DonJayamanne Dec 14, 2017
52bb7ae
Merge remote-tracking branch 'upstream/master'
DonJayamanne Dec 15, 2017
b6b2531
Merge remote-tracking branch 'upstream/master'
DonJayamanne Dec 19, 2017
8d8d2fc
Merge remote-tracking branch 'upstream/master'
DonJayamanne Dec 19, 2017
c425a55
Merge remote-tracking branch 'upstream/master'
DonJayamanne Jan 3, 2018
3963217
Merge remote-tracking branch 'upstream/master'
DonJayamanne Jan 3, 2018
a696f2a
Merge remote-tracking branch 'upstream/master'
DonJayamanne Jan 3, 2018
a31e659
Merge remote-tracking branch 'upstream/master'
DonJayamanne Jan 4, 2018
2663cd5
Merge remote-tracking branch 'upstream/master'
DonJayamanne Jan 4, 2018
7c85e0b
Merge remote-tracking branch 'upstream/master'
DonJayamanne Jan 5, 2018
beb82c2
Merge remote-tracking branch 'upstream/master'
DonJayamanne Jan 9, 2018
01e722a
Merge remote-tracking branch 'upstream/master'
DonJayamanne Jan 10, 2018
d84da8e
Merge remote-tracking branch 'upstream/master'
DonJayamanne Jan 17, 2018
56d9ac4
tests for attaching a debugger
DonJayamanne Jan 17, 2018
ba5699d
fix code review comments
DonJayamanne Jan 17, 2018
a952b2e
try change to ip
DonJayamanne Jan 17, 2018
d383caf
limited test
DonJayamanne Jan 17, 2018
524f078
start from port 3000
DonJayamanne Jan 17, 2018
3c0bb33
flush stdout and wait till proc starts
DonJayamanne Jan 17, 2018
c062b7f
remove input prompt
DonJayamanne Jan 18, 2018
ce27f37
flush and ignore linebreaks
DonJayamanne Jan 18, 2018
c528c6d
await for continuation
DonJayamanne Jan 18, 2018
0f7f879
revert change
DonJayamanne Jan 18, 2018
41068a8
disable the test
DonJayamanne Jan 18, 2018
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
125 changes: 125 additions & 0 deletions src/test/debugger/attach.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

import { expect, use } from 'chai';
import * as chaiAsPromised from 'chai-as-promised';
import { ChildProcess } from 'child_process';
import * as getFreePort from 'get-port';
import { EOL } from 'os';
import * as path from 'path';
import { ThreadEvent } from 'vscode-debugadapter';
import { DebugClient } from 'vscode-debugadapter-testsupport';
import { createDeferred } from '../../client/common/helpers';
import { BufferDecoder } from '../../client/common/process/decoder';
import { ProcessService } from '../../client/common/process/proc';
import { AttachRequestArguments } from '../../client/debugger/Common/Contracts';
import { initialize } from '../initialize';

use(chaiAsPromised);

const fileToDebug = path.join(__dirname, '..', '..', '..', 'src', 'testMultiRootWkspc', 'workspace5', 'remoteDebugger.py');
const ptvsdPath = path.join(__dirname, '..', '..', '..', 'pythonFiles', 'PythonTools');
const DEBUG_ADAPTER = path.join(__dirname, '..', '..', 'client', 'debugger', 'Main.js');

// tslint:disable-next-line:max-func-body-length
suite('Attach Debugger', () => {
let debugClient: DebugClient;
let procToKill: ChildProcess;
suiteSetup(function () {
// tslint:disable-next-line:no-invalid-this
this.skip();
return initialize();
});

setup(async () => {
await new Promise(resolve => setTimeout(resolve, 1000));
debugClient = new DebugClient('node', DEBUG_ADAPTER, 'python');
await debugClient.start();
});
teardown(async () => {
// Wait for a second before starting another test (sometimes, sockets take a while to get closed).
await new Promise(resolve => setTimeout(resolve, 1000));
try {
debugClient.stop();
// tslint:disable-next-line:no-empty
} catch (ex) { }
if (procToKill) {
procToKill.kill();
}
});
test('Confirm we are able to attach to a running program', async () => {
const port = await getFreePort({ host: 'localhost', port: 3000 });
const args: AttachRequestArguments = {
localRoot: path.dirname(fileToDebug),
remoteRoot: path.dirname(fileToDebug),
port: port,
host: 'localhost',
secret: 'super_secret'
};

const customEnv = { ...process.env };

// Set the path for PTVSD to be picked up.
// tslint:disable-next-line:no-string-literal
customEnv['PYTHONPATH'] = ptvsdPath;
const procService = new ProcessService(new BufferDecoder());
const result = procService.execObservable('python', [fileToDebug, port.toString()], { env: customEnv, cwd: path.dirname(fileToDebug) });
procToKill = result.proc;

const completed = createDeferred();
const expectedOutputs = [
{ value: 'start', deferred: createDeferred() },
{ value: 'Peter Smith', deferred: createDeferred() },
{ value: 'end', deferred: createDeferred() }
];
const startOutputReceived = expectedOutputs[0].deferred.promise;
const firstOutputReceived = expectedOutputs[1].deferred.promise;
const secondOutputReceived = expectedOutputs[2].deferred.promise;

result.out.subscribe(output => {
if (expectedOutputs[0].value === output.out) {
expectedOutputs.shift()!.deferred.resolve();
}
}, ex => {
completed.reject(ex);
}, () => {
completed.resolve();
});

await startOutputReceived;

const threadIdPromise = createDeferred<number>();
debugClient.on('thread', (data: ThreadEvent) => {
if (data.body.reason === 'started') {
threadIdPromise.resolve(data.body.threadId);
}
});

const initializePromise = debugClient.initializeRequest({
adapterID: 'python',
linesStartAt1: true,
columnsStartAt1: true,
supportsRunInTerminalRequest: true,
pathFormat: 'path'
});
await debugClient.attachRequest(args);
await initializePromise;

// Wait till we get the thread of the program.
const threadId = await threadIdPromise.promise;
expect(threadId).to.be.greaterThan(0, 'ThreadId not received');

// Continue the program.
await debugClient.continueRequest({ threadId });

// Value for input prompt.
result.proc.stdin.write(`Peter Smith${EOL}`);
await firstOutputReceived;

result.proc.stdin.write(`${EOL}`);
await secondOutputReceived;
await completed.promise;

await debugClient.waitForEvent('terminated');
});
});
16 changes: 16 additions & 0 deletions src/testMultiRootWkspc/workspace5/remoteDebugger.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
import sys
import ptvsd
import time

sys.stdout.write('start')
sys.stdout.flush()
address = ('0.0.0.0', int(sys.argv[1]))
ptvsd.enable_attach('super_secret', address)
ptvsd.wait_for_attach()

name = input()
sys.stdout.write(name)
sys.stdout.flush()
input()
sys.stdout.write('end')
sys.stdout.flush()