reduce bash 4.2 and 4.3 to unsupported

due to their crashes not returning the correct exit status, mark them as unsupported / only partially supported for now, at a later point once this PR is merged, we can focus on more improvements here

Author: balupton

.github/workflows/dorothy-workflow.yml

@@ -226,18 +226,20 @@ jobs:
         bash:
           - '3.2.57'
           - '4.0'
+          - '4.1'
           - '4.2.53'
           - '4.3.30'
           - '4.4.18'
           - '5.0'
           - '5.1.16'
           - '5.2.37'
           - '5.3'
-          # ^ this should all mirror [setup-util-bash]
+          # This should match all versions known in [bash.bash] and include in [continue-on-error] the unsupported versions
     steps:
       - name: 'Dorothy Test'
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # prevent rate limiting
+        continue-on-error: ${{ matrix.bash == '4.1' || matrix.bash == '4.2.53' || matrix.bash == '4.3.30' }}
         run: |
           # ensure dorothy is cloned, and run command
           bash -c "$(curl -fsSL 'https://dorothy.bevry.me/run?slug=${{ github.event.pull_request.head.repo.full_name || github.repository }}&commit=${{ github.event.pull_request.head.sha || github.sha }}')" -- dorothy test --bash-version="${{ matrix.bash }}"

commands/debug-bash

@@ -136,32 +136,27 @@ function debug_bash() (
 				__get_all_bash_binaries
 			continue
 		fi
+		# convert version number to executable
 		if [[ $bash_input =~ ^[0-9] ]]; then
-			# convert version number to executable
-			setup-util-bash --version="$bash_input"
-			# should match [setup-util-bash]
-			case "$bash_input" in
-			3 | 3. | 3.2*) bash_input='3.2.57' ;;
-			4.0*) bash_input='4.0' ;;
-			4.2*) bash_input='4.2.53' ;;
-			4.3*) bash_input='4.3.30' ;;
-			4 | 4. | 4.4*) bash_input='4.4.18' ;;
-			5.0*) bash_input='5.0' ;;
-			5.1*) bash_input='5.1.16' ;;
-			5 | 5. | 5.2*) bash_input='5.2.37' ;;
-			5.3*) bash_input='5.3' ;; # still too new
-			*)
-				echo-style --error="The bash version [$item] is not supported by Dorothy."
-				return 75 # EPROGMISMATCH 75 Program version wrong
-				;;
-			esac
-			bash_input="$(expand-path -- "$XDG_BIN_HOME/bash-$bash_input*" | echo-first-line --stdin)"
-			# if it doesn't exist, install it
+			bash_input="$(__get_coerced_bash_version "$bash_input" || :)"
+			if [[ -n $bash_input ]]; then
+				bash_input="$(expand-path -- "$XDG_BIN_HOME/bash-$bash_input*" | echo-first-line --stdin || :)"
+				if [[ -z $bash_input ]]; then
+					setup-util-bash --version="$bash_input" || return
+					bash_input="$(expand-path -- "$XDG_BIN_HOME/bash-$bash_input*" | echo-first-line --stdin || :)"
+				fi
+			fi
+		fi
+		# convert input to binary path
+		if [[ -n $bash_input ]]; then
+			bash_binary="$(type -P "$bash_input" || :)"
+		else
+			bash_binary=''
 		fi
-		bash_binary="$(type -P "$bash_input" || :)"
+		# add binary path or note failure
 		if [[ -z $bash_binary ]]; then
 			echo-style --error='The bash binary ' --code="$bash_input" ' does not exist.'
-			__exit_status=2 # ENOENT 2 No such file or directory
+			__exit_status=75 # EPROGMISMATCH 75 Program version wrong
 			continue
 		else
 			bash_binaries+=("$bash_binary")

commands/setup-util-bash

@@ -1,35 +1,22 @@
 #!/usr/bin/env bash
 
 # https://repology.org/project/bash/versions
