Skip to content

Commit

Permalink
chore(test): improve log output on error
Browse files Browse the repository at this point in the history
  • Loading branch information
mmarchini committed Jul 15, 2023
1 parent 1b94e27 commit 8001691
Show file tree
Hide file tree
Showing 8 changed files with 21 additions and 19 deletions.
18 changes: 18 additions & 0 deletions test/common.js
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,15 @@ function startFixtureProcess(t, withInspector = false, port = '0') {
execArgv.push('--inspect');
}
const child = fork('./test/fixtures/default-program.js', { execArgv, silent: true});
let output = '';
child.stdout.setEncoding('utf-8');
child.stdout.on('data', (data) => output += `[${ child.pid }][stdout] ${ data }`);
child.stderr.setEncoding('utf-8');
child.stderr.on('data', (data) => output += `[${ child.pid }][stderr] ${ data }`);
const fixture = new FixtureProcess(child);
fixture.on('timeout', t.fail);
t.once('result', ({ ok }) => { if (!ok) { console.log(output) } });
t.teardown(() => fixture.exit());
return fixture;
}

Expand Down Expand Up @@ -128,6 +135,7 @@ class FixtureProcess extends EventEmitter {
super();
this._p = p;
this.pid = p.pid;
this.exited = false;
this._backlog = {};
p.on('message', ({ event, payload }) => {
payload = payload || {};
Expand All @@ -152,6 +160,16 @@ class FixtureProcess extends EventEmitter {
send(event, payload = {}) {
this._p.send({ event, payload });
}

exit() {
// I'm not sure this is the best way to handle this, but there is one test
// that needs to call exit(), but we want to have teardown() run it for
// every other test
if (!this.exited) {
this.exited = true;
this.send('exit');
}
}
}

function validateCpuProfile({ nodes, startTime, endTime, samples, timeDeltas }) {
Expand Down
2 changes: 2 additions & 0 deletions test/fixtures/default-program.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ function maybeSendInspectorReadyEvent() {
}

function openInspector() {
console.log('opening inspector');
inspector.open();
console.log('inspector opened');
maybeSendInspectorReadyEvent();
}

Expand Down
3 changes: 0 additions & 3 deletions test/test-cpu-profile.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ test('take cpu profile', (t) => {
t.notEqual(stream.data.length, 0);
const result = JSON.parse(stream.data);
t.ok(validateCpuProfile(result));
f.send('exit');
t.end();
});
});
Expand All @@ -37,7 +36,6 @@ test('take cpu profile with duration', (t) => {
const result = JSON.parse(stream.data);
t.ok(validateCpuProfile(result));

f.send('exit');
t.end();
});
});
Expand All @@ -58,7 +56,6 @@ test('take cpu profile with samplingInterval', (t) => {
// samples will be captured.
t.ok(samples1.length * 3 < samples2.length);

f.send('exit');
t.end();
});
});
7 changes: 0 additions & 7 deletions test/test-executables.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ test('observe heap-profile', async (t) => {
t.notEqual(head, undefined);
const { callFrame } = head;
t.notEqual(callFrame, undefined);
f.send('exit');
t.end();
});
});
Expand All @@ -33,7 +32,6 @@ test('observe heap-profile to file', async (t) => {
t.notEqual(head, undefined);
const { callFrame } = head;
t.notEqual(callFrame, undefined);
f.send('exit');
t.end();
});
});
Expand All @@ -49,7 +47,6 @@ test('observe heap-snapshot', async (t) => {
t.notEqual(nodes, undefined);
t.notEqual(edges, undefined);
t.notEqual(strings, undefined);
f.send('exit');
t.end();
});
});
Expand All @@ -65,7 +62,6 @@ test('observe heap-snapshot to file', async (t) => {
t.notEqual(nodes, undefined);
t.notEqual(edges, undefined);
t.notEqual(strings, undefined);
f.send('exit');
t.end();
});
});
Expand All @@ -77,7 +73,6 @@ test('observe cpu-profile', async (t) => {
const options = { pid: f.pid, port, options: ['-d', 1]};
const result = await runObserveExecutable('cpu-profile', options);
t.ok(validateCpuProfile(result));
f.send('exit');
t.end();
});
});
Expand All @@ -89,7 +84,6 @@ test('observe cpu-profile to file', async (t) => {
const options = { pid: f.pid, port, toFile: true, options: ['-d', 1]};
const result = await runObserveExecutable('cpu-profile', options);
t.ok(validateCpuProfile(result));
f.send('exit');
t.end();
});
});
Expand All @@ -103,7 +97,6 @@ test('observe --close', async (t) => {
setTimeout(async () => {
t.notOk(await isPortInUse(port));
t.ok(validateCpuProfile(result));
f.send('exit');
t.end();
}, 500);
});
Expand Down
3 changes: 0 additions & 3 deletions test/test-heap-profile.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ test('take heap profile', (t) => {
t.notEqual(head, undefined);
const { callFrame } = head;
t.notEqual(callFrame, undefined);
f.send('exit');
t.end();
});
});
Expand All @@ -41,7 +40,6 @@ test('take heap profile with duration', (t) => {
const { callFrame } = head;
t.notEqual(callFrame, undefined);

f.send('exit');
t.end();
});
});
Expand All @@ -61,7 +59,6 @@ test('take heap profile with samplingInterval', (t) => {
// is a grouped profile format.
t.ok(stream1.data.length * 3 < stream2.data.length);

f.send('exit');
t.end();
});
});
1 change: 0 additions & 1 deletion test/test-heap-snapshot.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ test('take heap snapshot', (t) => {
t.notEqual(nodes, undefined);
t.notEqual(edges, undefined);
t.notEqual(strings, undefined);
f.send('exit');
t.end();
});
});
3 changes: 0 additions & 3 deletions test/test-inspector-client.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ test('attach to existing process', (t) => {
try {
await client.connect();
await client.disconnect();
f.send('exit');
t.end();
} catch (e) {
t.fail(e.toString())
Expand All @@ -33,7 +32,6 @@ test('send message', (t) => {
t.deepEqual(await client.post('Profiler.enable'), {});
t.deepEqual(await client.post('Profiler.disable', {}), {});
await client.disconnect();
f.send('exit');
t.end();
} catch (e) {
t.fail(e.toString())
Expand All @@ -56,7 +54,6 @@ test('receive message', (t) => {
});
client.on('Debugger.resumed', async () => {
await client.disconnect();
f.send('exit');
t.end();
});
t.deepEqual(await client.post('Debugger.pause', {}), {});
Expand Down
3 changes: 1 addition & 2 deletions test/test-utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,13 @@ test('attach to existing process', (t) => {
}));

f.on('inspectorReady', () => {
f.send('exit');
t.end();
});
});

test('attach to non-existing process', (t) => {
const f = startFixtureProcess(t);
f.on('ready', () => f.send('exit'));
f.on('ready', () => f.exit());

// TODO(mmarchini): There's probably a better way to do this.
f._p.on('close', () => {
Expand Down

0 comments on commit 8001691

Please sign in to comment.