Merge pull request #4807 from Microsoft/users/lukillgo/sshscript

#959233: SSH: add inline script support

Author: lkillgore

Tasks/SSH/Strings/resources.resjson/en-US/resources.resjson

@@ -12,6 +12,8 @@
   "loc.input.help.commands": "Specify the shell commands to run on the remote machine. Enter each command along with its arguments on a new line. To run multiple commands together, enter them on the same line separated by semi-colons (e.g. cd /home/user/myFolder;build).",
   "loc.input.label.scriptPath": "Shell script path",
   "loc.input.help.scriptPath": "Path to the shell script file to run on the remote machine.",
+  "loc.input.label.inline": "Inline Script",
+  "loc.input.help.inline": "Write the shell script to run on the remote machine.",
   "loc.input.label.args": "Arguments",
   "loc.input.help.args": "Arguments to pass to the shell script.",
   "loc.input.label.failOnStdErr": "Fail on STDERR",

Tasks/SSH/ssh.ts

@@ -55,6 +55,21 @@ async function run() {
 
         if(runOptions === 'commands') {
             commands = tl.getDelimitedInput('commands', '\n', true);
+        } else if (runOptions === 'inline') {
+            var inlineScript: string = tl.getInput('inline', true);
+            const scriptHeader:string = '#!';
+            if (inlineScript && !inlineScript.startsWith(scriptHeader)) {
+                const bashHeader: string =  '#!/bin/bash';
+                tl.debug('No script header detected.  Adding: ' + bashHeader);
+                inlineScript = bashHeader + os.EOL + inlineScript;
+            }
+            scriptFile = path.join(os.tmpdir(), 'sshscript_' + new Date().getTime()); // default name
+            try {
+                fs.writeFileSync(scriptFile, inlineScript);
+            } catch (err) {
+                this.deleteFile(scriptFile);
+                throw err;
+            }
         } else {
             scriptFile = tl.getPathInput('scriptPath', true, true);
             args = tl.getInput('args')
@@ -83,7 +98,7 @@ async function run() {
                         commands[i], sshClientConnection, remoteCmdOptions);
                     tl.debug('Command ' + commands[i] + ' completed with return code = ' + returnCode);
                 }
-            } else if (runOptions === 'script') {
+            } else { // both other runOptions: inline and script
                 //setup script path on remote machine relative to user's $HOME directory
                 var remoteScript = './' + path.basename(scriptFile);
                 var remoteScriptPath = '"' + remoteScript + '"';

Tasks/SSH/task.json

@@ -16,7 +16,7 @@
     "author": "Microsoft Corporation",
     "version": {
         "Major": 0,
-        "Minor": 115,
+        "Minor": 121,
         "Patch": 0
     },
     "demands": [],
@@ -46,7 +46,8 @@
             "defaultValue": "commands",
             "options": {
                 "commands": "Commands",
-                "script": "Shell script"
+                "script": "Script File",
+                "inline": "Inline Script"
             },
             "helpMarkDown": "Choose to either run shell commands or a shell script on the remote machine."
         },
@@ -72,6 +73,19 @@
             "visibleRule": "runOptions = script",
             "helpMarkDown": "Path to the shell script file to run on the remote machine."
         },
+        {
+            "name": "inline",
+            "type": "multiLine",
+            "label": "Inline Script",
+            "defaultValue": "",
+            "required": true,
+            "visibleRule": "runOptions = inline",
+            "helpMarkDown": "Write the shell script to run on the remote machine.",
+            "properties": {
+                "resizable": "true",
+                "rows": "10"
+            }
+        },
         {
             "name": "args",
             "type": "string",

Tasks/SSH/task.loc.json

@@ -16,7 +16,7 @@
   "author": "Microsoft Corporation",
   "version": {
     "Major": 0,
-    "Minor": 115,
+    "Minor": 121,
     "Patch": 0
   },
   "demands": [],
@@ -46,7 +46,8 @@
       "defaultValue": "commands",
       "options": {
         "commands": "Commands",
-        "script": "Shell script"
+        "script": "Script File",
+        "inline": "Inline Script"
       },
       "helpMarkDown": "ms-resource:loc.input.help.runOptions"
     },
@@ -72,6 +73,19 @@
       "visibleRule": "runOptions = script",
       "helpMarkDown": "ms-resource:loc.input.help.scriptPath"
     },
+    {
+      "name": "inline",
+      "type": "multiLine",
+      "label": "ms-resource:loc.input.label.inline",
+      "defaultValue": "",
+      "required": true,
+      "visibleRule": "runOptions = inline",
+      "helpMarkDown": "ms-resource:loc.input.help.inline",
+      "properties": {
+        "resizable": "true",
+        "rows": "10"
+      }
+    },
     {
       "name": "args",
       "type": "string",