Add support for --fail-on-warnings

Author: brianwyka

.github/workflows/major-version-update.yml

@@ -0,0 +1,11 @@
+name: Major Version Update
+on:
+  release:
+    types: [ published ]
+jobs:
+  actions-tagger:
+    runs-on: windows-latest
+    steps:
+      - uses: Actions-R-Us/actions-tagger@v2
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -1,5 +1,3 @@
 .idea
 *.iml
-sourcehawk-scan-results.txt
-sourcehawk-scan-results.json
-sourcehawk-scan-results.md
+sourcehawk-scan-results.*

Dockerfile

@@ -1,15 +1,16 @@
+# Github Docs: https://docs.github.com/en/free-pro-team@latest/actions/creating-actions/dockerfile-support-for-github-actions
+
 # Small Linux based image with sourcehawk installed
-FROM optumopensource/sourcehawk:0.1.3-alpine
+FROM optumopensource/sourcehawk:0.1.5-alpine
 
 # Need root to write
 USER root
 
 # Repository gets mounted to this directory
 WORKDIR /github/workspace
 
-# Copy Entrypoint script into image and make sure its executable
+# Copy Entrypoint script into image
 COPY entrypoint.sh /entrypoint.sh
-RUN chmod +x /entrypoint.sh
 
 # Execute the entrypoint
 ENTRYPOINT ["/entrypoint.sh"]

README.md

@@ -36,6 +36,18 @@ The configuration file path
 
 **Default**: `sourcehawk-scan-results.txt`
 
+### `fail-on-warnings`
+
+Whether or not to fail the build on warnings
+
+**Default**: `false`
+
+### `fail-build`
+
+Whether or not to fail the build if the scan fails
+
+**Default**: `true`
+
 ## Outputs
 
 ### `scan-passed`
@@ -86,7 +98,7 @@ jobs:
         uses: actions/checkout@v2
       - name: Run Sourcehawk Scan
         id: sourcehawk
-        uses: pptum/sourcehawk-scan-github-action@v1
+        uses: optum/sourcehawk-scan-github-action@v1
         with:
           output-format: JSON
           output-file: sourcehawk-scan-results.json

action.yml

@@ -1,5 +1,8 @@
 name: 'Sourcehawk Scan'
 description: 'Run a sourcehawk scan on the code base'
+branding:
+  icon: 'terminal'
+  color: 'blue'
 inputs:
   repository-root:
     description: 'Repository Root'
@@ -17,6 +20,10 @@ inputs:
     description: 'Output file to write results to'
     required: false
     default: 'sourcehawk-scan-results.txt'
+  fail-on-warnings:
+    description: 'Whether or not to fail the scan if only warnings found'
+    required: false
+    default: 'false'
   fail-build:
     description: 'Whether or not to fail the build on scan failure'
     required: false
@@ -32,5 +39,6 @@ runs:
     - ${{ inputs.config-file }}
     - ${{ inputs.output-format }}
     - ${{ inputs.output-file }}
+    - ${{ inputs.fail-on-warnings }}
     - ${{ inputs.fail-build }}
 

entrypoint.sh

@@ -20,12 +20,17 @@ REPOSITORY_ROOT=${1:-'.'}
 CONFIG_FILE=${2:-'sourcehawk.yml'}
 OUTPUT_FORMAT=${3:-TEXT}
 OUTPUT_FILE=${4:-'sourcehawk-scan-results.txt'}
-FAIL_BUILD=${5:-true}
+FAIL_ON_WARNINGS=${5:-false}
+FAIL_BUILD=${6:-true}
 
 PASSED=false
 
 # Run the scan and output the results
-sourcehawk scan --verbosity MEDIUM --config-file "$CONFIG_FILE" --output-format "$OUTPUT_FORMAT" "$REPOSITORY_ROOT" > "$OUTPUT_FILE"
+if [ "$FAIL_ON_WARNINGS" = "true" ]; then
+  sourcehawk scan --config-file "$CONFIG_FILE" --output-format "$OUTPUT_FORMAT" --fail-on-warnings "$REPOSITORY_ROOT" > "$OUTPUT_FILE"
+else
+  sourcehawk scan --config-file "$CONFIG_FILE" --output-format "$OUTPUT_FORMAT" "$REPOSITORY_ROOT" > "$OUTPUT_FILE"
+fi
 
 # Determine if scan passed
 if [ $? -eq 0 ]; then

