Refactored base_wrapper function into an executable called 'base-wrapper' that would be used in the shebang line of Base scripts

The contract that a base CLI needs to adhere to is this: 1. Use "#!/usr/bin/env base-wrapper" as the shebang line 2. Have three functions: base_describe - To print one line description of what the script does base_help - To show help main - The entry point to the script base-wrapper gives these features out of the box: - automatically handles -h / --help / -help option to retrieve help text - automatically handles --describe / -describe option to retrieve one line summary of the script - automatically handles --debug option to enable debugging - imports lib/stdlib.sh More helper functions and automatic options may be added in the future.

Author: codeforester

README.md

@@ -80,7 +80,6 @@ In a typical setting, `.bashrc` sources in `$BASE_HOME/base_init.sh` which does
 # **Functions exported by base_init.sh**
 
 * import - sources in libraries from any place under `BASE_HOME` directory
-* base_wrapper - initializes Base inside scripts
 * base_update - does a `git pull` on Base git directory; add it to `user/<user>.sh` to "auto update" Base
 
 # **FAQ**

base_init.sh

@@ -62,7 +62,7 @@ base_deactivate() {
  unset _old_PATH _old_PS1 _old_vars_saved _old_BASE_HOME
  unset BASE_OS BASE_HOST BASE_DEBUG BASE_SOURCES
  unset -f check_bash_version do_init base_debug base_error set_base_home source_it \
- import_libs_and_profiles base_update base_wrapper base_main \
+ import_libs_and_profiles base_update base_main \
  base_deactivate
  unset __base_init_sourced__
  fi
@@ -186,48 +186,6 @@ base_update() (
  }
 )
 
