Squashed 'vendor/github.com/rcaloras/bash-preexec/' content from commit 7884535
git-subtree-dir: vendor/github.com/rcaloras/bash-preexec git-subtree-split: 7884535ed423ac27d3b6b473c61b1fe41905aca1
This commit is contained in:
buhl
22
test/README.md
Normal file
22
test/README.md
Normal file
@@ -0,0 +1,22 @@
|
||||
Testing `bash-preexec`
|
||||
======================
|
||||
|
||||
**Note on test conditions**
|
||||
|
||||
When writing test conditions, use `[ ... ]` instead of `[[ ... ]]` since the
|
||||
former are supported by Bats on Bash versions before 4.1. In particular, macOS
|
||||
uses Bash 3.2, and `[[ ... ]]` tests always pass on macOS.
|
||||
|
||||
In some cases, you may want to use a feature unique to `[[ ... ]]` such as
|
||||
pattern matching (`[[ $name = a* ]]`) or regular expressions (`[[ $(date) =~
|
||||
^Fri\ ...\ 13 ]]`). In those cases, use the following pattern to replace “bare”
|
||||
`[[ ... ]]`.
|
||||
|
||||
```
|
||||
[[ ... ]] || return 1
|
||||
```
|
||||
|
||||
References:
|
||||
* [Differences between `[` and `[[`](http://mywiki.wooledge.org/BashFAQ/031)
|
||||
* [Problems with `[[` in Bats](https://github.com/sstephenson/bats/issues/49)
|
||||
* [Using `|| return 1` instead of `|| false`](https://github.com/bats-core/bats-core/commit/e5695a673faad4d4d33446ed5c99d70dbfa6d8be)
|
||||
364
test/bash-preexec.bats
Normal file
364
test/bash-preexec.bats
Normal file
@@ -0,0 +1,364 @@
|
||||
#!/usr/bin/env bats
|
||||
|
||||
setup() {
|
||||
PROMPT_COMMAND='' # in case the invoking shell has set this
|
||||
history -s fake command # preexec requires there be some history
|
||||
set -o nounset # in case the user has this set
|
||||
__bp_delay_install="true"
|
||||
source "${BATS_TEST_DIRNAME}/../bash-preexec.sh"
|
||||
}
|
||||
|
||||
bp_install() {
|
||||
__bp_install_after_session_init
|
||||
eval "$PROMPT_COMMAND"
|
||||
}
|
||||
|
||||
test_echo() {
|
||||
echo "test echo"
|
||||
}
|
||||
|
||||
test_preexec_echo() {
|
||||
printf "%s\n" "$1"
|
||||
}
|
||||
|
||||
@test "__bp_install_after_session_init should exit with 1 if we're not using bash" {
|
||||
unset BASH_VERSION
|
||||
run '__bp_install_after_session_init'
|
||||
[ $status -eq 1 ]
|
||||
[ -z "$output" ]
|
||||
}
|
||||
|
||||
@test "__bp_install should exit if it's already installed" {
|
||||
bp_install
|
||||
|
||||
run '__bp_install'
|
||||
[ $status -eq 1 ]
|
||||
[ -z "$output" ]
|
||||
}
|
||||
|
||||
@test "__bp_install should remove trap logic and itself from PROMPT_COMMAND" {
|
||||
__bp_install_after_session_init
|
||||
|
||||
[[ "$PROMPT_COMMAND" == *"trap - DEBUG"* ]] || return 1
|
||||
[[ "$PROMPT_COMMAND" == *"__bp_install"* ]] || return 1
|
||||
|
||||
eval "$PROMPT_COMMAND"
|
||||
|
||||
[[ "$PROMPT_COMMAND" != *"trap DEBUG"* ]] || return 1
|
||||
[[ "$PROMPT_COMMAND" != *"__bp_install"* ]] || return 1
|
||||
}
|
||||
|
||||
@test "__bp_install should preserve an existing DEBUG trap" {
|
||||
trap_invoked_count=0
|
||||
foo() { (( trap_invoked_count += 1 )); }
|
||||
|
||||
# note setting this causes BATS to mis-report the failure line when this test fails
|
||||
trap foo DEBUG
|
||||
[ "$(trap -p DEBUG | cut -d' ' -f3)" == "'foo'" ]
|
||||
|
||||
bp_install
|
||||
trap_count_snapshot=$trap_invoked_count
|
||||
|
||||
[ "$(trap -p DEBUG | cut -d' ' -f3)" == "'__bp_preexec_invoke_exec" ]
|
||||
[[ "${preexec_functions[*]}" == *"__bp_original_debug_trap"* ]] || return 1
|
||||
|
||||
__bp_interactive_mode # triggers the DEBUG trap
|
||||
|
||||
# ensure the trap count is still being incremented after the trap's been overwritten
|
||||
(( trap_count_snapshot < trap_invoked_count ))
|
||||
}
|
||||
|
||||
@test "__bp_sanitize_string should remove semicolons and trim space" {
|
||||
|
||||
__bp_sanitize_string output " true1; "$'\n'
|
||||
[ "$output" == "true1" ]
|
||||
|
||||
__bp_sanitize_string output " ; true2; "
|
||||
[ "$output" == "true2" ]
|
||||
|
||||
__bp_sanitize_string output $'\n'" ; true3; "
|
||||
[ "$output" == "true3" ]
|
||||
|
||||
}
|
||||
|
||||
@test "Appending to PROMPT_COMMAND should work after bp_install" {
|
||||
bp_install
|
||||
|
||||
PROMPT_COMMAND="$PROMPT_COMMAND; true"
|
||||
eval "$PROMPT_COMMAND"
|
||||
}
|
||||
|
||||
@test "Appending or prepending to PROMPT_COMMAND should work after bp_install_after_session_init" {
|
||||
__bp_install_after_session_init
|
||||
nl=$'\n'
|
||||
PROMPT_COMMAND="$PROMPT_COMMAND; true"
|
||||
PROMPT_COMMAND="$PROMPT_COMMAND $nl true"
|
||||
PROMPT_COMMAND="$PROMPT_COMMAND; true"
|
||||
PROMPT_COMMAND="true; $PROMPT_COMMAND"
|
||||
PROMPT_COMMAND="true; $PROMPT_COMMAND"
|
||||
PROMPT_COMMAND="true; $PROMPT_COMMAND"
|
||||
PROMPT_COMMAND="true $nl $PROMPT_COMMAND"
|
||||
eval "$PROMPT_COMMAND"
|
||||
}
|
||||
|
||||
# Case where a user is appending or prepending to PROMPT_COMMAND.
|
||||
# This can happen after 'source bash-preexec.sh' e.g.
|
||||
# source bash-preexec.sh; PROMPT_COMMAND="$PROMPT_COMMAND; other_prompt_command_hook"
|
||||
@test "Adding to PROMPT_COMMAND before and after initiating install" {
|
||||
PROMPT_COMMAND="echo before"
|
||||
PROMPT_COMMAND="$PROMPT_COMMAND; echo before2"
|
||||
__bp_install_after_session_init
|
||||
PROMPT_COMMAND="$PROMPT_COMMAND"$'\n echo after'
|
||||
PROMPT_COMMAND="echo after2; $PROMPT_COMMAND;"
|
||||
|
||||
eval "$PROMPT_COMMAND"
|
||||
|
||||
expected_result=$'__bp_precmd_invoke_cmd\necho after2; echo before; echo before2\n echo after\n__bp_interactive_mode'
|
||||
[ "$PROMPT_COMMAND" == "$expected_result" ]
|
||||
}
|
||||
|
||||
@test "Adding to PROMPT_COMMAND after with semicolon" {
|
||||
PROMPT_COMMAND="echo before"
|
||||
__bp_install_after_session_init
|
||||
PROMPT_COMMAND="$PROMPT_COMMAND; echo after"
|
||||
|
||||
eval "$PROMPT_COMMAND"
|
||||
|
||||
expected_result=$'__bp_precmd_invoke_cmd\necho before\n echo after\n__bp_interactive_mode'
|
||||
[ "$PROMPT_COMMAND" == "$expected_result" ]
|
||||
}
|
||||
|
||||
@test "during install PROMPT_COMMAND and precmd functions should be executed each once" {
|
||||
PROMPT_COMMAND="echo before"
|
||||
PROMPT_COMMAND="$PROMPT_COMMAND; echo before2"
|
||||
__bp_install_after_session_init
|
||||
PROMPT_COMMAND="$PROMPT_COMMAND; echo after"
|
||||
PROMPT_COMMAND="echo after2; $PROMPT_COMMAND;"
|
||||
|
||||
precmd() { echo "inside precmd"; }
|
||||
run eval "$PROMPT_COMMAND"
|
||||
[ "${lines[0]}" == "after2" ]
|
||||
[ "${lines[1]}" == "before" ]
|
||||
[ "${lines[2]}" == "before2" ]
|
||||
[ "${lines[3]}" == "inside precmd" ]
|
||||
[ "${lines[4]}" == "after" ]
|
||||
[ "${#lines[@]}" == '5' ]
|
||||
}
|
||||
|
||||
@test "No functions defined for preexec should simply return" {
|
||||
__bp_interactive_mode
|
||||
|
||||
run '__bp_preexec_invoke_exec' 'true'
|
||||
[ $status -eq 0 ]
|
||||
[ -z "$output" ]
|
||||
}
|
||||
|
||||
@test "precmd should execute a function once" {
|
||||
precmd_functions+=(test_echo)
|
||||
run '__bp_precmd_invoke_cmd'
|
||||
[ $status -eq 0 ]
|
||||
[ "$output" == "test echo" ]
|
||||
}
|
||||
|
||||
@test "precmd should set \$? to be the previous exit code" {
|
||||
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 ]
|
||||
[ "$output" == "251" ]
|
||||
}
|
||||
|
||||
@test "precmd should set \$BP_PIPESTATUS to the previous \$PIPESTATUS" {
|
||||
echo_pipestatus() {
|
||||
echo "${BP_PIPESTATUS[*]}"
|
||||
}
|
||||
# Helper function is necessary because Bats' run doesn't preserve $PIPESTATUS
|
||||
set_pipestatus_and_run_precmd() {
|
||||
false | true
|
||||
__bp_precmd_invoke_cmd
|
||||
}
|
||||
|
||||
precmd_functions+=(echo_pipestatus)
|
||||
run 'set_pipestatus_and_run_precmd'
|
||||
[ $status -eq 0 ]
|
||||
[ "$output" == "1 0" ]
|
||||
}
|
||||
|
||||
@test "precmd should set \$_ to be the previous last arg" {
|
||||
echo_last_arg() {
|
||||
echo "$_"
|
||||
}
|
||||
precmd_functions+=(echo_last_arg)
|
||||
|
||||
bats_trap=$(trap -p DEBUG)
|
||||
trap DEBUG # remove the Bats stack-trace trap so $_ doesn't get overwritten
|
||||
: "last-arg"
|
||||
__bp_preexec_invoke_exec "$_"
|
||||
eval "$bats_trap" # Restore trap
|
||||
run '__bp_precmd_invoke_cmd'
|
||||
[ $status -eq 0 ]
|
||||
[ "$output" == "last-arg" ]
|
||||
}
|
||||
|
||||
@test "preexec should execute a function with the last command in our history" {
|
||||
preexec_functions+=(test_preexec_echo)
|
||||
__bp_interactive_mode
|
||||
git_command="git commit -a -m 'committing some stuff'"
|
||||
history -s $git_command
|
||||
|
||||
run '__bp_preexec_invoke_exec'
|
||||
[ $status -eq 0 ]
|
||||
[ "$output" == "$git_command" ]
|
||||
}
|
||||
|
||||
@test "preexec should execute multiple functions in the order added to their arrays" {
|
||||
fun_1() { echo "$1 one"; }
|
||||
fun_2() { echo "$1 two"; }
|
||||
preexec_functions+=(fun_1)
|
||||
preexec_functions+=(fun_2)
|
||||
__bp_interactive_mode
|
||||
|
||||
run '__bp_preexec_invoke_exec'
|
||||
[ $status -eq 0 ]
|
||||
[ "${#lines[@]}" == '2' ]
|
||||
[ "${lines[0]}" == "fake command one" ]
|
||||
[ "${lines[1]}" == "fake command two" ]
|
||||
}
|
||||
|
||||
@test "preecmd should execute multiple functions in the order added to their arrays" {
|
||||
fun_1() { echo "one"; }
|
||||
fun_2() { echo "two"; }
|
||||
precmd_functions+=(fun_1)
|
||||
precmd_functions+=(fun_2)
|
||||
|
||||
run '__bp_precmd_invoke_cmd'
|
||||
[ $status -eq 0 ]
|
||||
[ "${#lines[@]}" == '2' ]
|
||||
[ "${lines[0]}" == "one" ]
|
||||
[ "${lines[1]}" == "two" ]
|
||||
}
|
||||
|
||||
@test "preexec should execute a function with IFS defined to local scope" {
|
||||
IFS=_
|
||||
name_with_underscores_1() { parts=(1_2); echo $parts; }
|
||||
preexec_functions+=(name_with_underscores_1)
|
||||
|
||||
__bp_interactive_mode
|
||||
run '__bp_preexec_invoke_exec'
|
||||
[ $status -eq 0 ]
|
||||
[ "$output" == "1 2" ]
|
||||
}
|
||||
|
||||
@test "precmd should execute a function with IFS defined to local scope" {
|
||||
IFS=_
|
||||
name_with_underscores_2() { parts=(2_2); echo $parts; }
|
||||
precmd_functions+=(name_with_underscores_2)
|
||||
run '__bp_precmd_invoke_cmd'
|
||||
[ $status -eq 0 ]
|
||||
[ "$output" == "2 2" ]
|
||||
}
|
||||
|
||||
@test "preexec should set \$? to be the exit code of preexec_functions" {
|
||||
return_nonzero() {
|
||||
return 1
|
||||
}
|
||||
preexec_functions+=(return_nonzero)
|
||||
|
||||
__bp_interactive_mode
|
||||
|
||||
run '__bp_preexec_invoke_exec'
|
||||
[ $status -eq 1 ]
|
||||
}
|
||||
|
||||
@test "in_prompt_command should detect if a command is part of PROMPT_COMMAND" {
|
||||
|
||||
PROMPT_COMMAND=$'precmd_invoke_cmd\n something; echo yo\n __bp_interactive_mode'
|
||||
run '__bp_in_prompt_command' "something"
|
||||
[ $status -eq 0 ]
|
||||
|
||||
run '__bp_in_prompt_command' "something_else"
|
||||
[ $status -eq 1 ]
|
||||
|
||||
# Should trim commands and arguments here.
|
||||
PROMPT_COMMAND=" precmd_invoke_cmd ; something ; some_stuff_here;"
|
||||
run '__bp_in_prompt_command' " precmd_invoke_cmd "
|
||||
[ $status -eq 0 ]
|
||||
|
||||
PROMPT_COMMAND=" precmd_invoke_cmd ; something ; some_stuff_here;"
|
||||
run '__bp_in_prompt_command' " not_found"
|
||||
[ $status -eq 1 ]
|
||||
|
||||
}
|
||||
|
||||
@test "__bp_adjust_histcontrol should remove ignorespace and ignoreboth" {
|
||||
|
||||
# Should remove ignorespace
|
||||
HISTCONTROL="ignorespace:ignoredups:*"
|
||||
__bp_adjust_histcontrol
|
||||
[ "$HISTCONTROL" == ":ignoredups:*" ]
|
||||
|
||||
# Should remove ignoreboth and replace it with ignoredups
|
||||
HISTCONTROL="ignoreboth"
|
||||
__bp_adjust_histcontrol
|
||||
[ "$HISTCONTROL" == "ignoredups:" ]
|
||||
|
||||
# Handle a few inputs
|
||||
HISTCONTROL="ignoreboth:ignorespace:some_thing_else"
|
||||
__bp_adjust_histcontrol
|
||||
echo "$HISTCONTROL"
|
||||
[ "$HISTCONTROL" == "ignoredups:::some_thing_else" ]
|
||||
|
||||
}
|
||||
|
||||
@test "preexec should respect HISTTIMEFORMAT" {
|
||||
preexec_functions+=(test_preexec_echo)
|
||||
__bp_interactive_mode
|
||||
git_command="git commit -a -m 'committing some stuff'"
|
||||
HISTTIMEFORMAT='%F %T '
|
||||
history -s $git_command
|
||||
|
||||
run '__bp_preexec_invoke_exec'
|
||||
[ $status -eq 0 ]
|
||||
[ "$output" == "$git_command" ]
|
||||
}
|
||||
|
||||
@test "preexec should not strip whitespace from commands" {
|
||||
preexec_functions+=(test_preexec_echo)
|
||||
__bp_interactive_mode
|
||||
history -s " this command has whitespace "
|
||||
|
||||
run '__bp_preexec_invoke_exec'
|
||||
[ $status -eq 0 ]
|
||||
[ "$output" == " this command has whitespace " ]
|
||||
}
|
||||
|
||||
@test "preexec should preserve multi-line strings in commands" {
|
||||
preexec_functions+=(test_preexec_echo)
|
||||
__bp_interactive_mode
|
||||
history -s "this 'command contains
|
||||
a multiline string'"
|
||||
run '__bp_preexec_invoke_exec'
|
||||
[ $status -eq 0 ]
|
||||
[ "$output" == "this 'command contains
|
||||
a multiline string'" ]
|
||||
}
|
||||
|
||||
@test "preexec should work on options to 'echo' commands" {
|
||||
preexec_functions+=(test_preexec_echo)
|
||||
__bp_interactive_mode
|
||||
history -s -- '-n'
|
||||
run '__bp_preexec_invoke_exec'
|
||||
[ $status -eq 0 ]
|
||||
[ "$output" == '-n' ]
|
||||
}
|
||||
20
test/include-test.bats
Normal file
20
test/include-test.bats
Normal file
@@ -0,0 +1,20 @@
|
||||
#!/usr/bin/env bats
|
||||
|
||||
@test "should not import if it's already defined" {
|
||||
__bp_imported="defined"
|
||||
source "${BATS_TEST_DIRNAME}/../bash-preexec.sh"
|
||||
[ -z $(type -t __bp_preexec_and_precmd_install) ]
|
||||
}
|
||||
|
||||
@test "should import if not defined" {
|
||||
unset __bp_imported
|
||||
source "${BATS_TEST_DIRNAME}/../bash-preexec.sh"
|
||||
[ -n $(type -t __bp_install) ]
|
||||
}
|
||||
|
||||
@test "bp should stop installation if HISTTIMEFORMAT is readonly" {
|
||||
readonly HISTTIMEFORMAT
|
||||
run source "${BATS_TEST_DIRNAME}/../bash-preexec.sh"
|
||||
[ $status -ne 0 ]
|
||||
[[ "$output" =~ "HISTTIMEFORMAT" ]] || return 1
|
||||
}
|
||||
Reference in New Issue
Block a user