From ef35efc4d320fcd42d61ef47baa309d30383d3ab Mon Sep 17 00:00:00 2001 From: Landon Curt Noll Date: Thu, 18 Jul 2024 13:37:44 -0700 Subject: [PATCH] canonicalize failure :-) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit We fix some error messages in a few bin scripts. Sorry (tm Canada 🇨) for the punny log message. --- bin/entry2csv.sh | 27 ++++++++++++++++++--------- bin/gen-status.sh | 6 +++--- bin/md2html.sh | 32 ++++++++++++++++---------------- 3 files changed, 37 insertions(+), 28 deletions(-) diff --git a/bin/entry2csv.sh b/bin/entry2csv.sh index c3d8950f0..103dd4d4a 100755 --- a/bin/entry2csv.sh +++ b/bin/entry2csv.sh @@ -100,7 +100,7 @@ shopt -s globstar # enable ** to match all files and zero or more directories an # set variables referenced in the usage message # -export VERSION="1.0.1 2024-07-14" +export VERSION="1.0.2 2024-07-14" NAME=$(basename "$0") export NAME export V_FLAG=0 @@ -270,6 +270,7 @@ Exit codes: $NAME version: $VERSION" + # parse command line # while getopts :hv:Vd:D:nNj: flag; do @@ -308,6 +309,7 @@ while getopts :hv:Vd:D:nNj: flag; do esac done + # remove the options # shift $(( OPTIND - 1 )); @@ -327,6 +329,7 @@ case "$#" in ;; esac + # if CSV files exist, verify that they are in a writable directory # if [[ -z $AUTHOR_WINS_CSV ]]; then @@ -340,8 +343,8 @@ if [[ ! -w $AUTHOR_WINS_CSV_DIR ]]; then exit 8 fi # -if [[ -z $AUTHOR_WINS_CSV ]]; then - echo "$0: ERROR: AUTHOR_WINS_CSV is empty" 1>&2 +if [[ -z $MANIFEST_CSV ]]; then + echo "$0: ERROR: MANIFEST_CSV is empty" 1>&2 exit 8 fi MANIFEST_WINS_CSV_DIR=$(dirname "$MANIFEST_CSV") @@ -362,6 +365,7 @@ if [[ ! -w $YEAR_PRIZE_CSV_DIR ]]; then exit 8 fi + # verify that we have a topdir directory # if [[ -z $TOPDIR ]]; then @@ -377,6 +381,7 @@ if [[ ! -d $TOPDIR ]]; then exit 6 fi + # cd to topdir # if [[ ! -e $TOPDIR ]]; then @@ -400,6 +405,7 @@ if [[ $V_FLAG -ge 3 ]]; then echo "$0: debug[3]: now in directory: $(/bin/pwd)" 1>&2 fi + # verify we have a non-empty readable .top file # export TOP_FILE=".top" @@ -420,6 +426,7 @@ if [[ ! -s $TOP_FILE ]]; then exit 6 fi + # verify that we have a bin subdirectory # export BIN_PATH="$TOPDIR/bin" @@ -445,6 +452,7 @@ if [[ ! -r $MANIFEST_ENTRY_CSV_ENTRY_AWK ]]; then exit 6 fi + # verify jparse tool # if [[ -z "$JPARSE_TOOL" ]]; then @@ -460,6 +468,7 @@ if [[ ! -x "$JPARSE_TOOL" ]]; then exit 5 fi + # print running info if verbose # # If -v 3 or higher, print exported variables in order that they were exported. @@ -487,6 +496,7 @@ if [[ $V_FLAG -ge 3 ]]; then echo "$0: debug[3]: MANIFEST_ENTRY_CSV_ENTRY_AWK=$MANIFEST_ENTRY_CSV_ENTRY_AWK" 1>&2 fi + # -N stops early before any processing is performed # if [[ -n $DO_NOT_PROCESS ]]; then @@ -592,7 +602,6 @@ elif [[ $V_FLAG -ge 3 ]]; then fi - # process each year # export YYYY @@ -830,7 +839,7 @@ for YYYY in $(< "$TOP_FILE"); do awk -f "$MANIFEST_ENTRY_CSV_ENTRY_AWK" "$ENTRY_JSON" >> "$TMP_MANIFEST_CSV" status="$?" if [[ status -ne 0 ]]; then - echo "$0: ERROR: awk -f $MANIFEST_ENTRY_CSV_ENTRY_AWK $ENTRY_JSON >> $TMP_MANIFEST_CSV," \ + echo "$0: ERROR: awk -f $MANIFEST_ENTRY_CSV_ENTRY_AWK $ENTRY_JSON >> $TMP_MANIFEST_CSV failed," \ "error code: $status" 1>&2 exit 8 fi @@ -860,7 +869,7 @@ if [[ -z $NOOP ]]; then sort "$TMP_AUTHOR_WIN" -o "$TMP_AUTHOR_WIN" status="$?" if [[ status -ne 0 ]]; then - echo "$0: ERROR: sort $TMP_AUTHOR_WIN -o $TMP_AUTHOR_WIN," \ + echo "$0: ERROR: sort $TMP_AUTHOR_WIN -o $TMP_AUTHOR_WIN failed," \ "error code: $status" 1>&2 exit 8 elif [[ $V_FLAG -ge 3 ]]; then @@ -929,7 +938,7 @@ if [[ -z $NOOP ]]; then sort -t, -k1d,1 -k2d,2 "$TMP_AUTHOR_WINS_CSV" -o "$TMP_AUTHOR_WINS_CSV" status="$?" if [[ status -ne 0 ]]; then - echo "$0: ERROR: sort -t, -k1d,1 -k2d,2 $TMP_AUTHOR_WINS_CSV -o $TMP_AUTHOR_WINS_CSV," \ + echo "$0: ERROR: sort -t, -k1d,1 -k2d,2 $TMP_AUTHOR_WINS_CSV -o $TMP_AUTHOR_WINS_CSV failed," \ "error code: $status" 1>&2 EXIT_CODE=8 # exit 8 elif [[ $V_FLAG -ge 3 ]]; then @@ -994,7 +1003,7 @@ if [[ -z $NOOP ]]; then sort -t, -k1,1 -k2d,2 -k4g,4 -k3d,3 -k5d,8 "$TMP_MANIFEST_CSV" -o "$TMP_MANIFEST_CSV" status="$?" if [[ status -ne 0 ]]; then - echo "$0: ERROR: sort -t, -k1,1 -k2d,2 -k4n,4 -k3d,3 -k5d,8 $TMP_MANIFEST_CSV -o $TMP_MANIFEST_CSV," \ + echo "$0: ERROR: sort -t, -k1,1 -k2d,2 -k4n,4 -k3d,3 -k5d,8 $TMP_MANIFEST_CSV -o $TMP_MANIFEST_CSV failed," \ "error code: $status" 1>&2 EXIT_CODE=8 # exit 8 elif [[ $V_FLAG -ge 3 ]]; then @@ -1059,7 +1068,7 @@ if [[ -z $NOOP ]]; then sort -t, -k1d,1 -k2d,2 "$TMP_YEAR_PRIZE_CSV" -o "$TMP_YEAR_PRIZE_CSV" status="$?" if [[ status -ne 0 ]]; then - echo "$0: ERROR: sort -t, -k1d,1 -k2d,2 $TMP_YEAR_PRIZE_CSV -o $TMP_YEAR_PRIZE_CSV," \ + echo "$0: ERROR: sort -t, -k1d,1 -k2d,2 $TMP_YEAR_PRIZE_CSV -o $TMP_YEAR_PRIZE_CSV failed," \ "error code: $status" 1>&2 EXIT_CODE=8 # exit 8 elif [[ $V_FLAG -ge 3 ]]; then diff --git a/bin/gen-status.sh b/bin/gen-status.sh index 7b0bb0fac..70e9230fb 100755 --- a/bin/gen-status.sh +++ b/bin/gen-status.sh @@ -84,7 +84,7 @@ shopt -s globstar # enable ** to match all files and zero or more directories an # set variables referenced in the usage message # -export VERSION="1.5.3 2024-06-21" +export VERSION="1.5.4 2024-07-18" NAME=$(basename "$0") export NAME export V_FLAG=0 @@ -1114,7 +1114,7 @@ if [[ -z $NOOP ]]; then "$RULES_MD" >> "$TMP_RULES_MD" status="$?" if [[ $status -ne 0 ]]; then - echo "$0: ERROR: failed to sed -e '1,//d' $RULES_MD >> $TMP_RULES_MD," \ + echo "$0: ERROR: failed to sed -e '1,//d' $RULES_MD >> $TMP_RULES_MD failed," \ "error code: $status" 1>&2 exit 26 fi @@ -1198,7 +1198,7 @@ if [[ -z $NOOP ]]; then "$GUIDELINES_MD" >> "$TMP_GUIDELINES_MD" status="$?" if [[ $status -ne 0 ]]; then - echo "$0: ERROR: failed to sed -e '1,//d' $GUIDELINES_MD >> $TMP_GUIDELINES_MD," \ + echo "$0: ERROR: failed to sed -e '1,//d' $GUIDELINES_MD >> $TMP_GUIDELINES_MD failed," \ "error code: $status" 1>&2 exit 30 fi diff --git a/bin/md2html.sh b/bin/md2html.sh index b565d06a5..e8a1e696b 100755 --- a/bin/md2html.sh +++ b/bin/md2html.sh @@ -141,7 +141,7 @@ shopt -s lastpipe # run last command of a pipeline not executed in the backgroun # set variables referenced in the usage message # -export VERSION="1.5.1 2024-04-28" +export VERSION="1.5.2 2024-07-18" NAME=$(basename "$0") export NAME export V_FLAG=0 @@ -978,7 +978,7 @@ function append_html_phase sed -f "$SED_SCRIPT" "$PHASE_FILE" > "$TMP_PHASE_FILE" status="$?" if [[ $status -ne 0 ]]; then - echo "$0: ERROR: sed error on HTML phase $PHASE_NUMBER ($NAME_OF_PHASE) file: $PHASE_FILE," \ + echo "$0: ERROR: sed error on HTML phase $PHASE_NUMBER ($NAME_OF_PHASE) file: $PHASE_FILE failed," \ "error code: $status" 1>&2 return $(( STARTING_EXIT_CODE+1 )) fi @@ -1022,7 +1022,7 @@ function append_html_phase cat "$TMP_PHASE_FILE" >> "$TMP_APPEND" status="$?" if [[ $status -ne 0 ]]; then - echo "$0: ERROR: cat $TMP_PHASE_FILE >> $TMP_APPEND for HTML phase $PHASE_NUMBER ($NAME_OF_PHASE)," \ + echo "$0: ERROR: cat $TMP_PHASE_FILE >> $TMP_APPEND for HTML phase $PHASE_NUMBER ($NAME_OF_PHASE) failed," \ "error code: $status" 1>&2 return $(( STARTING_EXIT_CODE+3 )) fi @@ -1798,7 +1798,7 @@ append_html_phase "$CUR_PHASE_NUM" "$CUR_PHASE_NAME" "$BASE_EXIT_CODE" "$TMP_SED status="$?" if [[ $status -ne 0 ]]; then echo "$0: ERROR: append_html_phase" \ - "$CUR_PHASE_NUM $CUR_PHASE_NAME $BASE_EXIT_CODE $TMP_SED_SCRIPT $TMP_PHASE $TMP_INDEX_HTML," \ + "$CUR_PHASE_NUM $CUR_PHASE_NAME $BASE_EXIT_CODE $TMP_SED_SCRIPT $TMP_PHASE $TMP_INDEX_HTML failed," \ "error code: $status" 1>&2 exit "$status" fi @@ -1817,7 +1817,7 @@ append_html_phase "$CUR_PHASE_NUM" "$CUR_PHASE_NAME" "$BASE_EXIT_CODE" "$TMP_SED status="$?" if [[ $status -ne 0 ]]; then echo "$0: ERROR: append_html_phase" \ - "$CUR_PHASE_NUM $CUR_PHASE_NAME $BASE_EXIT_CODE $TMP_SED_SCRIPT $TMP_PHASE $TMP_INDEX_HTML," \ + "$CUR_PHASE_NUM $CUR_PHASE_NAME $BASE_EXIT_CODE $TMP_SED_SCRIPT $TMP_PHASE $TMP_INDEX_HTML failed," \ "error code: $status" 1>&2 exit "$status" fi @@ -1867,7 +1867,7 @@ append_html_phase "$CUR_PHASE_NUM" "$CUR_PHASE_NAME" "$BASE_EXIT_CODE" "$TMP_SED status="$?" if [[ $status -ne 0 ]]; then echo "$0: ERROR: append_html_phase" \ - "$CUR_PHASE_NUM $CUR_PHASE_NAME $BASE_EXIT_CODE $TMP_SED_SCRIPT $TMP_PHASE $TMP_INDEX_HTML," \ + "$CUR_PHASE_NUM $CUR_PHASE_NAME $BASE_EXIT_CODE $TMP_SED_SCRIPT $TMP_PHASE $TMP_INDEX_HTML failed," \ "error code: $status" 1>&2 exit "$status" fi @@ -1886,7 +1886,7 @@ append_html_phase "$CUR_PHASE_NUM" "$CUR_PHASE_NAME" "$BASE_EXIT_CODE" "$TMP_SED status="$?" if [[ $status -ne 0 ]]; then echo "$0: ERROR: append_html_phase" \ - "$CUR_PHASE_NUM $CUR_PHASE_NAME $BASE_EXIT_CODE $TMP_SED_SCRIPT $TMP_PHASE $TMP_INDEX_HTML," \ + "$CUR_PHASE_NUM $CUR_PHASE_NAME $BASE_EXIT_CODE $TMP_SED_SCRIPT $TMP_PHASE $TMP_INDEX_HTML failed," \ "error code: $status" 1>&2 exit "$status" fi @@ -1905,7 +1905,7 @@ append_html_phase "$CUR_PHASE_NUM" "$CUR_PHASE_NAME" "$BASE_EXIT_CODE" "$TMP_SED status="$?" if [[ $status -ne 0 ]]; then echo "$0: ERROR: append_html_phase" \ - "$CUR_PHASE_NUM $CUR_PHASE_NAME $BASE_EXIT_CODE $TMP_SED_SCRIPT $TMP_PHASE $TMP_INDEX_HTML," \ + "$CUR_PHASE_NUM $CUR_PHASE_NAME $BASE_EXIT_CODE $TMP_SED_SCRIPT $TMP_PHASE $TMP_INDEX_HTML failed," \ "error code: $status" 1>&2 exit "$status" fi @@ -1924,7 +1924,7 @@ append_html_phase "$CUR_PHASE_NUM" "$CUR_PHASE_NAME" "$BASE_EXIT_CODE" "$TMP_SED status="$?" if [[ $status -ne 0 ]]; then echo "$0: ERROR: append_html_phase" \ - "$CUR_PHASE_NUM $CUR_PHASE_NAME $BASE_EXIT_CODE $TMP_SED_SCRIPT $TMP_PHASE $TMP_INDEX_HTML," \ + "$CUR_PHASE_NUM $CUR_PHASE_NAME $BASE_EXIT_CODE $TMP_SED_SCRIPT $TMP_PHASE $TMP_INDEX_HTML failed," \ "error code: $status" 1>&2 exit "$status" fi @@ -1943,7 +1943,7 @@ append_html_phase "$CUR_PHASE_NUM" "$CUR_PHASE_NAME" "$BASE_EXIT_CODE" "$TMP_SED status="$?" if [[ $status -ne 0 ]]; then echo "$0: ERROR: append_html_phase" \ - "$CUR_PHASE_NUM $CUR_PHASE_NAME $BASE_EXIT_CODE $TMP_SED_SCRIPT $TMP_PHASE $TMP_INDEX_HTML," \ + "$CUR_PHASE_NUM $CUR_PHASE_NAME $BASE_EXIT_CODE $TMP_SED_SCRIPT $TMP_PHASE $TMP_INDEX_HTML failed," \ "error code: $status" 1>&2 exit "$status" fi @@ -2187,7 +2187,7 @@ append_html_phase "$CUR_PHASE_NUM" "$CUR_PHASE_NAME" "$BASE_EXIT_CODE" "$TMP_SED status="$?" if [[ $status -ne 0 ]]; then echo "$0: ERROR: append_html_phase" \ - "$CUR_PHASE_NUM $CUR_PHASE_NAME $BASE_EXIT_CODE $TMP_SED_SCRIPT $TMP_PHASE $TMP_INDEX_HTML," \ + "$CUR_PHASE_NUM $CUR_PHASE_NAME $BASE_EXIT_CODE $TMP_SED_SCRIPT $TMP_PHASE $TMP_INDEX_HTML failed," \ "error code: $status" 1>&2 exit "$status" fi @@ -2206,7 +2206,7 @@ append_html_phase "$CUR_PHASE_NUM" "$CUR_PHASE_NAME" "$BASE_EXIT_CODE" "$TMP_SED status="$?" if [[ $status -ne 0 ]]; then echo "$0: ERROR: append_html_phase" \ - "$CUR_PHASE_NUM $CUR_PHASE_NAME $BASE_EXIT_CODE $TMP_SED_SCRIPT $TMP_PHASE $TMP_INDEX_HTML," \ + "$CUR_PHASE_NUM $CUR_PHASE_NAME $BASE_EXIT_CODE $TMP_SED_SCRIPT $TMP_PHASE $TMP_INDEX_HTML failed," \ "error code: $status" 1>&2 exit "$status" fi @@ -2225,7 +2225,7 @@ append_html_phase "$CUR_PHASE_NUM" "$CUR_PHASE_NAME" "$BASE_EXIT_CODE" "$TMP_SED status="$?" if [[ $status -ne 0 ]]; then echo "$0: ERROR: append_html_phase" \ - "$CUR_PHASE_NUM $CUR_PHASE_NAME $BASE_EXIT_CODE $TMP_SED_SCRIPT $TMP_PHASE $TMP_INDEX_HTML," \ + "$CUR_PHASE_NUM $CUR_PHASE_NAME $BASE_EXIT_CODE $TMP_SED_SCRIPT $TMP_PHASE $TMP_INDEX_HTML failed," \ "error code: $status" 1>&2 exit "$status" fi @@ -2238,17 +2238,17 @@ fi # if [[ -z $NOOP ]]; then if [[ ! -e $TMP_INDEX_HTML ]]; then - echo "$0: ERROR: after HTML phase $CUR_PHASE_NUM ($CUR_PHASE_NAME)," \ + echo "$0: ERROR: after HTML phase $CUR_PHASE_NUM ($CUR_PHASE_NAME) failed," \ "temporary index HTML file is missing: $TMP_INDEX_HTML" 1>&2 exit 135 fi if [[ ! -f $TMP_INDEX_HTML ]]; then - echo "$0: ERROR: after HTML phase $CUR_PHASE_NUM ($CUR_PHASE_NAME)," \ + echo "$0: ERROR: after HTML phase $CUR_PHASE_NUM ($CUR_PHASE_NAME) failed," \ "temporary index HTML file is not a file: $TMP_INDEX_HTML" 1>&2 exit 136 fi if [[ ! -r $TMP_INDEX_HTML ]]; then - echo "$0: ERROR: after HTML phase $CUR_PHASE_NUM ($CUR_PHASE_NAME)," \ + echo "$0: ERROR: after HTML phase $CUR_PHASE_NUM ($CUR_PHASE_NAME) failed," \ "temporary index HTML file is not a readable file: $TMP_INDEX_HTML" 1>&2 exit 137 fi