chore(release): 4.0.2 [skip ci]

## [4.0.2](https://github.com/easingthemes/ssh-deploy/compare/v4.0.1...v4.0.2) (2023-01-03)

### Bug Fixes

* add githubWorkspace as default source root ([3ef66d0](3ef66d0be9))

.eslintrc.js

@@ -12,14 +12,14 @@ module.exports = {
     SharedArrayBuffer: 'readonly'
   },
   parserOptions: {
-    ecmaVersion: 2018,
+    ecmaVersion: 2018
   },
   rules: {
-    "comma-dangle": [
+    'comma-dangle': [
-      "error",
+      'error',
-      "never"
+      'never'
     ],
-    "no-console": "off",
+    'no-console': 'off',
-    "object-curly-newline": "off"
+    'object-curly-newline': 'off'
   }
 };

.github/workflows/build.yml

@@ -18,9 +18,9 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Setup Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
       - name: Install dependencies

.github/workflows/codeql-analysis.yml

@@ -31,11 +31,11 @@ jobs:
         language: [ 'javascript' ]
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
+      uses: github/codeql-action/init@v2
       with:
         languages: ${{ matrix.language }}
 
@@ -44,4 +44,4 @@ jobs:
         npm run build --if-present
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+      uses: github/codeql-action/analyze@v2

.github/workflows/e2e-manual.yml

@@ -0,0 +1,104 @@
+name: e2e Manual Test
+
+on:
+  workflow_dispatch:
+    inputs:
+      ARGS:
+        description: 'ARGS'
+        required: true
+        default: '-rlgoDzvc -i --delete --chmod=ugo+rwX --progress'
+      EXCLUDE:
+        description: 'EXCLUDE'
+        required: true
+        default: 'skip_dir/, /node_modules/'
+      SSH_CMD_ARGS:
+        description: 'SSH_CMD_ARGS'
+        required: true
+        default: '-o StrictHostKeyChecking=no, -o UserKnownHostsFile=/dev/null'
+
+
+env:
+  TEST_HOST_DOCKER: ./test
+  TEST_USER: test
+
+jobs:
+  e2e-manual:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+#         ----------------------------------------------------------------
+#         START E2E Test Specific - steps
+#         ----------------------------------------------------------------
+
+      - name: E2E Test Specific - Clean up old test files
+        run: |
+          docker stop ssh-host-container || true && docker rm ssh-host-container || true
+
+      - name: E2E Test Specific - Create ssh keys
+        run: |
+          echo $HOME
+          ls -la $HOME
+          ssh-keygen -m PEM -t rsa -b 4096 -f "$HOME/.ssh/id_rsa" -N ""
+          eval `ssh-agent -s`
+          ssh-add "$HOME/.ssh/id_rsa"
+          ssh-add -l
+          echo "SSH_PRIVATE_KEY<<EOF" >> $GITHUB_ENV
+          cat $HOME/.ssh/id_rsa >> $GITHUB_ENV
+          echo "EOF" >> $GITHUB_ENV
+
+      - name: E2E Test Specific - Build Host Server Image
+        working-directory: ${{ env.TEST_HOST_DOCKER }}
+        run: |
+          docker build \
+            -t ssh-host-image . \
+            --build-arg SSH_PUB_KEY="$(cat $HOME/.ssh/id_rsa.pub)"
+          docker run -d -p 8822:22 --name=ssh-host-container ssh-host-image
+          docker exec ssh-host-container sh -c "hostname --ip-address" > ip.txt
+          echo "REMOTE_HOST<<EOF" >> $GITHUB_ENV
+          cat ip.txt >> $GITHUB_ENV
+          echo "EOF" >> $GITHUB_ENV
+        shell: bash
+
+      - name: E2E Test Specific - Create project file
+        run: |
+          mkdir test_project2 && cd "$_"
+          truncate -s 5MB info2.txt
+          cd ../
+          mkdir test_project && cd "$_"
+          touch index.html
+          date +"%Y-%m-%d %H:%M:%S,%3N" >> index.html
+          truncate -s 50MB image.svg
+          truncate -s 5MB info.txt
+          truncate -s 500MB big_file.txt
+          mkdir skip_dir && cd "$_"
+          truncate -s 5MB text_in_skip_dir.txt
+          cd ../
+          cat index.html
+          echo "test_project:" && ls -lR
+          echo "skip_dir:" && ls -lR skip_dir
+
+#         ----------------------------------------------------------------
+#         END E2E Test Specific - steps
+#         ----------------------------------------------------------------
+
+      - name: e2e Test ssh-deploy action
+        uses: easingthemes/ssh-deploy@main
+        env:
+          # ENV Vars created in previous steps:
+          # SSH_PRIVATE_KEY: $EXAMPLE_SSH_PRIVATE_KEY
+          # REMOTE_HOST: $EXAMPLE_REMOTE_HOST
+          REMOTE_USER: ${{ env.TEST_USER }}
+          ARGS: ${{ github.event.inputs.ARGS }}
+          SSH_CMD_ARGS: ${{ github.event.inputs.SSH_CMD_ARGS }}
+          SOURCE: test_project/ test_project2/
+          TARGET: /var/www/html/
+          EXCLUDE: ${{ github.event.inputs.EXCLUDE }}
+          SCRIPT_BEFORE: |
+            whoami
+            ls -lR /var/www/html/
+          SCRIPT_AFTER: |
+            ls -lR /var/www/html/
+            echo $RSYNC_STDOUT

.github/workflows/e2e.yml

@@ -7,6 +7,7 @@ on:
 env:
   TEST_HOST_DOCKER: ./test
   TEST_USER: test
+  TEST_USER2: test2
 
 jobs:
   e2e:
@@ -16,11 +17,15 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v3
 
-      - name: Clean up old test files
+#         : ---------------------------------------------------------------
+#         : START E2E Test Specific - steps
+#         : ----------------------------------------------------------------
+
+      - name: E2E Test Specific - Clean up old test files
         run: |
           docker stop ssh-host-container || true && docker rm ssh-host-container || true
 
-      - name: Create ssh keys
+      - name: E2E Test Specific - Create ssh keys
         run: |
           echo $HOME
           ls -la $HOME
@@ -32,13 +37,12 @@ jobs:
           cat $HOME/.ssh/id_rsa >> $GITHUB_ENV
           echo "EOF" >> $GITHUB_ENV
 
-      - name: Build Host Server Image
+      - name: E2E Test Specific - Build Host Server Image
         working-directory: ${{ env.TEST_HOST_DOCKER }}
         run: |
           docker build \
             -t ssh-host-image . \
-            --build-arg SSH_PUB_KEY="$(cat $HOME/.ssh/id_rsa.pub)" \
+            --build-arg SSH_PUB_KEY="$(cat $HOME/.ssh/id_rsa.pub)"
-            --build-arg ssh_user="${{ env.TEST_USER }}"
           docker run -d -p 8822:22 --name=ssh-host-container ssh-host-image
           docker exec ssh-host-container sh -c "hostname --ip-address" > ip.txt
           echo "REMOTE_HOST<<EOF" >> $GITHUB_ENV
@@ -46,21 +50,124 @@ jobs:
           echo "EOF" >> $GITHUB_ENV
         shell: bash
 
-      - name: Create project file
+      - name: E2E Test Specific - Create project file
         run: |
