From 3f349c353107c94582960af8f86d896fcfc06095 Mon Sep 17 00:00:00 2001
From: Dave Conway-Jones <conway@uk.ibm.com>
Date: Wed, 29 Mar 2017 21:44:58 +0100
Subject: [PATCH] remove requirement for cmd in exec node config + new style
 info

---
 nodes/core/core/75-exec.html         | 26 +++++++++++++++++---------
 nodes/core/core/75-exec.js           |  3 ++-
 test/nodes/core/core/75-exec_spec.js | 16 ++++++++--------
 3 files changed, 27 insertions(+), 18 deletions(-)

diff --git a/nodes/core/core/75-exec.html b/nodes/core/core/75-exec.html
index 03a02566a..cd0e33fa9 100644
--- a/nodes/core/core/75-exec.html
+++ b/nodes/core/core/75-exec.html
@@ -45,24 +45,32 @@
 
 <script type="text/x-red" data-help-name="exec">
     <p>Calls out to a system command.<br/></p>
-    <p>Provides 3 outputs: stdout, stderr, and return code.</p>
-    <p>By default uses the <code>exec</code> system call which calls the command, waits for it to complete, and
-    returns the normal output to the first port, any error text to the second port, and a return code object to the
-    third port. For example a succesful command should return <code>{ code: 0 }</code>.</p>
+    <p><b>Inputs</b></p>
+    <ul><li><code>msg.payload</code> - optionally appended to the configured command.</li></ul>
+    <ul><li><code><i>msg.kill</i></code> - can be used to kill a running command, see below.</li></ul>
+    <ul><li><code><i>msg.pid</i></code> - can be used to kill a specific running command, see below.</li></ul>
+    <p><b>Outputs</b></p>
+    <ol>
+        <li>stdout, <code>msg.payload</code> containing the returned output from the command.</li>
+        <li>stderr, <code>msg.payload</code> containing any error output from the command.</li>
+        <li>return code, <code>msg.payload</code> containing the return (see below).</li>
+    </ol>
+    <p><b>Details</b></p>
+    <p>By default uses the <code>exec</code> system call which calls the command, waits for it to complete, and then
+    returns the output. For example a succesful command should have a return code of <code>{ code: 0 }</code>.</p>
     <p>Optionally can use <code>spawn</code> instead, which returns the output from stdout and stderr
     as the command runs, usually one line at a time. On completion it then returns a numeric return code
     on the 3rd port. For example a successful command should return <code>0</code>.</p>
-    <p>The <code>exec</code> method spawns a subshell and therefore can be used for more complicated
-    commands involving pipes. However, it waits for completion of the whole command before returing anything.</p>
     <p>The optional <b>append</b> gets added to the command after <code>msg.payload</code> - so you can do
     things like pipe the result to another command.</p>
     <p>Commands or parameters with spaces should be enclosed in quotes - <i>"This is a single parameter"</i></p>
-    <p>The <code>payload</code> is usually a <i>string</i>, unless binary is detected, in which case it contains a <i>buffer</i>.</p>
+    <p>The returned <code>payload</code> is usually a <i>string</i>, unless non-UTF8 characters are detected, in which
+    case it contains a <i>buffer</i>.</p>
     <p>The blue status icon and PID will be visible while the node is active. This can be read by a <code>status</code> node.</p>
     <p>Sending <code>msg.kill</code> will kill a single active process. <code>msg.kill</code> should be a string containing
     the type of signal to be sent, e.g. "SIGINT", "SIGQUIT", "SIGHUP", etc. Defaults to "SIGTERM" if blank ("").
     If there is more than one process running then <code>msg.pid</code> must also be set with the value of the PID to be killed.</p>
-    <p><b>Tip: </b>If running a Python app you may need to use the <code>-u</code> parameter to stop the output being buffered.</p>
+    <p><b>Tip</b>: If running a Python app you may need to use the <code>-u</code> parameter to stop the output being buffered.</p>
 </script>
 
 <script type="text/javascript">
@@ -70,7 +78,7 @@
         category: 'advanced-function',
         color:"darksalmon",
         defaults: {
-            command: {value:"",required:true},
+            command: {value:""},
             addpay: {value:true},
             append: {value:""},
             useSpawn: {value:""},
diff --git a/nodes/core/core/75-exec.js b/nodes/core/core/75-exec.js
index 7d6355baf..b97d2b3a9 100644
--- a/nodes/core/core/75-exec.js
+++ b/nodes/core/core/75-exec.js
@@ -119,7 +119,7 @@ module.exports = function(RED) {
                         msg.payload = new Buffer(stdout,"binary");
                         if (isUtf8(msg.payload)) { msg.payload = msg.payload.toString(); }
                         var msg2 = null;
-                        if(stderr) {
+                        if (stderr) {
                             msg2 = {payload: stderr};
                         }
                         var msg3 = null;
@@ -147,6 +147,7 @@ module.exports = function(RED) {
                 }
             }
         });
