ssh-client-wrapper 2.2.3 → 2.2.4

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/index.js

@@ -67,8 +67,6 @@ 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) {
     debug("exec called", cmd);
@@ -92,33 +90,6 @@ class SshClientWrapper {
     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.

package/lib/util.js

@@ -74,7 +74,10 @@ const buff2String = (func, data)=>{
  */
 const sanityCheck = (hostInfo)=>{
   debug("sanityCheck called", hostInfo);
-  //keep password, passphrase, and masterPty
+  //keep password, passphrase, and masterPty before validate.
+  //these properties can have invalid value for JSON.
+  //ajv will remove that at validation pahse becase of additionalProperties setting
+  //so we keep them here and put back later.
   const { password, passphrase, masterPty } = hostInfo;
   validate(hostInfo);
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ssh-client-wrapper",
-  "version": "2.2.3",
+  "version": "2.2.4",
   "description": "wrapper library for open ssh client and rsync",
   "keywords": [
     "ssh",
@@ -47,17 +47,19 @@
     "chai-fs": "^2.0.0",
     "eslint": "^8.38.0",
     "eslint-config-eslint": "^7.0.0",
+    "eslint-config-standard": "^17.1.0",
     "eslint-plugin-chai-expect": "^3.0.0",
-    "eslint-plugin-chai-friendly": "^0.7.2",
-    "eslint-plugin-jsdoc": "^43.0.6",
-    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-chai-friendly": "^0.7.4",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-n": "^16.6.2",
+    "eslint-plugin-promise": "^6.1.1",
     "fs-extra": "^11.1.1",
     "husky": "^8.0.0",
     "lint-staged": "^13.2.1",
     "mocha": "^10.2.0",
-    "sinon": "^15.0.3",
-    "rewire": "^7.0.0",
     "nyc": "^15.1.0",
+    "rewire": "^7.0.0",
+    "sinon": "^15.0.3",
     "sinon-chai": "^3.7.0"
   }
 }

package/run_test_all.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+docker-compose up testbed -d
+export TEST_HOST=localhost
+export TEST_USER=testuser
+export TEST_PW=passw0rd
+export TEST_PORT=4000
+npm run test
+docker-compose run --build --rm tester &&
+docker-compose run --build --rm tester-bullseye &&
+docker-compose run --build --rm tester-buster &&
+docker-compose rm --stop --force testbed

package/test/interface.js

@@ -42,7 +42,6 @@ describe("test for interface", ()=>{
     it("should successfully instanciate only with host prop", ()=>{
       expect(new SshClientWrapper({ host: "hoge" })).to.have.property("exec");
       expect(new SshClientWrapper({ host: "hoge" })).to.have.property("ls");
-      expect(new SshClientWrapper({ host: "hoge" })).to.have.property("watch");
       expect(new SshClientWrapper({ host: "hoge" })).to.have.property("send");
       expect(new SshClientWrapper({ host: "hoge" })).to.have.property("recv");
       expect(new SshClientWrapper({ host: "hoge" })).to.have.property("canConnect");