test.sh

@@ -3,10 +3,39 @@
 set -e
 
 # Set up testing environment
-./tests/setup.sh
+ROOT=$(dirname "$(readlink -fm "$0")")
+TEST_IMAGE="sourcehawk-scan-github-action:test"
+docker build -t "$TEST_IMAGE" .
 
-# Execute tests
-./tests/scan-passed.sh
-./tests/scan-failed.sh
-./tests/scan-error.sh
-./tests/scan-custom.sh
+# Define Tests
+TESTS=( "scan-passed" "scan-failed" "scan-error" "scan-custom" "scan-warning" "scan-warning-fail" )
+
+PASSED=()
+FAILED=()
+
+echo "Running Tests"
+echo "----------------------------------------"
+
+# Execute Tests
+for test in "${TESTS[@]}"; do
+
+  echo "[TEST]: ${test}"
+  echo "----------------------------------------"
+
+  if ./tests/"${test}".sh "$ROOT" "$TEST_IMAGE"; then
+    echo " >> PASSED"
+    PASSED+=("${test}")
+  else
+    echo " >> [ERROR] FAILED"
+    FAILED+=("${test}")
+  fi
+  echo "----------------------------------------"
+
+done
+
+echo "Tests Completed"
+echo -n " >> Result: "
+[ ${#FAILED[@]} -gt 0 ] && echo "FAILURE " || echo "SUCCESS"
+echo " >> Tests: $((${#PASSED[@]}+${#FAILED[@]})), Passed: ${#PASSED[@]}, Failed: ${#FAILED[@]}"
+echo "----------------------------------------"
+exit ${#FAILED[@]}

tests/scan-custom.sh

@@ -1,36 +1,39 @@
 #!/usr/bin/env bash
 
-set -e
-
-echo "Running test: Scan Custom"
-echo "-------------------------"
-
-ROOT="$(dirname "$(dirname "$(readlink -fm "$0")")")"
-
-OUTPUT=$(docker run -v "$ROOT:/github/workspace" sourcehawk-scan-github-action:test "tests/scan-custom" "sh.yml" "JSON" "sourcehawk-scan-results.json")
+OUTPUT=$(docker run -v "$1:/github/workspace" "$2" "tests/scan-custom" "sh.yml" "JSON" "sourcehawk-scan-results.json")
 SCAN_EXIT_CODE=$?
 
+PASSED=()
+FAILED=()
+
+TEST_NAME="SCAN_EXIT_CODE"
 if [[ $SCAN_EXIT_CODE -eq 0 ]]; then
-  echo " > SCAN_EXIT_CODE: Correct"
+  echo " > $TEST_NAME: Correct"
+  PASSED+=("$TEST_NAME")
 else
-  echo " > SCAN_EXIT_CODE: Incorrect, expected 0, got $SCAN_EXIT_CODE"
+  echo " > $TEST_NAME: Incorrect, expected 0, got $SCAN_EXIT_CODE"
+  FAILED+=("$TEST_NAME")
 fi
 
+TEST_NAME="SCAN_RESULT_MESSAGE"
 FIRST_LINE=$(echo "$OUTPUT" | head -1 | sed -e 's/[[:space:]]*$//')
 EXPECTED='{"passed":true,"errorCount":0,"warningCount":0,"messages":{},"formattedMessages":[]}'
 if [[ "$FIRST_LINE" = "$EXPECTED" ]]; then
-  echo " > SCAN_RESULT_MESSAGE: Correct"
+  echo " > $TEST_NAME: Correct"
+  PASSED+=("$TEST_NAME")
 else
-  echo " > SCAN_RESULT_MESSAGE: Missing or incorrect, found: [$FIRST_LINE], expected: [$EXPECTED]"
-  exit 1
+  echo " > $TEST_NAME: Missing or incorrect, found: [$FIRST_LINE], expected: [$EXPECTED]"
+  FAILED+=("$TEST_NAME")
 fi
 
+TEST_NAME="RESULT_FILE"
 if [[ -f "sourcehawk-scan-results.json" ]]; then
-  echo " > RESULT_FILE: Correct"
+  echo " > $TEST_NAME: Correct"
+  PASSED+=("$TEST_NAME")
 else
-  echo " > RESULT_FILE: Missing result file at path: sourcehawk-scan-results.json"
-  exit 1
+  echo " > $TEST_NAME: Missing result file at path: sourcehawk-scan-results.json"
+  FAILED+=("$TEST_NAME")
 fi
 
-echo "Test Passed"
-echo "-------------------------"
+echo " >> Tests: $((${#PASSED[@]}+${#FAILED[@]})), Passed: ${#PASSED[@]}, Failed: ${#FAILED[@]}"
+exit ${#FAILED[@]}

tests/scan-error.sh

@@ -1,45 +1,49 @@
 #!/usr/bin/env bash
 
-echo "Running test: Scan Error"
-echo "-------------------------"
-
-ROOT="$(dirname "$(dirname "$(readlink -fm "$0")")")"
-
-OUTPUT=$(docker run -v "$ROOT:/github/workspace" sourcehawk-scan-github-action:test "tests/scan-error")
+OUTPUT=$(docker run -v "$1:/github/workspace" "$2" "tests/scan-error")
 SCAN_EXIT_CODE=$?
 
+TEST_NAME="SCAN_EXIT_CODE"
 if [[ $SCAN_EXIT_CODE -eq 1 ]]; then
-  echo " > SCAN_EXIT_CODE: Correct"
+  echo " > $TEST_NAME: Correct"
+  PASSED+=("$TEST_NAME")
 else
-  echo " > SCAN_EXIT_CODE: Incorrect, expected 1, got $SCAN_EXIT_CODE"
+  echo " > $TEST_NAME: Incorrect, expected 1, got $SCAN_EXIT_CODE"
+  FAILED+=("$TEST_NAME")
 fi
 
+TEST_NAME="SCAN_RESULT_MESSAGE"
 FIRST_LINE=$(echo "$OUTPUT" | head -1 | sed -e 's/[[:space:]]*$//')
 EXPECTED="Scan resulted in failure. Error(s): 1, Warning(s): 0"
 if [[ "$FIRST_LINE" = "$EXPECTED" ]]; then
-  echo " > SCAN_RESULT_MESSAGE: Correct"
+  echo " > $TEST_NAME: Correct"
+  PASSED+=("$TEST_NAME")
 else
-  echo " > SCAN_RESULT_MESSAGE: Missing or incorrect, found: [$FIRST_LINE], expected: [$EXPECTED]"
-  exit 1
+  echo " > $TEST_NAME: Missing or incorrect, found: [$FIRST_LINE], expected: [$EXPECTED]"
+  FAILED+=("$TEST_NAME")
 fi
 
+TEST_NAME="SCAN_RESULT_ERROR"
 SECOND_LINE=$(echo "$OUTPUT" | tail -2 | head -1 | sed -e 's/[[:space:]]*$//')
 EXPECTED="[ERROR] sourcehawk.yml :: Configuration file not found"
 if [[ "$SECOND_LINE" = "$EXPECTED" ]]; then
-  echo " > SCAN_RESULT_ERROR: Correct"
+  echo " > $TEST_NAME: Correct"
+  PASSED+=("$TEST_NAME")
 else
-  echo " > SCAN_RESULT_ERROR: Missing or incorrect, found: [$SECOND_LINE], expected: [$EXPECTED]"
-  exit 1
+  echo " > $TEST_NAME: Missing or incorrect, found: [$SECOND_LINE], expected: [$EXPECTED]"
+  FAILED+=("$TEST_NAME")
 fi
 
+TEST_NAME="GITHUB_ACTION_OUTPUT"
 LAST_LINE=$(echo "$OUTPUT" | tail -1 | sed -e 's/[[:space:]]*$//')
 EXPECTED="::set-output name=scan-passed::false"
 if [[ "$LAST_LINE" = "$EXPECTED" ]]; then
-  echo " > GITHUB_ACTION_OUTPUT: Correct"
+  echo " > $TEST_NAME: Correct"
+  PASSED+=("$TEST_NAME")
 else
-  echo " > GITHUB_ACTION_OUTPUT: Missing scan-passed(false) output"
-  exit 1
+  echo " > $TEST_NAME: Missing scan-passed(false) output"
+  FAILED+=("$TEST_NAME")
 fi
 
-echo "Test Passed"
-echo "-------------------------"
+echo " >> Tests: $((${#PASSED[@]}+${#FAILED[@]})), Passed: ${#PASSED[@]}, Failed: ${#FAILED[@]}"
+exit ${#FAILED[@]}

tests/scan-failed.sh

@@ -1,45 +1,49 @@
 #!/usr/bin/env bash
 
-echo "Running test: Scan Failed"
-echo "-------------------------"
-
-ROOT="$(dirname "$(dirname "$(readlink -fm "$0")")")"
-
-OUTPUT=$(docker run -v "$ROOT:/github/workspace" sourcehawk-scan-github-action:test "tests/scan-failed")
+OUTPUT=$(docker run -v "$1:/github/workspace" "$2" "tests/scan-failed")
 SCAN_EXIT_CODE=$?
 
+EST_NAME="SCAN_EXIT_CODE"
 if [[ $SCAN_EXIT_CODE -eq 1 ]]; then
-  echo " > SCAN_EXIT_CODE: Correct"
+  echo " > $TEST_NAME: Correct"
+  PASSED+=("$TEST_NAME")
 else
-  echo " > SCAN_EXIT_CODE: Incorrect, expected 1, got $SCAN_EXIT_CODE"
+  echo " > $TEST_NAME: Incorrect, expected 1, got $SCAN_EXIT_CODE"
+  FAILED+=("$TEST_NAME")
 fi
 
+TEST_NAME="SCAN_RESULT_MESSAGE"
 FIRST_LINE=$(echo "$OUTPUT" | head -1 | sed -e 's/[[:space:]]*$//')
 EXPECTED="Scan resulted in failure. Error(s): 1, Warning(s): 0"
 if [[ "$FIRST_LINE" = "$EXPECTED" ]]; then
-  echo " > SCAN_RESULT_MESSAGE: Correct"
+  echo " > $TEST_NAME: Correct"
+  PASSED+=("$TEST_NAME")
 else
-  echo " > SCAN_RESULT_MESSAGE: Missing or incorrect, found: [$FIRST_LINE], expected: [$EXPECTED]"
-  exit 1
+  echo " > $TEST_NAME: Missing or incorrect, found: [$FIRST_LINE], expected: [$EXPECTED]"
+  FAILED+=("$TEST_NAME")
 fi
 
+TEST_NAME="SCAN_RESULT_ERROR"
 SECOND_LINE=$(echo "$OUTPUT" | tail -2 | head -1 | sed -e 's/[[:space:]]*$//')
 EXPECTED="[ERROR] foo.bar :: File not found"
 if [[ "$SECOND_LINE" = "$EXPECTED" ]]; then
-  echo " > SCAN_RESULT_ERROR: Correct"
+  echo " > $TEST_NAME: Correct"
+  PASSED+=("$TEST_NAME")
 else
-  echo " > SCAN_RESULT_ERROR: Missing or incorrect, found: [$SECOND_LINE], expected: [$EXPECTED]"
-  exit 1
+  echo " > $TEST_NAME: Missing or incorrect, found: [$SECOND_LINE], expected: [$EXPECTED]"
+  FAILED+=("$TEST_NAME")
 fi
 
+TEST_NAME="GITHUB_ACTION_OUTPUT"
 LAST_LINE=$(echo "$OUTPUT" | tail -1 | sed -e 's/[[:space:]]*$//')
 EXPECTED="::set-output name=scan-passed::false"
 if [[ "$LAST_LINE" = "$EXPECTED" ]]; then
-  echo " > GITHUB_ACTION_OUTPUT: Correct"
+  echo " > $TEST_NAME: Correct"
+  PASSED+=("$TEST_NAME")
 else
-  echo " > GITHUB_ACTION_OUTPUT: Missing scan-passed(false) output"
-  exit 1
+  echo " > $TEST_NAME: Missing scan-passed(false) output"
+  FAILED+=("$TEST_NAME")
 fi
 
-echo "Test Passed"
-echo "-------------------------"
+echo " >> Tests: $((${#PASSED[@]}+${#FAILED[@]})), Passed: ${#PASSED[@]}, Failed: ${#FAILED[@]}"
+exit ${#FAILED[@]}