ssh-client-wrapper 2.2.3 → 2.2.6

package/.dockerignore

@@ -1 +1,2 @@
 node_modules
+run_test_all.sh

package/.eslintrc.json

@@ -1,163 +1,34 @@
 {
-  "root": true,
-  "extends": [
-    "eslint"
-  ],
-  "plugins": [
-    "node",
-    "jsdoc"
-  ],
   "env": {
-    "node": true,
-    "es6": true
+    "browser": true,
+    "commonjs": true,
+    "es2021": true
   },
-  "rules": {
-    "no-param-reassign": "warn",
-    "arrow-parens": [
-      "error",
-      "always"
-    ],
-    "arrow-body-style": [
-      "error",
-      "always"
-    ],
-    "arrow-spacing": [
-      "error",
-      {
-        "before": false,
-        "after": false
-      }
-    ],
-    "camelcase": [
-      "error",
-      {
-        "properties": "never"
-      }
-    ],
-    "eqeqeq": [
-      "error",
-      "always",
-      {
-        "null": "ignore"
-      }
-    ],
-    "func-style": [
-      "error",
-      "declaration",
-      {
-        "allowArrowFunctions": true
-      }
-    ],
-    "indent": [
-      "error",
-      2,
-      {
-        "SwitchCase": 1
-      }
-    ],
-    "lines-around-comment": [
-      "error",
-      {
-        "beforeBlockComment": true,
-        "beforeLineComment": false
-      }
-    ],
-    "lines-between-class-members": [
-      "error",
-      "always",
-      {
-        "exceptAfterSingleLine": true
-      }
-    ],
-    "newline-per-chained-call": "error",
-    "no-use-before-define": [
-      "error",
-      {
-        "functions": false
-      }
-    ],
-    "no-warning-comments": "warn",
-    "padded-blocks": [
-      "error",
-      "never"
-    ],
-    "padding-line-between-statements": [
-      "error",
-      {
-        "blankLine": "any",
-        "prev": [
-          "const",
-          "let",
-          "var"
-        ],
-        "next": "*"
+  "extends": ["standard"],
+  "overrides": [
+    {
+      "env": {
+        "node": true
       },
-      {
-        "blankLine": "always",
-        "prev": "*",
-        "next": [
-          "block-like",
-          "class",
-          "do",
-          "for",
-          "function",
-          "multiline-block-like",
-          "switch",
-          "try",
-          "while"
-        ]
-      },
-      {
-        "blankLine": "any",
-        "prev": [
-          "const",
-          "let",
-          "var",
-          "for",
-          "while",
-          "do",
-          "block-like",
-          "multiline-block-like"
-        ],
-        "next": [
-          "block-like",
-          "do",
-          "for",
-          "multiline-block-like",
-          "switch",
-          "try",
-          "while"
-        ]
+      "files": [
+        ".eslintrc.{js,cjs}"
+      ],
+      "parserOptions": {
+        "sourceType": "script"
       }
-    ],
-    "spaced-comment": [
-      "error",
-      "never"
-    ],
-    "node/exports-style": [
-      "error",
-      "module.exports"
-    ],
-    "require-unicode-regexp": "off",
-    "node/no-unsupported-features": [
+    }
+  ],
+  "parserOptions": {
+    "ecmaVersion": "latest"
+  },
+  "rules": {
+    "semi": [
       "error",
-      {
-        "version": 10
-      }
-    ],
-    "jsdoc/require-hyphen-before-param-description": [
-      "warn",
       "always"
     ],
-    "jsdoc/newline-after-description": "off",
-    "jsdoc/require-param-description": "warn",
-    "jsdoc/require-param-name": "warn",
-    "jsdoc/require-param-type": "warn",
-    "jsdoc/require-jsdoc": "off",
-    "jsdoc/require-param": "off",
-    "jsdoc/require-returns": "off"
-  },
-  "parserOptions": {
-    "ecmaVersion": 2018
+    "quotes": [
+      "error",
+      "double"
+    ]
   }
 }

package/Dockerfile

@@ -1,9 +1,7 @@
 # syntax=docker/dockerfile:1
-FROM --platform=linux/amd64 node:hydrogen-bookworm-slim
-#FROM --platform=linux/amd64 node:hydrogen-bullseye-slim
-#FROM --platform=linux/amd64 node:hydrogen-buster-slim
+FROM --platform=linux/amd64 node:20-bookworm-slim
 
-WORKDIR /work
+WORKDIR /work/ssh-client-wrapper
 RUN apt-get update && apt -y install ssh rsync bzip2 python3 g++ build-essential
-COPY ./ ssh-client-wrapper
-RUN cd  ssh-client-wrapper && npm install
+COPY ./ ./
+RUN npm install

package/Dockerfile-bullseye

@@ -0,0 +1,7 @@
+# syntax=docker/dockerfile:1
+FROM --platform=linux/amd64 node:20-bookworm-slim
+
+WORKDIR /work/ssh-client-wrapper
+RUN apt-get update && apt -y install ssh rsync bzip2 python3 g++ build-essential
+COPY ./ ./
+RUN npm install

package/Dockerfile-buster

@@ -0,0 +1,7 @@
+# syntax=docker/dockerfile:1
+FROM --platform=linux/amd64 node:20-bookworm-slim
+
+WORKDIR /work/ssh-client-wrapper
+RUN apt-get update && apt -y install ssh rsync bzip2 python3 g++ build-essential
+COPY ./ ./
+RUN npm install

package/README.md

@@ -4,9 +4,3 @@
 [![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
-
-
-# how to test on local machine
-```
-docker-compose up --build
-```

package/docker-compose.yml

@@ -1,9 +1,9 @@
 version: "3.8"
 services:
-  test-bed:
+  testbed:
     image: naoso5/test-sshd
     ports:
-      - 4000:22
+      - "4000:22"
     container_name: testbed
   tester:
     build:
@@ -14,4 +14,24 @@ services:
       TEST_PW: passw0rd
       TEST_HOST: testbed
     working_dir: /work/ssh-client-wrapper
-    command: bash -c "mkdir /root/.ssh 2>/dev/null; npm run test"
+    command: bash -c "mkdir /root/.ssh 2>/dev/null; npm run mocha"
+  tester-bullseye:
+    build:
+      context: .
+      dockerfile: Dockerfile-bullseye
+    environment:
+      TEST_USER: testuser
+      TEST_PW: passw0rd
+      TEST_HOST: testbed
+    working_dir: /work/ssh-client-wrapper
+    command: bash -c "mkdir /root/.ssh 2>/dev/null; npm run mocha"
+  tester-buster:
+    build:
+      context: .
+      dockerfile: Dockerfile-buster
+    environment:
+      TEST_USER: testuser
+      TEST_PW: passw0rd
+      TEST_HOST: testbed
+    working_dir: /work/ssh-client-wrapper
+    command: bash -c "mkdir /root/.ssh 2>/dev/null; npm run mocha"

package/lib/fork.js

@@ -11,8 +11,8 @@ const nodePtyOpt = {
   windowsHide: true
 };
 
-function sshLoginCallback(output, ptyProcess, pw, ph, logger = debugSendPty) {
-  return new Promise((resolve, reject)=>{
+function sshLoginCallback (output, ptyProcess, pw, ph, logger = debugSendPty) {
+  return new Promise((resolve, reject) => {
     if (reNewHostPrompt.test(output)) {
       sendPty(ptyProcess, "yes\n", logger, 17);
       resolve();
@@ -26,10 +26,10 @@ function sshLoginCallback(output, ptyProcess, pw, ph, logger = debugSendPty) {
       if (typeof pw === "function") {
         debug("call password callback function");
         pw()
-          .then((v)=>{
+          .then((v) => {
             sendPty(ptyProcess, `${v}\n`, logger, 30);
           })
-          .catch((e)=>{
+          .catch((e) => {
             reject(e);
           });
         resolve();
@@ -44,10 +44,10 @@ function sshLoginCallback(output, ptyProcess, pw, ph, logger = debugSendPty) {
       if (typeof ph === "function") {
         debug("call passphrase callback function");
         ph()
-          .then((v)=>{
+          .then((v) => {
             sendPty(ptyProcess, `${v}\n`, logger, 45);
           })
-          .catch((e)=>{
+          .catch((e) => {
             reject(e);
           });
       }
@@ -58,7 +58,7 @@ function sshLoginCallback(output, ptyProcess, pw, ph, logger = debugSendPty) {
 /**
  * create pty for master ssh session and store to hostInfo.masterPty
  */
-function createMasterPty(hostInfo) {
+function createMasterPty (hostInfo) {
   debug("fork pty for master connection");
 
   if (hostInfo.masterPty) {
@@ -69,13 +69,13 @@ function createMasterPty(hostInfo) {
   hostInfo.masterPty = ptyProcess;
 }
 
-async function fork(hostInfo, cmd, args, timeout, outputCallback) {
-  return new Promise((resolve, reject)=>{
+async function fork (hostInfo, cmd, args, timeout, outputCallback) {
+  return new Promise((resolve, reject) => {
     debug(`cmd=${cmd}: args=${args}`);
     const ptyProcess = spawn(cmd, args, nodePtyOpt);
     let ac = null;
     if (timeout > 0) {
-      ac = watchDogTimer(timeout, cmd, ()=>{
+      ac = watchDogTimer(timeout, cmd, () => {
         ptyProcess.kill();
         const err = new Error(`watchdog timer expired ${timeout}`);
         err.code = "TIMEEXPIRE";
@@ -85,7 +85,7 @@ async function fork(hostInfo, cmd, args, timeout, outputCallback) {
     ptyProcess.onData(buff2String.bind(null, debugVerbose));
 
     if (hostInfo !== null) {
-      ptyProcess.onData(async (data)=>{
+      ptyProcess.onData(async (data) => {
         const output = data.toString();
         sshLoginCallback(output, ptyProcess, hostInfo.password, hostInfo.passphrase)
           .catch(reject);
@@ -102,7 +102,7 @@ async function fork(hostInfo, cmd, args, timeout, outputCallback) {
     if (typeof outputCallback === "function") {
       ptyProcess.onData(buff2String.bind(null, outputCallback));
     }
-    ptyProcess.onExit(({ exitCode, signal })=>{
+    ptyProcess.onExit(({ exitCode, signal }) => {
       debug("onExit", exitCode, signal);
 
       if (ac !== null) {

package/lib/index.js

@@ -32,7 +32,7 @@ const { isArrayOfString, sanityCheck } = require("./util.js");
  * @param {string[]} hostInfo.sshOpt - additional options for ssh
  */
 
-const logAndReject = (message)=>{
+const logAndReject = (message) => {
   debug(message);
   return Promise.reject(new Error(message));
 };
@@ -42,11 +42,11 @@ const logAndReject = (message)=>{
  * @constructor
  */
 class SshClientWrapper {
-  constructor(hostInfo) {
+  constructor (hostInfo) {
     debug("constructor called for", hostInfo.host);
     debugVerbose("hostInfo=", hostInfo);
-    sanityCheck(hostInfo);
     this.hostInfo = { ...hostInfo };
+    sanityCheck(this.hostInfo);
     this.hostInfo.masterPty = null;
     this.hostInfo.rsyncVersion = null;
 
@@ -67,10 +67,8 @@ class SshClientWrapper {
    * @param {Integer} timeout - timeout in secconds
    * @param { Function } outputCallback - call back routine for output
    * @returns {Integer} - Return code of cmd.
-   *
-   * If stdout and stderr is array, last 5 line of stdout and stderr is stored in them.
    */
-  async exec(cmd, timeout = 0, outputCallback = null) {
+  async exec (cmd, timeout = 0, outputCallback = null) {
     debug("exec called", cmd);
 
     if (typeof cmd !== "string" || cmd === "") {
@@ -79,7 +77,6 @@ class SshClientWrapper {
     return sshExec(this.hostInfo, cmd, timeout, outputCallback);
   }
 
-
   /**
    * execute ls command and return output
    * @param {string} target - file or directory path to watch
@@ -87,38 +84,11 @@ class SshClientWrapper {
    * @param {Integer} timeout - timeout in secconds
    * @returns {string[]} - output from ls
    */
-  async ls(target, lsOpt = [], timeout = 0) {
+  async ls (target, lsOpt = [], timeout = 0) {
     debug("ls called", target, lsOpt);
     return ls(this.hostInfo, target, lsOpt, timeout);
   }
 
-  /**
-   * Execute command repeatedly until specified keyword is found in stdout and/or stderr.
-   * @param {string} cmd - Cmdline which will be executed.
-   * @param {RegExp} regexp - End condition.
-   * @param {number} retryDelay - Duration between each try (in sec).
-   * @param {number} maxRetry - Max retry count.
-   * @returns {Integer} - Return code of cmd.
-   */
-  async watch(cmd, regexp, retryDelay = 3, maxRetry = null) {
-    debug("watch called", cmd, regexp, retryDelay, maxRetry);
-
-    if (typeof cmd !== "string") {
-      return logAndReject("cmd must be string");
-    }
-    if (!(regexp instanceof RegExp)) {
-      const err = new Error("illegal regexp specified");
-      err.regexp = regexp;
-      err.cmd = cmd;
-      err.retryDelay = retryDelay;
-      err.maxRetry = maxRetry;
-      return Promise.reject(new Error("err"));
-    }
-    //not implemented yet !!!
-    return this.exec(cmd, ()=>{
-    });
-  }
-
   /**
    * Send file or directory and its child to server.
    * @param {string[]} src - File or directory name which to be recieve.
@@ -127,13 +97,13 @@ class SshClientWrapper {
    * @param {Integer} timeout - timeout in secconds
    * @returns {Promise} - Resolved with undefined when file transfer is done.
    */
-  async send(src, dst, opt = [], timeout = 0) {
+  async send (src, dst, opt = [], timeout = 0) {
     debug("send called", src, dst, opt);
 
     if (!isArrayOfString(src)) {
       return logAndReject("src must be array of string");
     }
-    if (!src.some((e)=>{
+    if (!src.some((e) => {
       return e !== "";
     })) {
       return logAndReject("src must contain non-empty string");
@@ -158,13 +128,13 @@ class SshClientWrapper {
    * @param {Integer} timeout - timeout in secconds
    * @returns {Promise} - Resolved with undefined when file transfer is done.
    */
-  async recv(src, dst, opt = [], timeout = 0) {
+  async recv (src, dst, opt = [], timeout = 0) {
     debug("recv called", src, dst, opt);
 
     if (!isArrayOfString(src)) {
       return logAndReject("src must be array of string");
     }
-    if (!src.some((e)=>{
+    if (!src.some((e) => {
       return e !== "";
     })) {
       return logAndReject("src must contain non-empty string");
@@ -186,7 +156,7 @@ class SshClientWrapper {
    * @param {Integer} timeout - timeout in secconds
    * @returns {Promise} - Resolved with true on success, otherwise rejected with Error.
    */
-  async canConnect(timeout = 60) {
+  async canConnect (timeout = 60) {
     debug("canConnect called with timeout=", timeout);
     debugVerbose("hostInfo=", this.hostInfo);
 
@@ -199,7 +169,7 @@ class SshClientWrapper {
   /**
    * Disconnect master session
    */
-  async disconnect() {
+  async disconnect () {
     debug(`disconnect from ${this.hostInfo.host} called`);
     disconnect(this.hostInfo);
   }

package/lib/rsyncExec.js

@@ -9,9 +9,9 @@ const { fork } = require("./fork.js");
 
 const { sshCmd, rsyncCmd, getSshOption } = require("./util.js");
 
-async function checkRsyncVersion(timeout) {
+async function checkRsyncVersion (timeout) {
   const rt = {};
-  await fork(null, rsyncCmd, ["--version"], timeout, (output)=>{
+  await fork(null, rsyncCmd, ["--version"], timeout, (output) => {
     const result = /^rsync *version *(\d+)\.(\d+)\.(\d+).*$/m.exec(output);
 
     if (result) {
@@ -33,13 +33,13 @@ async function checkRsyncVersion(timeout) {
  *
  * this function execute rsync -avv --copy-unsafe-links  src rsync://[user@]host[:port]/dst
  */
-async function send(hostInfo, argSrc, dst, rsyncOpt, timeout) {
+async function send (hostInfo, argSrc, dst, rsyncOpt, timeout) {
   await connect(hostInfo);
-  const promises = await Promise.allSettled(argSrc.map((e)=>{
+  const promises = await Promise.allSettled(argSrc.map((e) => {
     return glob(e);
   }));
   const src = promises
-    .map((e, i)=>{
+    .map((e, i) => {
       if (e.status !== "fulfilled") {
         return null;
       }
@@ -48,10 +48,10 @@ async function send(hostInfo, argSrc, dst, rsyncOpt, timeout) {
       }
       return e.value;
     })
-    .filter((e)=>{
+    .filter((e) => {
       return e !== null;
     })
-    .flatMap((e)=>{
+    .flatMap((e) => {
       return e;
     });
 
@@ -87,7 +87,7 @@ async function send(hostInfo, argSrc, dst, rsyncOpt, timeout) {
  * @param {Object} hostInfo - hostinfo object
  * @returns {boolean} - rsync command version is higher than 3.2.4 or not
  */
-async function isNewRsync(hostInfo) {
+async function isNewRsync (hostInfo) {
   if (!hostInfo.rsyncVersion ||
     !Number.isInteger(hostInfo.rsyncVersion.major) ||
     !Number.isInteger(hostInfo.rsyncVersion.minor) ||
@@ -107,7 +107,7 @@ async function isNewRsync(hostInfo) {
  *
  * this function execute rsync -av --copy-unsafe-links  rsync://[user@]host[:port]/src dst
  */
-async function recv(hostInfo, argSrc, dst, rsyncOpt, timeout) {
+async function recv (hostInfo, argSrc, dst, rsyncOpt, timeout) {
   await connect(hostInfo);
   const src = `${hostInfo.host}:${argSrc.join(" ")}`;
   const sshArgs = getSshOption(hostInfo, true);