tests

src/functions.sh

@@ -303,10 +303,13 @@ is_debug () {
 # GITHUB_ACTIONS is set when Differential ShellCheck is running in GitHub Actions
 # https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables
 is_github_actions () {
-  if [[ -z "${GITHUB_ACTIONS}" ]]; then
-    return 1
-  fi
+  [[ -z "${GITHUB_ACTIONS}" ]] && return 1
+  return 0
+}
 
+# Function to check if the script is run in unit tests environment
+is_unit_tests () {
+  [[ -z "${UNIT_TESTS}" ]] && return 1
   return 0
 }
 

src/setup.sh

@@ -2,8 +2,8 @@
 
 # TODO set up required variables
 
-export DISPLAY_ENGINE="${INPUT_DISPLAY_ENGINE:-csgrep}"
-is_debug && echo "DISPLAY_ENGINE: ${DISPLAY_ENGINE}"
+export INPUT_DISPLAY_ENGINE="${INPUT_DISPLAY_ENGINE:='csgrep'}"
+is_debug && echo "DISPLAY_ENGINE: ${INPUT_DISPLAY_ENGINE}"
 
 # Set required variables based on the environment
 if is_github_actions; then

src/validation.sh

@@ -24,18 +24,19 @@ print_result () {
   [[ $# -le 0 ]] && return 1
   local results="$1"
 
-  if [[ "${DISPLAY_ENGINE:-'csgrep'}" == "sarif-fmt" ]]; then
+  if [[ "${INPUT_DISPLAY_ENGINE:-'csgrep'}" == "sarif-fmt" ]]; then
+    local color="always"
+    is_unit_tests && color="never"
+
     # When sarif-fmt is used, we need to generate SARIF file first
     # only csgrep can utilize JSON output from csdiff
     generate_SARIF "${results}" "tmp.sarif"
-    sarif-fmt --color="always" < "tmp.sarif"
+    sarif-fmt --color="${color}" < "tmp.sarif"
     rm "tmp.sarif"
   else
     [[ $# -le 1 ]] && return 1
     local context="$2"
 
-    defect=
-
     csgrep --embed-context "${context}" "${results}"
   fi
 }

test/fixtures/print_result/defects.log

@@ -0,0 +1,49 @@
+{
+    "defects": [
+        {
+            "checker": "SHELLCHECK_WARNING",
+            "language": "shell",
+            "tool": "shellcheck",
+            "key_event_idx": 0,
+            "events": [
+                {
+                    "file_name": "innocent-script.sh",
+                    "line": 7,
+                    "event": "warning[SC2034]",
+                    "message": "UNUSED_VAR2 appears unused. Verify use (or export if used externally).",
+                    "verbosity_level": 0
+                }
+            ]
+        },
+        {
+            "checker": "SHELLCHECK_WARNING",
+            "language": "shell",
+            "tool": "shellcheck",
+            "key_event_idx": 0,
+            "events": [
+                {
+                    "file_name": "innocent-script.sh",
+                    "line": 11,
+                    "event": "warning[SC2115]",
+                    "message": "Use \"${var:?}\" to ensure this never expands to / .",
+                    "verbosity_level": 0
+                }
+            ]
+        },
+        {
+            "checker": "SHELLCHECK_WARNING",
+            "language": "shell",
+            "tool": "shellcheck",
+            "key_event_idx": 0,
+            "events": [
+                {
+                    "file_name": "innocent-script.sh",
+                    "line": 11,
+                    "event": "warning[SC2115]",
+                    "message": "Use \"${var:?}\" to ensure this never expands to / .",
+                    "verbosity_level": 0
+                }
+            ]
+        }
+    ]
+}

test/fixtures/print_result/fixes.log

@@ -0,0 +1,34 @@
+{
+    "defects": [
+        {
+            "checker": "SHELLCHECK_WARNING",
+            "language": "shell",
+            "tool": "shellcheck",
+            "key_event_idx": 0,
+            "events": [
+                {
+                    "file_name": "innocent-script.sh",
+                    "line": 7,
+                    "event": "warning[SC2034]",
+                    "message": "UNUSED_VAR2 appears unused. Verify use (or export if used externally).",
+                    "verbosity_level": 0
+                }
+            ]
+        },
+        {
+            "checker": "SHELLCHECK_WARNING",
+            "language": "shell",
+            "tool": "shellcheck",
+            "key_event_idx": 0,
+            "events": [
+                {
+                    "file_name": "innocent-script.sh",
+                    "line": 11,
+                    "event": "warning[SC2115]",
+                    "message": "Use \"${var:?}\" to ensure this never expands to / .",
+                    "verbosity_level": 0
+                }
+            ]
+        }
+    ]
+}

test/print_result.bats

@@ -0,0 +1,90 @@
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+setup_file () {
+  load 'test_helper/common-setup'
+  _common_setup
+}
+
+setup () {
+  load 'test_helper/bats-assert/load'
+  load 'test_helper/bats-support/load'
+}
+
+@test "print_result() - arguments" {
+  source "${PROJECT_ROOT}/src/functions.sh"
+  source "${PROJECT_ROOT}/src/validation.sh"
+
+  INPUT_DISPLAY_ENGINE="csgrep"
+  run print_result
+  assert_failure 1
+
+  run print_result "./test/fixtures/print_result/defects.log"
+  assert_failure 1
+
+  run print_result "./test/fixtures/print_result/defects.log" "4"
+  assert_success
+
+  INPUT_DISPLAY_ENGINE="sarif-fmt"
+  run print_result "./test/fixtures/print_result/defects.log"
+  assert_success
+}
+
+@test "print_result() - csgrep" {
+  source "${PROJECT_ROOT}/src/validation.sh"
+
+  INPUT_DISPLAY_ENGINE="csgrep"
+  run print_result "./test/fixtures/print_result/defects.log" "4"
+  assert_success
+  assert_output \
+'Error: SHELLCHECK_WARNING:
+innocent-script.sh:7: warning[SC2034]: UNUSED_VAR2 appears unused. Verify use (or export if used externally).
+
+Error: SHELLCHECK_WARNING:
+innocent-script.sh:11: warning[SC2115]: Use "${var:?}" to ensure this never expands to / .
+
+Error: SHELLCHECK_WARNING:
+innocent-script.sh:11: warning[SC2115]: Use "${var:?}" to ensure this never expands to / .'
+
+  run print_result "./test/fixtures/print_result/fixes.log" "2"
+  assert_success
+  assert_output \
+'Error: SHELLCHECK_WARNING:
+innocent-script.sh:7: warning[SC2034]: UNUSED_VAR2 appears unused. Verify use (or export if used externally).
+
+Error: SHELLCHECK_WARNING:
+innocent-script.sh:11: warning[SC2115]: Use "${var:?}" to ensure this never expands to / .'
+}
+
+@test "print_result() - sarif-fmt" {
+  source "${PROJECT_ROOT}/src/functions.sh"
+  source "${PROJECT_ROOT}/src/validation.sh"
+
+  UNIT_TESTS="true"
+  INPUT_DISPLAY_ENGINE="sarif-fmt"
+  run print_result "./test/fixtures/print_result/defects.log"
+  assert_success
+  assert_output \
+'warning: UNUSED_VAR2 appears unused. Verify use (or export if used externally).
+
+warning: Use "${var:?}" to ensure this never expands to / .
+
+warning: Use "${var:?}" to ensure this never expands to / .
+
+warning: 3 warnings emitted'
+
+  run print_result "./test/fixtures/print_result/fixes.log"
+  assert_success
+  assert_output \
+'warning: UNUSED_VAR2 appears unused. Verify use (or export if used externally).
+
+warning: Use "${var:?}" to ensure this never expands to / .
+
+warning: 2 warnings emitted'
+}
+
+teardown () {
+  export \
+    INPUT_DISPLAY_ENGINE="" \
+    UNIT_TESTS=""
+  rm -f tmp.sarif
+}