Skip to content

Commit db5006c

Browse files
micelliusmicellius
committed
Add test debugging support
When cli.js executed by Node.js running in debug mode, child processes are also running in debug mode with different port. It is possible to run cli.js in normal mode and debug only child processes using --debug option. It is possible to specify debug port after --debug option. Close qunitjs#108.
1 parent 7065bb8 commit db5006c

File tree

4 files changed

+77
-45
lines changed

4 files changed

+77
-45
lines changed

‎bin/cli.js

+10-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ var root = __dirname + '/..',
88
args = argsparser.parse(),
99
testrunner = require(root),
1010
o = testrunner.options,
11-
code, tests,
11+
code, tests, debug,
1212
help;
1313

1414
help = ''
@@ -17,6 +17,7 @@ help = ''
1717
+ '\nOptions:'
1818
+ '\n -c, --code path to code you want to test'
1919
+ '\n -t, --tests path to tests (space separated)'
20+
+ '\n --debug debugging port'
2021
+ '\n -d, --deps dependency paths - files required before code (space separated)'
2122
+ '\n -l, --log logging options, json have to be used'
2223
+ '\n --cov create tests coverage report'
@@ -65,6 +66,9 @@ for (var key in args) {
6566
// of QUnit in browsers.
6667
tests = args[key];
6768
break;
69+
case '--debug':
70+
debug = args[key];
71+
break;
6872
case '-d':
6973
case '--deps':
7074
o.deps = args[key];
@@ -105,7 +109,11 @@ if(!code || !tests) {
105109
return;
106110
}
107111

108-
testrunner.run({ code: code, tests: tests, deps: o.deps, log: o.log }, function(err, stats) {
112+
debug = debug || process.execArgv.reduce(function (prevArg, curArg) {
113+
return prevArg || curArg.indexOf('--debug') === 0;
114+
}, false);
115+
116+
testrunner.run({ code: code, tests: tests, deps: o.deps, log: o.log, debug: debug }, function(err, stats) {
109117
if (err) {
110118
console.error(err);
111119
process.exit(1);

‎lib/child.js

+8-6
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,15 @@ var options = JSON.parse(process.argv.pop()),
1616
currentModule = path.basename(options.code.path, '.js'),
1717
currentTest;
1818

19-
// send ping messages to when child is blocked.
20-
// after I sent the first ping, testrunner will start to except the next ping
21-
// within maxBlockDuration, otherwise this process will be killed
22-
process.send({event: 'ping'});
23-
setInterval(function() {
19+
if(!options.debug) {
20+
// send ping messages to when child is blocked.
21+
// after I sent the first ping, testrunner will start to except the next ping
22+
// within maxBlockDuration, otherwise this process will be killed
2423
process.send({event: 'ping'});
25-
}, Math.floor(options.maxBlockDuration / 2));
24+
setInterval(function () {
25+
process.send({event: 'ping'});
26+
}, Math.floor(options.maxBlockDuration / 2));
27+
}
2628

2729
process.on('uncaughtException', function(err) {
2830
if (QUnit.config.current) {

‎lib/testrunner.js

+57-36
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ var fs = require('fs'),
33
coverage = require('./coverage'),
44
cp = require('child_process'),
55
_ = require('underscore'),
6+
freeport = require('freeport'),
67
log = exports.log = require('./log');
78

89
var options,
@@ -48,7 +49,10 @@ options = exports.options = {
4849
namespace: null,
4950

5051
// max amount of ms child can be blocked, after that we assume running an infinite loop
51-
maxBlockDuration: 2000
52+
maxBlockDuration: 2000,
53+
54+
// port that should be used for debugging
55+
debug: null
5256
};
5357

5458
/**
@@ -60,9 +64,23 @@ function runOne(opts, callback) {
6064
var child;
6165
var pingCheckTimeoutId;
6266
var argv = process.argv.slice();
67+
var debug = opts.debug;
6368

6469
argv.push(JSON.stringify(opts));
65-
child = cp.fork(__dirname + '/child.js', argv, {env: process.env});
70+
71+
if (debug) {
72+
if (typeof debug === 'boolean') {
73+
freeport(function (er, port) {
74+
process.execArgv.push('--debug-brk=' + port);
75+
fork();
76+
});
77+
} else {
78+
process.execArgv.push('--debug-brk=' + debug);
79+
fork();
80+
}
81+
} else {
82+
fork();
83+
}
6684

6785
function kill() {
6886
process.removeListener('exit', kill);
@@ -75,40 +93,43 @@ function runOne(opts, callback) {
7593
callback(err, data)
7694
}
7795

78-
child.on('message', function(msg) {
79-
switch (msg.event) {
80-
case 'ping':
81-
clearTimeout(pingCheckTimeoutId);
82-
pingCheckTimeoutId = setTimeout(function() {
83-
complete(new Error('Process blocked for too long'));
84-
}, opts.maxBlockDuration);
85-
break;
86-
case 'assertionDone':
87-
log.add('assertions', msg.data);
88-
break;
89-
case 'testDone':
90-
log.add('tests', msg.data);
91-
break;
92-
case 'done':
93-
clearTimeout(pingCheckTimeoutId);
94-
msg.data.code = opts.code.path;
95-
log.add('summaries', msg.data);
96-
if (opts.coverage) {
97-
coverage.add(msg.data.coverage);
98-
msg.data.coverage = coverage.get();
99-
msg.data.coverage.code = msg.data.code;
100-
log.add('coverages', msg.data.coverage);
101-
}
102-
if (opts.log.testing) {
103-
console.log('done');
104-
}
105-
complete(null, msg.data);
106-
break;
107-
case 'uncaughtException':
108-
complete(_.extend(new Error(), msg.data));
109-
break;
110-
}
111-
});
96+
function fork() {
97+
child = cp.fork(__dirname + '/child.js', argv, {env: process.env});
98+
child.on('message', function (msg) {
99+
switch (msg.event) {
100+
case 'ping':
101+
clearTimeout(pingCheckTimeoutId);
102+
pingCheckTimeoutId = setTimeout(function () {
103+
complete(new Error('Process blocked for too long'));
104+
}, opts.maxBlockDuration);
105+
break;
106+
case 'assertionDone':
107+
log.add('assertions', msg.data);
108+
break;
109+
case 'testDone':
110+
log.add('tests', msg.data);
111+
break;
112+
case 'done':
113+
clearTimeout(pingCheckTimeoutId);
114+
msg.data.code = opts.code.path;
115+
log.add('summaries', msg.data);
116+
if (opts.coverage) {
117+
coverage.add(msg.data.coverage);
118+
msg.data.coverage = coverage.get();
119+
msg.data.coverage.code = msg.data.code;
120+
log.add('coverages', msg.data.coverage);
121+
}
122+
if (opts.log.testing) {
123+
console.log('done');
124+
}
125+
complete(null, msg.data);
126+
break;
127+
case 'uncaughtException':
128+
complete(_.extend(new Error(), msg.data));
129+
break;
130+
}
131+
});
132+
}
112133

113134
process.on('exit', kill);
114135

‎package.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "qunit",
33
"description": "QUnit testing framework for nodejs",
4-
"version": "0.7.5",
4+
"version": "0.7.6",
55
"author": "Oleg Slobodskoi <[email protected]>",
66
"contributors": [
77
{
@@ -39,6 +39,7 @@
3939
"argsparser": "^0.0.6",
4040
"cli-table": "^0.3.0",
4141
"co": "^3.0.6",
42+
"freeport": "^1.0.3",
4243
"qunitjs": "1.10.0",
4344
"tracejs": "^0.1.8",
4445
"underscore": "^1.6.0"

0 commit comments

Comments
 (0)