From ead2d03a91fa9bb2c24d2ece16f3bede22c6d556 Mon Sep 17 00:00:00 2001 From: Rob Loach Date: Thu, 3 Oct 2024 00:27:28 -0400 Subject: [PATCH] plugins: Improve progress plugin --- plugins/progress/README.md | 4 +- plugins/progress/progress.plugin.sh | 79 +++++++++++++++++++---------- 2 files changed, 55 insertions(+), 28 deletions(-) diff --git a/plugins/progress/README.md b/plugins/progress/README.md index 5d4e226ef..5491c0c8c 100644 --- a/plugins/progress/README.md +++ b/plugins/progress/README.md @@ -22,8 +22,8 @@ Bash. The function handles printing of the progress bar. 2. **Invoke `progress` Function:** - Within a shell function, call the `progress` function whenever you want to display the progress bar. - Pass two parameters to the `progress` function: - - `PARAM_PROGRESS`: The progress percentage (0-100) of the task. - - `PARAM_STATUS`: Optional. A status message to display alongside the progress bar. + - `value`: The progress percentage (0-100) of the task. Passing 0 will reset the progress bar status. + - `message`: Optional. A status message to display alongside the progress bar. ```bash # Example usage: diff --git a/plugins/progress/progress.plugin.sh b/plugins/progress/progress.plugin.sh index b00cb536d..a141016ad 100644 --- a/plugins/progress/progress.plugin.sh +++ b/plugins/progress/progress.plugin.sh @@ -17,6 +17,8 @@ ################################################################################ +# Global variable to store progress value +_omb_plugin_progress_value=0 # # Description : delay executing script @@ -29,32 +31,57 @@ function delay() # # Description : print out executing progress # -CURRENT_PROGRESS=0 function progress() { - PARAM_PROGRESS=$1; - PARAM_STATUS=$2; - - if [ $CURRENT_PROGRESS -le 0 -a $PARAM_PROGRESS -ge 0 ] ; then printf "[..........................] (0%) %s \r" "$PARAM_PHASE" ; delay; fi; - if [ $CURRENT_PROGRESS -le 5 -a $PARAM_PROGRESS -ge 5 ] ; then printf "[#.........................] (5%) %s \r" "$PARAM_PHASE" ; delay; fi; - if [ $CURRENT_PROGRESS -le 10 -a $PARAM_PROGRESS -ge 10 ]; then printf "[##........................] (10%) %s \r" "$PARAM_PHASE" ; delay; fi; - if [ $CURRENT_PROGRESS -le 15 -a $PARAM_PROGRESS -ge 15 ]; then printf "[###.......................] (15%) %s \r" "$PARAM_PHASE" ; delay; fi; - if [ $CURRENT_PROGRESS -le 20 -a $PARAM_PROGRESS -ge 20 ]; then printf "[####......................] (20%) %s \r" "$PARAM_PHASE" ; delay; fi; - if [ $CURRENT_PROGRESS -le 25 -a $PARAM_PROGRESS -ge 25 ]; then printf "[#####.....................] (25%) %s \r" "$PARAM_PHASE" ; delay; fi; - if [ $CURRENT_PROGRESS -le 30 -a $PARAM_PROGRESS -ge 30 ]; then printf "[######....................] (30%) %s \r" "$PARAM_PHASE" ; delay; fi; - if [ $CURRENT_PROGRESS -le 35 -a $PARAM_PROGRESS -ge 35 ]; then printf "[#######...................] (35%) %s \r" "$PARAM_PHASE" ; delay; fi; - if [ $CURRENT_PROGRESS -le 40 -a $PARAM_PROGRESS -ge 40 ]; then printf "[########..................] (40%) %s \r" "$PARAM_PHASE" ; delay; fi; - if [ $CURRENT_PROGRESS -le 45 -a $PARAM_PROGRESS -ge 45 ]; then printf "[#########.................] (45%) %s \r" "$PARAM_PHASE" ; delay; fi; - if [ $CURRENT_PROGRESS -le 50 -a $PARAM_PROGRESS -ge 50 ]; then printf "[##########................] (50%) %s \r" "$PARAM_PHASE" ; delay; fi; - if [ $CURRENT_PROGRESS -le 55 -a $PARAM_PROGRESS -ge 55 ]; then printf "[###########...............] (55%) %s \r" "$PARAM_PHASE" ; delay; fi; - if [ $CURRENT_PROGRESS -le 60 -a $PARAM_PROGRESS -ge 60 ]; then printf "[############..............] (60%) %s \r" "$PARAM_PHASE" ; delay; fi; - if [ $CURRENT_PROGRESS -le 65 -a $PARAM_PROGRESS -ge 65 ]; then printf "[#############.............] (65%) %s \r" "$PARAM_PHASE" ; delay; fi; - if [ $CURRENT_PROGRESS -le 70 -a $PARAM_PROGRESS -ge 70 ]; then printf "[###############...........] (70%) %s \r" "$PARAM_PHASE" ; delay; fi; - if [ $CURRENT_PROGRESS -le 75 -a $PARAM_PROGRESS -ge 75 ]; then printf "[#################.........] (75%) %s \r" "$PARAM_PHASE" ; delay; fi; - if [ $CURRENT_PROGRESS -le 80 -a $PARAM_PROGRESS -ge 80 ]; then printf "[####################......] (80%) %s \r" "$PARAM_PHASE" ; delay; fi; - if [ $CURRENT_PROGRESS -le 85 -a $PARAM_PROGRESS -ge 85 ]; then printf "[#######################...] (90%) %s \r" "$PARAM_PHASE" ; delay; fi; - if [ $CURRENT_PROGRESS -le 90 -a $PARAM_PROGRESS -ge 90 ]; then printf "[##########################] (100%) %s \r" "$PARAM_PHASE"; delay; fi; - if [ $CURRENT_PROGRESS -le 100 -a $PARAM_PROGRESS -ge 100 ];then printf 'Done! \n' ; delay; fi; - - CURRENT_PROGRESS=$PARAM_PROGRESS; + local value=$1; + local message=$2; + + if [ -z $value ]; then + printf "Usage: progress [message]\n\n" + printf "Options:\n" + printf " value The value for the progress bar. Use 0 to reset.\n" + printf " message The optional message to display next to the progress bar.\n" + return 0 + fi + + if [ $value -lt 0 ]; then + _omb_log_error "invalid value: value' (expect: 0-100)" >&2 + return 2 + fi + + # Reset the progress value + if [ $value -eq 0 ]; then + _omb_plugin_progress_value=0; + return 0 + fi + + # Clear the message whitespace + local size=40-${#message} + local whitespace="" + for ((i=0; i