isar-installer: show progress bar during bmaptool copy process

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

Commit Message

Kasturi Shekar March 6, 2025, 10:28 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         | 44 ++++++++++++++++++-
 1 file changed, 42 insertions(+), 2 deletions(-)

Comments

Jan Kiszka March 7, 2025, 10:41 a.m. UTC | #1
On 06.03.25 11:28, '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.

Which issues were these? Is there some related upstream or Debian bug?

3.8 means trixie, just to clearify.

> - 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         | 44 ++++++++++++++++++-
>  1 file changed, 42 insertions(+), 2 deletions(-)
> 
> 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..1265d0cc 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,8 +149,48 @@ if ! $installer_unattended; then
>      clear
>  fi
>  
> -if ! bmaptool copy ${bmap_options} "$installer_image_uri" "${installer_target_dev}"; then
> -    exit 1
> +# Function to compare version numbers
> +version_gt() {
> +    if [ "$(printf '%s\n' "$1" "$2" | sort -V | head -n 1)" != "$1" ]; then

This should be possible as well:

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 using dpkg-query
> +bmap_version=$(dpkg-query -W -f='${Version}' bmap-tools | awk -F'[~+-]' '{ print $1 }')
> +
> +if version_gt "$bmap_version" "3.8" || [ "$bmap_version" = "3.8" ]; then

... and will obsolete the second test.

> +    # 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
> +
> +    # 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 &
> +
> +    # Run bmaptool with psplash for versions greater than or equal to 3.8

The version tests are done above - commenting here is a bit confusing.

> +    if ! bmaptool -q copy ${bmap_options} --psplash-pipe="$progress_pipe" "$installer_image_uri" "$installer_target_dev"; then
> +        exit 1
> +    fi
> +
> +    # Clean up the named pipe after completion
> +    rm "$progress_pipe"
> +
> +else
> +    if ! bmaptool copy ${bmap_options} "$installer_image_uri" "$installer_target_dev"; then
> +        exit 1
> +    fi
>  fi
>  
>  if ! $installer_unattended; then

Didn't try yet, but I can imagine that it looks nice :)

Jan
Kasturi Shekar March 10, 2025, 5:25 a.m. UTC | #2
-----Original Message-----
From: Kiszka, Jan (FT RPD CED) <jan.kiszka@siemens.com> 
Sent: 07 March 2025 16:11
To: Shekar, Kasturi (FT FDS CES LX PBU 2) <kasturi.shekar@siemens.com>; isar-users@googlegroups.com
Subject: Re: [PATCH] isar-installer: show progress bar during bmaptool copy process

On 06.03.25 11:28, '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.

Which issues were these? Is there some related upstream or Debian bug?

3.8 means trixie, just to clearify.

Yes, it’s a Debian issue and 3.8 is Trixie. 

> - 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         | 44 ++++++++++++++++++-
>  1 file changed, 42 insertions(+), 2 deletions(-)
> 
> 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..1265d0cc 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-im
> +++ age-wic.sh
> @@ -149,8 +149,48 @@ if ! $installer_unattended; then
>      clear
>  fi
>  
> -if ! bmaptool copy ${bmap_options} "$installer_image_uri" "${installer_target_dev}"; then
> -    exit 1
> +# Function to compare version numbers
> +version_gt() {
> +    if [ "$(printf '%s\n' "$1" "$2" | sort -V | head -n 1)" != "$1" 
> +]; then

This should be possible as well:

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 using dpkg-query bmap_version=$(dpkg-query 
> +-W -f='${Version}' bmap-tools | awk -F'[~+-]' '{ print $1 }')
> +
> +if version_gt "$bmap_version" "3.8" || [ "$bmap_version" = "3.8" ]; 
> +then

... and will obsolete the second test.

> +    # 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
> +
> +    # 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 &
> +
> +    # Run bmaptool with psplash for versions greater than or equal to 
> + 3.8

The version tests are done above - commenting here is a bit confusing.

> +    if ! bmaptool -q copy ${bmap_options} --psplash-pipe="$progress_pipe" "$installer_image_uri" "$installer_target_dev"; then
> +        exit 1
> +    fi
> +
> +    # Clean up the named pipe after completion
> +    rm "$progress_pipe"
> +
> +else
> +    if ! bmaptool copy ${bmap_options} "$installer_image_uri" "$installer_target_dev"; then
> +        exit 1
> +    fi
>  fi
>  
>  if ! $installer_unattended; then

Didn't try yet, but I can imagine that it looks nice :)

Jan

--
Siemens AG, Foundational Technologies
Linux Expert Center
Kasturi Shekar March 10, 2025, 5:40 a.m. UTC | #3
-----Original Message-----
From: Kiszka, Jan (FT RPD CED) <jan.kiszka@siemens.com>
Sent: 07 March 2025 16:11
To: Shekar, Kasturi (FT FDS CES LX PBU 2) <kasturi.shekar@siemens.com>; isar-users@googlegroups.com
Subject: Re: [PATCH] isar-installer: show progress bar during bmaptool copy process

On 06.03.25 11:28, '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.

Which issues were these? Is there some related upstream or Debian bug?

3.8 means trixie, just to clearify.

Yes, it’s a Debian issue and 3.8 is Trixie. https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1034290

> - 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         | 44 ++++++++++++++++++-
>  1 file changed, 42 insertions(+), 2 deletions(-)
> 
> 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..1265d0cc 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-im
> +++ age-wic.sh
> @@ -149,8 +149,48 @@ if ! $installer_unattended; then
>      clear
>  fi
>  
> -if ! bmaptool copy ${bmap_options} "$installer_image_uri" "${installer_target_dev}"; then
> -    exit 1
> +# Function to compare version numbers
> +version_gt() {
> +    if [ "$(printf '%s\n' "$1" "$2" | sort -V | head -n 1)" != "$1" 
> +]; then

This should be possible as well:

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 using dpkg-query bmap_version=$(dpkg-query 
> +-W -f='${Version}' bmap-tools | awk -F'[~+-]' '{ print $1 }')
> +
> +if version_gt "$bmap_version" "3.8" || [ "$bmap_version" = "3.8" ]; 
> +then

... and will obsolete the second test.

> +    # 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
> +
> +    # 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 &
> +
> +    # Run bmaptool with psplash for versions greater than or equal to
> + 3.8

The version tests are done above - commenting here is a bit confusing.

> +    if ! bmaptool -q copy ${bmap_options} --psplash-pipe="$progress_pipe" "$installer_image_uri" "$installer_target_dev"; then
> +        exit 1
> +    fi
> +
> +    # Clean up the named pipe after completion
> +    rm "$progress_pipe"
> +
> +else
> +    if ! bmaptool copy ${bmap_options} "$installer_image_uri" "$installer_target_dev"; then
> +        exit 1
> +    fi
>  fi
>  
>  if ! $installer_unattended; then

Didn't try yet, but I can imagine that it looks nice :)

Jan

--
Siemens AG, Foundational Technologies
Linux Expert Center
Jan Kiszka March 10, 2025, 6:29 a.m. UTC | #4
On 10.03.25 06:40, Shekar, Kasturi (FT FDS CES LX PBU 2) wrote:
> -----Original Message-----
> From: Kiszka, Jan (FT RPD CED) <jan.kiszka@siemens.com>
> Sent: 07 March 2025 16:11
> To: Shekar, Kasturi (FT FDS CES LX PBU 2) <kasturi.shekar@siemens.com>; isar-users@googlegroups.com
> Subject: Re: [PATCH] isar-installer: show progress bar during bmaptool copy process
> 
> On 06.03.25 11:28, '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.
> 
> Which issues were these? Is there some related upstream or Debian bug?
> 
> 3.8 means trixie, just to clearify.
> 
> Yes, it’s a Debian issue and 3.8 is Trixie. https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1034290
> 

Kasturi, please fix your email client settings so that you are inserting
proper citation markers ("> "), and your answers become easier
distinguishable.

Felix, did you try to motivate upstream for a stable fix as well?

Jan

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..1265d0cc 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,8 +149,48 @@  if ! $installer_unattended; then
     clear
 fi
 
-if ! bmaptool copy ${bmap_options} "$installer_image_uri" "${installer_target_dev}"; then
-    exit 1
+# Function to compare version numbers
+version_gt() {
+    if [ "$(printf '%s\n' "$1" "$2" | sort -V | head -n 1)" != "$1" ]; then
+        return 0
+    else
+        return 1
+    fi
+}
+
+# Get bmap-tools version using dpkg-query
+bmap_version=$(dpkg-query -W -f='${Version}' bmap-tools | awk -F'[~+-]' '{ print $1 }')
+
+if version_gt "$bmap_version" "3.8" || [ "$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
+
+    # 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 &
+
+    # Run bmaptool with psplash for versions greater than or equal to 3.8
+    if ! bmaptool -q copy ${bmap_options} --psplash-pipe="$progress_pipe" "$installer_image_uri" "$installer_target_dev"; then
+        exit 1
+    fi
+
+    # Clean up the named pipe after completion
+    rm "$progress_pipe"
+
+else
+    if ! bmaptool copy ${bmap_options} "$installer_image_uri" "$installer_target_dev"; then
+        exit 1
+    fi
 fi
 
 if ! $installer_unattended; then