-#
-# base_wrapper
-#
-# This function is meant to be called by scripts that are built on top of base.
-# base_wrapper is exported so that it is visible to sub processes started from the login shell.
-# It discovers base_init and sources it. It also looks at the command line arguments and interprets a few of those,
-# like --debug. It calls the main function the modified argument list. The main function is expected to be defined by
-# the calling script.
-#
-base_wrapper() {
- local grab_debug=0 arg args script
- [[ $1 = "-d" ]] && { grab_debug=1; shift; }
- [[ $BASE_HOME ]] || { printf '%s\n' "ERROR: BASE_HOME is not set" >&2; exit 1; }
- [[ -d $BASE_HOME ]] || { printf '%s\n' "ERROR: BASE_HOME '$BASE_HOME'is not a directory or is not readable" >&2; exit 1; }
- script=$BASE_HOME/base_init.sh
- [[ -f $script ]] || { printf '%s\n' "ERROR: base_init script '$script'is not present or is not readable" >&2; exit 1; }
- # shellcheck source=/dev/null
- source "$script"
- ((grab_debug)) && {
- #
- # grab out '-debug' or '--debug' from argument list and set a global variable to turn on debug mode
- #
- for arg; do
- if [[ $arg = "-debug" || $arg = "--debug" ]]; then
- BASE_DEBUG=1
- elif [[ $arg = "-describe" || $arg = "--describe" ]]; then
- _describe
- exit $?
- elif [[ $arg = "-help" || $arg = "--help" ]]; then
- _help
- exit $?
- else
- args+=("$arg")
- fi
- done
-
- set -- "${args[@]}"
- }
-
- main "$@"
-}
-
 base_main() {
  check_bash_version 4 2 || return $?
  do_init || return $?
@@ -243,7 +201,7 @@ base_main() {
  #
  # these functions need to be available to user's subprocesses
  #
- export -f base_update base_wrapper import base_activate base_deactivate
+ export -f base_update import base_activate base_deactivate
 }
 
 #

bin/base-wrapper

@@ -0,0 +1,67 @@
+#!/usr/bin/env bash
+
+#
+# base_wrapper
+#
+# This script is meant to be used in the shebang line of Base scripts, like this:
+#
+# #!/usr/bin/env base-wrapper
+#
+# What does this wrapper do?
+#
+# It discovers base_init and sources it. It also looks at the command line options and interprets a few of those,
+# like --debug, --help, --describe etc. It calls the main function with the special options removed from the argument list.
+# The main function is expected to be defined by the wrapped script.
+#
+
+_check_and_execute() {
+ local cmd=$1; shift
+ if command -v -- "$cmd" &>/dev/null; then
+ "$cmd" "$@"
+ exit $?
+ else
+ print_error "Function '$cmd' not implemented"
+ exit 1
+ fi
+}
+
+base_wrapper() {
+ local arg args script
+
+ ##
+ ## Do Base set up
+ ##
+
+ [[ $1 = "-d" ]] && { grab_debug=1; shift; }
+ [[ $BASE_HOME ]] || { printf '%s\n' "ERROR: BASE_HOME is not set" >&2; exit 1; }
+ [[ -d $BASE_HOME ]] || { printf '%s\n' "ERROR: BASE_HOME '$BASE_HOME'is not a directory or is not readable" >&2; exit 1; }
+ script=$BASE_HOME/base_init.sh
+ [[ -f $script ]] || { printf '%s\n' "ERROR: base_init script '$script'is not present or is not readable" >&2; exit 1; }
+ # shellcheck source=/dev/null
+ source "$script"
+ import lib/stdlib.sh
+
+ ##
+ ## Execute the script after processing the special command line arguments
+ ##
+
+ source "$1"
+ shift
+ for arg; do
+ if [[ $arg = "-debug" || $arg = "--debug" ]]; then
+ BASE_DEBUG=1
+ set -x
+ elif [[ $arg = "-describe" || $arg = "--describe" ]]; then
+ _check_and_execute base_describe
+ elif [[ $arg = "-help" || $arg = "--help" || $arg = "-h" ]]; then
+ _check_and_execute base_help
+ else
+ args+=("$arg")
+ fi
+ done
+
+ set -- "${args[@]}"
+ _check_and_execute main "$@"
+}
+
+base_wrapper "$@"

bin/caff

@@ -1,16 +1,20 @@
+#!/usr/bin/env base-wrapper
+
 #
 # caff: call caffeinate for a named process
 #
 
-_help() {
+name=caff
+description="Caffeinate a named process"
+base_help() {
  cat << EOUSAGE
 $description
 Usage: caff process_name
 If process_name matches multiple running process, we pick up the first one.
 EOUSAGE
 }
 
-_describe() {
+base_describe() {
  printf '%s\n' "$description"
 }
 
@@ -27,7 +31,7 @@ main() {
 
  (($# != 1)) && {
  print_error "need an argument"
- _help
+ base_help
  exit 2
  }
 
@@ -50,9 +54,3 @@ main() {
  caffeinate -iw "$vpid" & disown
  exit $?
 }
-
-description="Caffeinate a named process"
-base_wrapper -d "$@" || {
- printf '%s\n' "You need to initialize Base before running this script." >&2
- exit 1
-}

company/bin/test_command1

@@ -1,3 +1,5 @@
+#!/usr/bin/env base-wrapper
+
 #
 # test command
 #
@@ -6,5 +8,3 @@ main() {
  # do something
  log_info "Finished"
 }
-
-base_wrapper "$@" || { printf '%s\n' "ERROR: base environment not initialized; make sure you have sourced base_init.sh before invoking this script" >&2; exit 1; }

team/test-team1/bin/test_command1

@@ -1,3 +1,5 @@
+#!/usr/bin/env base-wrapper
+
 #
 # test command for team
 #
@@ -6,5 +8,3 @@ main() {
  # do something
  log_info "Finished"
 }
-
-base_wrapper "$@" || { printf '%s\n' "ERROR: base environment not initialized; make sure you have sourced base_init.sh before invoking this script" >&2; exit 1; }

team/test-team2/bin/test_command1

@@ -1,3 +1,5 @@
+#!/usr/bin/env base-wrapper
+
 #
 # test command for team
 #
@@ -6,5 +8,3 @@ main() {
  # do something
  log_info "Finished"
 }
-
-base_wrapper "$@" || { printf '%s\n' "ERROR: base environment not initialized; make sure you have sourced base_init.sh before invoking this script" >&2; exit 1; }