chore: Refactor login/logout actions

internal/fod-login/action.yml

@@ -1,30 +1,19 @@
 name: 'Run "fcli fod session login" command'
-description: 'Run "fcli fod session login" command based on environment variables'
+description: 'Run "fcli fod session login" command based on environment variables, auto-logout on job termination'
 author: 'Fortify'
 runs:
   using: composite
   steps:
-    # Define login options
-    - run: |
-        if [ -z "$FOD_URL" ]; then
-          echo "ERROR: FOD_URL environment variable must be set"; exit 1;
-        fi
-        if [ -n "${FOD_CLIENT_ID}" -a -n "${FOD_CLIENT_SECRET}" ]; then
-          echo '_FOD_LOGIN_OPTS=--url "${FOD_URL}" --client-id "${FOD_CLIENT_ID}" --client-secret "${FOD_CLIENT_SECRET}" ${EXTRA_FOD_LOGIN_OPTS}' >> $GITHUB_ENV
-        elif [ -n "${FOD_USER}" -a -n "${FOD_PASSWORD}" -a -n "${FOD_TENANT}" ]; then
-          echo '_FOD_LOGIN_OPTS=--url "${FOD_URL}" -t "${FOD_TENANT}" -u "${FOD_USER}" -p "${FOD_PASSWORD}" ${EXTRA_FOD_LOGIN_OPTS}' >> $GITHUB_ENV
-        else
-          echo "ERROR: Either FOD_CLIENT_ID and FOD_CLIENT_SECRET, or FOD_TENANT, FOD_USER and FOD_PASSWORD environment variables must be set"; exit 1;
-        fi
-      shell: bash
-    # Run fcli login command; note that the calling action/workflow is responsible for installing fcli
-    - uses: fortify/github-action/internal/[email protected]
+    # If not run before: check preconditions, run fcli login command, and run 
+    # post-job fcli logout command.
+    # Note that the calling action/workflow is responsible for installing fcli
+    - uses: fortify/github-action/internal/[email protected]
+      if: ${{ !env._FOD_LOGGED_IN }}
       with:
-        cmd: '"${FCLI_CMD}" fod session login ${_FOD_LOGIN_OPTS}'  
-    # Clean up temporary environment variables
-    - run: |
-        echo '_FOD_LOGIN_OPTS=""' >> $GITHUB_ENV
-      shell: bash      
+        cwd: ${{ github.action_path }}
+        script: ./fod-login.sh
+        post: ./fod-logout.sh
+
 branding:
   icon: 'shield'
   color: 'blue'

internal/fod-login/fod-login.sh

@@ -0,0 +1,25 @@
+#!/bin/bash
+
+### Start common code
+if [ -n "$RUNNER_DEBUG" ]; then
+  set -v -x
+fi
+if [ -z "$FCLI_CMD" ]; then
+  echo "ERROR: fortify/github-action/setup must be run to set up fcli before running this action"
+  exit 1;
+fi
+### End common code
+
+if [ -z "$FOD_URL" ]; then
+  echo "ERROR: FOD_URL environment variable must be set"; exit 1;
+fi
+if [ -n "${FOD_CLIENT_ID}" -a -n "${FOD_CLIENT_SECRET}" ]; then
+  _FOD_AUTH_OPTS=("--client-id" "${FOD_CLIENT_ID}" "--client-secret" "${FOD_CLIENT_SECRET}")
+elif [ -n "${FOD_USER}" -a -n "${FOD_PASSWORD}" -a -n "${FOD_TENANT}" ]; then
+  _FOD_AUTH_OPTS=("-t" "${FOD_TENANT}" "-u" "${FOD_USER}" "-p" "${FOD_PASSWORD}")
+else
+  echo "ERROR: Either FOD_CLIENT_ID and FOD_CLIENT_SECRET, or FOD_TENANT, FOD_USER and FOD_PASSWORD environment variables must be set"
+  exit 1;
+fi
+${FCLI_CMD} fod session login --url "${FOD_URL}" "${_FOD_AUTH_OPTS[@]}" ${EXTRA_FOD_LOGIN_OPTS} || exit 1
+echo '_FOD_LOGGED_IN=true' >> $GITHUB_ENV 

internal/fod-login/fod-logout.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+### Start common code
+if [ -n "$RUNNER_DEBUG" ]; then
+  set -v -x
+fi
+if [ -z "$FCLI_CMD" ]; then
+  echo "ERROR: fortify/github-action/setup must be run to set up fcli before running this action"
+  exit 1;
+fi
+### End common code
+
+if [[ "${_FOD_LOGGED_IN}" == "true" ]]; then
+  echo '_FOD_LOGGED_IN=false' >> $GITHUB_ENV
+  ${FCLI_CMD} fod session logout || exit 1
+fi

internal/run-script/action.yml

