forked from NOAA-GSL/global-workflow
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Move bash utility functions out of preamble (NOAA-EMC#2447)
The preamble was accumulating a bunch of utility functions. These functions are now moved to a separate file that is sourced by the preamble. The only functions remaining in the preamble are those related to script control and logging (`set_trace()`, `set_strict()`, `postamble()`). Resolves NOAA-EMC#2346
- Loading branch information
1 parent
4a39c8a
commit c54fe98
Showing
3 changed files
with
128 additions
and
127 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,127 @@ | ||
| #! /usr/bin/env bash | ||
|
|
||
| function generate_com() { | ||
| # | ||
| # Generate a list COM variables from a template by substituting in env variables. | ||
| # | ||
| # Each argument must have a corresponding template with the name ${ARG}_TMPL. Any | ||
| # variables in the template are replaced with their values. Undefined variables | ||
| # are just removed without raising an error. | ||
| # | ||
| # Accepts as options `-r` and `-x`, which do the same thing as the same options in | ||
| # `declare`. Variables are automatically marked as `-g` so the variable is visible | ||
| # in the calling script. | ||
| # | ||
| # Syntax: | ||
| # generate_com [-rx] $var1[:$tmpl1] [$var2[:$tmpl2]] [...]] | ||
| # | ||
| # options: | ||
| # -r: Make variable read-only (same as `decalre -r`) | ||
| # -x: Mark variable for export (same as `declare -x`) | ||
| # var1, var2, etc: Variable names whose values will be generated from a template | ||
| # and declared | ||
| # tmpl1, tmpl2, etc: Specify the template to use (default is "${var}_TMPL") | ||
| # | ||
| # Examples: | ||
| # # Current cycle and RUN, implicitly using template COM_ATMOS_ANALYSIS_TMPL | ||
| # YMD=${PDY} HH=${cyc} generate_com -rx COM_ATMOS_ANALYSIS | ||
| # | ||
| # # Previous cycle and gdas using an explicit template | ||
| # RUN=${GDUMP} YMD=${gPDY} HH=${gcyc} generate_com -rx \ | ||
| # COM_ATMOS_HISTORY_PREV:COM_ATMOS_HISTORY_TMPL | ||
| # | ||
| # # Current cycle and COM for first member | ||
| # MEMDIR='mem001' YMD=${PDY} HH=${cyc} generate_com -rx COM_ATMOS_HISTORY | ||
| # | ||
| if [[ ${DEBUG_WORKFLOW:-"NO"} == "NO" ]]; then set +x; fi | ||
| local opts="-g" | ||
| local OPTIND=1 | ||
| while getopts "rx" option; do | ||
| opts="${opts}${option}" | ||
| done | ||
| shift $((OPTIND-1)) | ||
|
|
||
| for input in "$@"; do | ||
| IFS=':' read -ra args <<< "${input}" | ||
| local com_var="${args[0]}" | ||
| local template | ||
| local value | ||
| if (( ${#args[@]} > 1 )); then | ||
| template="${args[1]}" | ||
| else | ||
| template="${com_var}_TMPL" | ||
| fi | ||
| if [[ ! -v "${template}" ]]; then | ||
| echo "FATAL ERROR in generate_com: Requested template ${template} not defined!" | ||
| exit 2 | ||
| fi | ||
| value=$(echo "${!template}" | envsubst) | ||
| # shellcheck disable=SC2086 | ||
| declare ${opts} "${com_var}"="${value}" | ||
| # shellcheck disable= | ||
| echo "generate_com :: ${com_var}=${value}" | ||
| done | ||
| set_trace | ||
| } | ||
|
|
||
| function wait_for_file() { | ||
| # | ||
| # Wait for a file to exist and return the status. | ||
| # | ||
| # Checks if a file exists periodically up to a maximum number of attempts. When the file | ||
| # exists or the limit is reached, the status is returned (0 if the file exists,1 if it | ||
| # does not). This allows it to be used as a conditional to handle missing files. | ||
| # | ||
| # Syntax: | ||
| # wait_for_file file_name [sleep_interval [max_tries]] | ||
| # | ||
| # file_name: File to check the existence of (must be readable) | ||
| # sleep_interval: Time to wait between each check (in seconds) [default: 60] | ||
| # max_tries: The maximum number of checks to make [default: 100] | ||
| # | ||
| # Example: | ||
| # ``` | ||
| # file_name=/path/to/foo | ||
| # sleep_interval=60 | ||
| # max_tries=30 | ||
| # if wait_for_file; then | ||
| # echo "FATAL ERROR: ${file_name} still does not exist after waiting one-half hour." | ||
| # exit 1 | ||
| # fi | ||
| # # Code that depends on file existing | ||
| # ``` | ||
| # | ||
| set +x | ||
| local file_name=${1:?"wait_for_file() requires a file name"} | ||
| local sleep_interval=${2:-60} | ||
| local max_tries=${3:-100} | ||
|
|
||
| for (( iter=0; iter<max_tries; iter++ )); do | ||
| if [[ -r ${file_name} ]]; then | ||
| set_trace | ||
| return 0 | ||
| fi | ||
| sleep "${sleep_interval}" | ||
| done | ||
| set_trace | ||
| return 1 | ||
| } | ||
|
|
||
| function detect_py_ver() { | ||
| # | ||
| # Returns the major.minor version of the currently active python executable | ||
| # | ||
| regex="[0-9]+\.[0-9]+" | ||
| # shellcheck disable=SC2312 | ||
| if [[ $(python --version) =~ ${regex} ]]; then | ||
| echo "${BASH_REMATCH[0]}" | ||
| else | ||
| echo "FATAL ERROR: Could not detect the python version" | ||
| exit 1 | ||
| fi | ||
| } | ||
| # shellcheck disable= | ||
|
|
||
| declare -xf generate_com | ||
| declare -xf wait_for_file | ||
| declare -xf detect_py |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters