Create random sock file if none passed (#42)

* SIP-388 feat: make socket-path optional with rand temp file as default

* SIP-388 fix: include default in yml

* SIP-388 refactor: use "-u" to unlink temp file prior to ssh-agent

* SIP-388 docs: adjust readme to hint at optional property

* SIP-388 build: test itself during ci pipeline

* SIP-388 fix: end action on error

* SIP-388 build: adjust ci for a new specific socket file

* SIP-388 fix: error handling for file path generation

* SIP-388 refactor: move console log after socketPath set

* SIP-388 fix: properly set socketPath

* SIP-388 fix: trim newlines away

---------

Co-authored-by: Connor Tumbleson <[email protected]>

Author: jyann

.github/workflows/ci.yml

@@ -18,3 +18,24 @@ jobs:
       - run: yarn install
 
       - run: yarn build
+
+      - name: Test Itself (Random Socket)
+        id: ssh-socket-action-random
+        uses: ./
+        with:
+          host: github.com
+          key: ${{ secrets.BASE64_INTENTIONAL_EXAMPLE_PUBLIC_SECRET_KEY }}
+
+      - name: Use SSH socket (Random Socket)
+        run: ls -l "${{ steps.ssh-socket-action-random.outputs.socket-path }}"
+
+      - name: Test Itself (Specified Socket)
+        id: ssh-socket-action-specified
+        uses: ./
+        with:
+          host: github.com
+          socket-path: '/tmp/ssh_agent.sock'
+          key: ${{ secrets.BASE64_INTENTIONAL_EXAMPLE_PUBLIC_SECRET_KEY }}
+
+      - name: Use SSH socket (Specified Socket)
+        run: ls -l "${{ steps.ssh-socket-action-specified.outputs.socket-path }}"

README.md

@@ -10,7 +10,7 @@ Following inputs can be used as `step.with` keys
 |---------------|----------|--------|------------------------------------|
 | `host`        | Yes      | String | Remote hostname.                   |
 | `port`        | No       | Number | SSH Port (default: `22`).          |
-| `socket-path` | Yes      | String | Path at which to create socket.    |
+| `socket-path` | No       | String | Path at which to create socket.    |
 | `key`         | Yes      | String | base64 private key                 |
 | `lifetime`    | No       | Number | Seconds to keep key (default: 600) |
 
@@ -32,11 +32,11 @@ Store that in GitHub Secrets to securely pass to the action.
 ```yaml
 - name: SSH Socket Setup
   id: ssh-socket-action
-  uses: sourcetoad/ssh-socket-action@v1.0.0
+  uses: sourcetoad/ssh-socket-action@v1
   with:
       host: github.com
       port: 22 # optional
-      socket-path: /tmp/ssh_agent.sock
+      socket-path: /tmp/ssh_agent.sock # optional
       key: ${{ secrets.BASE64_SECRET_KEY }}
 
 - name: Use SSH socket

action.yml

@@ -14,7 +14,8 @@ inputs:
     required: false
   socket-path:
     description: 'path at which to create socket'
-    required: true
+    required: false
+    default: ''
   key:
     description: 'ssh private key'
     required: true

index.js

@@ -4,9 +4,19 @@ const { execSync } = require('child_process');
 
 const host = core.getInput('host');
 const port = core.getInput('port');
-const socketPath = core.getInput('socket-path');
 const key = core.getInput('key');
 const lifetimeInSeconds = core.getInput('lifetime');
+let socketPath = core.getInput('socket-path');
+
+// Create random socket path, if none passed.
+if (!socketPath) {
+    try {
+        socketPath = execSync('mktemp -u', {encoding: 'utf-8'}).trim();
+    } catch (e) {
+        core.setFailed(e.message);
+        process.exit(1);
+    }
+}
 
 console.log(`Attempting to create ${socketPath}...`);
 
@@ -24,6 +34,7 @@ try {
         core.info('Agent already exists on sock. Skipping creation.');
     } else {
         core.setFailed(e.message);
+        process.exit(1);
     }
 }