Skip to content

doc: child_process: clarify subprocess.pid can be undefined when ENOENT #37014

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.

Sign up for GitHub

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
aduh95 merged 2 commits into from
Feb 22, 2021
Merged

doc: child_process: clarify subprocess.pid can be undefined when ENOENT #37014

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c1c98fb
doc,child_process: `pid` can be `undefined` when `ENOENT`
dr-js Jan 25, 2021
1e0cfa3
test,child_process: add check for `subProcess.pid`
dr-js Jan 25, 2021
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
Prev Previous commit
test,child_process: add check for subProcess.pid 
Note: this only add checks for async spawn, as the sync spawn do not
return a `subProcess`.

PR-URL: #37014
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
  • Loading branch information
@dr-js @aduh95
dr-js authored and aduh95 committed Feb 22, 2021
commit 1e0cfa3361cfb24341096eb907ae47b6b19fcd8f
17 changes: 10 additions & 7 deletions test/parallel/test-child-process-cwd.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,14 @@ const assert = require('assert');
const { spawn } = require('child_process');

// Spawns 'pwd' with given options, then test
// - whether the child pid is undefined or number,
// - whether the exit code equals expectCode,
// - optionally whether the trimmed stdout result matches expectData
function testCwd(options, expectCode = 0, expectData) {
function testCwd(options, expectPidType, expectCode = 0, expectData) {
const child = spawn(...common.pwdCommand, options);

assert.strictEqual(typeof child.pid, expectPidType);

child.stdout.setEncoding('utf8');

// No need to assert callback since `data` is asserted.
Expand All @@ -57,18 +60,18 @@ function testCwd(options, expectCode = 0, expectData) {

// Assume does-not-exist doesn't exist, expect exitCode=-1 and errno=ENOENT
{
testCwd({ cwd: 'does-not-exist' }, -1)
testCwd({ cwd: 'does-not-exist' }, 'undefined', -1)
.on('error', common.mustCall(function(e) {
assert.strictEqual(e.code, 'ENOENT');
}));
}

// Assume these exist, and 'pwd' gives us the right directory back
testCwd({ cwd: tmpdir.path }, 0, tmpdir.path);
testCwd({ cwd: tmpdir.path }, 'number', 0, tmpdir.path);
const shouldExistDir = common.isWindows ? process.env.windir : '/dev';
testCwd({ cwd: shouldExistDir }, 0, shouldExistDir);
testCwd({ cwd: shouldExistDir }, 'number', 0, shouldExistDir);

// Spawn() shouldn't try to chdir() to invalid arg, so this should just work
testCwd({ cwd: '' });
testCwd({ cwd: undefined });
testCwd({ cwd: null });
testCwd({ cwd: '' }, 'number');
testCwd({ cwd: undefined }, 'number');
testCwd({ cwd: null }, 'number');
14 changes: 9 additions & 5 deletions test/parallel/test-child-process-exec-error.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,21 @@ const common = require('../common');
const assert = require('assert');
const child_process = require('child_process');

function test(fn, code) {
fn('does-not-exist', common.mustCall(function(err) {
function test(fn, code, expectPidType = 'number') {
const child = fn('does-not-exist', common.mustCall(function(err) {
assert.strictEqual(err.code, code);
assert(err.cmd.includes('does-not-exist'));
}));

assert.strictEqual(typeof child.pid, expectPidType);
}

// With `shell: true`, expect pid (of the shell)
if (common.isWindows) {
test(child_process.exec, 1); // Exit code of cmd.exe
test(child_process.exec, 1, 'number'); // Exit code of cmd.exe
} else {
test(child_process.exec, 127); // Exit code of /bin/sh
test(child_process.exec, 127, 'number'); // Exit code of /bin/sh
}

test(child_process.execFile, 'ENOENT');
// With `shell: false`, expect no pid
test(child_process.execFile, 'ENOENT', 'undefined');
3 changes: 3 additions & 0 deletions test/parallel/test-child-process-spawn-error.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@ assert.strictEqual(enoentChild.stdio[0], enoentChild.stdin);
assert.strictEqual(enoentChild.stdio[1], enoentChild.stdout);
assert.strictEqual(enoentChild.stdio[2], enoentChild.stderr);

// Verify pid is not assigned.
assert.strictEqual(enoentChild.pid, undefined);

enoentChild.on('spawn', common.mustNotCall());

enoentChild.on('error', common.mustCall(function(err) {
Expand Down