Merge pull request #335 from shelljs/more-exec-options

ariporad · ariporad · commit c0d9cf7ba11f · 2016-02-04T14:56:25.000-08:00
feat(exec): allow all exec options to pass through
diff --git a/README.md b/README.md
@@ -487,6 +487,8 @@ Available options (all `false` by default):
 + `async`: Asynchronous execution. If a callback is provided, it will be set to
   `true`, regardless of the passed value.
 + `silent`: Do not echo program output to console.
++ and any option available to NodeJS's
+  [child_process.exec()](https://nodejs.org/api/child_process.html#child_process_child_process_exec_command_options_callback)
 
 Examples:
 
diff --git a/src/exec.js b/src/exec.js
@@ -5,6 +5,8 @@ var path = require('path');
 var fs = require('fs');
 var child = require('child_process');
 
+var DEFAULT_MAXBUFFER_SIZE = 20*1024*1024;
+
 // Hack to run child_process.exec() synchronously (sync avoids callback hell)
 // Uses a custom wait loop that checks for a flag file, created when the child process is done.
 // (Can't do a wait loop that checks for internal Node variables/messages as
@@ -18,15 +20,18 @@ function execSync(cmd, opts) {
       scriptFile = path.resolve(tempDir+'/'+common.randomFileName()),
       sleepFile = path.resolve(tempDir+'/'+common.randomFileName());
 
-  var options = common.extend({
-    silent: common.config.silent
+  opts = common.extend({
+    silent: common.config.silent,
+    cwd: _pwd(),
+    env: process.env,
+    maxBuffer: DEFAULT_MAXBUFFER_SIZE
   }, opts);
 
   var previousStdoutContent = '',
       previousStderrContent = '';
   // Echoes stdout and stderr changes from running process, if not silent
   function updateStream(streamFile) {
-    if (options.silent || !fs.existsSync(streamFile))
+    if (opts.silent || !fs.existsSync(streamFile))
       return;
 
     var previousStreamContent,
@@ -58,19 +63,13 @@ function execSync(cmd, opts) {
   if (fs.existsSync(codeFile)) common.unlinkSync(codeFile);
 
   var execCommand = '"'+process.execPath+'" '+scriptFile;
-  var execOptions = {
-    env: process.env,
-    cwd: _pwd(),
-    maxBuffer: 20*1024*1024
-  };
-
   var script;
 
   if (typeof child.execSync === 'function') {
     script = [
       "var child = require('child_process')",
       "  , fs = require('fs');",
-      "var childProcess = child.exec('"+escape(cmd)+"', {env: process.env, maxBuffer: 20*1024*1024}, function(err) {",
+      "var childProcess = child.exec('"+escape(cmd)+"', {env: process.env, maxBuffer: "+opts.maxBuffer+"}, function(err) {",
       "  fs.writeFileSync('"+escape(codeFile)+"', err ? err.code.toString() : '0');",
       "});",
       "var stdoutStream = fs.createWriteStream('"+escape(stdoutFile)+"');",
@@ -88,28 +87,28 @@ function execSync(cmd, opts) {
 
     fs.writeFileSync(scriptFile, script);
 
-    if (options.silent) {
-      execOptions.stdio = 'ignore';
+    if (opts.silent) {
+      opts.stdio = 'ignore';
     } else {
-      execOptions.stdio = [0, 1, 2];
+      opts.stdio = [0, 1, 2];
     }
 
     // Welcome to the future
-    child.execSync(execCommand, execOptions);
+    child.execSync(execCommand, opts);
   } else {
     cmd += ' > '+stdoutFile+' 2> '+stderrFile; // works on both win/unix
 
     script = [
       "var child = require('child_process')",
       "  , fs = require('fs');",
-      "var childProcess = child.exec('"+escape(cmd)+"', {env: process.env, maxBuffer: 20*1024*1024}, function(err) {",
+      "var childProcess = child.exec('"+escape(cmd)+"', {env: process.env, maxBuffer: "+opts.maxBuffer+"}, function(err) {",
       "  fs.writeFileSync('"+escape(codeFile)+"', err ? err.code.toString() : '0');",
       "});"
     ].join('\n');
 
     fs.writeFileSync(scriptFile, script);
 
-    child.exec(execCommand, execOptions);
+    child.exec(execCommand, opts);
 
     // The wait loop
     // sleepFile is used as a dummy I/O op to mitigate unnecessary CPU usage
@@ -156,24 +155,27 @@ function execAsync(cmd, opts, callback) {
   var stdout = '';
   var stderr = '';
 
-  var options = common.extend({
-    silent: common.config.silent
+  opts = common.extend({
+    silent: common.config.silent,
+    cwd: _pwd(),
+    env: process.env,
+    maxBuffer: DEFAULT_MAXBUFFER_SIZE
   }, opts);
 
-  var c = child.exec(cmd, {env: process.env, maxBuffer: 20*1024*1024}, function(err) {
+  var c = child.exec(cmd, opts, function(err) {
     if (callback)
       callback(err ? err.code : 0, stdout, stderr);
   });
 
   c.stdout.on('data', function(data) {
     stdout += data;
-    if (!options.silent)
+    if (!opts.silent)
       process.stdout.write(data);
   });
 
   c.stderr.on('data', function(data) {
     stderr += data;
-    if (!options.silent)
+    if (!opts.silent)
       process.stderr.write(data);
   });
 
@@ -187,6 +189,8 @@ function execAsync(cmd, opts, callback) {
 //@ + `async`: Asynchronous execution. If a callback is provided, it will be set to
 //@   `true`, regardless of the passed value.
 //@ + `silent`: Do not echo program output to console.
+//@ + and any option available to NodeJS's
+//@   [child_process.exec()](https://nodejs.org/api/child_process.html#child_process_child_process_exec_command_options_callback)
 //@
 //@ Examples:
 //@
@@ -233,9 +237,13 @@ function _exec(command, options, callback) {
     async: false
   }, options);
 
-  if (options.async)
-    return execAsync(command, options, callback);
-  else
-    return execSync(command, options);
+  try {
+    if (options.async)
+      return execAsync(command, options, callback);
+    else
+      return execSync(command, options);
+  } catch (e) {
+    common.error('internal error');
+  }
 }
 module.exports = _exec;
diff --git a/test/exec.js b/test/exec.js
@@ -1,7 +1,9 @@
 var shell = require('..');
 
-var assert = require('assert'),
-    util = require('util');
+var assert = require('assert');
+var util = require('util');
+var path = require('path');
+var os = require('os');
 
 shell.config.silent = true;
 
@@ -79,6 +81,32 @@ assert.equal(shell.error(), null);
 assert.equal(result.code, 0);
 assert.equal(result.stdout, "'+'_'+'\n");
 
+// set cwd
+var cmdString = process.platform === 'win32' ? 'cd' : 'pwd';
+result = shell.exec(cmdString, {cwd: '..'});
+assert.equal(shell.error(), null);
+assert.equal(result.code, 0);
+assert.equal(result.stdout, path.resolve('..') + os.EOL);
+
+// set maxBuffer (very small)
+result = shell.exec('echo 1234567890'); // default maxBuffer is ok
+assert.equal(shell.error(), null);
+assert.equal(result.code, 0);
+assert.equal(result.stdout, '1234567890' + os.EOL);
+if (process.version >= 'v0.11') { // this option doesn't work on v0.10
+  shell.exec('echo 1234567890', {maxBuffer: 6});
+  assert.ok(shell.error());
+}
+
+// set timeout option
+result = shell.exec('node resources/exec/slow.js'); // default timeout is ok
+assert.ok(!shell.error());
+assert.equal(result.code, 0);
+if (process.version >= 'v0.11') { // this option doesn't work on v0.10
+  result = shell.exec('node resources/exec/slow.js', {timeout: 10}); // times out
+  assert.ok(shell.error());
+}
+
 //
 // async
 //
diff --git a/test/resources/exec/slow.js b/test/resources/exec/slow.js
@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+// sleep for 5 seconds
+setTimeout(function() {
+    console.log('slow');
+}, 100);
