ssh-client-wrapper 1.5.4 → 1.7.9

package/.eslintrc.json

@@ -149,6 +149,7 @@
       "warn",
       "always"
     ],
+    "jsdoc/newline-after-description": "off",
     "jsdoc/require-param-description": "warn",
     "jsdoc/require-param-name": "warn",
     "jsdoc/require-param-type": "warn",

package/.github/workflows/run_test.yml

@@ -5,6 +5,7 @@ on:
       - 'v*'
     branches:
       - '*'
+      - '!main'
   workflow_call:
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -33,4 +34,25 @@ jobs:
           node-version: ${{ matrix.node-version }}
       - run: npm ci
       - run: npm run test
-      - run: npm test
+      - run: npm run coverage
+      - uses: actions/upload-artifact@v3
+        with:
+          name: code-coverage-report
+          path: coverage-report.lcov
+          retention-days: 1
+  coverage:
+    needs: [test]
+    name: coverage report
+    runs-on: ubuntu-latest
+    env:
+      CC_TEST_REPORTER_ID: 52ae52d099fd6546c12030f23b20e2a4e0b485c6a1b139ec11e3615ab073e689
+    steps:
+      - run: echo ${CC_TEST_REPORTER_ID}
+      - run: echo '${{ toJSON(secrets.ccid) }}'
+      - uses: actions/checkout@v3
+      - uses: actions/download-artifact@v3
+        with:
+          name: code-coverage-report
+      - uses: paambaati/codeclimate-action@v5.0.0
+        with:
+          coverageLocations: "coverage-report.lcov:lcov"

package/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx lint-staged

package/README.md