+# https://ftp.gnu.org/gnu/bash/?C=M;O=D
 
 function setup_util_bash() (
 	source "$DOROTHY/sources/bash.bash"
 	# imports:
 	# IS_BASH_VERSION_OUTDATED
 	# BASH_VERSION_CURRENT
 	# BASH_VERSION_LATEST
+	# BASH_VERSIONS_SUPPORTED
 
-	local all_versions=(
-		# they all compile on ubuntu x86 without any flags, however byacc is needed for a few of them
-		# 3.0.16 # compiles on macos with CPPFLAGS modification <-- not supported by dorothy
-		# 3.1    # compiles on macos with CPPFLAGS modification <-- not supported by dorothy
-		3.2.57 # compiles on macos with CPPFLAGS modification
-		4.0    # compiles on macos with CPPFLAGS modification
-		# 4.1    # compiles on macos with CPPFLAGS modification <-- not supported by dorothy
-		4.2.53 # compiles on macos with CPPFLAGS modification
-		4.3.30 # compiles on macos with CPPFLAGS modification
-		4.4.18 # compiles on macos with CPPFLAGS modification
-		5.0    # compiles on macos with CPPFLAGS modification
-		5.1.16 # compiles on macos x86 without any flags
-		5.2.37 # compiles on macos x86 without any flags
-		5.3    # compiles on macos x86 without any flags
-	)
 	local item versions=() util_options=()
 	while [[ $# -ne 0 ]]; do
 		item="$1"
 		shift
 		case "$item" in
-		--all | --av | --all-versions | --all-bash-versions) versions+=("${all_versions[@]}") ;;
+		--all | --av | --all-versions | --all-bash-versions) versions+=("${BASH_VERSIONS_SUPPORTED[@]}") ;;
 		--v=* | --version=* | --versions=* | --bash-version=* | --bash-versions=*) __split --target={versions} --append --no-zero-length --delimiters=$'\n\t ,|' -- "${item#*=}" ;;
 		*) util_options+=("$item") ;;
 		esac
@@ -39,25 +26,10 @@ function setup_util_bash() (
 	# setup bash
 	if [[ ${#versions[@]} -ne 0 ]]; then
 		# convert short versions into preferred versions
-		local index __exit_status=0
+		local index
 		for index in "${!versions[@]}"; do
 			item="${versions[index]}"
-			# should match [debug-bash]
-			case "$item" in
-			3 | 3. | 3.2*) versions[index]='3.2.57' ;;
-			4.0*) versions[index]='4.0' ;;
-			4.2*) versions[index]='4.2.53' ;;
-			4.3*) versions[index]='4.3.30' ;;
-			4 | 4. | 4.4*) versions[index]='4.4.18' ;;
-			5.0*) versions[index]='5.0' ;;
-			5.1*) versions[index]='5.1.16' ;;
-			5 | 5. | 5.2*) versions[index]='5.2.37' ;;
-			5.3*) versions[index]='5.3' ;; # still too new
-			*)
-				echo-style --error="The bash version [$item] is not supported by Dorothy."
-				return 75 # EPROGMISMATCH 75 Program version wrong
-				;;
-			esac
+			versions[index]="$(__get_coerced_bash_version "$item")" || return
 		done
 
 		# this block offers no benefit as it is already fast enough

docs/bash/versions.md

@@ -18,7 +18,7 @@ From manual discovery:
 
 ## bash v3.2
 
-> [!CAUTION]
+> [!IMPORTANT]
 > This is this is the minimum required version for Dorothy.
 
 From manual discovery:
@@ -72,9 +72,16 @@ Changelog:
 
 ## bash v4.1
 
+> [!CAUTION]
+> Because of the bugs in this version, this version is discouraged.
+
 > [!NOTE]
 > Dorothy's `bash.bash` includes cross-version compatible implementations of `__open_fd`.
 
+From manual discovery:
+
+- Has a bug where modifications of a file do not actually modify the file, see comment at `bash.bash:__wait_for_semaphores`.
+
 From changelog:
 
 - Introduces `${arr:0:-N}` for getting the last N items or characters of an array or string.
@@ -93,6 +100,9 @@ Changelog:
 
 ## bash v4.2
 