+        
         this.on('close',function() {
             for (var pid in node.activeProcesses) {
                 /* istanbul ignore else  */
diff --git a/test/nodes/core/core/75-exec_spec.js b/test/nodes/core/core/75-exec_spec.js
index 86392b10d..7b4901a38 100644
--- a/test/nodes/core/core/75-exec_spec.js
+++ b/test/nodes/core/core/75-exec_spec.js
@@ -52,7 +52,7 @@ describe('exec node', function() {
             var flow = [{id:"n1",type:"exec",wires:[["n2"],["n3"],["n4"]],command:"echo", addpay:false, append:""},
                         {id:"n2", type:"helper"},{id:"n3", type:"helper"},{id:"n4", type:"helper"}];
             var spy = sinon.stub(child_process, 'exec',
-            function(arg1,arg2,arg3,arg4) {
+            function(arg1, arg2, arg3, arg4) {
                 //console.log(arg1);
                 // arg3(error,stdout,stderr);
                 arg3(null,arg1,arg1.toUpperCase());
@@ -70,7 +70,7 @@ describe('exec node', function() {
                     if (received < 3) {
                         return;
                     }
-                    try{
+                    try {
                         var msg = messages[0];
                         msg.should.have.property("payload");
                         msg.payload.should.be.a.String();
@@ -78,7 +78,7 @@ describe('exec node', function() {
 
                         msg = messages[1];
                         msg.should.have.property("payload");
-                        msg.payload.should.be.a.String,
+                        msg.payload.should.be.a.String;
                         msg.payload.should.equal("ECHO");
 
                         msg = messages[2];
@@ -112,7 +112,7 @@ describe('exec node', function() {
             var flow = [{id:"n1",type:"exec",wires:[["n2"],["n3"],["n4"]],command:"echo", addpay:true, append:"more"},
                         {id:"n2", type:"helper"},{id:"n3", type:"helper"},{id:"n4", type:"helper"}];
             var spy = sinon.stub(child_process, 'exec',
-                function(arg1,arg2,arg3,arg4) {
+                function(arg1, arg2, arg3, arg4) {
                     //console.log(arg1);
                     // arg3(error,stdout,stderr);
                     arg3(null,arg1,arg1.toUpperCase());
@@ -165,7 +165,7 @@ describe('exec node', function() {
             var flow = [{id:"n1",type:"exec",wires:[["n2"],["n3"],["n4"]],command:"echo", addpay:true, append:"more"},
                         {id:"n2", type:"helper"},{id:"n3", type:"helper"},{id:"n4", type:"helper"}];
             var spy = sinon.stub(child_process, 'exec',
-                function(arg1,arg2,arg3,arg4) {
+                function(arg1, arg2, arg3, arg4) {
                     //console.log(arg1);
                     // arg3(error,stdout,stderr);
                     arg3("error",new Buffer([0x01,0x02,0x03,0x88]));
@@ -275,7 +275,7 @@ describe('exec node', function() {
             var flow = [{id:"n1",type:"exec",wires:[["n2"],["n3"],["n4"]],command:"error", addpay:false, append:""},
                         {id:"n2", type:"helper"},{id:"n3", type:"helper"},{id:"n4", type:"helper"}];
             var spy = sinon.stub(child_process, 'exec',
-            function(arg1,arg2,arg3,arg4) {
+            function(arg1, arg2, arg3, arg4) {
                 //console.log(arg1);
                 // arg3(error,stdout,stderr);
                 arg3({code: 1},arg1,arg1.toUpperCase());
@@ -292,7 +292,7 @@ describe('exec node', function() {
                     if (received < 3) {
                         return;
                     }
-                    try{
+                    try {
                         var msg = messages[0];
                         msg.should.have.property("payload");
                         msg.payload.should.be.a.String();
@@ -300,7 +300,7 @@ describe('exec node', function() {
 
                         msg = messages[1];
                         msg.should.have.property("payload");
-                        msg.payload.should.be.a.String,
+                        msg.payload.should.be.a.String;
                         msg.payload.should.equal("ERROR");
 
                         msg = messages[2];