[SshV0] Migrated to ssh2-sftp-client

Tasks/SshV0/package.json

@@ -4,7 +4,7 @@
     "@types/q": "^1.0.7",
     "@types/ssh2": "0.5.43",
     "azure-pipelines-task-lib": "^2.9.3",
-    "scp2": "0.5.0",
+    "ssh2-sftp-client": "^5.1.2",
     "ssh2": "0.8.2",
     "uuid": "^3.2.1"
   }

Tasks/SshV0/ssh.ts

@@ -114,11 +114,11 @@ async function run() {
                 // both other runOptions: inline and script
                 // setup script path on remote machine relative to user's $HOME directory
                 const remoteScript: string = `./${path.basename(scriptFile)}`;
-                let remoteScriptPath: string = `"${remoteScript}"`;
+                let remoteScriptPath: string = `${remoteScript}`;
                 const windowsEncodedRemoteScriptPath: string = remoteScriptPath;
                 const isWin: boolean = (os.platform() === 'win32');
                 if (isWin) {
-                    remoteScriptPath = `"${remoteScript}._unix"`;
+                    remoteScriptPath = `${remoteScript}._unix`;
                 }
                 tl.debug(`remoteScriptPath = ${remoteScriptPath}`);
 
@@ -127,7 +127,6 @@ async function run() {
                     host: hostname,
                     port: port,
                     username: username,
-                    path: remoteScript
                 };
 
                 if (privateKey) {
@@ -139,7 +138,7 @@ async function run() {
 
                  //copy script file to remote machine
                 tl.debug('Copying script to remote machine.');
-                await sshHelper.copyScriptToRemoteMachine(scriptFile, scpConfig);
+                await sshHelper.copyScriptToRemoteMachine(scriptFile, remoteScriptPath, scpConfig);
 
                 //change the line encodings
                 if (isWin) {

Tasks/SshV0/ssh2helpers.ts

@@ -1,7 +1,7 @@
 import * as tl from 'azure-pipelines-task-lib/task';
 import * as Q from 'q';
-import * as scp2 from 'scp2';
 import * as ssh2 from 'ssh2';
+const SftpClient = require('ssh2-sftp-client');
 
 export class RemoteCommandOptions {
     public failOnStdErr: boolean;
@@ -63,23 +63,33 @@ function handleStreamClose(command: string, stdErrWritten: boolean, defer: Q.Def
 }
 
 /**
- * Uses scp2 to copy a file to remote machine
- * @param scriptFile
- * @param scpConfig
+ * Uses sftp to copy a file to remote machine
+ * @param src
+ * @param dest
+ * @param sftpConfig
  * @returns {Promise<string>}
  */
-export function copyScriptToRemoteMachine(scriptFile: string, scpConfig: any): Q.Promise<string> {
+export async function copyScriptToRemoteMachine(src: string, dest: string, sftpConfig: any): Promise<string> {
     const defer = Q.defer<string>();
+    const sftpClient = new SftpClient();;
+
+    try {
+        await sftpClient.connect(sftpConfig);
+        await sftpClient.put(src, dest);
+        tl.debug('Copied script file to remote machine at: ' + dest);
+        defer.resolve();
+    } catch (err) {
+        defer.reject(tl.loc('RemoteCopyFailed', err));
+    }
 
-    scp2.scp(scriptFile, scpConfig, (err) => {
-        if (err) {
-            defer.reject(tl.loc('RemoteCopyFailed', err));
-        } else {
-            tl.debug('Copied script file to remote machine at: ' + scpConfig.path);
-            defer.resolve(scpConfig.path);
-        }
-    });
-
+    try {
+        sftpClient.on('error', (err) => {
+            tl.debug('sftpClient: Ignoring error diconnecting: ' + err);
+        }); // ignore logout errors; see: https://github.com/mscdex/node-imap/issues/695
+        await sftpClient.end();
+    } catch(err) {
+        tl.debug('Failed to close SFTP client: ' + err);
+    }
     return defer.promise;
 }
 
@@ -192,6 +202,4 @@ export interface ScpConfig {
     privateKey?: string;
     /** For an encrypted private key, this is the passphrase used to decrypt it. */
     passphrase?: string;
-    /** String that contains path where the file will be placed on the server  */
-    path: string;
 }

Tasks/SshV0/task.json

@@ -18,7 +18,7 @@
     "version": {
         "Major": 0,
         "Minor": 176,
-        "Patch": 0
+        "Patch": 1
     },
     "demands": [],
     "minimumAgentVersion": "2.102.0",
@@ -138,7 +138,7 @@
         }
     ],
     "execution": {
-        "Node": {
+        "Node10": {
             "target": "ssh.js",
             "argumentFormat": ""
         }

Tasks/SshV0/task.loc.json

@@ -18,7 +18,7 @@
   "version": {
     "Major": 0,
     "Minor": 176,
-    "Patch": 0
+    "Patch": 1
   },
   "demands": [],
   "minimumAgentVersion": "2.102.0",
@@ -138,7 +138,7 @@
     }
   ],
   "execution": {
-    "Node": {
+    "Node10": {
       "target": "ssh.js",
       "argumentFormat": ""
     }