Return original value from __bp_precmd_invoke_cmd (#131)

* Return original value from `__bp_precmd_invoke_cmd`

WIthout this change, `__bp_precmd_invoke_cmd` may not restore `$?` to its original value after being run.

Since `__bp_precmd_invoke_cmd` get installed as the first thing in `PROMPT_COMMAND`, this will cause problems if there is an existing `PROMPT_COMMAND` (which is perhaps not aware of `bash-preexec`) that wants to do something with the exit status of the command that was just run.

* Updating tests to allow preserving original exist status for other commands in PROMPT_COMMAND

Co-authored-by: Ryan Caloras <[email protected]>

Author: jordemort

bash-preexec.sh

@@ -156,6 +156,8 @@ __bp_precmd_invoke_cmd() {
             "$precmd_function"
         fi
     done
+
+    __bp_set_ret_value "$__bp_last_ret_value"
 }
 
 # Sets a return value in $?. We may want to get access to the $? variable in our

test/bash-preexec.bats

@@ -21,6 +21,17 @@ test_preexec_echo() {
   printf "%s\n" "$1"
 }
 
+# Helper functions necessary because Bats' run doesn't preserve $?
+return_exit_code() {
+  return $1
+}
+
+set_exit_code_and_run_precmd() {
+  return_exit_code ${1:-0}
+  __bp_precmd_invoke_cmd
+}
+
+
 @test "sourcing bash-preexec should exit with 1 if we're not using bash" {
   unset BASH_VERSION
   run source "${BATS_TEST_DIRNAME}/../bash-preexec.sh"
@@ -155,7 +166,7 @@ test_preexec_echo() {
 
 @test "precmd should execute a function once" {
     precmd_functions+=(test_echo)
-    run '__bp_precmd_invoke_cmd'
+    run set_exit_code_and_run_precmd
     [ $status -eq 0 ]
     [ "$output" == "test echo" ]
 }
@@ -164,18 +175,10 @@ test_preexec_echo() {
     echo_exit_code() {
       echo "$?"
     }
-    return_exit_code() {
-      return $1
-    }
-    # Helper function is necessary because Bats' run doesn't preserve $?
-    set_exit_code_and_run_precmd() {
-      return_exit_code 251
-      __bp_precmd_invoke_cmd
-    }
 
     precmd_functions+=(echo_exit_code)
-    run 'set_exit_code_and_run_precmd'
-    [ $status -eq 0 ]
+    run set_exit_code_and_run_precmd 251
+    [ $status -eq 251 ]
     [ "$output" == "251" ]
 }
 
@@ -206,7 +209,7 @@ test_preexec_echo() {
     : "last-arg"
     __bp_preexec_invoke_exec "$_"
     eval "$bats_trap" # Restore trap
-    run '__bp_precmd_invoke_cmd'
+    run set_exit_code_and_run_precmd
     [ $status -eq 0 ]
     [ "$output" == "last-arg" ]
 }
@@ -242,7 +245,7 @@ test_preexec_echo() {
     precmd_functions+=(fun_1)
     precmd_functions+=(fun_2)
 
-    run '__bp_precmd_invoke_cmd'
+    run set_exit_code_and_run_precmd
     [ $status -eq 0 ]
     [ "${#lines[@]}" == '2' ]
     [ "${lines[0]}" == "one" ]