+> [!CAUTION]
+> Because of the exit status bug in this version, this version is discouraged.
+
 From manual discovery:
 
 - If a crash occurs via `errexit` the exit status will always be `1` instead of the intended exit status. Refer to <errors.md> for guidance.
@@ -111,6 +121,9 @@ Changelog:
 
 ## bash v4.3
 
+> [!CAUTION]
+> Because of the exit status bug in this version, this version is discouraged.
+
 > [!NOTE]
 > Dorothy's `bash.bash` includes cross-version compatible implementations of `__get_var_declaration`.
 
@@ -134,12 +147,16 @@ Changelog:
 
 ## bash v4.4
 
-> [!CAUTION]
+> [!IMPORTANT]
 > This is this is the recommended minimum version for Dorothy.
 
 > [!NOTE]
 > Dorothy's `bash.bash` disables `nounset` on earlier bash versions to prevent crashes on accessing empty arrays. This has no notable downside, as the exact same logic paths are hit on modern bash versions, so undefined variables will be still be caught for resolution on them.
 
+From manual discovery:
+
+- Crashes now return the correct exit status.
+
 From changelog:
 
 - No longer throws upon accessing an empty array. Previously must do `[[ "${#arr[@]}" -ne 0 ]] && for item in "${arr[@]}"; do`.

sources/bash.bash

@@ -361,6 +361,47 @@ if [[ -z ${BASH_VERSION_CURRENT-} ]]; then
 	fi
 fi
 
+# Unsupported versions should be reflected in `dorothy-workflow.yml`
+# trunk-ignore(shellcheck/SC2034)
+BASH_VERSIONS_SUPPORTED=(
+	# they all compile on ubuntu x86 without any flags, however byacc is needed for a few of them
+	# 3.0.16 # compiles on macos with CPPFLAGS modification <-- not supported by dorothy
+	# 3.1    # compiles on macos with CPPFLAGS modification <-- not supported by dorothy
+	3.2.57 # compiles on macos with CPPFLAGS modification
+	4.0    # compiles on macos with CPPFLAGS modification
+	# 4.1    # compiles on macos with CPPFLAGS modification <-- not supported by dorothy, see note at `__wait_for_semaphores`
+	# 4.2.53 # compiles on macos with CPPFLAGS modification <-- partially supported by dorothy, crashes can fail to return the correct exit status
+	# 4.3.30 # compiles on macos with CPPFLAGS modification <-- partially supported by dorothy, crashes can fail to return the correct exit status
+	4.4.18 # compiles on macos with CPPFLAGS modification
+	5.0    # compiles on macos with CPPFLAGS modification
+	5.1.16 # compiles on macos x86 without any flags
+	5.2.37 # compiles on macos x86 without any flags
+	5.3    # compiles on macos x86 without any flags
+)
+
+function __get_coerced_bash_version {
+	local input="$1" result
+	case "$input" in
+	3.0*) result='3.0.16' ;;
+	3.1*) result='3.1' ;;
+	3 | 3. | 3.2*) result='3.2.57' ;;
+	4.0*) result='4.0' ;;
+	4.1*) result='4.1' ;;
+	4.2*) result='4.2.53' ;;
+	4.3*) result='4.3.30' ;;
+	4 | 4. | 4.4*) result='4.4.18' ;;
+	5.0*) result='5.0' ;;
+	5.1*) result='5.1.16' ;;
+	5.2*) result='5.2.37' ;;
+	'' | 5 | 5. | 5.3*) result='5.3' ;;
+	*)
+		__print_lines "ERROR: The bash version $(__dump --value="$input" || :) is not supported by Dorothy." >&2 || :
+		return 75 # EPROGMISMATCH 75 Program version wrong
+		;;
+	esac
+	printf '%s' "$result" || return
+}
+
 # CONSIDER
 # bash v5: localvar_inherit: If set, local variables inherit the value and attributes of a variable of the same name that exists at a previous scope before any new value is assigned. The nameref attribute is not inherited.
 # shopt -s localvar_inherit 2>/dev/null || :