isar-installer: show progress bar during bmaptool copy process

Message ID 20250318052012.4701-1-kasturi.shekar@siemens.com
State Superseded
Headers show
Series isar-installer: show progress bar during bmaptool copy process | expand

Commit Message

Kasturi Shekar March 18, 2025, 5:20 a.m. UTC
- Added support for a progress gauge using a named pipe to capture and display
 percentage progress when using `bmaptool`.
- The progress bar is displayed only when the `bmaptool` version is 3.8 or above,
 as versions prior to 3.8 has some issues with `--psplash-pipe` flag.
- For `bmaptool` versions below 3.8, the image copy process continues without a
 progress bar to maintain compatibility.
- The gauge uses `dialog --gauge` to dynamically update the progress based on
 output from the `bmaptool` process.

Signed-off-by: Kasturi Shekar <kasturi.shekar@siemens.com>
---
 .../files/usr/bin/deploy-image-wic.sh         | 38 ++++++++++++++++++-
 1 file changed, 37 insertions(+), 1 deletion(-)

Comments

Jan Kiszka March 18, 2025, 6:05 a.m. UTC | #1
Please always version our patches, or you will only create confusion for
reviewers and maintainers. This would be "PATCH v5" now.

Jan

On 18.03.25 06:20, 'Kasturi Shekar' via isar-users wrote:
> - Added support for a progress gauge using a named pipe to capture and display
>  percentage progress when using `bmaptool`.
> - The progress bar is displayed only when the `bmaptool` version is 3.8 or above,
>  as versions prior to 3.8 has some issues with `--psplash-pipe` flag.
> - For `bmaptool` versions below 3.8, the image copy process continues without a
>  progress bar to maintain compatibility.
> - The gauge uses `dialog --gauge` to dynamically update the progress based on
>  output from the `bmaptool` process.
> 
> Signed-off-by: Kasturi Shekar <kasturi.shekar@siemens.com>
> ---
>  .../files/usr/bin/deploy-image-wic.sh         | 38 ++++++++++++++++++-
>  1 file changed, 37 insertions(+), 1 deletion(-)
> 
> diff --git a/meta-isar/recipes-installer/deploy-image/files/usr/bin/deploy-image-wic.sh b/meta-isar/recipes-installer/deploy-image/files/usr/bin/deploy-image-wic.sh
> index 7f552eee..66c35506 100755
> --- a/meta-isar/recipes-installer/deploy-image/files/usr/bin/deploy-image-wic.sh
> +++ b/meta-isar/recipes-installer/deploy-image/files/usr/bin/deploy-image-wic.sh
> @@ -149,7 +149,43 @@ if ! $installer_unattended; then
>      clear
>  fi
>  
> -if ! bmaptool copy ${bmap_options} "$installer_image_uri" "${installer_target_dev}"; then
> +# Function to compare version numbers
> +version_ge() {
> +    if [ "$(printf '%s\n' "$1"X "$2" | sort -V | head -n 1)" != "$1"X ]; then
> +        return 0
> +    else
> +        return 1
> +    fi
> +}
> +
> +# Get bmap-tools version
> +bmap_version=$(bmaptool --version | awk '{ print $NF }')
> +
> +if version_ge "$bmap_version" "3.8"; then
> +    # Create a named pipe for progress communication
> +    progress_pipe="/tmp/progress"
> +    if ! mkfifo "$progress_pipe"; then
> +        echo "Error: Failed to create named pipe $progress_pipe"
> +        exit 1
> +    fi
> +
> +    # Add psplash pipe to bmap_options
> +    bmap_options="$bmap_options --psplash-pipe=$progress_pipe"
> +    quiet_flag="-q"
> +
> +    # Initialize the dialog gauge and update it dynamically
> +    (
> +        while true; do
> +            if read -r line < "$progress_pipe"; then
> +                percentage=$(echo "$line" | awk '{ print $2 }')
> +                echo "$percentage"
> +            fi
> +        done
> +    ) | dialog --gauge "Flashing image, please wait..." 10 70 0 &
> +
> +fi
> +
> +if ! bmaptool ${quiet_flag} copy ${bmap_options} "$installer_image_uri" "${installer_target_dev}"; then
>      exit 1
>  fi
>

Patch

diff --git a/meta-isar/recipes-installer/deploy-image/files/usr/bin/deploy-image-wic.sh b/meta-isar/recipes-installer/deploy-image/files/usr/bin/deploy-image-wic.sh
index 7f552eee..66c35506 100755
--- a/meta-isar/recipes-installer/deploy-image/files/usr/bin/deploy-image-wic.sh
+++ b/meta-isar/recipes-installer/deploy-image/files/usr/bin/deploy-image-wic.sh
@@ -149,7 +149,43 @@  if ! $installer_unattended; then
     clear
 fi
 
-if ! bmaptool copy ${bmap_options} "$installer_image_uri" "${installer_target_dev}"; then
+# Function to compare version numbers
+version_ge() {
+    if [ "$(printf '%s\n' "$1"X "$2" | sort -V | head -n 1)" != "$1"X ]; then
+        return 0
+    else
+        return 1
+    fi
+}
+
+# Get bmap-tools version
+bmap_version=$(bmaptool --version | awk '{ print $NF }')
+
+if version_ge "$bmap_version" "3.8"; then
+    # Create a named pipe for progress communication
+    progress_pipe="/tmp/progress"
+    if ! mkfifo "$progress_pipe"; then
+        echo "Error: Failed to create named pipe $progress_pipe"
+        exit 1
+    fi
+
+    # Add psplash pipe to bmap_options
+    bmap_options="$bmap_options --psplash-pipe=$progress_pipe"
+    quiet_flag="-q"
+
+    # Initialize the dialog gauge and update it dynamically
+    (
+        while true; do
+            if read -r line < "$progress_pipe"; then
+                percentage=$(echo "$line" | awk '{ print $2 }')
+                echo "$percentage"
+            fi
+        done
+    ) | dialog --gauge "Flashing image, please wait..." 10 70 0 &
+
+fi
+
+if ! bmaptool ${quiet_flag} copy ${bmap_options} "$installer_image_uri" "${installer_target_dev}"; then
     exit 1
 fi