@renault-digital/bash-base 2.4.1 → 2.5.0

package/spec/process.spec.sh

@@ -9,38 +9,101 @@ AfterRun preserve
 Describe 'prc_filter_by_port'
     It 'with port number'
         nc -lk 127.0.0.1 9999 &
+        listener_pid=$!
         sleep 1
         echo "=== Debug: check listener ==="
         lsof -iTCP:9999 -sTCP:LISTEN -n -P
         When call prc_filter_by_port 9999
         The status should be success
         The output should include ":9999"
-        kill $(lsof -iTCP:9999 -sTCP:LISTEN -n -P -t)
+        kill "$listener_pid" 2>/dev/null || true
+        wait "$listener_pid" 2>/dev/null || true
     End
 
     It 'without port number'
         nc -l 9999 &
+        listener_pid=$!
+        sleep 1
         When call prc_filter_by_port
         The status should be success
         The output should include ":9999"
-        kill $(lsof -iTCP:9999 -sTCP:LISTEN -n -P -t)
+        kill "$listener_pid" 2>/dev/null || true
+        wait "$listener_pid" 2>/dev/null || true
     End
 End
 
 
+# Use an owned listener and wait until it is actually listening before
+# exercising the public API. Redirect all background descriptors so an
+# unsuccessful kill cannot hold the command-substitution output pipe open.
+prc_test_kill_listener() {
+    local port="$1" signal="$2"
+    local listener_pid="" supervisor_pid attempt ready=0 rc=1 pid_file
+
+    pid_file="$(mktemp "${TMPDIR:-/tmp}/bash-base-listener.XXXXXX")" || return 1
+
+    # A SIGKILL-ed direct background job causes Bash to write "Killed: 9"
+    # on ShellSpec's stderr, even if nc itself redirects stderr. Instead,
+    # the direct child is a POSIX sh supervisor that exits normally after
+    # waiting for nc. Keep nc's PID to verify we are testing our listener.
+    sh -c '
+        nc -l "$1" </dev/null >/dev/null 2>&1 &
+        child=$!
+        trap "kill $child 2>/dev/null || :" 0 1 2 15
+        printf "%s\n" "$child" > "$2"
+        wait "$child" 2>/dev/null || :
+    ' sh "$port" "$pid_file" </dev/null >/dev/null 2>&1 &
+    supervisor_pid=$!
+
+    for ((attempt = 0; attempt < 50; attempt++)); do
+        if [[ -s "$pid_file" ]]; then
+            IFS= read -r listener_pid < "$pid_file" || :
+        fi
+        if [[ -n "$listener_pid" ]] &&
+           lsof -nP -iTCP:"$port" -sTCP:LISTEN -t 2>/dev/null | grep -qx "$listener_pid"; then
+            ready=1
+            break
+        fi
+        if ! kill -0 "$supervisor_pid" 2>/dev/null; then
+            break
+        fi
+        sleep 0.1
+    done
+
+    if ((ready)); then
+        actual="$(prc_kill_by_port "$port" "$signal")"
+        rc=$?
+    else
+        printf 'Test listener failed to bind on port %s\n' "$port" >&2
+    fi
+
+    # Cleanup only the processes owned by this test. Reap the normal-exiting
+    # supervisor, not the signal-terminated nc child it manages.
+    if [[ -n "$listener_pid" ]]; then
+        kill "$listener_pid" 2>/dev/null || :
+    fi
+    wait "$supervisor_pid" 2>/dev/null || :
+    rm -f "$pid_file"
+    return "$rc"
+}
+
 Describe 'prc_kill_by_port'
     It 'signal term'
-        func() {  actual=$( nc -l 9999 & prc_kill_by_port 9999 ); }
+        test_port=$((22000 + RANDOM % 20000))
+        func() { prc_test_kill_listener "$test_port" 15; }
         When run func
         The status should be success
-        The value "${actual}" should include ":9999"
+        The value "${actual}" should include ":${test_port}"
+        The value "${actual}" should include "Start to kill port listener by signal 15..."
     End
 
     It 'signal kill'
-        func() {  actual=$( nc -l 9999 & prc_kill_by_port 9999 9); }
+        test_port=$((22000 + RANDOM % 20000))
+        func() { prc_test_kill_listener "$test_port" 9; }
         When run func
         The status should be success
-        The value "${actual}" should include ":9999"
+        The value "${actual}" should include ":${test_port}"
+        The value "${actual}" should include "Start to kill port listener by signal 9..."
     End
 
     It 'port not listened'
@@ -52,39 +115,70 @@ Describe 'prc_kill_by_port'
 End
 
 
+# The default macOS "ps" output depends on the controlling terminal.
+# GitHub Actions has no such terminal, so these unit tests provide an explicit
+# process table. Do not change the public functions' existing `ps` behavior.
 Describe 'prc_filter_by_cmd'
