ssh-client-wrapper 1.0.8 → 1.1.0

package/.github/workflows/npm-publish.yml

@@ -1,8 +1,14 @@
-name: publish
+name: publish npm package
 on:
-  workflow_call:
+  push:
+    tags:
+      - 'v*'
 jobs:
+  test:
+    uses: ./.github/workflows/run_test.yml
   publish-npm:
+    needs:
+      - test
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3

package/.github/workflows/run_test.yml

@@ -1,6 +1,12 @@
 name: run UT
 on:
+  push:
+    tags-ignore:
+      - 'v*'
   workflow_call:
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 jobs:
   test:
     services:

package/lib/fork.js

@@ -15,8 +15,8 @@ async function fork(hostInfo, cmd, args, argOpt, outputCallback) {
   return new Promise((resolve, reject)=>{
     const opt = argOpt || defaultOpt;
 
-    const ptyProcess = spawn(cmd, args, opt);
     debug(`cmd=${cmd}: args=${args}`);
+    const ptyProcess = spawn(cmd, args, opt);
     ptyProcess.onData(buff2String.bind(null, debugVerbose));
 
     ptyProcess.onData((data)=>{
@@ -31,7 +31,10 @@ async function fork(hostInfo, cmd, args, argOpt, outputCallback) {
           debugSendPty(hostInfo.password);
           ptyProcess.write(`${hostInfo.password}\n`);
         } else if (typeof hostInfo.password === "function") {
-          hostInfo.password(ptyProcess.write);
+          hostInfo.password()
+            .then((pw)=>{
+              ptyProcess.write(`${pw}\n`);
+            });
         }
       }
       if (rePhPrompt.test(output)) {
@@ -39,7 +42,10 @@ async function fork(hostInfo, cmd, args, argOpt, outputCallback) {
           debugSendPty(hostInfo.passphrase);
           ptyProcess.write(`${hostInfo.passphrase}\n`);
         } else if (typeof hostInfo.passphrase === "function") {
-          hostInfo.passphrase(ptyProcess.write);
+          hostInfo.passphrase()
+            .then((pw)=>{
+              ptyProcess.write(`${pw}\n`);
+            });
         }
       }
     });

package/lib/index.js

@@ -83,17 +83,23 @@ class SshClientWrapper {
    * @param {[string]} opt - option for rsync
    * @returns {Promise} - Resolved with undefined when file transfer is done.
    */
-  async send(src, dst, opt = {}) {
-    debug("send called", src, dst);
+  async send(src, dst, opt) {
+    debug("send called", src, dst, opt);
 
     if (!isArrayOfString(src)) {
-      return new Error("src must be array of string");
+      const err = "src must be array of string";
+      debug(err);
+      return new Error(err);
     }
     if (typeof dst !== "string") {
-      return new Error("dst must be string");
+      const err = "dst must be string";
+      debug(err);
+      return new Error(err);
     }
-    if (!isArrayOfString(opt)) {
-      return new Error("opt must be array of string");
+    if (typeof opt !== "undefined" && !isArrayOfString(opt)) {
+      const err = "opt must be array of string";
+      debug(err);
+      return new Error(err);
     }
     return send(this.hostInfo, src, dst, opt);
   }
@@ -105,19 +111,24 @@ class SshClientWrapper {
    * @param {[string]} opt - option for rsync
    * @returns {Promise} - Resolved with undefined when file transfer is done.
    */
-  async recv(src, dst, opt = {}) {
-    debug("recv called", src, dst);
+  async recv(src, dst, opt) {
+    debug("recv called", src, dst, opt);
 
     if (!isArrayOfString(src)) {
-      return new Error("src must be array of string");
+      const err = "src must be array of string";
+      debug(err);
+      return new Error(err);
     }
     if (typeof dst !== "string") {
-      return new Error("dst must be string");
+      const err = "dst must be string";
+      debug(err);
+      return new Error(err);
     }
-    if (!isArrayOfString(opt)) {
-      return new Error("opt must be array of string");
+    if (typeof opt !== "undefined" && !isArrayOfString(opt)) {
+      const err = "opt must be array of string";
+      debug(err);
+      return new Error(err);
     }
-
     return recv(this.hostInfo, src, dst, opt);
   }
 

package/lib/rsyncExec.js

@@ -34,6 +34,8 @@ async function send(hostInfo, argSrc, dst, rsyncOpt = []) {
 
   const args = ["-amvv", "--copy-unsafe-links", ...rshOpt, ...rsyncOpt, ...src, `${hostInfo.host}:${dst}`];
   const { dir: remoteDir } = path.parse(dst);
+  debug("remoteDir=", remoteDir);
+
   if (remoteDir !== "" && remoteDir !== "/") {
     debug(`mkdir ${remoteDir}`);
     sshExec(hostInfo, `mkdir -p ${remoteDir}`, debugVerbose);

package/lib/sshExec.js

@@ -28,7 +28,7 @@ async function canConnect(hostInfo, timeout) {
   const words = crypto.randomUUID();
   const args = getSshOption(hostInfo);
   if (Number.isInteger(timeout) && timeout > 0) {
-    args.push(`-OConnectTimeout=${timeout}`);
+    args.push(`-oConnectTimeout=${timeout}`);
   }
   args.push(`echo ${words}`);
 

package/lib/util.js

@@ -50,7 +50,7 @@ const getSshOption = (hostInfo, withoutDestination)=>{
   }
   const renewInterval = Number.isInteger(hostInfo.renewInterval) && hostInfo.renewInterval > 0 ? hostInfo.renewInterval : 180;
   args.push("-oControlMaster=auto");
-  args.push("-oControlPath=~/.ssh/wheel-%r@%h:%p");
+  args.push("-oControlPath=~/.ssh/ssh-client-wrapper-%r@%h:%p");
   args.push(`-oControlPersist=${renewInterval}`);
   return args;
 };
@@ -72,7 +72,8 @@ const isArrayOfString = (target)=>{
   if (!Array.isArray(target)) {
     return false;
   }
-  return target.some((e)=>{
+  return !target.some((e)=>{
+    //target has non string member
     return typeof e !== "string";
   });
 };

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "ssh-client-wrapper",
-  "version": "1.0.8",
+  "version": "1.1.0",
   "description": "wrapper library for open ssh client and rsync",
   "main": "lib/index.js",
   "scripts": {
     "test": "mocha --recursive test",
     "lint": "eslint --fix lib test",
-    "postversion": "git push origin $(git describe --abbrev=0 --tags)"
+    "postversion": "git push && git push origin $(git describe --abbrev=0 --tags)"
   },
   "engines": {
     "node": ">=12.9"

package/.github/workflows/kicker_release.yml

@@ -1,11 +0,0 @@
-name: release package
-on:
-  push:
-    tags:
-      - 'v*'
-jobs:
-  test:
-    uses: ./.github/workflows/run_test.yml
-  publish-npm:
-    uses: ./.github/workflows/npm-publish.yml
-    secrets: inherit

package/.github/workflows/kicker_test_only.yml

@@ -1,8 +0,0 @@
-name: run UT only
-on:
-  push:
-    tags-ignore:
-      - 'v*'
-jobs:
-  test:
-    uses: ./.github/workflows/run_test.yml