Skip to content

Commit

Permalink
debugger: restart with custom debug port
Browse files Browse the repository at this point in the history 
Fixed a bug in debugger repl where `restart` command did not work
when a custom debug port was specified via command-line option
--port={number}.

File test/simple/helper-debugger-repl.js was extracted
from test/simple/test-debugger-repl.js
  • Loading branch information
@bajtos @piscisaureus
bajtos authored and piscisaureus committed Apr 26, 2013
1 parent 45ed546 commit 74323a9
Show file tree
Hide file tree
Showing 4 changed files with 179 additions and 113 deletions.
7 changes: 4 additions & 3 deletions lib/_debugger.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1601,7 +1601,8 @@ Interface.prototype.trySpawn = function(cb) {
var self = this,
breakpoints = this.breakpoints || [],
port = exports.port,
host = 'localhost';
host = 'localhost',
childArgs = this.args;

this.killChild();

Expand Down Expand Up @@ -1634,13 +1635,13 @@ Interface.prototype.trySpawn = function(cb) {
// Start debugger on custom port
// `node debug --port=5858 app.js`
port = parseInt(match[1], 10);
this.args.splice(0, 2, '--debug-brk=' + port);
childArgs = ['--debug-brk=' + port].concat(this.args.slice(2));
}
}
}

