ssh-client-wrapper 2.4.1 → 2.6.0

package/lib/rsyncExec.js

@@ -7,7 +7,7 @@ const { glob } = require("glob");
 const { connect, retryWrapper, sshExec } = require("./sshExec.js");
 const { fork } = require("./fork.js");
 
-const { sshCmd, rsyncCmd, getSshOption } = require("./util.js");
+const { sshCmd, rsyncCmd, acceptableRsyncRetrunCodes, getSshOption } = require("./util.js");
 
 async function checkRsyncVersion (timeout) {
   const rt = {};
@@ -79,7 +79,7 @@ async function send (hostInfo, argSrc, dst, rsyncOpt, timeout) {
   }
   debug(`send ${src} to ${hostInfo.host}:${dst}`);
   debugVerbose(`send: ${rsyncCmd} ${args.join(" ")}`);
-  return retryWrapper(fork.bind(null, hostInfo, rsyncCmd, args, timeout, null, [12]), hostInfo);
+  return retryWrapper(fork.bind(null, hostInfo, rsyncCmd, args, timeout, null, acceptableRsyncRetrunCodes), hostInfo);
 }
 
 /**
@@ -119,7 +119,7 @@ async function recv (hostInfo, argSrc, dst, rsyncOpt, timeout) {
 
   debug(`recv ${src} to ${dst}`);
   debugVerbose(`recv: ${rsyncCmd} ${args.join(" ")}`);
-  return retryWrapper(fork.bind(null, hostInfo, rsyncCmd, args, timeout, null, [12]), hostInfo);
+  return retryWrapper(fork.bind(null, hostInfo, rsyncCmd, args, timeout, null, acceptableRsyncRetrunCodes), hostInfo);
 }
 module.exports = {
   checkRsyncVersion,

package/lib/sshExec.js

@@ -247,7 +247,7 @@ async function ls (hostInfo, target, lsOpt, timeout) {
  * @param {Integer} argMaxRetry - max retry number
  */
 async function retryWrapper (func, hostInfo, argMaxRetry, argDuration) {
-  const maxRetry = argMaxRetry || hostInfo.maxRetry || 1;
+  const maxRetry = argMaxRetry || hostInfo.maxRetry || 3;
   const duration = argDuration || hostInfo.retryDuration || 1000;
   if (maxRetry === 1) {
     return func();

package/lib/util.js

@@ -6,6 +6,7 @@ const { setTimeout: setTimeoutPromise } = require("timers/promises");
 
 const sshCmd = "ssh";
 const rsyncCmd = "rsync";
+const acceptableRsyncRetrunCodes = [10, 11, 12, 13, 14];
 
 const rePwPrompt = /password:/;
 const rePhPrompt = /Enter passphrase for key/;
@@ -36,6 +37,7 @@ const hostInfoSchema = {
     noStrictHostkeyChecking: { type: "boolean" },
     ControlPersist: { type: "number", minimum: 0, default: 180 },
     ConnectTimeout: { type: "number", minimum: 0 },
+    ControlPersistDir: { type: "string", pattern: "\\S+", transform: ["trim"] },
     maxRetry: { type: "number", minimum: 0, default: 3 },
     retryDuration: { type: "number", minimum: 0, default: 1000 },
     sshOpt: { type: "array", minItems: 1, items: { type: "string", pattern: "\\S+", transform: ["trim"] } }
@@ -45,7 +47,8 @@ const hostInfoSchema = {
 
 const stringOptions = [
   "user",
-  "keyFile"
+  "keyFile",
+  "ControlPersistDir"
 ];
 const numberOptions = [
   "ControlPersist",
@@ -129,6 +132,18 @@ const sanityCheck = (hostInfo) => {
   return hostInfo;
 };
 
+function getControlPersistDir (hostInfo) {
+  for (const candidate of [hostInfo.ControlPersistDir, process.env.SSH_CONTROL_PERSIST_DIR]) {
+    if (typeof candidate === "string") {
+      const stat = fs.statSync(candidate, { throwIfNoEntry: false });
+      if (stat.isDirectory()) {
+        return candidate;
+      }
+    }
+  }
+  return "~/.ssh";
+}
+
 /**
  * return ssh option with some hard corded options
  * @param { Object} hostInfo - host information object defined in index.js
@@ -178,10 +193,11 @@ const getSshOption = (hostInfo, withoutDestination) => {
   if (hostInfo.noStrictHostkeyChecking) {
     args.push("-oStrictHostKeyChecking=no");
   }
-  const ControlPersist = Number.isInteger(hostInfo.ControlPersist) && hostInfo.ControlPersist >= 0 ? hostInfo.ControlPersist : "180";
+  const controlPersist = Number.isInteger(hostInfo.ControlPersist) && hostInfo.ControlPersist >= 0 ? hostInfo.ControlPersist : "180";
+  const controlPersistDir = getControlPersistDir(hostInfo);
   args.push("-oControlMaster=auto");
-  args.push("-oControlPath=~/.ssh/ssh-client-wrapper-%r@%h:%p");
-  args.push(`-oControlPersist=${ControlPersist}`);
+  args.push(`-oControlPath=${controlPersistDir}/ssh-client-wrapper-%r@%h:%p`);
+  args.push(`-oControlPersist=${controlPersist}`);
 
   if (Number.isInteger(hostInfo.ConnectTimeout) && hostInfo.ConnectTimeout > 0) {
     args.push(`-oConnectTimeout=${hostInfo.ConnectTimeout}`);
@@ -244,6 +260,7 @@ const watchDogTimer = (timeout, label, cb) => {
 module.exports = {
   sshCmd,
   rsyncCmd,
+  acceptableRsyncRetrunCodes,
   rePwPrompt,
   rePhPrompt,
   reNewHostPrompt,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ssh-client-wrapper",
-  "version": "2.4.1",
+  "version": "2.6.0",
   "description": "wrapper library for open ssh client and rsync",
   "keywords": [
     "ssh",

package/test/getSshOption.js

@@ -0,0 +1,49 @@
+"use strict";
+process.on("unhandledRejection", console.dir); // eslint-disable-line no-console
+
+// setup test framework
+const chai = require("chai");
+const { expect } = require("chai");
+chai.use(require("chai-as-promised"));
+
+// testee
+const { getSshOption } = require("../lib/util.js");
+
+describe("test for getSshOption", () => {
+  const defaultValues = {
+    host: "testHostName",
+    ControlPersist: 180,
+    maxRetry: 3,
+    retryDuration: 1000
+  };
+  it("should return minimum ssh option array", () => {
+    const sshOpts = getSshOption(defaultValues);
+    expect(sshOpts).to.be.an("array");
+    expect(sshOpts).to.have.lengthOf(4);
+    expect(sshOpts[0]).to.equal(defaultValues.host);
+    expect(sshOpts[1]).to.equal("-oControlMaster=auto");
+    expect(sshOpts[2]).to.equal("-oControlPath=~/.ssh/ssh-client-wrapper-%r@%h:%p");
+    expect(sshOpts[3]).to.equal("-oControlPersist=180");
+  });
+  it("should change ControlPath by ControlPersistDir", () => {
+    const hostInfo = { ...defaultValues };
+    hostInfo.ControlPersistDir = "/tmp";
+    const sshOpts = getSshOption(hostInfo);
+    expect(sshOpts).to.be.an("array");
+    expect(sshOpts).to.have.lengthOf(4);
+    expect(sshOpts[0]).to.equal(defaultValues.host);
+    expect(sshOpts[1]).to.equal("-oControlMaster=auto");
+    expect(sshOpts[2]).to.equal("-oControlPath=/tmp/ssh-client-wrapper-%r@%h:%p");
+    expect(sshOpts[3]).to.equal("-oControlPersist=180");
+  });
+  it("should change ControlPath by Environment variable", () => {
+    process.env.SSH_CONTROL_PERSIST_DIR = "/tmp";
+    const sshOpts = getSshOption(defaultValues);
+    expect(sshOpts).to.be.an("array");
+    expect(sshOpts).to.have.lengthOf(4);
+    expect(sshOpts[0]).to.equal(defaultValues.host);
+    expect(sshOpts[1]).to.equal("-oControlMaster=auto");
+    expect(sshOpts[2]).to.equal("-oControlPath=/tmp/ssh-client-wrapper-%r@%h:%p");
+    expect(sshOpts[3]).to.equal("-oControlPersist=180");
+  });
+});