@@ -0,0 +1,23 @@
+name: Run a script with optional post-job cleanup
+
+description: 'Action to execute a bash script, optionally executing another script on job completion.'
+
+inputs:
+  script:
+    description: 'Script to run'
+    required: true
+  post:
+    description: 'Script to run on job completion'
+    required: false
+  cwd:
+    description: 'Script working directory'
+    required: false
+  key:
+    description: 'Name of the state variable used to detect the post step.'
+    required: false
+    default: POST
+
+runs:
+  using: 'node20'
+  main: 'main.js'
+  post: 'main.js'

internal/run-script/main.js

@@ -0,0 +1,22 @@
+const { spawn } = require("child_process");
+const { appendFileSync } = require("fs");
+const { EOL } = require("os");
+
+function run(script) {
+  if ( script ) {
+      const cwd = process.env.INPUT_CWD || process.cwd;
+      const subprocess = spawn(`bash -c -o pipefail -v ${script}`, { stdio: "inherit", shell: true,  cwd: cwd });
+      subprocess.on("exit", (exitCode) => {
+        process.exitCode = exitCode;
+      });
+  }
+}
+
+const key = process.env.INPUT_KEY.toUpperCase();
+
+if ( process.env[`STATE_${key}`] !== undefined ) { // Are we in the 'post' step?
+  run(process.env.INPUT_POST);
+} else { // Otherwise, this is the main step
+  appendFileSync(process.env.GITHUB_STATE, `${key}=true${EOL}`);
+  run(process.env.INPUT_SCRIPT);
+}

internal/sc-sast-login/action.yml

@@ -7,27 +7,17 @@ runs:
     # TODO If we wait for scan completion, potentially we could generate a CIToken if 
     #      SSC_USER and SSC_PASSWORD have been set, and then revoke the token once the
     #      scan has been successfully processed on SSC.
-    # Define login options
-    - run: |
-        if [ -z "$SSC_URL" ]; then
-          echo "ERROR: SSC_URL environment variable must be set"; exit 1;
-        fi
-        if [ -z "$SC_SAST_TOKEN" ]; then
-          echo "ERROR: SC_SAST_TOKEN environment variable must be set"; exit 1;
-        fi
-        if [ -z "SSC_TOKEN" ]; then
-          echo "ERROR: SSC_TOKEN environment variable must be set"; exit 1;
-        fi
-        echo '_SC_SAST_LOGIN_OPTS=--ssc-url "${SSC_URL}" -t "${SSC_TOKEN}" -c "${SC_SAST_TOKEN}" ${EXTRA_SC_SAST_LOGIN_OPTS}' >> $GITHUB_ENV
-      shell: bash
-    # Run fcli login command; note that the calling action/workflow is responsible for installing fcli
-    - uses: fortify/github-action/internal/[email protected]
+
+    # If not run before: check preconditions, run fcli login command, and run 
+    # post-job fcli logout command.
+    # Note that the calling action/workflow is responsible for installing fcli
+    - uses: fortify/github-action/internal/[email protected]
+      if: ${{ !env._SC_SAST_LOGGED_IN }}
       with:
-        cmd: '"${FCLI_CMD}" sc-sast session login ${_SC_SAST_LOGIN_OPTS}' 
-    # Clean up temporary environment variables
-    - run: |
-        echo '_SC_SAST_LOGIN_OPTS=""' >> $GITHUB_ENV
-      shell: bash              
+        cwd: ${{ github.action_path }}
+        script: ./sc-sast-login.sh
+        post: ./sc-sast-logout.sh
+
 branding:
   icon: 'shield'
   color: 'blue'

internal/sc-sast-login/sc-sast-login.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+### Start common code
+if [ -n "$RUNNER_DEBUG" ]; then
+  set -v -x
+fi
+if [ -z "$FCLI_CMD" ]; then
+  echo "ERROR: fortify/github-action/setup must be run to set up fcli before running this action"
+  exit 1;
+fi
+### End common code
+
+if [ -z "$SSC_URL" ]; then
+  echo "ERROR: SSC_URL environment variable must be set"; exit 1;
+fi
+if [ -z "$SC_SAST_TOKEN" ]; then
+  echo "ERROR: SC_SAST_TOKEN environment variable must be set"; exit 1;
+fi
+if [ -z "SSC_TOKEN" ]; then
+  echo "ERROR: SSC_TOKEN environment variable must be set"; exit 1;
+fi
+${FCLI_CMD} sc-sast session login --ssc-url "${SSC_URL}" -t "${SSC_TOKEN}" -c "${SC_SAST_TOKEN}" ${EXTRA_SC_SAST_LOGIN_OPTS}
+echo '_SC_SAST_LOGGED_IN=true' >> $GITHUB_ENV 