if (!this.child) {
this.child = spawn(process.execPath, this.args);
this.child = spawn(process.execPath, childArgs);

this.child.stdout.on('data', this.childPrint.bind(this));
this.child.stderr.on('data', this.childPrint.bind(this));
Expand Down
141 changes: 141 additions & 0 deletions test/simple/helper-debugger-repl.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,141 @@
// Copyright Joyent, Inc. and other Node contributors.
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to permit
// persons to whom the Software is furnished to do so, subject to the
// following conditions:
//
// The above copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
// USE OR OTHER DEALINGS IN THE SOFTWARE.

process.env.NODE_DEBUGGER_TIMEOUT = 2000;
var common = require('../common');
var assert = require('assert');
var spawn = require('child_process').spawn;

var port = common.PORT + 1337;

var child;
var buffer = '';
var expected = [];

function startDebugger(scriptToDebug) {
scriptToDebug = process.env.NODE_DEBUGGER_TEST_SCRIPT ||
common.fixturesDir + '/' + scriptToDebug;

child = spawn(process.execPath, ['debug', '--port=' + port, scriptToDebug]);

console.error('./node', 'debug', '--port=' + port, scriptToDebug);

child.stdout.setEncoding('utf-8');
child.stdout.on('data', function(data) {
data = (buffer + data).split('\n');
buffer = data.pop();
data.forEach(function(line) {
child.emit('line', line);
});
});
child.stderr.pipe(process.stderr);

child.on('line', function(line) {
line = line.replace(/^(debug> *)+/, '');
console.log(line);
assert.ok(expected.length > 0, 'Got unexpected line: ' + line);

var expectedLine = expected[0].lines.shift();
assert.ok(line.match(expectedLine) !== null, line + ' != ' + expectedLine);

if (expected[0].lines.length === 0) {
var callback = expected[0].callback;
expected.shift();
callback && callback();
}
});

var childClosed = false;
child.on('close', function(code) {
assert(!code);
childClosed = true;
});

var quitCalled = false;
function quit() {
if (quitCalled || childClosed) return;
quitCalled = true;
child.stdin.write('quit');
child.kill('SIGTERM');
}

setTimeout(function() {
console.error('dying badly buffer=%j', buffer);
var err = 'Timeout';
if (expected.length > 0 && expected[0].lines) {
err = err + '. Expected: ' + expected[0].lines.shift();
}

child.on('close', function() {
console.error('child is closed');
throw new Error(err);
});

quit();
}, 5000).unref();

process.once('uncaughtException', function(e) {
console.error('UncaughtException', e, e.stack);
quit();
console.error(e.toString());
process.exit(1);
});

process.on('exit', function(code) {
console.error('process exit', code);
quit();
if (code === 0)
assert(childClosed);
});
}

function addTest(input, output) {
function next() {
if (expected.length > 0) {
console.log('debug> ' + expected[0].input);
child.stdin.write(expected[0].input + '\n');

if (!expected[0].lines) {
var callback = expected[0].callback;
expected.shift();

callback && callback();
}
} else {
quit();
}
};
expected.push({input: input, lines: output, callback: next});
}

var initialLines = [
/listening on port \d+/,
/connecting.* ok/,
/break in .*:1/,
/1/, /2/, /3/
];

// Process initial lines
addTest(null, initialLines);

exports.startDebugger = startDebugger;
exports.addTest = addTest;
exports.initialLines = initialLines;
31 changes: 31 additions & 0 deletions test/simple/test-debugger-repl-restart.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
// Copyright Joyent, Inc. and other Node contributors.
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to permit
// persons to whom the Software is furnished to do so, subject to the
// following conditions:
//
// The above copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
// USE OR OTHER DEALINGS IN THE SOFTWARE.

var repl = require('./helper-debugger-repl.js');

repl.startDebugger('breakpoints.js');

// Restart the debugged script
repl.addTest('restart', [
/terminated/,
].concat(repl.initialLines));

repl.addTest('quit', []);
113 changes: 3 additions & 110 deletions test/simple/test-debugger-repl.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,75 +19,11 @@
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
// USE OR OTHER DEALINGS IN THE SOFTWARE.

process.env.NODE_DEBUGGER_TIMEOUT = 2000;
var common = require('../common');
var assert = require('assert');
var spawn = require('child_process').spawn;
var debug = require('_debugger');
var repl = require('./helper-debugger-repl.js');

var port = common.PORT + 1337;
repl.startDebugger('breakpoints.js');

var script = process.env.NODE_DEBUGGER_TEST_SCRIPT ||
common.fixturesDir + '/breakpoints.js';

var child = spawn(process.execPath, ['debug', '--port=' + port, script]);

console.error('./node', 'debug', '--port=' + port, script);

var buffer = '';
child.stdout.setEncoding('utf-8');
child.stdout.on('data', function(data) {
data = (buffer + data.toString()).split(/\n/g);
buffer = data.pop();
data.forEach(function(line) {
child.emit('line', line);
});
});
child.stderr.pipe(process.stderr);

var expected = [];

child.on('line', function(line) {
line = line.replace(/^(debug> *)+/, '');
console.log(line);
assert.ok(expected.length > 0, 'Got unexpected line: ' + line);

var expectedLine = expected[0].lines.shift();
assert.ok(line.match(expectedLine) !== null, line + ' != ' + expectedLine);

if (expected[0].lines.length === 0) {
var callback = expected[0].callback;
expected.shift();
callback && callback();
}
});

function addTest(input, output) {
function next() {
if (expected.length > 0) {
console.log('debug> ' + expected[0].input);
child.stdin.write(expected[0].input + '\n');

if (!expected[0].lines) {
var callback = expected[0].callback;
expected.shift();

callback && callback();
}
} else {
quit();
}
};
expected.push({input: input, lines: output, callback: next});
}

// Initial lines
addTest(null, [
/listening on port \d+/,
/connecting... ok/,
/break in .*:1/,
/1/, /2/, /3/
]);
var addTest = repl.addTest;

// Next
addTest('n', [
Expand Down Expand Up @@ -139,46 +75,3 @@ addTest('c', [
]);

addTest('quit', []);

var childClosed = false;
child.on('close', function(code) {
assert(!code);
childClosed = true;
});

var quitCalled = false;
function quit() {
if (quitCalled || childClosed) return;
quitCalled = true;
child.stdin.write('quit');
child.kill('SIGTERM');
}

setTimeout(function() {
console.error('dying badly buffer=%j', buffer);
var err = 'Timeout';
if (expected.length > 0 && expected[0].lines) {
err = err + '. Expected: ' + expected[0].lines.shift();
}

child.on('close', function() {
console.error('child is closed');
throw new Error(err);
});

quit();
}, 5000).unref();

process.once('uncaughtException', function(e) {
console.error('UncaughtException', e, e.stack);
quit();
console.error(e.toString());
process.exit(1);
});

process.on('exit', function(code) {
console.error('process exit', code);
quit();
if (code === 0)
assert(childClosed);
});

0 comments on commit 74323a9

Please sign in to comment.