-          mkdir test_project
+          mkdir test_project2 && cd "$_"
-          cd test_project
+          truncate -s 5MB info2.txt
+          cd ../
+          mkdir test_project && cd "$_"
           touch index.html
           date +"%Y-%m-%d %H:%M:%S,%3N" >> index.html
+          truncate -s 50MB image.svg
+          truncate -s 5MB info.txt
+          truncate -s 500MB big_file.txt
+          mkdir skip_dir && cd "$_"
+          truncate -s 5MB text_in_skip_dir.txt
+          cd ../
           cat index.html
+          echo "test_project:" && ls -lR
+          echo "skip_dir:" && ls -lR skip_dir
 
-      - name: e2e Test published ssh-deploy action
+#         ----------------------------------------------------------------
+#         END E2E Test Specific - steps
+#         ----------------------------------------------------------------
+
+      - name: set shared ENV variables for multi target deployment
+        run: |
+          echo "ARGS=-rlgoDzvcR -i --delete --chmod=ugo+rwX --progress" >> $GITHUB_ENV
+          echo "SSH_CMD_ARGS=-o StrictHostKeyChecking=no, -o UserKnownHostsFile=/dev/null" >> $GITHUB_ENV
+          echo "SOURCE=test_project/ test_project2/" >> $GITHUB_ENV
+          echo "EXCLUDE=skip_dir/, /node_modules/" >> $GITHUB_ENV
+          echo "SCRIPT_BEFORE<<EOF" >> $GITHUB_ENV
+          echo "whoami" >> $GITHUB_ENV
+          echo "ls -lR /var/www/html/" >> $GITHUB_ENV
+          echo "EOF" >> $GITHUB_ENV
+          echo "SCRIPT_AFTER<<EOF" >> $GITHUB_ENV
+          echo $RSYNC_STDOUT >> $GITHUB_ENV
+          echo "ls -lR /var/www/html/" >> $GITHUB_ENV
+          echo "EOF" >> $GITHUB_ENV
+
+      - name: e2e Test ssh-deploy action - Target 1
         uses: easingthemes/ssh-deploy@main
         env:
-          # SSH_PRIVATE_KEY: $EXAMPLE_SSH_PRIVATE_KEY
+          # Shared ENV Vars created in previous steps
-          # REMOTE_HOST: $EXAMPLE_REMOTE_HOST1
           REMOTE_USER: ${{ env.TEST_USER }}
-          ARGS: "-rltgoDzvO"
+          TARGET: /var/www/html/${{ env.TEST_USER }}
-          SOURCE: "test_project/"
+
-          TARGET: "/var/www/html/"
+      - name: e2e Test ssh-deploy action - Target 2
-          EXCLUDE: "/dist/, /node_modules/"
+        uses: easingthemes/ssh-deploy@main
+        env:
+          # Shared ENV Vars created in previous steps
+          REMOTE_USER: ${{ env.TEST_USER2 }}
+          TARGET: /var/www/html/${{ env.TEST_USER2 }}
+  e2e-v3:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      #         : ---------------------------------------------------------------
+      #         : START E2E Test Specific - steps
+      #         : ----------------------------------------------------------------
+
+      - name: E2E Test Specific - Clean up old test files
+        run: |
+          docker stop ssh-host-container || true && docker rm ssh-host-container || true
+
+      - name: E2E Test Specific - Create ssh keys
+        run: |
+          echo $HOME
+          ls -la $HOME
+          ssh-keygen -m PEM -t rsa -b 4096 -f "$HOME/.ssh/id_rsa" -N ""
+          eval `ssh-agent -s`
+          ssh-add "$HOME/.ssh/id_rsa"
+          ssh-add -l
+          echo "SSH_PRIVATE_KEY<<EOF" >> $GITHUB_ENV
+          cat $HOME/.ssh/id_rsa >> $GITHUB_ENV
+          echo "EOF" >> $GITHUB_ENV
+
+      - name: E2E Test Specific - Build Host Server Image
+        working-directory: ${{ env.TEST_HOST_DOCKER }}
+        run: |
+          docker build \
+            -t ssh-host-image . \
+            --build-arg SSH_PUB_KEY="$(cat $HOME/.ssh/id_rsa.pub)"
+          docker run -d -p 8822:22 --name=ssh-host-container ssh-host-image
+          docker exec ssh-host-container sh -c "hostname --ip-address" > ip.txt
+          echo "REMOTE_HOST<<EOF" >> $GITHUB_ENV
+          cat ip.txt >> $GITHUB_ENV
+          echo "EOF" >> $GITHUB_ENV
+        shell: bash
+
+      - name: E2E Test Specific - Create project file
+        run: |
+          mkdir test_project2 && cd "$_"
+          truncate -s 5MB info2.txt
+          cd ../
+          mkdir test_project && cd "$_"
+          touch index.html
+          date +"%Y-%m-%d %H:%M:%S,%3N" >> index.html
+          truncate -s 50MB image.svg
+          truncate -s 5MB info.txt
+          truncate -s 500MB big_file.txt
+          mkdir skip_dir && cd "$_"
+          truncate -s 5MB text_in_skip_dir.txt
+          cd ../
+          cat index.html
+          echo "test_project:" && ls -lR
+          echo "skip_dir:" && ls -lR skip_dir
+
+      #         ----------------------------------------------------------------
+      #         END E2E Test Specific - steps
+      #         ----------------------------------------------------------------
+
+      - name: e2e Test ssh-deploy action - Target 1
+        uses: easingthemes/ssh-deploy@v3.4.3
+        env:
+          # Shared ENV Vars created in previous steps
+          REMOTE_USER: ${{ env.TEST_USER }}
+          TARGET: /var/www/html/${{ env.TEST_USER }}
+          SOURCE: test_project/
+          EXCLUDE: skip_dir/, /node_modules/
+          ARGS: -rlgoDzvcO

.github/workflows/manual-release.yml

@@ -2,39 +2,21 @@ name: Manual Release
 on:
   workflow_dispatch:
     inputs:
-      dryrun:
+      version:
-        description: 'DryRUn'
+        description: 'Version'
+        type: choice
         required: true
-        default: 'false'
+        default: patch
-jobs:
+        options:
-  release:
+          - patch
-    name: Test, Build and Release
+          - minor
-    runs-on: ${{ matrix.os }}
+          - major
-    strategy:
+      dryRun:
-      matrix:
+        description: 'DryRun'
-        os: [ ubuntu-latest ]
+        type: boolean
-        node-version: [ 16.x ]
+        default: true
-    steps:
+# ENV and Config
-      - name: Checkout
+env:
-        uses: actions/checkout@v2
-      - name: Setup Node.js
-        uses: actions/setup-node@v1
-        with:
-          node-version: ${{ matrix['node-version'] }}
-      - name: Install dependencies
-        run: npm ci
-      - name: Build Library
-        run: npm run build --if-present
-      - name: Run Tests
-        run: npm test --if-present
-      - name: Release
-        uses: cycjimmy/semantic-release-action@v2
-        with:
-          dry_run: ${{ github.event.inputs.dryrun == 'true' }}
-          extra_plugins: |
-            @semantic-release/changelog@3.0.0
-            @semantic-release/git
-        env:
   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
   NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
   GIT_AUTHOR_NAME: github-actions
