feat: feature flag enable parallel only macos and ubuntu

TypedDevs · Oct 13, 2024 · d35cbf7 · d35cbf7
1 parent 61dc052
commit d35cbf7
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 19 deletions.
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -9,7 +9,7 @@ on:
 jobs:
 
   simple-output:
-    name: "On ${{ matrix.os }} - simple & sync"
+    name: "${{ matrix.os }} - simple & sync"
     timeout-minutes: 10
     runs-on: ${{ matrix.os }}
     strategy:
@@ -28,7 +28,7 @@ jobs:
           ./bashunit --simple --no-parallel tests/
 
   simple-output-parallel:
-    name: "On ${{ matrix.os }} - simple & parallel"
+    name: "${{ matrix.os }} - simple & parallel"
     timeout-minutes: 10
     runs-on: ${{ matrix.os }}
     strategy:
@@ -47,7 +47,7 @@ jobs:
           ./bashunit --simple --parallel tests/
 
   detailed-output-parallel:
-    name: "On ${{ matrix.os }} - detailed & parallel"
+    name: "${{ matrix.os }} - detailed & parallel"
     timeout-minutes: 10
     runs-on: ${{ matrix.os }}
     strategy:
@@ -66,7 +66,7 @@ jobs:
           ./bashunit --detailed --parallel tests/
 
   windows:
-    name: "On windows (${{ matrix.test_chunk }})"
+    name: "windows (${{ matrix.test_chunk }})"
     timeout-minutes: 10
     runs-on: windows-latest
     strategy:
@@ -85,7 +85,7 @@ jobs:
           ./bashunit tests/${{ matrix.test_chunk }}/*_test.sh
 
   alpine:
-    name: "On alpine-latest"
+    name: "alpine-latest"
     runs-on: ubuntu-latest
     steps:
       - name: Checkout

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,7 @@
 ## [Unreleased](https://github.com/TypedDevs/bashunit/compare/0.17.0...main)
 
 - Added `-p|--parallel` to enable running tests in parallel
+    - Enabled only in macOS and Ubuntu
 - Added `assert_file_contains` and `assert_file_not_contains`
 - Added `assert_true` and `assert_false`
 - Added `BASHUNIT_DEV_LOG`

diff --git a/src/main.sh b/src/main.sh
@@ -19,23 +19,25 @@ function main::exec_tests() {
   trap 'main::cleanup' SIGINT
   trap '[[ $? -eq $EXIT_CODE_STOP_ON_FAILURE ]] && main::handle_stop_on_failure_sync' EXIT
 
-  if env::is_parallel_run_enabled && check_os::is_alpine; then
-    printf "%sWarning: Parallel test execution on Alpine Linux is currently" "${_COLOR_INCOMPLETE}"
-    printf "in a beta stage.\nThis means there may be unresolved issues, "
-    printf "particularly involving race conditions.%s\n" "${_COLOR_DEFAULT}"
+  if env::is_parallel_run_enabled && ! parallel::is_enabled; then
+    printf "%sWarning: Parallel tests are working only for macOS and Ubuntu.\n" "${_COLOR_INCOMPLETE}"
+    printf "For other OS (Linux/Alpine, Windows), --parallel is not enabled due to inconsistent results,\n"
+    printf "particularly involving race conditions.%s " "${_COLOR_DEFAULT}"
+    printf "%sFallback using --no-parallel%s\n" "${_COLOR_SKIPPED}" "${_COLOR_DEFAULT}"
   fi
 
-  if env::is_parallel_run_enabled; then
+  if parallel::is_enabled; then
     parallel::reset
   fi
 
   console_header::print_version_with_env "$filter" "${test_files[@]}"
   runner::load_test_files "$filter" "${test_files[@]}"
-  if env::is_parallel_run_enabled; then
+
+  if parallel::is_enabled; then
     wait
   fi
 
-  if env::is_parallel_run_enabled && parallel::must_stop_on_failure; then
+  if parallel::is_enabled && parallel::must_stop_on_failure; then
     printf "\r%sStop on failure enabled...%s\n"  "${_COLOR_SKIPPED}" "${_COLOR_DEFAULT}"
   fi
 

diff --git a/src/parallel.sh b/src/parallel.sh
@@ -83,3 +83,8 @@ function parallel::reset() {
   rm -rf "$TEMP_DIR_PARALLEL_TEST_SUITE"
   [ -f "$TEMP_FILE_PARALLEL_STOP_ON_FAILURE" ] && rm "$TEMP_FILE_PARALLEL_STOP_ON_FAILURE"
 }
+
+function parallel::is_enabled() {
+  [[ $(env::is_parallel_run_enabled) \
+    && ($(check_os::is_macos) || $(check_os::is_ubuntu)) ]]
+}
diff --git a/src/runner.sh b/src/runner.sh
@@ -13,7 +13,7 @@ function runner::load_test_files() {
     # shellcheck source=/dev/null
     source "$test_file"
     runner::run_set_up_before_script
-    if env::is_parallel_run_enabled; then
+    if parallel::is_enabled; then
       runner::call_test_functions "$test_file" "$filter" 2>/dev/null &
     else
       runner::call_test_functions "$test_file" "$filter"
@@ -22,7 +22,7 @@ function runner::load_test_files() {
     runner::clean_set_up_and_tear_down_after_script
   done
 
-  if env::is_parallel_run_enabled; then
+  if parallel::is_enabled; then
     wait
     runner::spinner &
     local spinner_pid=$!
@@ -74,14 +74,14 @@ function runner::call_test_functions() {
     return
   fi
 
-  if ! env::is_simple_output_enabled && ! env::is_parallel_run_enabled; then
+  if ! env::is_simple_output_enabled && ! parallel::is_enabled; then
     echo "Running $script"
   fi
 
   helper::check_duplicate_functions "$script" || true
 
   for function_name in "${functions_to_run[@]}"; do
-    if env::is_parallel_run_enabled && parallel::must_stop_on_failure; then
+    if parallel::is_enabled && parallel::must_stop_on_failure; then
       break
     fi
 
@@ -193,7 +193,7 @@ function runner::run_test() {
     runner::write_failure_result_output "$test_file" "$subshell_output"
 
     if env::is_stop_on_failure_enabled; then
-      if env::is_parallel_run_enabled; then
+      if parallel::is_enabled; then
         parallel::mark_stop_on_failure
       else
         exit "$EXIT_CODE_STOP_ON_FAILURE"
@@ -249,7 +249,7 @@ function runner::parse_result() {
   shift
   local args=("$@")
 
-  if env::is_parallel_run_enabled; then
+  if parallel::is_enabled; then
     runner::parse_result_parallel "$function_name" "$execution_result" "${args[@]}"
   else
     runner::parse_result_sync "$function_name" "$execution_result"

diff --git a/src/state.sh b/src/state.sh
@@ -205,7 +205,7 @@ function state::print_line() {
     *)                char="?" && log "warning" "unknown test type '$type'" ;;
   esac
 
-  if env::is_parallel_run_enabled; then
+  if parallel::is_enabled; then
       printf "%s" "$char"
   else
     if (( _TOTAL_TESTS_COUNT % 50 == 0 )); then