refactor: use command realpath instead of readlink, more portable(support macOS) 🔗

Author: oldratlee

README.md

@@ -118,8 +118,9 @@ Example:
 ```sh
 $ gen_source_guard
 #_ source guard begin _#
-[ -z "${__source_guard_0EDD6400_96EC_43E4_871A_E65F6781B828:+has_value}" ] || return 0
-__source_guard_0EDD6400_96EC_43E4_871A_E65F6781B828="$(dirname "$(readlink -f "${BASH_SOURCE[0]}")")"
-readonly __source_guard_0EDD6400_96EC_43E4_871A_E65F6781B828
+[ -n "${__source_guard_0EDD6400_96EC_43E4_871A_E65F6781B828:+has_value}" ] && return
+__source_guard_0EDD6400_96EC_43E4_871A_E65F6781B828=$(realpath -- "${BASH_SOURCE[0]}")
+# the value of source guard is the canonical dir path of this script
+readonly __source_guard_0EDD6400_96EC_43E4_871A_E65F6781B828=${__source_guard_0EDD6400_96EC_43E4_871A_E65F6781B828%/*}
 #_ source guard end _#
 ```

bin/gen_source_guard

@@ -26,9 +26,10 @@ new_source_guard() {
 
   cat <<EOF
 #_ source guard begin _#
-[ -z "\${$source_guard_var_name:+has_value}" ] || return 0
-$source_guard_var_name="\$(dirname "\$(readlink -f "\${BASH_SOURCE[0]}")")"
-readonly $source_guard_var_name
+[ -n "\${$source_guard_var_name:+has_value}" ] && return
+$source_guard_var_name=\$(realpath -- "\${BASH_SOURCE[0]}")
+# the value of source guard is the canonical dir path of this script
+readonly $source_guard_var_name=\${$source_guard_var_name%/*}
 #_ source guard end _#
 EOF
 }

lib/common_utils.sh

@@ -28,9 +28,10 @@
 ################################################################################
 #
 #_ source guard begin _#
-[ -z "${__source_guard_B016CBE5_CBB5_4AF4_BE46_ECA9FD30BACA:+has_value}" ] || return 0
-__source_guard_B016CBE5_CBB5_4AF4_BE46_ECA9FD30BACA="$(dirname "$(readlink -f "${BASH_SOURCE[0]}")")"
-readonly __source_guard_B016CBE5_CBB5_4AF4_BE46_ECA9FD30BACA
+[ -n "${__source_guard_B016CBE5_CBB5_4AF4_BE46_ECA9FD30BACA:+has_value}" ] && return
+__source_guard_B016CBE5_CBB5_4AF4_BE46_ECA9FD30BACA=$(realpath -- "${BASH_SOURCE[0]}")
+# the value of source guard is the canonical dir path of this script
+readonly __source_guard_B016CBE5_CBB5_4AF4_BE46_ECA9FD30BACA=${__source_guard_B016CBE5_CBB5_4AF4_BE46_ECA9FD30BACA%/*}
 #_ source guard end _#
 
 set -eEuo pipefail

lib/java_utils.sh

@@ -11,9 +11,10 @@
 ################################################################################
 #
 #_ source guard begin _#
-[ -z "${__source_guard_ED79675F_4289_4394_A843_03D06DB48AFA:+has_value}" ] || return 0
-__source_guard_ED79675F_4289_4394_A843_03D06DB48AFA="$(dirname "$(readlink -f "${BASH_SOURCE[0]}")")"
-readonly __source_guard_ED79675F_4289_4394_A843_03D06DB48AFA
+[ -n "${__source_guard_ED79675F_4289_4394_A843_03D06DB48AFA:+has_value}" ] && return
+__source_guard_ED79675F_4289_4394_A843_03D06DB48AFA=$(realpath -- "${BASH_SOURCE[0]}")
+# the value of source guard is the canonical dir path of this script
+readonly __source_guard_ED79675F_4289_4394_A843_03D06DB48AFA=${__source_guard_ED79675F_4289_4394_A843_03D06DB48AFA%/*}
 #_ source guard end _#
 
 set -eEuo pipefail

lib/maven_utils.sh

@@ -9,9 +9,10 @@
 ################################################################################
 #
 #_ source guard begin _#
-[ -z "${__source_guard_364DF1B5_9CA2_44D3_9C62_CDF6C2ECB24F:+has_value}" ] || return 0
-__source_guard_364DF1B5_9CA2_44D3_9C62_CDF6C2ECB24F="$(dirname "$(readlink -f "${BASH_SOURCE[0]}")")"
-readonly __source_guard_364DF1B5_9CA2_44D3_9C62_CDF6C2ECB24F
+[ -n "${__source_guard_364DF1B5_9CA2_44D3_9C62_CDF6C2ECB24F:+has_value}" ] && return
+__source_guard_364DF1B5_9CA2_44D3_9C62_CDF6C2ECB24F=$(realpath -- "${BASH_SOURCE[0]}")
+# the value of source guard is the canonical dir path of this script
+readonly __source_guard_364DF1B5_9CA2_44D3_9C62_CDF6C2ECB24F=${__source_guard_364DF1B5_9CA2_44D3_9C62_CDF6C2ECB24F%/*}
 #_ source guard end _#
 
 set -eEuo pipefail
@@ -43,7 +44,8 @@ mvu::_find_mvn_cmd_path() {
   fi
 
   # 2. find mvnw from parent dirs
-  local d="$PWD"
+  local d
+  d=$(realpath -- "$PWD")
   while true; do
     local mvnw_path="$d/$maven_wrapper_name"
     [ -x "$mvnw_path" ] && {
@@ -53,7 +55,7 @@ mvu::_find_mvn_cmd_path() {
     }
 
     [ "/" = "$d" ] && break
-    d=$(dirname "$d")
+    d=${d%/*}
   done
 
   # 3. find mvn from $PATH

lib/prepare_jdks.sh

@@ -15,9 +15,10 @@
 ################################################################################
 #
 #_ source guard begin _#
-[ -z "${__source_guard_E2AA8C4F_215B_4CDA_9816_429C7A2CD465:+has_value}" ] || return 0
-__source_guard_E2AA8C4F_215B_4CDA_9816_429C7A2CD465="$(dirname "$(readlink -f "${BASH_SOURCE[0]}")")"
-readonly __source_guard_E2AA8C4F_215B_4CDA_9816_429C7A2CD465
+[ -n "${__source_guard_E2AA8C4F_215B_4CDA_9816_429C7A2CD465:+has_value}" ] && return
+__source_guard_E2AA8C4F_215B_4CDA_9816_429C7A2CD465=$(realpath -- "${BASH_SOURCE[0]}")
+# the value of source guard is the canonical dir path of this script
+readonly __source_guard_E2AA8C4F_215B_4CDA_9816_429C7A2CD465=${__source_guard_E2AA8C4F_215B_4CDA_9816_429C7A2CD465%/*}
 #_ source guard end _#
 
 set -eEuo pipefail

lib/trap_error_info.sh

@@ -15,9 +15,10 @@
 ################################################################################
 #
 #_ source guard begin _#
-[ -z "${__source_guard_84949D19_1C7A_40AF_BC28_BA5967A0B6CE:+has_value}" ] || return 0
-__source_guard_84949D19_1C7A_40AF_BC28_BA5967A0B6CE="$(dirname "$(readlink -f "${BASH_SOURCE[0]}")")"
-readonly __source_guard_84949D19_1C7A_40AF_BC28_BA5967A0B6CE
+[ -n "${__source_guard_84949D19_1C7A_40AF_BC28_BA5967A0B6CE:+has_value}" ] && return
+__source_guard_84949D19_1C7A_40AF_BC28_BA5967A0B6CE=$(realpath -- "${BASH_SOURCE[0]}")
+# the value of source guard is the canonical dir path of this script
+readonly __source_guard_84949D19_1C7A_40AF_BC28_BA5967A0B6CE=${__source_guard_84949D19_1C7A_40AF_BC28_BA5967A0B6CE%/*}
 #_ source guard end _#
 
 set -eEu -o pipefail -o functrace

templates/integration_test.template.sh

@@ -1,8 +1,11 @@
 #!/bin/bash
 set -eEuo pipefail
-cd "$(dirname "$(readlink -f "$0")")"
+# the canonical path of this script
+SELF_PATH=$(realpath -- "$0")
+readonly SELF_PATH SELF_DIR=${SELF_PATH%/*}
+cd "$SELF_DIR"
 
-FIXME BASH_BUDDY_ROOT="$(readlink -f path/to/bash-buddy/dir)"
+FIXME BASH_BUDDY_ROOT="$(realpath -- path/to/bash-buddy/dir)"
 readonly BASH_BUDDY_ROOT
 
 source "$BASH_BUDDY_ROOT/lib/trap_error_info.sh"
@@ -28,7 +31,7 @@ source "$BASH_BUDDY_ROOT/lib/maven_utils.sh"
 # ci build logic
 ################################################################################
 
-FIXME PROJECT_ROOT_DIR="$(readlink -f /path/to/project/root/dir)"
+FIXME PROJECT_ROOT_DIR="$(realpath -- /path/to/project/root/dir)"
 cd "$PROJECT_ROOT_DIR"
 
 ########################################