@@ -42,3 +24,50 @@ jobs:
   GIT_COMMITTER_NAME: github-actions
   GIT_COMMITTER_EMAIL: github-actions@github.com
   CI: true
+  CONFIG_NODE_VERSION: '["lts/*"]'
+  CONFIG_OS: '["ubuntu-latest"]'
+# Main Job
+jobs:
+  config:
+    runs-on: ubuntu-latest
+    outputs:
+      NODE_VERSION: ${{ steps.set-config.outputs.CONFIG_NODE_VERSION }}
+      OS: ${{ steps.set-config.outputs.CONFIG_OS }}
+    steps:
+      - id: set-config
+        run: |
+          echo "CONFIG_NODE_VERSION=${{ toJSON(env.CONFIG_NODE_VERSION) }}" >> $GITHUB_OUTPUT
+          echo "CONFIG_OS=${{ toJSON(env.CONFIG_OS) }}" >> $GITHUB_OUTPUT
+  release-manual:
+    name: Test, Build and force Release
+    needs: config
+
+    runs-on: ${{ matrix.OS }}
+    strategy:
+      matrix:
+        OS: ${{ fromJSON(needs.config.outputs.OS) }}
+        NODE_VERSION: ${{ fromJSON(needs.config.outputs.NODE_VERSION) }}
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v3
+      - name: Setup Node.js ${{ matrix.NODE_VERSION }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.NODE_VERSION }}
+      - name: Commit trigger
+        run: |
+          git commit --allow-empty -m "${{ github.event.inputs.version }}: Trigger Manual Release"
+      - name: Install dependencies
+        run: npm ci
+      - name: Build Library
+        run: npm run build --if-present
+      - name: Run Tests
+        run: npm test --if-present
+      - name: Publish npm package
+        uses: cycjimmy/semantic-release-action@v3
+        with:
+          dry_run: ${{ github.event.inputs.dryRun == 'true' }}
+          extra_plugins: |
+            @semantic-release/changelog
+            @semantic-release/git

.github/workflows/stale.yml

@@ -0,0 +1,26 @@
+# This workflow warns and then closes issues and PRs that have had no activity for a specified amount of time.
+#
+# You can adjust the behavior by modifying this file.
+# For more information, see:
+# https://github.com/actions/stale
+name: Close stale issues
+
+on:
+  schedule:
+  - cron: '30 1 * * *'
+
+jobs:
+  stale:
+
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+
+    steps:
+    - uses: actions/stale@v7
+      with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        stale-issue-message: 'This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.'
+        days-before-stale: 30
+        days-before-close: 5
+        stale-issue-label: 'stale'

README.md

@@ -1,6 +1,8 @@
 # ssh deployments
 
-Deploy code with rsync over ssh, using NodeJS.
+Deploy code with rsync over ssh.
+
+Execute remote scripts before or after rsync
 
 NodeJS version is more than a minute `faster` than simple Docker version.
 
@@ -8,6 +10,8 @@ This GitHub Action deploys specific directory from `GITHUB_WORKSPACE` to a folde
 
 This action would usually follow a build/test action which leaves deployable code in `GITHUB_WORKSPACE`, eg `dist`;
 
+In addition to rsync, this action provides scripts execution on remote host before and/or after rsync.
+
 # Configuration
 
 Pass configuration with `env` vars
@@ -37,13 +41,14 @@ eg: myusername
 
 eg: '59184'
 
-##### 5. `ARGS` (optional, default '-rltgoDzvO')
+##### 5. `ARGS` (optional, default '-rlgoDzvc -i')
 
 For any initial/required rsync flags, eg: `-avzr --delete`
 
 ##### 6. `SOURCE` (optional, default '')
 
-The source directory, path relative to `$GITHUB_WORKSPACE` root, eg: `dist/`
+The source directory, path relative to `$GITHUB_WORKSPACE` root, eg: `dist/`.
+Multiple sources should be separated by space.
 
 ##### 7. `TARGET` (optional, default '/home/REMOTE_USER/')
 
@@ -53,6 +58,23 @@ The target directory
 
 path to exclude separated by `,`, ie: `/dist/, /node_modules/`
 
+##### 9. `SCRIPT_BEFORE` (optional, default '')
+
+Script to run on host machine before rsync. Single line or multiline commands.
+Execution is preformed by storing commands in `.sh` file and executing it via `.bash` over `ssh`
+If you have issues with `ssh` connection, use this var, eg `SCRIPT_BEFORE: ls`.
+This will force `known_hosts` update, adding your host via `ssh-keyscan`.
+
+##### 10. `SCRIPT_AFTER` (optional, default '')
+
+Script to run on host machine after rsync.
+Rsync output is stored in `$RSYNC_STDOUT` env variable.
+
+##### 11. `SSH_CMD_ARGS` (optional, default '-o StrictHostKeyChecking=no')
+
+A list of ssh arguments, they must be prefixed with -o and separated by a comma, for example: -o SomeArgument=no, -o SomeOtherArgument=5
+
+
 # Usage
 
 Use the latest version from Marketplace,eg: ssh-deploy@v2
@@ -63,12 +85,19 @@ or use the latest version from a branch, eg: ssh-deploy@main
     uses: easingthemes/ssh-deploy@main
     env:
       SSH_PRIVATE_KEY: ${{ secrets.SSH_PRIVATE_KEY }}
-      ARGS: "-rltgoDzvO"
+      ARGS: "-rlgoDzvc -i"
       SOURCE: "dist/"
       REMOTE_HOST: ${{ secrets.REMOTE_HOST }}
       REMOTE_USER: ${{ secrets.REMOTE_USER }}
       TARGET: ${{ secrets.REMOTE_TARGET }}
       EXCLUDE: "/dist/, /node_modules/"
