ssh-client-wrapper 2.10.2 → 2.11.0

package/{docker-compose.yml → compose.yml}

@@ -23,7 +23,7 @@ services:
       TEST_PW: passw0rd
       TEST_HOST: testbed
     working_dir: /work/ssh-client-wrapper
-    command: bash -c "mkdir /root/.ssh 2>/dev/null; npm run mocha"
+    command: bash -c "mkdir /root/.ssh 2>/dev/null;  npm run mocha"
   tester-buster:
     build:
       context: .
@@ -33,4 +33,4 @@ services:
       TEST_PW: passw0rd
       TEST_HOST: testbed
     working_dir: /work/ssh-client-wrapper
-    command: bash -c "mkdir /root/.ssh 2>/dev/null; npm run mocha"
+    command: bash -c "mkdir /root/.ssh 2>/dev/null;  npm run mocha"

package/lib/index.js

@@ -28,6 +28,8 @@ const { isArrayOfString, sanityCheck } = require("./util.js");
  * @param {Integer} hostInfo.ConnectTimeout=60 - timeout used when connectiong to ths SSH server
  * @param {Integer} hostInfo.maxRetry=3 - max number of retry
  * @param {Integer} hostInfo.retryDuration=1000 - duration time (msec) between each retry
+ * @param {string} hostInfo.rcfile - rcfile path which will be sourced before executing actual command
+ * @param {string} hostInfo.prependCmd - command string which will be executed before executing actual command
  * @param {string[]} hostInfo.sshOpt - additional options for ssh
  */
 
@@ -65,15 +67,19 @@ class SshClientWrapper {
    * @param {string} cmd - Cmdline which will be executed.
    * @param {Integer} timeout - timeout in secconds
    * @param { Function } outputCallback - call back routine for output
+   * @param {string} rcfile - rcfile path which will be sourced before executing actual command
+   * @param {string} prependCmd - command string which will be executed before executing actual command
    * @returns {Integer} - Return code of cmd.
+   *
+   * note rcfile and prependCmd override hostInfo.rcfile and hostInfo.prependCmd respectively
    */
-  async exec (cmd, timeout = 0, outputCallback = null) {
+  async exec (cmd, timeout = 0, outputCallback = null, rcfile = null, prependCmd = null) {
     debug("exec called", cmd);
 
     if (typeof cmd !== "string" || cmd === "") {
       return logAndReject("cmd must be string");
     }
-    return sshExec(this.hostInfo, cmd, timeout, outputCallback);
+    return sshExec(this.hostInfo, cmd, timeout, outputCallback, rcfile, prependCmd);
   }
 
   /**

package/lib/sshExec.js

@@ -12,13 +12,26 @@ const { fork, createMasterPty, sshLoginCallback } = require("./fork.js");
  * @param {Object} hostInfo - hostinfo object
  * @param {string} cmd - Cmdline which will be executed on remote host.
  * @param {number} timeout - timeout (in sec.)
+ * @param {string} rcfile - rcfile path which will be sourced before executing actual command
+ * @param {string} prependCmd - command string which will be executed before executing actual command
  * @param {Function} outputCallback - Callback routine for stdout and stderr.
  */
-async function sshExec (hostInfo, cmd, timeout, outputCallback) {
+async function sshExec (hostInfo, cmd, timeout, outputCallback, rcfile, prependCmd) {
   debug("sshExec called");
   await connect(hostInfo);
   debug("exec", cmd, "on remote server");
   const args = getSshOption(hostInfo, false);
+  if (rcfile) {
+    args.push(`. ${rcfile};`);
+  } else if (hostInfo.rcfile) {
+    args.push(`. ${hostInfo.rcfile};`);
+  }
+  if (prependCmd) {
+    args.push(`${prependCmd};`);
+  } else if (hostInfo.prependCmd) {
+    args.push(`${hostInfo.prependCmd};`);
+  }
+
   args.push(cmd);
   debugVerbose(`exec: ${sshCmd} ${args.join(" ")}`);
 

package/lib/util.js

@@ -40,6 +40,8 @@ const hostInfoSchema = {
     ControlPersistDir: { type: "string", pattern: "\\S+", transform: ["trim"] },
     maxRetry: { type: "number", minimum: 0, default: 3 },
     retryDuration: { type: "number", minimum: 0, default: 1000 },
+    rcfile: { type: "string", pattern: "\\S+", transform: ["trim"] },
+    prependCmd: { type: "string", pattern: "\\S+", transform: ["trim"] },
     sshOpt: { type: "array", minItems: 1, items: { type: "string", pattern: "\\S+", transform: ["trim"] } }
   },
   required: ["host"]
@@ -207,6 +209,7 @@ const getSshOption = (hostInfo, withoutDestination) => {
       return typeof e === "string";
     }));
   }
+
   return args;
 };
 

package/package.json

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

package/run_test_all.sh

@@ -1,21 +1,11 @@
 #!/bin/bash
-
 function cleanup(){
-  docker compose rm --stop --force testbed
+  docker compose down
 }
-
 trap cleanup EXIT
 set -e -o pipefail
 
-docker compose up testbed -d
-export TEST_HOST=localhost
-export TEST_USER=testuser
-export TEST_PW=passw0rd
-export TEST_PORT=4100
-ssh-keygen -R '[localhost]:4100'
-
-npm run test
-echo local test success
+./run_test_local.sh keep
 
 docker compose run --build --rm tester
 echo test on latest ubuntu success
@@ -25,3 +15,4 @@ echo test on bullseye success
 
 docker compose run --build --rm tester-buster
 echo test on buster success
+docker compose down

package/run_test_local.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+docker compose up testbed -d
+export TEST_HOST=localhost
+export TEST_USER=testuser
+export TEST_PW=passw0rd
+export TEST_PORT=4100
+ssh-keygen -R '[localhost]:4100'
+
+npm run test
+echo local test success
+if [ x${1} != xkeep ];then
+  docker compose down
+fi

package/test/sshExec.js

@@ -19,17 +19,23 @@ const { sshExec, canConnect, disconnect, ls } = require("../lib/sshExec.js");
 // test helpers
 const hostInfo = require("./testUtil/hostInfo.js");
 const { clearRemoteTestFiles, clearLocalTestFiles, createRemoteFiles, nonExisting, remoteRoot, remoteEmptyDir } = require("./testUtil/testFiles.js");
+const { send } = require("../lib/rsyncExec.js");
 
 describe("test for ssh execution", function () {
+  const rcfilePath = "/home/testuser/testrc";
   this.timeout(65000);// eslint-disable-line no-invalid-this
   beforeEach(async () => {
     sshout.reset();
     await clearRemoteTestFiles(hostInfo);
   });
+  before(async () => {
+    await send(hostInfo, [path.resolve(__dirname, "./testUtil/testrc")], rcfilePath, [], 0);
+  });
   after(async () => {
     if (!process.env.TEST_KEEP_FILES) {
       await clearRemoteTestFiles(hostInfo);
       await clearLocalTestFiles();
+      await sshExec(hostInfo, `rm ${rcfilePath}`);
     }
     await disconnect(hostInfo);
   });
@@ -48,8 +54,36 @@ describe("test for ssh execution", function () {
       expect(sshout).to.be.called;
       expect(sshout).to.be.calledWithMatch(/^hoge/);
     });
+    it("should execute 2 command by prependCmd ", async () => {
+      const rt = await sshExec(hostInfo, `echo ${testText}`, 0, sshout, null, "echo foo");
+      expect(rt).to.equal(0);
+      expect(sshout).to.be.calledOnce;
+      expect(sshout).to.be.calledWithMatch(/^foo\nhoge\n/);
+    });
+    it("should execute 2 command by hostInfo.prependCmd ", async () => {
+      hostInfo.prependCmd = "echo foo";
+      const rt = await sshExec(hostInfo, `echo ${testText}`, 0, sshout, null);
+      expect(rt).to.equal(0);
+      expect(sshout).to.be.calledOnce;
+      expect(sshout).to.be.calledWithMatch(/^foo\nhoge\n/);
+      delete hostInfo.prependCmd;
+    });
+    it("should execute 2 command by rcfile", async () => {
+      const rt = await sshExec(hostInfo, `echo ${testText}`, 0, sshout, rcfilePath);
+      expect(rt).to.equal(0);
+      expect(sshout).to.be.calledOnce;
+      expect(sshout).to.be.calledWithMatch(/^this is test rcfile\nhoge\n/);
+    });
+    it("should execute 2 command by hostInfo.prependCmd ", async () => {
+      hostInfo.rcfile = rcfilePath;
+      const rt = await sshExec(hostInfo, `echo ${testText}`, 0, sshout, null);
+      expect(rt).to.equal(0);
+      expect(sshout).to.be.calledOnce;
+      expect(sshout).to.be.calledWithMatch(/^this is test rcfile\nhoge\n/);
+      delete hostInfo.rcfile;
+    });
     // please note that exec() resolves with non-zero value
-    // (126 permisssion deny or 127 file not found)
+    // (126 permission deny or 127 file not found)
     // but does not reject in following 2 cases
     it("should not execute command which do not have exec permission", async () => {
       await sshExec(hostInfo, "echo echo hoge >hoge");

package/test/testUtil/testrc

@@ -0,0 +1 @@
+echo this is test rcfile