internal/sc-sast-login/sc-sast-logout.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+### Start common code
+if [ -n "$RUNNER_DEBUG" ]; then
+  set -v -x
+fi
+if [ -z "$FCLI_CMD" ]; then
+  echo "ERROR: fortify/github-action/setup must be run to set up fcli before running this action"
+  exit 1;
+fi
+### End common code
+
+if [[ "${_SC_SAST_LOGGED_IN}" == "true" ]]; then
+  echo '_SC_SAST_LOGGED_IN=false' >> $GITHUB_ENV
+  ${FCLI_CMD} sc-sast session logout --no-revoke-token || exit 1
+fi

internal/ssc-login/action.yml

@@ -4,27 +4,15 @@ author: 'Fortify'
 runs:
   using: composite
   steps:
-    # Define login options
-    - run: |
-        if [ -z "$SSC_URL" ]; then
-          echo "ERROR: SSC_URL environment variable must be set"; exit 1;
-        fi
-        if [ -n "${SSC_TOKEN}" ]; then
-          echo '_SSC_LOGIN_OPTS=--url "${SSC_URL}" --token "${SSC_TOKEN}" ${EXTRA_SSC_LOGIN_OPTS}' >> $GITHUB_ENV
-        elif [ -n "${SSC_USER}" -a -n "${SSC_PASSWORD}" ]; then
-          echo '_SSC_LOGIN_OPTS=--url "${SSC_URL}" -u "${SSC_USER}" -p "${SSC_PASSWORD}" ${EXTRA_SSC_LOGIN_OPTS}' >> $GITHUB_ENV
-        else
-          echo "ERROR: Either SSC_TOKEN, or SSC_USER and SSC_PASSWORD environment variables must be set"; exit 1;
-        fi
-      shell: bash
-    # Run fcli login command; note that the calling action/workflow is responsible for installing fcli
-    - uses: fortify/github-action/internal/[email protected]
+    # If not run before: check preconditions, run fcli login command, and run 
+    # post-job fcli logout command.
+    # Note that the calling action/workflow is responsible for installing fcli
+    - uses: fortify/github-action/internal/[email protected]
+      if: ${{ !env._SSC_LOGGED_IN }}
       with:
-        cmd: '"${FCLI_CMD}" ssc session login ${_SSC_LOGIN_OPTS}'   
-    # Clean up temporary environment variables
-    - run: |
-        echo '_SSC_LOGIN_OPTS=""' >> $GITHUB_ENV
-      shell: bash       
+        cwd: ${{ github.action_path }}
+        script: ./ssc-login.sh
+        post: ./ssc-logout.sh
 branding:
   icon: 'shield'
   color: 'blue'

internal/ssc-login/ssc-login.sh

@@ -0,0 +1,24 @@
+#!/bin/bash
+
+### Start common code
+if [ -n "$RUNNER_DEBUG" ]; then
+  set -v -x
+fi
+if [ -z "$FCLI_CMD" ]; then
+  echo "ERROR: fortify/github-action/setup must be run to set up fcli before running this action"
+  exit 1;
+fi
+### End common code
+
+if [ -z "$SSC_URL" ]; then
+  echo "ERROR: SSC_URL environment variable must be set"; exit 1;
+fi
+if [ -n "${SSC_TOKEN}" ]; then
+  _SSC_AUTH_OPTS=("--token" "${SSC_TOKEN}")
+elif [ -n "${SSC_USER}" -a -n "${SSC_PASSWORD}" ]; then
+  _SSC_AUTH_OPTS=("-u" "${SSC_USER}" "-p" "${SSC_PASSWORD}")
+else
+  echo "ERROR: Either SSC_TOKEN, or SSC_USER and SSC_PASSWORD environment variables must be set"; exit 1;
+fi
+${FCLI_CMD} ssc session login --url "${SSC_URL}" "${_SSC_AUTH_OPTS[@]}" ${EXTRA_SSC_LOGIN_OPTS}
+echo '_SSC_LOGGED_IN=true' >> $GITHUB_ENV 

internal/ssc-login/ssc-logout.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+### Start common code
+if [ -n "$RUNNER_DEBUG" ]; then
+  set -v -x
+fi
+if [ -z "$FCLI_CMD" ]; then
+  echo "ERROR: fortify/github-action/setup must be run to set up fcli before running this action"
+  exit 1;
+fi
+### End common code
+
+if [[ "${_SSC_LOGGED_IN}" == "true" ]]; then
+  echo '_SSC_LOGGED_IN=false' >> $GITHUB_ENV
+  if [ -n "${SSC_TOKEN}" ]; then
+    _SSC_LOGOUT_OPTS=("--no-revoke-token")
+  elif [ -n "${SSC_USER}" -a -n "${SSC_PASSWORD}" ]; then
+    _SSC_LOGOUT_OPTS=("-u" "${SSC_USER}" "-p" "${SSC_PASSWORD}")
+  else
+    echo "ERROR: Either SSC_TOKEN, or SSC_USER and SSC_PASSWORD environment variables must be set"; exit 1;
+  fi
+  ${FCLI_CMD} ssc session logout "${_SSC_LOGOUT_OPTS[@]}" || exit 1
+fi