Indicate in CLI when a partition was skipped or being verified, fix incorrect chunk size being shown. (#908)

* Indicate in CLI when a partition was skipped or being verified

* Fix target address alignment, and just append to last msg.

* Modify changelog with logs of changes

Author: nullstalgia

CHANGELOG.md

@@ -35,6 +35,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `flash_write_size` and `max_ram_block_size` functions no longer take a connection parameter and return a Result type (#903)
 - `DefaultProgressCallback` which implements `ProgressCallbacks` but all methods are no-ops (#904)
 - Update checks can now be skipped by setting the `ESPFLASH_SKIP_UPDATE_CHECK` environment variable (#900)
+- `ProgressCallbacks` now has a `verifying` method to notify when post-flash checksum checking has begun (#908)
 
 ### Changed
 
@@ -68,6 +69,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - The command module, and `Command` related structs now exist in a top level module, instead of the `connection` module (#901)
 - API's that take `Option<&mut dyn ProgressCallbacks>` now take `&mut dyn ProgressCallbacks` instead (#904)
 - `ProgressCallbacks::finish()` now has a `skipped: bool` parameter to indicate if a segment was skipped (#904)
+- CLI usage now shows when a segment has been skipped due to already-matching checksum and when a segment is being verified (#908)
 
 ### Fixed
 

espflash/src/cli/mod.rs

@@ -745,13 +745,14 @@ pub(crate) fn display_image_size(app_size: u32, part_size: Option<u32>) {
 #[derive(Debug, Default)]
 pub struct EspflashProgress {
     pb: Option<ProgressBar>,
+    verifying: bool,
 }
 
 impl ProgressCallbacks for EspflashProgress {
     /// Initialize the progress bar
     fn init(&mut self, addr: u32, len: usize) {
         let pb = ProgressBar::new(len as u64)
-            .with_message(format!("{addr:#X}"))
+            .with_message(format!("{addr:<#8X}"))
             .with_style(
                 ProgressStyle::default_bar()
                     .template("[{elapsed_precise}] [{bar:40}] {pos:>7}/{len:7} {msg}")
@@ -760,20 +761,43 @@ impl ProgressCallbacks for EspflashProgress {
             );
 
         self.pb = Some(pb);
+        self.verifying = false;
     }
 
     /// Update the progress bar
     fn update(&mut self, current: usize) {
-        if let Some(ref pb) = self.pb {
+        if let Some(pb) = &self.pb {
             pb.set_position(current as u64);
         }
     }
 
+    /// Tell user we're verifying the flashed data
+    fn verifying(&mut self) {
+        if let Some(pb) = &self.pb {
+            self.verifying = true;
+            let last_msg = pb.message();
+
+            pb.set_message(format!("{last_msg} Verifying..."));
+        }
+    }
+
     /// End the progress bar
-    fn finish(&mut self, _skipped: bool) {
-        if let Some(ref pb) = self.pb {
-            pb.finish();
+    fn finish(&mut self, skipped: bool) {
+        if let Some(pb) = &self.pb {
+            use crossterm::style::Stylize;
+            let last_msg = pb.message();
+
+            if skipped {
+                let skipped = "Skipped! (checksum matches)".cyan();
+                pb.finish_with_message(format!("{last_msg} {skipped}"));
+            } else if self.verifying {
+                let ok = "OK!".green();
+                pb.finish_with_message(format!("{last_msg} {ok}"));
+            } else {
+                pb.finish();
+            }
         }
+        self.verifying = false;
     }
 }
 

espflash/src/target/flash_target/esp32.rs

@@ -125,7 +125,7 @@ impl FlashTarget for Esp32Target {
         let chunks = compressed.chunks(flash_write_size);
         let num_chunks = chunks.len();
 
-        progress.init(addr, num_chunks + self.verify as usize);
+        progress.init(addr, num_chunks);
 
         if self.skip {
             let flash_checksum_md5: u128 = connection.with_timeout(
@@ -190,6 +190,7 @@ impl FlashTarget for Esp32Target {
         }
 
         if self.verify {
+            progress.verifying();
             let flash_checksum_md5: u128 = connection.with_timeout(
                 CommandType::FlashMd5.timeout_for_size(segment.data.len() as u32),
                 |connection| {
@@ -206,7 +207,6 @@ impl FlashTarget for Esp32Target {
                 return Err(Error::VerifyFailed);
             }
             debug!("Segment at address '0x{addr:x}' verified successfully");
-            progress.update(num_chunks + 1)
         }
 
         progress.finish(false);

espflash/src/target/flash_target/mod.rs

@@ -27,6 +27,8 @@ pub trait ProgressCallbacks {
     fn init(&mut self, addr: u32, total: usize);
     /// Update some progress report.
     fn update(&mut self, current: usize);
+    /// Indicate post-flash checksum verification has begun.
+    fn verifying(&mut self);
     /// Finish some progress report.
     fn finish(&mut self, skipped: bool);
 }
@@ -38,5 +40,6 @@ pub struct DefaultProgressCallback;
 impl ProgressCallbacks for DefaultProgressCallback {
     fn init(&mut self, _addr: u32, _total: usize) {}
     fn update(&mut self, _current: usize) {}
+    fn verifying(&mut self) {}
     fn finish(&mut self, _skipped: bool) {}
 }