+      SCRIPT_BEFORE: |
+        whoami
+        ls -al
+      SCRIPT_AFTER: |
+        whoami
+        ls -al
+        echo $RSYNC_STDOUT
 ```
 
 # Example usage in workflow
@@ -97,7 +126,7 @@ jobs:
       uses: easingthemes/ssh-deploy@main
       env:
           SSH_PRIVATE_KEY: ${{ secrets.SSH_PRIVATE_KEY }}
-          ARGS: "-rltgoDzvO --delete"
+          ARGS: "-rlgoDzvc -i --delete"
           SOURCE: "dist/"
           REMOTE_HOST: ${{ secrets.REMOTE_HOST }}
           REMOTE_USER: ${{ secrets.REMOTE_USER }}
@@ -107,12 +136,30 @@ jobs:
 
 ## Issues
 
-Almost 95% of the issues are related to wrong SSH connection.
+This is a GitHub Action wrapping `rsync` via `ssh`. Only issues with action functionality can be fixed here.
+
+Almost 95% of the issues are related to wrong SSH connection or `rsync` params and permissions.
+These issues are not related to the action itself.
+
+- Check manually your ssh connection from your client before opening a bug report.
+- Check `rsync` params for your use-case. Default params are not going to be enough wor everyone, it highly depends on your setup.
+- Check manually your rsync command from your client before opening a bug report.
+
 I've added e2e test for this action.
+Real example is executed on every PR merge to `main`.
 Check actions tab for example.
 
-Check manually your ssh connection from your client before opening a bug report.
+More info for SSH keys: https://www.ssh.com/ssh/public-key-authentication
-Thanks.
+
+## Tips
+
+- Optional ENV variables are created for simple requirements.
+For complex use cases, use `ARGS` and `SSH_CMD_ARGS` to fully configure `rsync` with all possible options.
+- If you need to use multiple steps, eg multi targets deployment, save shared ENV variables in `>> $GITHUB_ENV`.
+Check .github/workflows/e2e.yml for an example
+- For multi sources, use -R ARG to manipulate folders structure.
+- Great post about `rsync` options specific to usage of this action: https://logansnotes.com/2020/gh-action-site-deploy/
+
 
 ## Disclaimer
 

action.yml

@@ -1,9 +1,9 @@
 name: "ssh deploy"
-description: "NodeJS action for FAST deployment with rsync/ssh"
+description: "NodeJS action for FAST deployment with rsync/ssh and remote script execution before/after rsync"
 author: "easingthemes"
 inputs:
-  SSH_PRIVATE_KEY: # Private Key
+  SSH_PRIVATE_KEY:
-    description: "Private Key"
+    description: "Private key part of an SSH key pair"
     required: true
   REMOTE_HOST:
     description: "Remote host"
@@ -16,7 +16,7 @@ inputs:
     required: false
     default: "22"
   SOURCE:
-    description: "Source directory"
+    description: "Source directory, path relative to `$GITHUB_WORKSPACE` root, eg: `dist/`"
     required: false
     default: ""
   TARGET:
@@ -26,9 +26,21 @@ inputs:
   ARGS:
     description: "Arguments to pass to rsync"
     required: false
-    default: "-rltgoDzvO"
+    default: "-rlgoDzvc -i"
+  SSH_CMD_ARGS:
+    description: "An array of ssh arguments, they must be prefixed with -o and separated by a comma, for example: -o SomeArgument=no, -o SomeOtherArgument=5 "
+    required: false
+    default: "-o StrictHostKeyChecking=no"
   EXCLUDE:
-    description: "An array of folder to exclude"
+    description: "paths to exclude separated by `,`, ie: `/dist/, /node_modules/`"
+    required: false
+    default: ""
+  SCRIPT_BEFORE:
+    description: "Script to run on host machine before rsync"
+    required: false
+    default: ""
+  SCRIPT_AFTER:
+    description: "Script to run on host machine after rsync"
     required: false
     default: ""
 outputs:

docs/CHANGELOG.md

@@ -1,3 +1,138 @@
+## [4.0.2](https://github.com/easingthemes/ssh-deploy/compare/v4.0.1...v4.0.2) (2023-01-03)
+
+
+### Bug Fixes
+
+* add githubWorkspace as default source root ([3ef66d0](https://github.com/easingthemes/ssh-deploy/commit/3ef66d0be999ee45434505e8bedea4f8b5b5a909))
+
+## [4.0.1](https://github.com/easingthemes/ssh-deploy/compare/v4.0.0...v4.0.1) (2023-01-03)
+
+
+### Bug Fixes
+
+* fix default source if empty ([9f191f4](https://github.com/easingthemes/ssh-deploy/commit/9f191f42633c4a0f66054f0fc229c9e30a08f00c))
+
+# [4.0.0](https://github.com/easingthemes/ssh-deploy/compare/v3.4.3...v4.0.0) (2023-01-03)
+
+
+### Bug Fixes
+
+* rebuild ([2169399](https://github.com/easingthemes/ssh-deploy/commit/2169399fef9a60a2fea1ab03cce4ec8c2371e5c2))
+
+
+### Performance Improvements
+
+* update default rsync options ([2be7efb](https://github.com/easingthemes/ssh-deploy/commit/2be7efb376866327c1d1209f51eb43f34f07b354))
+
+
+### BREAKING CHANGES
+
+* Default rsync options updated to speed up default deployments.
+from `rltgoDzvO` to `-rlgoDzvc -i`
+
+## [3.4.3](https://github.com/easingthemes/ssh-deploy/compare/v3.4.2...v3.4.3) (2023-01-03)
+
+
+### Bug Fixes
+
+* move e2e tests typo branch name ([6d3554b](https://github.com/easingthemes/ssh-deploy/commit/6d3554b01e9a05de9a9d2b30274bee411a4986ed))
+
+## [3.4.2](https://github.com/easingthemes/ssh-deploy/compare/v3.4.1...v3.4.2) (2023-01-03)
+
+
+### Bug Fixes
+
+* Update changelog ([765f5ff](https://github.com/easingthemes/ssh-deploy/commit/765f5ffd3153c76442521c61c04656cafc182731))
+
+## [3.4.1](https://github.com/easingthemes/ssh-deploy/compare/v3.4.0...v3.4.1) (2023-01-03)
+
+
+### Bug Fixes
+
+* move e2e tests to main branch ([0069fae](https://github.com/easingthemes/ssh-deploy/commit/0069faea9ff3ea3cdd095b0f2663c9e2bcd97480))
+
+# [3.4.0](https://github.com/easingthemes/ssh-deploy/compare/v3.3.4...v3.4.0) (2023-01-03)
+
+
+**Full Changelog**: https://github.com/easingthemes/ssh-deploy/compare/v3.1.0...v3.4.1
+
+### Features
+
+* Add SSH remote script support -  before and after rsync ([2cd8a82](https://github.com/easingthemes/ssh-deploy/commit/2cd8a820e22135b7002fbe6a47cf33f99e2d337b))
+* Add multi source and multi target support ([73a65ec](https://github.com/easingthemes/ssh-deploy/commit/73a65ec97c5046a53f6b4c40823be5fd3826ede0))
+* Add SSH_CMD_ARGS support ([51a0063](https://github.com/easingthemes/ssh-deploy/commit/51a00631e2b91983fb610ca2157a673b9ae03c95))
+* Add manual inputs for e2e test ([8f71595](https://github.com/easingthemes/ssh-deploy/commit/8f715957ab9283ab2934dd1e5be9d78f2eaf3fae))
+
+### Bug Fixes
+
+* Add visible Rsync CMD for debugging ([91b6d28](https://github.com/easingthemes/ssh-deploy/commit/91b6d280aee6a7ae666a11426fb356406f4a25a5))
+* log buffer from rsync stdout ([8e19e0d](https://github.com/easingthemes/ssh-deploy/commit/8e19e0d6bc9b1c332925ce0268ad64b50728fae5))
+* fix e2e yaml step name ([5c13615](https://github.com/easingthemes/ssh-deploy/commit/5c13615d4b7b0bda47f622ac5f4444484d8bcdb4))
+
+## [3.3.4](https://github.com/easingthemes/ssh-deploy/compare/v3.3.3...v3.3.4) (2023-01-02)
+
+
+### Bug Fixes
+
+* Add visible Rsync CMD for debugging ([91b6d28](https://github.com/easingthemes/ssh-deploy/commit/91b6d280aee6a7ae666a11426fb356406f4a25a5))
+
+## [3.3.3](https://github.com/easingthemes/ssh-deploy/compare/v3.3.2...v3.3.3) (2023-01-02)
+
+
+### Bug Fixes
+
+* log buffer from rsync stdout ([8e19e0d](https://github.com/easingthemes/ssh-deploy/commit/8e19e0d6bc9b1c332925ce0268ad64b50728fae5))
+
+## [3.3.2](https://github.com/easingthemes/ssh-deploy/compare/v3.3.1...v3.3.2) (2023-01-02)
+
+
+### Bug Fixes
+
+* Add manual inputs for e2e test ([8f71595](https://github.com/easingthemes/ssh-deploy/commit/8f715957ab9283ab2934dd1e5be9d78f2eaf3fae))
+
+## [3.3.1](https://github.com/easingthemes/ssh-deploy/compare/v3.3.0...v3.3.1) (2023-01-02)
+
+
+### Bug Fixes
+
+* Log rsync command ([85f4a96](https://github.com/easingthemes/ssh-deploy/commit/85f4a967435d7d44edf2fea628c9f59db5e890ee))
+
+# [3.3.0](https://github.com/easingthemes/ssh-deploy/compare/v3.2.0...v3.3.0) (2023-01-02)
+
+
+### Features
+
+* Add SSH_CMD_ARGS support ([51a0063](https://github.com/easingthemes/ssh-deploy/commit/51a00631e2b91983fb610ca2157a673b9ae03c95))
+
+# [3.2.0](https://github.com/easingthemes/ssh-deploy/pull/94/files) (2023-01-02)
+
+
+### Features
+
+* Add SSH remote script support -  before and after rsync ([2cd8a82](https://github.com/easingthemes/ssh-deploy/pull/94/files))
+* feat: add sshCmdArgs option
+* feat: add onStderr and onStdout logs
+* feat: Add RSYNC_STDOUT env variable
+* feat: Update emojis
+
+### Bug Fixes
+
+* fix: remove _unsafe _dirname
+* fix: Add promise instead of callback
+* fix: improve logs
+* fix: Add simple command exists instead of a plugin
+* fix: add non interactive install
+* fix: Improve reject messages
+* fix: update workflow actions
+
+
+## [3.1.1](https://github.com/easingthemes/ssh-deploy/compare/v3.1.0...v3.1.1) (2023-01-02)
+
+
+### Bug Fixes
+
+* use main branch for e2e testes ([21451fe](https://github.com/easingthemes/ssh-deploy/commit/21451fec978a02b55672490a2c11c6c17995ff95))
+
 # [3.1.0](https://github.com/easingthemes/ssh-deploy/compare/v3.0.1...v3.1.0) (2022-12-31)
 
 

package-lock.json

@@ -1,15 +1,14 @@
 {
   "name": "@draganfilipovic/ssh-deploy",
-  "version": "3.0.1",
+  "version": "3.1.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@draganfilipovic/ssh-deploy",
-      "version": "3.0.1",
+      "version": "3.1.0",
       "license": "MIT",
       "dependencies": {
-        "command-exists": "^1.2.9",
         "rsyncwrapper": "^3.0.1"
       },
       "devDependencies": {
@@ -301,11 +300,6 @@
       "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==",
       "dev": true
     },
-    "node_modules/command-exists": {
-      "version": "1.2.9",
-      "resolved": "https://registry.npmjs.org/command-exists/-/command-exists-1.2.9.tgz",
-      "integrity": "sha512-LTQ/SGc+s0Xc0Fu5WaKnR0YiygZkm9eKFvyS+fRsU7/ZWFF8ykFM6Pc9aCVf1+xasOOZpO3BAVgVrKvsqKHV7w=="
-    },
     "node_modules/concat-map": {
       "version": "0.0.1",
       "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz",
@@ -332,6 +326,21 @@
         "node": ">= 8"
       }
     },
+    "node_modules/cross-spawn/node_modules/which": {
+      "version": "2.0.2",
+      "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz",
+      "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==",
+      "dev": true,
+      "dependencies": {
+        "isexe": "^2.0.0"
+      },
+      "bin": {
+        "node-which": "bin/node-which"
+      },
+      "engines": {
+        "node": ">= 8"
+      }
+    },
     "node_modules/debug": {
       "version": "4.3.4",
       "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.4.tgz",
@@ -1922,21 +1931,6 @@
         "punycode": "^2.1.0"
       }
     },
-    "node_modules/which": {
-      "version": "2.0.2",
-      "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz",
-      "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==",
-      "dev": true,
-      "dependencies": {
-        "isexe": "^2.0.0"
-      },
-      "bin": {
-        "node-which": "bin/node-which"
-      },
-      "engines": {
-        "node": ">= 8"
-      }
-    },
     "node_modules/which-boxed-primitive": {
       "version": "1.0.2",
       "resolved": "https://registry.npmjs.org/which-boxed-primitive/-/which-boxed-primitive-1.0.2.tgz",
@@ -2188,11 +2182,6 @@
       "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==",
       "dev": true
     },
-    "command-exists": {
-      "version": "1.2.9",
-      "resolved": "https://registry.npmjs.org/command-exists/-/command-exists-1.2.9.tgz",
-      "integrity": "sha512-LTQ/SGc+s0Xc0Fu5WaKnR0YiygZkm9eKFvyS+fRsU7/ZWFF8ykFM6Pc9aCVf1+xasOOZpO3BAVgVrKvsqKHV7w=="
-    },
     "concat-map": {
       "version": "0.0.1",
       "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz",
@@ -2214,6 +2203,17 @@
         "path-key": "^3.1.0",
         "shebang-command": "^2.0.0",
         "which": "^2.0.1"
+      },
+      "dependencies": {
+        "which": {
+          "version": "2.0.2",
+          "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz",
+          "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==",
+          "dev": true,
+          "requires": {
+            "isexe": "^2.0.0"
+          }
+        }
       }
     },
     "debug": {
@@ -3359,15 +3359,6 @@
         "punycode": "^2.1.0"
       }
     },
-    "which": {
-      "version": "2.0.2",
-      "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz",
-      "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==",
-      "dev": true,
-      "requires": {
-        "isexe": "^2.0.0"
-      }
-    },
     "which-boxed-primitive": {
       "version": "1.0.2",
       "resolved": "https://registry.npmjs.org/which-boxed-primitive/-/which-boxed-primitive-1.0.2.tgz",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@draganfilipovic/ssh-deploy",
-  "version": "3.1.0",
+  "version": "4.0.2",
   "description": "Fast NodeJS action to deploy specific directory from `GITHUB_WORKSPACE` to a server via rsync over ssh.",
   "main": "dist/index.js",
   "files": [
@@ -30,7 +30,6 @@
   },
   "homepage": "https://github.com/easingthemes/ssh-deploy#readme",
   "dependencies": {
-    "command-exists": "^1.2.9",
     "rsyncwrapper": "^3.0.1"
   },
   "devDependencies": {

src/helpers.js

@@ -1,38 +1,71 @@
 const { existsSync, mkdirSync, writeFileSync } = require('fs');
-
+const { join } = require('path');
-const {
-  GITHUB_WORKSPACE
-} = process.env;
 
 const validateDir = (dir) => {
-  if (!existsSync(dir)) {
+  if (!dir) {
-    console.log(`[SSH] Creating ${dir} dir in `, GITHUB_WORKSPACE);
+    console.warn('⚠️ [DIR] dir is not defined');
+    return;
+  }
+  if (existsSync(dir)) {
+    console.log(`✅ [DIR] ${dir} dir exist`);
+    return;
+  }
+
+  console.log(`[DIR] Creating ${dir} dir in workspace root`);
   mkdirSync(dir);
-    console.log('✅ [SSH] dir created.');
+  console.log('✅ [DIR] dir created.');
-  } else {
+};
-    console.log(`[SSH] ${dir} dir exist`);
+
+const handleError = (message, isRequired) => {
+  if (isRequired) {
+    throw new Error(message);
+  }
+  console.warn(message);
+};
+
+const writeToFile = ({ dir, filename, content, isRequired, mode = '0644' }) => {
+  validateDir(dir);
+  const filePath = join(dir, filename);
+
+  if (existsSync(filePath)) {
+    const message = `⚠️ [FILE] ${filePath} Required file exist.`;
+    handleError(message, isRequired);
+    return;
+  }
+
+  try {
+    console.log(`[FILE] writing ${filePath} file ...`, content.length);
+    writeFileSync(filePath, content, {
+      encoding: 'utf8',
+      mode
+    });
+  } catch (error) {
+    const message = `⚠️[FILE] Writing to file error. filePath: ${filePath}, message:  ${error.message}`;
+    handleError(message, isRequired);
   }
 };
 
-const validateFile = (filePath) => {
+const validateRequiredInputs = (inputs) => {
-  if (!existsSync(filePath)) {
+  const inputKeys = Object.keys(inputs);
-    console.log(`[SSH] Creating ${filePath} file in `, GITHUB_WORKSPACE);
+  const validInputs = inputKeys.filter((inputKey) => {
-    try {
+    const inputValue = inputs[inputKey];
-      writeFileSync(filePath, '', {
+
-        encoding: 'utf8',
+    if (!inputValue) {
-        mode: 0o600
+      console.error(`❌ [INPUTS] ${inputKey} is mandatory`);
-      });
-      console.log('✅ [SSH] file created.');
-    } catch (e) {
-      console.error('⚠️ [SSH] writeFileSync error', filePath, e.message);
-      process.abort();
     }
-  } else {
+
-    console.log(`[SSH] ${filePath} file exist`);
+    return inputValue;
+  });
+
+  if (validInputs.length !== inputKeys.length) {
+    throw new Error('⚠️ [INPUTS] Inputs not valid, aborting ...');
   }
 };
 
+const snakeToCamel = (str) => str.replace(/[^a-zA-Z0-9]+(.)/g, (m, chr) => chr.toUpperCase());
+
 module.exports = {
-  validateDir,
+  writeToFile,
-  validateFile
+  validateRequiredInputs,
+  snakeToCamel
 };

src/index.js

@@ -1,79 +1,47 @@
 #!/usr/bin/env node
-const nodeRsync = require('rsyncwrapper');
+const { sshDeploy } = require('./rsyncCli');
+const { remoteCmdBefore, remoteCmdAfter } = require('./remoteCmd');
+const { addSshKey, getPrivateKeyPath, updateKnownHosts } = require('./sshKey');
+const { validateRequiredInputs } = require('./helpers');
+const inputs = require('./inputs');
 
-const { validateRsync, validateInputs } = require('./rsyncCli');
+const run = async () => {
-const { addSshKey } = require('./sshKey');
+  const {
-
+    source, remoteUser, remoteHost, remotePort,
-const {
+    deployKeyName, sshPrivateKey,
-  REMOTE_HOST, REMOTE_USER,
+    args, exclude, sshCmdArgs,
-  REMOTE_PORT, SSH_PRIVATE_KEY, DEPLOY_KEY_NAME,
+    scriptBefore, scriptAfter,
-  SOURCE, TARGET, ARGS, EXCLUDE,
+    rsyncServer
-  GITHUB_WORKSPACE
+  } = inputs;
-} = require('./inputs');
+  // Validate required inputs
-
+  validateRequiredInputs({ sshPrivateKey, remoteHost, remoteUser });
-const defaultOptions = {
+  // Add SSH key
-  ssh: true,
+  addSshKey(sshPrivateKey, deployKeyName);
-  sshCmdArgs: ['-o StrictHostKeyChecking=no'],
+  const { path: privateKeyPath } = getPrivateKeyPath(deployKeyName);
-  recursive: true
+  // Update known hosts if ssh command is present to avoid prompt
+  if (scriptBefore || scriptAfter) {
+    updateKnownHosts(remoteHost);
+  }
+  // Check Script before
+  if (scriptBefore) {
+    await remoteCmdBefore(scriptBefore, privateKeyPath);
+  }
+  /* eslint-disable object-property-newline */
+  await sshDeploy({
+    source, rsyncServer, exclude, remotePort,
+    privateKeyPath, args, sshCmdArgs
+  });
+  // Check script after
+  if (scriptAfter) {
+    await remoteCmdAfter(scriptAfter, privateKeyPath);
+  }
 };
 
-console.log('GITHUB_WORKSPACE: ', GITHUB_WORKSPACE);
+run()
-console.log('REMOTE_HOST: ', process.env.REMOTE_HOST);
+  .then((data = '') => {
-console.log('REMOTE_USER: ', process.env.REMOTE_USER);
+    console.log('✅ [DONE]', data);
-
+  })
-const sshDeploy = (() => {
+  .catch((error) => {
-  const rsync = ({ privateKey, port, src, dest, args, exclude }) => {
+    console.error('❌ [ERROR]', error.message);
-    console.log(`[Rsync] Starting Rsync Action: ${src} to ${dest}`);
+    process.exit(1);
-    if (exclude) console.log(`[Rsync] exluding folders ${exclude}`);
-
-    try {
-      // RSYNC COMMAND
-      nodeRsync({
-        src, dest, args, privateKey, port, excludeFirst: exclude, ...defaultOptions
-      }, (error, stdout, stderr, cmd) => {
-        if (error) {
-          console.error('⚠️ [Rsync] error: ', error.message);
-          console.log('⚠️ [Rsync] stderr: ', stderr);
-          console.log('⚠️ [Rsync] stdout: ', stdout);
-          console.log('⚠️ [Rsync] cmd: ', cmd);
-          process.abort();
-        } else {
-          console.log('✅ [Rsync] finished.', stdout);
-        }
   });
-    } catch (err) {
-      console.error('⚠️ [Rsync] command error: ', err.message, err.stack);
-      process.abort();
-    }
-  };
-
-  const init = ({ src, dest, args, host = 'localhost', port, username, privateKeyContent, exclude = [] }) => {
-    validateRsync(() => {
-      const privateKey = addSshKey(privateKeyContent, DEPLOY_KEY_NAME || 'deploy_key');
-      const remoteDest = `${username}@${host}:${dest}`;
-
-      rsync({ privateKey, port, src, dest: remoteDest, args, exclude });
-    });
-  };
-
-  return {
-    init
-  };
-})();
-
-const run = () => {
-  validateInputs({ SSH_PRIVATE_KEY, REMOTE_HOST, REMOTE_USER });
-
-  sshDeploy.init({
-    src: `${GITHUB_WORKSPACE}/${SOURCE || ''}`,
-    dest: TARGET || `/home/${REMOTE_USER}/`,
-    args: ARGS ? [ARGS] : ['-rltgoDzvO'],
-    host: REMOTE_HOST,
-    port: REMOTE_PORT || '22',
-    username: REMOTE_USER,
-    privateKeyContent: SSH_PRIVATE_KEY,
-    exclude: (EXCLUDE || '').split(',').map((item) => item.trim()) // split by comma and trim whitespace
-  });
-};
-
-run();

src/inputs.js

@@ -1,11 +1,50 @@
-const inputNames = ['REMOTE_HOST', 'REMOTE_USER', 'REMOTE_PORT', 'SSH_PRIVATE_KEY', 'DEPLOY_KEY_NAME', 'SOURCE', 'TARGET', 'ARGS', 'EXCLUDE'];
+const { snakeToCamel } = require('./helpers');
+
+const inputNames = [
+  'REMOTE_HOST', 'REMOTE_USER', 'REMOTE_PORT',
+  'SSH_PRIVATE_KEY', 'DEPLOY_KEY_NAME',
+  'SOURCE', 'TARGET', 'ARGS', 'SSH_CMD_ARGS', 'EXCLUDE',
+  'SCRIPT_BEFORE', 'SCRIPT_AFTER'];
+
+const githubWorkspace = process.env.GITHUB_WORKSPACE;
+const remoteUser = process.env.REMOTE_USER;
+
+const defaultInputs = {
+  source: '',
+  target: `/home/${remoteUser}/`,
+  exclude: '',
+  args: '-rlgoDzvc -i',
+  sshCmdArgs: '-o StrictHostKeyChecking=no',
+  deployKeyName: `deploy_key_${remoteUser}_${Date.now()}`
+};
 
 const inputs = {
-  GITHUB_WORKSPACE: process.env.GITHUB_WORKSPACE
+  githubWorkspace
 };
 
 inputNames.forEach((input) => {
-  inputs[input] = process.env[input] || process.env[`INPUT_${input}`];
+  const inputName = snakeToCamel(input.toLowerCase());
+  const inputVal = process.env[input] || process.env[`INPUT_${input}`];
+  const validVal = inputVal === undefined ? defaultInputs[inputName] : inputVal;
+  let extendedVal = validVal;
+  // eslint-disable-next-line default-case
+  switch (inputName) {
+    case 'source':
+      extendedVal = validVal.split(' ').map((src) => `${githubWorkspace}/${src}`);
+      break;
+    case 'args':
+      extendedVal = validVal.split(' ');
+      break;
+    case 'exclude':
+    case 'sshCmdArgs':
+      extendedVal = validVal.split(',').map((item) => item.trim());
+      break;
+  }
+
+  inputs[inputName] = extendedVal;
 });
 
+inputs.sshServer = `${inputs.remoteUser}@${inputs.remoteHost}`;
+inputs.rsyncServer = `${inputs.remoteUser}@${inputs.remoteHost}:${inputs.target}`;
+
 module.exports = inputs;

src/remoteCmd.js

@@ -0,0 +1,40 @@
+const { exec } = require('child_process');
+const { sshServer, githubWorkspace } = require('./inputs');
+const { writeToFile } = require('./helpers');
+
+const handleError = (message, isRequired, callback) => {
+  if (isRequired) {
+    callback(new Error(message));
+  } else {
+    console.warn(message);
+  }
+};
+
+// eslint-disable-next-line max-len
+const remoteCmd = async (content, privateKeyPath, isRequired, label) => new Promise((resolve, reject) => {
+  const filename = `local_ssh_script-${label}.sh`;
+  try {
+    writeToFile({ dir: githubWorkspace, filename, content });
+    console.log(`Executing remote script: ssh -i ${privateKeyPath} ${sshServer}`);
+    exec(
+      `DEBIAN_FRONTEND=noninteractive ssh -i ${privateKeyPath} -o StrictHostKeyChecking=no ${sshServer} 'RSYNC_STDOUT="${process.env.RSYNC_STDOUT}" bash -s' < ${filename}`,
+      (err, data, stderr) => {
+        if (err) {
+          const message = `⚠️ [CMD] Remote script failed: ${err.message}`;
+          console.warn(`${message} \n`, data, stderr);
+          handleError(message, isRequired, reject);
+        } else {
+          console.log('✅ [CMD] Remote script executed. \n', data, stderr);
+          resolve(data);
+        }
+      }
+    );
+  } catch (err) {
+    handleError(err.message, isRequired, reject);
+  }
+});
+
+module.exports = {
+  remoteCmdBefore: async (cmd, privateKeyPath, isRequired) => remoteCmd(cmd, privateKeyPath, isRequired, 'before'),
+  remoteCmdAfter: async (cmd, privateKeyPath, isRequired) => remoteCmd(cmd, privateKeyPath, isRequired, 'after')
+};

src/rsyncCli.js

@@ -1,46 +1,86 @@
-const { sync: commandExists } = require("command-exists");
+const { execSync } = require('child_process');
-const { exec, execSync } = require("child_process");
+const nodeRsync = require('rsyncwrapper');
 
-const validateRsync = (callback = () => {}) => {
+const nodeRsyncPromise = async (config) => new Promise((resolve, reject) => {
-  const rsyncCli = commandExists("rsync");
+  const logCMD = (cmd) => {
-  if (rsyncCli) {
+    console.warn('================================================================');
-    console.log('⚠️ [CLI] Rsync exists');
+    console.log(cmd);
-    const rsyncVersion = execSync("rsync --version", { stdio: 'inherit' });
+    console.warn('================================================================');
-    return callback();
+  };
-  }
 
-  console.log('⚠️ [CLI] Rsync doesn\'t exists. Start installation with "apt-get" \n');
+  try {
-
+    nodeRsync(config, (error, stdout, stderr, cmd) => {
-  exec("sudo apt-get update && sudo apt-get --no-install-recommends install rsync", (err, data, stderr) => {
+      if (error) {
-    if (err) {
+        console.error('❌ [Rsync] error: ');
-      console.log("⚠️ [CLI] Rsync installation failed. Aborting ... ", err.message);
+        console.error(error);
-      process.abort();
+        console.error('❌ [Rsync] stderr: ');
+        console.error(stderr);
+        console.error('❌️ [Rsync] stdout: ');
+        console.error(stdout);
+        console.error('❌ [Rsync] command: ');
+        logCMD(cmd);
+        reject(new Error(`${error.message}\n\n${stderr}`));
       } else {
-      console.log("✅ [CLI] Rsync installed. \n", data, stderr);
+        console.log('⭐ [Rsync] command finished: ');
-      callback();
+        logCMD(cmd);
+        resolve(stdout);
       }
     });
+  } catch (error) {
+    console.error('❌ [Rsync] command error: ', error.message, error.stack);
+    reject(error);
+  }
+});
+
+const validateRsync = async () => {
+  try {
+    execSync('rsync --version', { stdio: 'inherit' });
+    console.log('✅️ [CLI] Rsync exists');
+    return;
+  } catch (error) {
+    console.warn('⚠️ [CLI] Rsync doesn\'t exists', error.message);
+  }
+
+  console.log('[CLI] Start rsync installation with "apt-get" \n');
+  try {
+    execSync('sudo DEBIAN_FRONTEND=noninteractive apt-get -y update && sudo DEBIAN_FRONTEND=noninteractive apt-get --no-install-recommends -y install rsync', { stdio: 'inherit' });
+    console.log('✅ [CLI] Rsync installed. \n');
+  } catch (error) {
+    throw new Error(`⚠️ [CLI] Rsync installation failed. Aborting ... error: ${error.message}`);
+  }
+};
+
+const rsyncCli = async ({
+  source, rsyncServer, exclude, remotePort,
+  privateKeyPath, args, sshCmdArgs
+}) => {
+  console.log(`[Rsync] Starting Rsync Action: ${source} to ${rsyncServer}`);
+  if (exclude && exclude.length > 0) console.log(`[Rsync] excluding folders ${exclude}`);
+
+  const defaultOptions = {
+    ssh: true,
+    recursive: true,
+    onStdout: (data) => console.log(data.toString()),
+    onStderr: (data) => console.error(data.toString())
+  };
+
+  // RSYNC COMMAND
+  /* eslint-disable object-property-newline */
+  return nodeRsyncPromise({
+    ...defaultOptions,
+    src: source, dest: rsyncServer, excludeFirst: exclude, port: remotePort,
+    privateKey: privateKeyPath, args, sshCmdArgs
+  });
 };
 
-const validateInputs = (inputs) => {
+const sshDeploy = async (params) => {
-  const inputKeys = Object.keys(inputs);
+  await validateRsync();
-  const validInputs = inputKeys.filter((inputKey) => {
+  const stdout = await rsyncCli(params);
-    const inputValue = inputs[inputKey];
+  console.log('✅ [Rsync] finished.', stdout);
-
+  process.env.RSYNC_STDOUT = `${stdout}`;
-    if (!inputValue) {
+  return stdout;
-      console.error(`⚠️ [INPUTS] ${inputKey} is mandatory`);
-    }
-
-    return inputValue;
-  });
-
-  if (validInputs.length !== inputKeys.length) {
-    console.error("⚠️ [INPUTS] Inputs not valid, aborting ...");
-    process.abort();
-  }
 };
 
 module.exports = {
-  validateRsync,
+  sshDeploy
-  validateInputs,
 };

src/sshKey.js

@@ -1,37 +1,43 @@
-const { writeFileSync } = require('fs');
 const { join } = require('path');
+const { execSync } = require('child_process');
+const { writeToFile } = require('./helpers');
 
-const {
+const KNOWN_HOSTS = 'known_hosts';
-  validateDir,
+const getPrivateKeyPath = (filename = '') => {
-  validateFile
+  const { HOME } = process.env;
-} = require('./helpers');
+  const dir = join(HOME || '~', '.ssh');
+  const knownHostsPath = join(dir, KNOWN_HOSTS);
+  return {
+    dir,
+    filename,
+    path: join(dir, filename),
+    knownHostsPath
+  };
+};
 
-const {
+const addSshKey = (content, deployKeyName) => {
-  HOME
+  const { dir, filename } = getPrivateKeyPath(deployKeyName);
-} = process.env;
+  writeToFile({ dir, filename: KNOWN_HOSTS, content: '' });
-
+  console.log('✅ [SSH] known_hosts file ensured', dir);
-const addSshKey = (key, name) => {
+  writeToFile({ dir, filename, content, isRequired: true, mode: '0400' });
-  const sshDir = join(HOME || __dirname, '.ssh');
+  console.log('✅ [SSH] key added to `.ssh` dir ', dir, filename);
-  const filePath = join(sshDir, name);
+};
-
-  validateDir(sshDir);
-  validateFile(`${sshDir}/known_hosts`);
 
+const updateKnownHosts = (host) => {
+  const { knownHostsPath } = getPrivateKeyPath();
+  console.log('[SSH] Adding host to `known_hosts` ....', host, knownHostsPath);
   try {
-    writeFileSync(filePath, key, {
+    execSync(`ssh-keyscan -H ${host}  >> ${knownHostsPath}`, {
-      encoding: 'utf8',
+      stdio: 'inherit'
-      mode: 0o600
     });
-  } catch (e) {
+  } catch (error) {
-    console.error('⚠️ writeFileSync error', filePath, e.message);
+    console.error('❌ [SSH] Adding host to `known_hosts` ERROR', host, error.message);
-    process.abort();
   }
-
+  console.log('✅ [SSH] Adding host to `known_hosts` DONE', host, knownHostsPath);
-  console.log('✅ Ssh key added to `.ssh` dir ', filePath);
-
-  return filePath;
 };
 
 module.exports = {
+  getPrivateKeyPath,
+  updateKnownHosts,
   addSshKey
-}
+};

src/test.js

@@ -1,13 +0,0 @@
-console.log('||||||||||||||||||||||||||||||||||||||');
-console.log('EXAMPLE_REMOTE_HOST: ', process.env.EXAMPLE_REMOTE_HOST);
-console.log('EXAMPLE_REMOTE_USER: ', process.env.EXAMPLE_REMOTE_USER);
-console.log('EXAMPLE_SSH_PRIVATE_KEY: ', process.env.EXAMPLE_SSH_PRIVATE_KEY);
-console.log('||||||||||||||||||||||||||||||||||||||');
-console.log('EXAMPLE_REMOTE_HOST1: ', process.env.EXAMPLE_REMOTE_HOST1);
-console.log('EXAMPLE_REMOTE_USER1: ', process.env.EXAMPLE_REMOTE_USER1);
-console.log('EXAMPLE_SSH_PRIVATE_KEY1: ', process.env.EXAMPLE_SSH_PRIVATE_KEY1);
-console.log('||||||||||||||||||||||||||||||||||||||');
-console.log('REMOTE_USER: ', process.env.REMOTE_USER);
-console.log('REMOTE_HOST: ', process.env.REMOTE_HOST);
-console.log('SSH_PRIVATE_KEY: ', process.env.SSH_PRIVATE_KEY);
-console.log('||||||||||||||||||||||||||||||||||||||');

test/Dockerfile

@@ -6,23 +6,32 @@ RUN apt update
 
 RUN apt install openssh-server rsync sudo -y
 
-RUN useradd -rm -d /home/test -s /bin/bash -g root -G sudo -u 1000 test
-
-RUN usermod -aG sudo test
-
 RUN echo "PubkeyAuthentication yes" >> /etc/ssh/sshd_config.d/pub.conf
 RUN echo "AuthorizedKeysFile  .ssh/authorized_keys" >> /etc/ssh/sshd_config.d/pub.conf
 
 RUN mkdir -p /var/www/html
-RUN chown -R test /var/www/html
+RUN mkdir -p /var/www/html/test
+RUN mkdir -p /var/www/html/test2
+RUN chmod -R 775 /var/www/html
+
+RUN useradd -rm -d /home/test -s /bin/bash -g root -G sudo -u 1000 test
+RUN usermod -aG sudo test
 RUN mkdir -p /home/test/.ssh
 RUN echo "$SSH_PUB_KEY" > /home/test/.ssh/authorized_keys
 RUN chmod 700 /home/test/.ssh
 RUN chown -R test /home/test/.ssh
 
+RUN useradd -rm -d /home/test2 -s /bin/bash -g root -G sudo -u 1002 test2
+RUN usermod -aG sudo test2
+RUN mkdir -p /home/test2/.ssh
+RUN echo "$SSH_PUB_KEY" > /home/test2/.ssh/authorized_keys
+RUN chmod 700 /home/test2/.ssh
+RUN chown -R test2 /home/test2/.ssh
+
 RUN service ssh start
 
 RUN  echo 'test:test' | chpasswd
+RUN  echo 'test2:test2' | chpasswd
 
 EXPOSE 22