Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move bash utility functions out of preamble #2447

Merged
merged 4 commits into from
Apr 2, 2024
Merged

Move bash utility functions out of preamble #2447

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c6f4292
Move bash utility functions out of preamble
WalterKolczynski-NOAA Apr 1, 2024
1c78ea6
Rename the bash function script to bash_utils
WalterKolczynski-NOAA Apr 1, 2024
b559e1f
Add final blank line to bash_utils
WalterKolczynski-NOAA Apr 1, 2024
91caa7a
Group function exports at bottom of bash utils
WalterKolczynski-NOAA Apr 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions ush/bash_functions.sh
View file
Open in desktop

This file was deleted.

127 changes: 127 additions & 0 deletions ush/bash_utils.sh
View file
Open in desktop
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
126 changes: 1 addition & 125 deletions ush/preamble.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,131 +107,7 @@ postamble() {
trap "postamble ${_calling_script} ${start_time} \$?" EXIT
# shellcheck disable=

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}"
echo "generate_com :: ${com_var}=${value}"
done
set_trace
}
# shellcheck disable=
declare -xf generate_com

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
}
declare -xf wait_for_file

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 detect_py

source "${HOMEgfs}/ush/bash_utils.sh"

# Turn on our settings
set_strict
Expand Down
Loading