feat(ssh): support SSH-based command execution (#124)

.editorconfig

@@ -0,0 +1,30 @@
+# http://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{py,rst,ini}]
+indent_style = space
+indent_size = 4
+
+[*.{html,css,scss,json,yml,xml}]
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false
+
+[default.conf]
+indent_style = space
+indent_size = 2
+
+["Makefile"]
+indent_style = tab
+
+[*.{diff,patch}]
+trim_trailing_whitespace = false

.github/workflows/main.yaml

@@ -113,6 +113,22 @@ jobs:
       - name: Run unit tests
         run: makim tests.unittest
 
+      - name: Run smoke test for interactive args
+        run: makim smoke-tests.interactive-args
+
+      - name: Run smoke test for hooks (pre and post)
+        run: makim smoke-tests.run-hooks
+
+      - name: Run smoke test for matrix combinations
+        run: makim smoke-tests.matrix
+
+      - name: Run smoke test for shell app
+        run: makim smoke-tests.shell-app
+
+      - name: Run smoke test for ssh remote execution
+        if: ${{ matrix.os != 'macos' }}
+        run: makim smoke-tests.ssh-remote-execution
+
       - name: Semantic Release PR Title Check
         uses: osl-incubator/semantic-release-pr-title-check@v1.4.1
         if: success() || failure()

.makim.yaml

@@ -86,7 +86,8 @@ groups:
             - task: smoke-tests.interactive-args
             - task: smoke-tests.run-hooks
             - task: smoke-tests.matrix
-            - task: makim smoke-tests.shell-app
+            - task: smoke-tests.shell-app
+            - task: smoke-tests.ssh-remote-execution
 
       ci:
         help: Run all tasks used on CI
@@ -413,6 +414,22 @@ groups:
           makim $VERBOSE_FLAG --file $MAKIM_FILE test.browser
           makim $VERBOSE_FLAG --file $MAKIM_FILE test.browser --headless
 
+      ssh-remote-execution:
+        help: Test makim with remote execution
+        args:
+          verbose-mode:
+            help: Run the all the tests in verbose mode
+            type: bool
+            action: store_true
+        env:
+          MAKIM_FILE: tests/smoke/.makim-ssh.yaml
+        backend: bash
+        run: |
+          export VERBOSE_FLAG='${{ "--verbose" if args.verbose_mode else "" }}'
+          makim $VERBOSE_FLAG --file $MAKIM_FILE --help
+          makim $VERBOSE_FLAG --file $MAKIM_FILE --version
+          makim $VERBOSE_FLAG --file $MAKIM_FILE remote_test.echo_test
+
   error:
     help: This group helps tests failure tasks
     tasks:
@@ -458,4 +475,4 @@ groups:
         run: |
           # it requires the password manually
           ssh-keygen -R "[localhost]:2222" || true
-          ssh -o StrictHostKeyChecking=no testuser@localhost -p 2222
+          ssh -o StrictHostKeyChecking=no testuser@localhost -p 2222 'pwd'

pyproject.toml

@@ -38,6 +38,7 @@ python-levenshtein = ">=0.23.0"
 rich = ">=10.11.0"
 shellingham = ">=1.5.4"
 jsonschema = ">=4"
+paramiko = "^3.5.0"
 
 [tool.poetry.group.dev.dependencies]
 containers-sugar = ">=1.11.1"
@@ -60,6 +61,7 @@ jupyterlab = ">=4.1.5"
 nox = ">=2024.3.2"
 nbconvert = ">=7.16.3"
 pymdown-extensions = ">=10.7.1"
+types-paramiko = "^3.5.0.20240928"
 
 [build-system]
 requires = ["poetry-core>=1.0.0", "poetry>=1.5.1"]
@@ -118,7 +120,7 @@ quote-style = "single"
 [tool.bandit]
 exclude_dirs = ["tests"]
 targets = "src/makim/"
-skips = ["B102", "B701"]
+skips = ["B102", "B701", "B507", "B601"]
 
 [tool.vulture]
 exclude = ["tests"]