@@ -1,2 +1,6 @@
+[![npm version](https://badge.fury.io/js/ssh-client-wrapper.svg)](https://badge.fury.io/js/ssh-client-wrapper)
+[![Known Vulnerabilities](https://snyk.io/test/github/so5/ssh-client-wrapper/badge.svg)](https://snyk.io/test/github/so5/ssh-client-wrapper)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/3f9cba3c4f04d90561e3/test_coverage)](https://codeclimate.com/github/so5/ssh-client-wrapper/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/8f3c0ea00e755ae31081/maintainability)](https://codeclimate.com/github/so5/ssh-client-wrapper/maintainability)
 # ssh-client-wrapper
 open ssh client wrapper library for nodejs

package/lib/index.js

@@ -3,7 +3,7 @@ const debugLib = require("debug");
 const debug = debugLib("sshClientWrapper:interface");
 const { sshExec, canConnect, disconnect, ls } = require("./sshExec.js");
 const { send, recv } = require("./rsyncExec.js");
-const { isArrayOfString } = require("./util.js");
+const { isArrayOfString, sanityCheck } = require("./util.js");
 
 /**
  * Integer means integer number but it is defined as Object for now
@@ -36,9 +36,7 @@ const { isArrayOfString } = require("./util.js");
  */
 class SshClientWrapper {
   constructor(hostInfo) {
-    if (typeof hostInfo.host !== "string") {
-      return new Error("hostname must be specified!");
-    }
+    sanityCheck(hostInfo);
     this.hostInfo = { ...hostInfo };
     this.hostInfo.masterPty = null;
   }
@@ -78,8 +76,6 @@ class SshClientWrapper {
    * @param {number} retryDelay - Duration between each try (in sec).
    * @param {number} maxRetry - Max retry count.
    * @returns {Integer} - Return code of cmd.
-   *
-   * If stdout and stderr is array, last 10 line of stdout and stderr is stored in them.
    */
   async watch(cmd, regexp, retryDelay = 3, maxRetry = null) {
     debug("watch called", cmd, regexp, retryDelay, maxRetry);
@@ -95,7 +91,9 @@ class SshClientWrapper {
       err.maxRetry = maxRetry;
       return Promise.reject(err);
     }
-    //TODO promise retry
+    //not implemented yet !!!
+    return this.exec(cmd, ()=>{
+    });
   }
 
   /**
@@ -159,7 +157,7 @@ class SshClientWrapper {
    * @param {Integer} timeout - timeout in secconds
    * @returns {Promise} - Resolved with true on success, otherwise rejected with Error.
    */
-  canConnect(timeout = 60) {
+  async canConnect(timeout = 60) {
     debug("canConnect called timeout=", timeout);
 
     if (!Number.isInteger(timeout) || timeout <= 0) {
@@ -171,7 +169,7 @@ class SshClientWrapper {
   /**
    * Disconnect master session
    */
-  disconnect() {
+  async disconnect() {
     debug("disconnect called");
     disconnect(this.hostInfo);
   }

package/lib/sshExec.js

@@ -4,7 +4,7 @@ const crypto = require("crypto");
 const promiseRetry = require("promise-retry");
 const debug = require("debug")("sshClientWrapper:sshExec");
 const debugVerbose = require("debug")("sshClientWrapper:sshExec_verbose");
-const { sshCmd, getSshOption } = require("./util.js");
+const { sshCmd, getSshOption, sanityCheck } = require("./util.js");
 const { fork, getMasterPty } = require("./fork.js");
 
 /**
@@ -35,7 +35,7 @@ async function sshExec(hostInfo, cmd, outputCallback) {
       debug(`${cmd} not found but ignored`);
       return e.rt;
     }
-    throw e;
+    return e.rt;
   }
 }
 
@@ -45,60 +45,15 @@ async function sshExec(hostInfo, cmd, outputCallback) {
  * @param {Integer} timeout - timeout in secconds
  */
 async function canConnect(hostInfo, timeout = 60) {
-  debug("check connectibity");
-  const ac = new AbortController();
-  const signal = ac.signal;
+  debug("sanity check");
+  sanityCheck(hostInfo);
 
-  setTimeoutPromise(timeout * 1000, "neverUsedValue", { signal })
-    .then(()=>{
-      const err = new Error(`can not connect within ${timeout} sec`);
-      err.host = hostInfo.host;
-      err.user = hostInfo.user;
-      err.port = hostInfo.port;
-      throw err;
-    })
-    .catch((err)=>{
-      if (err.name === "AbortError") {
-        debug("timeout was aborted because connection check has done");
-      }
-    });
-
-  if (await existsMaster(hostInfo)) {
-    const words = crypto.randomUUID();
-    const args = getSshOption(hostInfo);
-    if (Number.isInteger(timeout) && timeout > 0) {
-      args.push(`-oConnectTimeout=${timeout}`);
-    }
-    args.push(`echo ${words}`);
-    let output = "";
-    const cb = (e)=>{
-      output += e;
-    };
-
-    debugVerbose(`canConnect: ${sshCmd} ${args.join(" ")}`);
-    const rt = await retryWrapper(fork.bind(null, hostInfo, sshCmd, args, cb), hostInfo);
-    ac.abort();
+  debug("check connectibity");
 
-    if (rt !== 0) {
-      const err = new Error(`can not connect to ${hostInfo.host}. return code=${rt}`);
-      err.rt = rt;
-      err.host = hostInfo.host;
-      err.user = hostInfo.user;
-      err.port = hostInfo.port;
-      return err;
-    }
-    const re = new RegExp(words);
-    if (!re.test(output)) {
-      throw new Error("can not get echo result correctly");
-    }
-    return true;
-  }
-  //do NOT catch following try
-  //if connect throw error, canConnect must be throw error
   try {
-    await connect(hostInfo);
+    await connect(hostInfo, timeout);
   } finally {
-    ac.abort();
+    await disconnect(hostInfo);
   }
   return true;
 }
@@ -116,11 +71,13 @@ async function existsMaster(hostInfo) {
   const cb = (e)=>{
     output += e;
   };
+
   try {
     debug(`check master session: ${sshCmd} ${args.join(" ")}`);
     await fork(hostInfo, sshCmd, args, cb);
   } catch (err) {
     if (err.rt !== 255) {
+      debug("check master session failed", err);
       throw err;
     }
   }
@@ -131,27 +88,48 @@ async function existsMaster(hostInfo) {
  * create master ssh connection
  * @param {Object} hostInfo - hostinfo object
  */
-async function connect(hostInfo) {
+async function connect(hostInfo, timeout = 60) {
   if (await existsMaster(hostInfo)) {
     debugVerbose("master connection exists");
     return;
   }
-
   debug(`create master ssh session to ${hostInfo.host}`);
-  const pty = hostInfo.masterPty || getMasterPty(hostInfo);
+  const pty = getMasterPty(hostInfo);
   hostInfo.masterPty = pty;
 
+  const ac = new AbortController();
+  const signal = ac.signal;
+  setTimeoutPromise(timeout * 1000, "neverUsedValue", { signal })
+    .then(()=>{
+      const err = new Error(`can not connect within ${timeout} sec`);
+      err.host = hostInfo.host;
+      err.user = hostInfo.user;
+      err.port = hostInfo.port;
+      pty.write("\n");
+      pty.write("exit\n");
+      throw err;
+    })
+    .catch((err)=>{
+      if (err.name === "AbortError") {
+        debug("timeout was aborted because connection check has done");
+      }
+    });
+
   const words = crypto.randomUUID();
   const re = new RegExp(`^${words}`);
-
   const p = new Promise((resolve, reject)=>{
+    let done = false;
     pty.onData((data)=>{
+      if (done) {
+        return;
+      }
       const output = data.toString();
       debugVerbose(output);
 
       if (re.test(output)) {
-        debug("call exit on remotehost");
+        debug("test done. call exit on remotehost");
         pty.write("exit\n");
+        done = true;
         resolve();
       } else if (/Permission denied \(/.test(output)) {
         reject(new Error("Permission denied"));
@@ -175,6 +153,7 @@ async function connect(hostInfo) {
   debugVerbose(cmd);
   pty.write(cmd);
   await p;
+  ac.abort();
   debug(`connected to ${hostInfo.host}`);
 }
 
@@ -234,12 +213,12 @@ async function ls(hostInfo, target, lsOpt = []) {
       throw e;
     }
   }
-
-  return outputArray
-    .join("\n")
-    .replace(/\n+/g, "\n")
-    .replace(/\n$/, "")
-    .split("\n");
+  return outputArray.length === 0 ? []
+    : outputArray
+      .join("\n")
+      .replace(/\n+/g, "\n")
+      .replace(/\n$/, "")
+      .split("\n");
 }
 
 /**
@@ -247,9 +226,9 @@ async function ls(hostInfo, target, lsOpt = []) {
  * @param {Function}  func - function to be wrapped
  */
 async function retryWrapper(func, hostInfo) {
-  const minTimeout = hostInfo.retryMinTimeout * 1000 || 60000;
-  const maxTimeout = hostInfo.retryMaxTimeout * 1000 || 300000;
-  const retries = hostInfo.maxRetry || 3;
+  const minTimeout = hostInfo.retryMinTimeout * 1000 || 1000;
+  const maxTimeout = hostInfo.retryMaxTimeout * 1000 || 5000;
+  const retries = hostInfo.maxRetry || 1;
   return promiseRetry({ retries, minTimeout, maxTimeout }, (retry, number)=>{
     return func()
       .catch((e)=>{

package/lib/util.js

@@ -17,6 +17,22 @@ const buff2String = (func, data)=>{
   func(data.toString().replace(/\r\n/g, EOL));
 };
 
+/**
+ * check if given hostInfo object is OK
+ * @param { Object} hostInfo - host information object defined in index.js
+ */
+const sanityCheck = (hostInfo)=>{
+  if (typeof hostInfo.host !== "string" || hostInfo.host === "") {
+    throw new Error("host must be non-empty string");
+  }
+  if (Object.prototype.hasOwnProperty.call(hostInfo, "port") && (typeof hostInfo.port === "string" || Number.isInteger(hostInfo.port))) {
+    const port = Number(hostInfo.port);
+    if (port < 0 || port > 65535) {
+      throw new Error("port number must be in the range of 0 to 65535");
+    }
+  }
+};
+
 /**
  * return ssh option with some hard corded options
  * @param { Object} hostInfo - host information object defined in index.js
@@ -41,7 +57,7 @@ const getSshOption = (hostInfo, withoutDestination)=>{
     args.push("-l");
     args.push(hostInfo.loginname);
   }
-  if (typeof hostInfo.port === "string" || typeof hostInfo.port === "number") {
+  if (typeof hostInfo.port === "string" || Number.isInteger(hostInfo.port)) {
     args.push("-p");
     args.push(hostInfo.port);
   }
@@ -88,5 +104,6 @@ module.exports = {
   reNewHostPrompt,
   buff2String,
   getSshOption,
+  sanityCheck,
   isArrayOfString
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ssh-client-wrapper",
-  "version": "1.5.4",
+  "version": "1.7.9",
   "description": "wrapper library for open ssh client and rsync",
   "keywords": [
     "ssh",
@@ -13,9 +13,12 @@
   ],
   "main": "lib/index.js",
   "scripts": {
-    "test": "mocha --recursive test",
+    "mocha": "mocha --recursive test",
     "lint": "eslint --fix lib test",
-    "postversion": "git push && git push origin $(git describe --abbrev=0 --tags)"
+    "test": "nyc --reporter=html --reporter=text mocha",
+    "coverage": "nyc report --reporter=text-lcov > coverage-report.lcov",
+    "postversion": "git push && git push origin $(git describe --abbrev=0 --tags)",
+    "prepare": "husky install"
   },
   "engines": {
     "node": ">=12.9"
@@ -27,18 +30,14 @@
     "url": "https://github.com/so5/ssh-client-wrapper"
   },
   "homepage": "https://github.com/so5/ssh-client-wrapper#readme",
-  "husky": {
-    "hooks": {
-      "pre-commit": "lint-staged"
-    }
-  },
   "lint-staged": {
     "*.js": "eslint --fix"
   },
   "dependencies": {
     "debug": "^4.3.4",
-    "glob": "^10.2.2",
+    "glob": "^10.3.1",
     "node-pty": "^0.10.1",
+    "nyc": "^15.1.0",
     "promise-retry": "^2.0.1"
   },
   "devDependencies": {
@@ -52,7 +51,7 @@
     "eslint-plugin-jsdoc": "^43.0.6",
     "eslint-plugin-node": "^11.1.0",
     "fs-extra": "^11.1.1",
-    "husky": "^8.0.3",
+    "husky": "^8.0.0",
     "lint-staged": "^13.2.1",
     "mocha": "^10.2.0",
     "sinon": "^15.0.3",

package/test/rsyncExec.js

@@ -31,10 +31,13 @@ const {
 } = require("./util/testFiles");
 
 const formatLsOutput = (array)=>{
-  return array.join(" ")
-    .replace(/\n/g, " ")
-    .trim()
-    .split(/\s+/);
+  const rt = [];
+  for (const e of array) {
+    rt.push(...e.split("\n"));
+  }
+  return rt.filter((e)=>{
+    return e !== "";
+  });
 };
 
 

package/test/sshExec.js

@@ -18,11 +18,10 @@ const { sshExec, canConnect, disconnect, ls } = require("../lib/sshExec.js");
 
 //test helpers
 const hostInfo = require("./util/hostInfo.js");
-const { clearRemoteTestFiles, createRemoteFiles, nonExisting, remoteRoot } = require("./util/testFiles.js");
-
+const { clearRemoteTestFiles, clearLocalTestFiles, createRemoteFiles, nonExisting, remoteRoot, remoteEmptyDir } = require("./util/testFiles.js");
 
 describe("test for ssh execution", function() {
-  this.timeout(20000);//eslint-disable-line no-invalid-this
+  this.timeout(65000);//eslint-disable-line no-invalid-this
   beforeEach(async ()=>{
     sshout.reset();
     await clearRemoteTestFiles(hostInfo);
@@ -30,6 +29,7 @@ describe("test for ssh execution", function() {
   after(async ()=>{
     if (!process.env.TEST_KEEP_FILES) {
       await clearRemoteTestFiles(hostInfo);
+      await clearLocalTestFiles();
     }
     await disconnect(hostInfo);
   });
@@ -73,7 +73,7 @@ describe("test for ssh execution", function() {
       await disconnect(hostInfo2);
     });
     it("should be resolved with true", async ()=>{
-      expect(await canConnect(hostInfo2, 2)).to.be.true;
+      return expect(await canConnect(hostInfo2, 2)).to.be.true;
     });
     it("should be rejected if user does not exist", async ()=>{
       hostInfo2.user = "xxxx";
@@ -129,5 +129,8 @@ describe("test for ssh execution", function() {
         return path.posix.join(remoteRoot, "hoge", e);
       }));
     });
+    it("should return empty array if specified target is empty directory", async ()=>{
+      expect(await ls(hostInfo, remoteEmptyDir)).to.be.an("array").that.is.empty;
+    });
   });
 });