tests: use function to check if scripts run in unit tests environment

redhat-plumbers-in-action · May 9, 2024 · 77a0419 · 77a0419
1 parent ed65a91
commit 77a0419
Show file tree

Hide file tree

Showing 5 changed files with 39 additions and 10 deletions.
diff --git a/src/functions.sh b/src/functions.sh
@@ -47,19 +47,19 @@ pick_base_and_head_hash () {
     "push")
       export BASE=${INPUT_PUSH_EVENT_BASE:-}
       export HEAD=${INPUT_PUSH_EVENT_HEAD:-}
-      [[ ${UNIT_TESTS:-1} -eq 0 ]] && echo "BASE:\"${BASE}\" ; HEAD:\"${HEAD}\""
+      is_unit_tests && echo "BASE:\"${BASE}\" ; HEAD:\"${HEAD}\""
       ;;
 
     "pull_request")
       export BASE=${INPUT_PULL_REQUEST_BASE:-}
       export HEAD=${INPUT_PULL_REQUEST_HEAD:-}
-      [[ ${UNIT_TESTS:-1} -eq 0 ]] && echo "BASE:\"${BASE}\" ; HEAD:\"${HEAD}\""
+      is_unit_tests && echo "BASE:\"${BASE}\" ; HEAD:\"${HEAD}\""
       ;;
 
     "manual")
       export BASE=${INPUT_BASE:-}
       export HEAD=${INPUT_HEAD:-}
-      [[ ${UNIT_TESTS:-1} -eq 0 ]] && echo "BASE:\"${BASE}\" ; HEAD:\"${HEAD}\""
+      is_unit_tests && echo "BASE:\"${BASE}\" ; HEAD:\"${HEAD}\""
     ;;
 
     *)
@@ -97,7 +97,7 @@ get_scripts_for_scanning () {
   done
 
   eval $output=\("${scripts_for_scanning[*]@Q}"\)
-  [[ ${UNIT_TESTS:-1} -eq 0 ]] && eval echo "\${${output}[@]@Q}"
+  is_unit_tests && eval echo "\${${output}[@]@Q}"
 }
 
 # Function to check whether the given file has the .{,a,ba,da,k}sh and .bats extension
@@ -220,7 +220,7 @@ file_to_array () {
     output+=("${file}")
   done < "${1}"
 
-  [[ ${UNIT_TESTS:-1} -eq 0 ]] && echo "${output[@]}"
+  is_unit_tests && echo "${output[@]}"
 
   eval "${2}"=\("${output[*]@Q}"\)
 }

diff --git a/test/file_to_array.bats b/test/file_to_array.bats
@@ -36,7 +36,7 @@ setup () {
 @test "file_to_array() - general" {
   source "${PROJECT_ROOT}/src/functions.sh"
 
-  UNIT_TESTS=0
+  UNIT_TESTS="true"
 
   file_array=()
   run file_to_array "./test/fixtures/file_to_array/files.txt" "file_array"
@@ -45,5 +45,7 @@ setup () {
 }
 
 teardown () {
+  export \
+    UNIT_TESTS=""
   rm -f file.txt
 }
diff --git a/test/get_scripts_for_scanning.bats b/test/get_scripts_for_scanning.bats
@@ -13,7 +13,7 @@ setup () {
 @test "get_scripts_for_scanning() - general" {
   source "${PROJECT_ROOT}/src/functions.sh"
 
-  UNIT_TESTS=0
+  UNIT_TESTS="true"
 
   run get_scripts_for_scanning
   assert_failure 1

diff --git a/test/is_unit_tests.bats b/test/is_unit_tests.bats
@@ -0,0 +1,27 @@
+# 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 "is_unit_tests()" {
+  source "${PROJECT_ROOT}/src/functions.sh"
+
+  run is_unit_tests
+  assert_failure 1
+
+  UNIT_TESTS="true"
+  run is_unit_tests
+  assert_success
+}
+
+teardown () {
+  export \
+    UNIT_TESTS=""
+}
diff --git a/test/pick_base_and_head_hash.bats b/test/pick_base_and_head_hash.bats
@@ -28,7 +28,7 @@ setup () {
   run pick_base_and_head_hash
   assert_failure 2
 
-  UNIT_TESTS=0
+  UNIT_TESTS="true"
   INPUT_PUSH_EVENT_BASE="abcdef123456"
   INPUT_PUSH_EVENT_HEAD="ghijkl789012"
 
@@ -58,7 +58,7 @@ setup () {
   run pick_base_and_head_hash
   assert_failure 2
 
-  UNIT_TESTS=0
+  UNIT_TESTS="true"
   INPUT_PULL_REQUEST_BASE="abcdef123456"
   INPUT_PULL_REQUEST_HEAD="ghijkl789012"
 
@@ -88,7 +88,7 @@ setup () {
   run pick_base_and_head_hash
   assert_failure 2
 
-  UNIT_TESTS=0
+  UNIT_TESTS="true"
   INPUT_BASE="abcdef123456"
   INPUT_HEAD="ghijkl789012"