+    ps() {
+        printf '%s\n' \
+            '  PID TTY           TIME CMD' \
+            '999999997 ttys001    0:00.00 /bin/bash -c fixture' \
+            '999999998 ttys001    0:00.00 sleep 10'
+    }
+
     It 'with command'
         When call prc_filter_by_cmd bash
         The status should be success
-        The output should include "bash"
+        The output should include '/bin/bash -c fixture'
+        The output should not include 'sleep 10'
     End
 
     It 'without command'
         When call prc_filter_by_cmd
         The status should be success
-        The output should include "bash"
+        The output should include '/bin/bash -c fixture'
+        The output should include 'sleep 10'
     End
 End
 
 
 Describe 'prc_kill_by_cmd'
+    # ps emits a deterministic table; fake PIDs cannot refer to real processes.
+    ps() {
+        printf '%s\n' \
+            '  PID TTY           TIME CMD' \
+            '999999997 ttys001    0:00.00 /bin/bash -c fixture' \
+            '999999998 ttys001    0:00.00 sleep 10'
+    }
+
+    # xargs invokes an external `kill`, not a shell function. Use ShellSpec's
+    # command-based Mock so signals are checked without terminating processes.
+    Mock kill
+        printf 'MOCK_KILL:'
+        printf ' <%s>' "$@"
+        printf '\n'
+    End
+
     It 'signal term'
-        func() {  actual=$( sleep 10 & prc_kill_by_cmd sleep); }
-        When run func
+        When call prc_kill_by_cmd sleep
         The status should be success
-        The value "${actual}" should include "sleep"
+        The output should include 'Start to kill command by signal 15...'
+        The output should include 'MOCK_KILL: <-15> <999999998>'
+        The output should not include 'MOCK_KILL: <-15> <999999997>'
     End
 
     It 'signal kill'
-        func() {  actual=$( sleep 10 & prc_kill_by_cmd sleep 9); }
-        When run func
+        When call prc_kill_by_cmd sleep 9
         The status should be success
-        The value "${actual}" should include "sleep"
+        The output should include 'Start to kill command by signal 9...'
+        The output should include 'MOCK_KILL: <-9> <999999998>'
+        The output should not include 'MOCK_KILL: <-9> <999999997>'
     End
 
     It 'not found command'
         When call prc_kill_by_cmd xxxx
         The status should be success
-        The output should include "No command to kill"
+        The output should include 'No command to kill'
+        The output should not include 'MOCK_KILL:'
     End
 End

package/spec/reflection.spec.sh

@@ -120,7 +120,7 @@ Describe 'reflect_function_names_of_file'
         When call reflect_function_names_of_file "${shellScriptFile}"
         The status should eq "0"
         The output should include "reflect_nth_arg"
-        The lines of output should eq 65
+        The lines of output should eq 67
 
         rm -fr "${shellScriptFile}"
     End

package/spec/spec_helper.sh

@@ -16,3 +16,20 @@ array_describe_equals() {
 
 
 
+
+# Compare ordered array values across Bash and zsh without assuming native
+# indexed-array numbering or typeset/declare output formatting.
+array_values_equal() {
+    local array_name="$1"
+    shift
+    local -a __bb_test_values
+    local element
+
+    eval "__bb_test_values=( \"\${${array_name}[@]}\" )" || return 1
+    [[ ${#__bb_test_values[@]} -eq $# ]] || return 1
+    for element in "${__bb_test_values[@]}"; do
+        [[ "$element" == "$1" ]] || return 1
+        shift
+    done
+    return 0
+}

package/spec/string.spec.sh

@@ -11,7 +11,7 @@ Describe 'string_split_to_array'
     It 'with variable'
         str="a b c"
         When call string_split_to_array ' ' actual "$str"
-        The variable actual should satisfy array_describe_equals actual "([0]='a' [1]='b' [2]='c')"
+        The variable actual should satisfy array_values_equal actual 'a' 'b' 'c'
     End
 
     It 'with pipe and print to stdout'
@@ -23,7 +23,7 @@ Describe 'string_split_to_array'
     It 'with token string including space'
         str="amy delimiterbmy delimiterc"
         When call string_split_to_array 'my delimiter' actual "$str"
-        The variable actual should satisfy array_describe_equals actual "([0]='a' [1]='b' [2]='c')"
+        The variable actual should satisfy array_values_equal actual 'a' 'b' 'c'
     End
 
     It 'with stdin'
@@ -33,7 +33,7 @@ Describe 'string_split_to_array'
 					* origin/feature/52-new-feature
 				EOF
         When call string_split_to_array $'\n' actual "${lines}"
-        The variable actual should satisfy array_describe_equals actual "([0]='  origin/develop' [1]='  origin/integration' [2]='* origin/feature/52-new-feature')"
+        The variable actual should satisfy array_values_equal actual '  origin/develop' '  origin/integration' '* origin/feature/52-new-feature'
     End
 
     It 'with file'
@@ -43,7 +43,7 @@ Describe 'string_split_to_array'
 					 3. C
 				EOF
         When call eval "string_split_to_array $'\n' actual < temp_file.txt"
-        The variable actual should satisfy array_describe_equals actual "([0]=' 1. A D' [1]=' 2. B' [2]=' 3. C')"
+        The variable actual should satisfy array_values_equal actual ' 1. A D' ' 2. B' ' 3. C'
 
         rm -fr temp_file.txt
     End
@@ -54,12 +54,12 @@ Describe 'string_pick_to_array'
     It 'with variable'
         str="[{age:12},{age:15},{age:16}]"
         When call string_pick_to_array '{age:' '}' actual "$str"
-        The variable actual should satisfy array_describe_equals actual "([0]='12' [1]='15' [2]='16')"
+        The variable actual should satisfy array_values_equal actual '12' '15' '16'
     End
 
     It 'with pipe and print to stdout'
         str="[{age:12},{age:15},{age:16}]"
-        When call eval "echo $str | string_pick_to_array '{age:' '}'"
+        When call eval 'printf "%s\n" "$str" | string_pick_to_array "{age:" "}"'
         The output should eq $'12\n15\n16'
     End
 
@@ -78,7 +78,7 @@ Describe 'string_pick_to_array'
 					]
 				EOF
         When call string_pick_to_array 'age:' $'\n' actual "${lines}"
-        The variable actual should satisfy array_describe_equals actual "([0]='12' [1]='15' [2]='16')"
+        The variable actual should satisfy array_values_equal actual '12' '15' '16'
     End
 
     It 'with file'
@@ -96,7 +96,7 @@ Describe 'string_pick_to_array'
 					]
 				EOF
         When call eval "string_pick_to_array 'age:' $'\n' actual < temp_file.txt"
-        The variable actual should satisfy array_describe_equals actual "([0]='12' [1]='15' [2]='16')"
+        The variable actual should satisfy array_values_equal actual '12' '15' '16'
 
         rm -fr temp_file.txt
     End
@@ -435,9 +435,8 @@ Describe 'string_before_first'
 					EFGH
 					IJKL
 				EOF
-        func() { actual=$(string_before_first 'FGH' < temp_file.txt); }
-        When run func
-        The variable actual should eq $'ABCD\nE'
+        When call eval 'string_before_first "FGH" < temp_file.txt'
+        The output should eq $'ABCD\nE'
         rm -fr temp_file.txt
     End
 End
@@ -465,9 +464,8 @@ Describe 'string_after_first'
 					EFGH
 					IJKL
 				EOF
-        func() { actual=$(string_after_first "FGH" < temp_file.txt); }
-        When run func
-        The variable actual should eq $'\nIJKL'
+        When call eval 'string_after_first "FGH" < temp_file.txt'
+        The output should eq $'\nIJKL'
         rm -fr temp_file.txt
     End
 End
@@ -548,9 +546,8 @@ Describe 'string_index_first'
 					EFGH
 					IJKL
 				EOF
-        func() { actual=$(string_index_first "FGH" < temp_file.txt); }
-        When run func
-        The variable actual should eq "6"
+        When call eval 'string_index_first "FGH" < temp_file.txt'
+        The output should eq "6"
         rm -fr temp_file.txt
     End
 End

package/src/alias.sh

@@ -1,9 +1,40 @@
 #!/usr/bin/env bash
 
-shopt -s expand_aliases 2>/dev/null # This file is for compatibility with previous versions
-
 source src/out.sh
 source src/tool.sh
 
-alias args_confirm='confirm_to_continue'
-alias args_print='print_args'
+#     Backward-compatible command names.  Use wrapper functions rather than aliases:
+#     aliases need different non-interactive expansion rules in Bash and zsh, while
+#     functions work identically when this library is sourced by either shell.
+
+# @NAME
+#     args_confirm -- show the name and value of variables, and continue execute if args_confirm by user, or exit if not
+# @SYNOPSIS
+#     args_confirm variableName...
+# @DESCRIPTION
+#     **variableName...** some existed variable names to show its value
+# @EXAMPLES
+#     a="correct value"
+#     b="wrong value"
+#     args_confirm a b
+# @SEE_ALSO
+#     args_print, stop_if_failed
+args_confirm() {
+	confirm_to_continue "$@"
+}
+
+# @NAME
+#     args_print -- if LOG_LEVEL<=$LOG_LEVEL_WARN, show the name and value of variables
+# @SYNOPSIS
+#     args_print variableName...
+# @DESCRIPTION
+#     **variableName...** some existed variable names to show its value
+# @EXAMPLES
+#     var1="value 1"
+#     var2="value 2"
+#     args_print var1 var2
+# @SEE_ALSO
+#     print_header, print_error, print_success, print_warn, print_info, print_debug
+args_print() {
+	print_args "$@"
+}