Add back the image format tests which had been previously removed (#266)

* Test the ESP8266 image format

* Test the IDF bootloader image format

* Add a README documenting how to generate the test resources

Author: jessebraham

espflash/src/image_format/esp8266.rs

@@ -161,3 +161,26 @@ fn encode_flash_size(size: FlashSize) -> Result<u8, FlashDetectError> {
         _ => Err(FlashDetectError::from(size as u8)),
     }
 }
+
+#[cfg(test)]
+mod tests {
+    use std::fs;
+
+    use super::*;
+    use crate::elf::ElfFirmwareImage;
+
+    #[test]
+    fn test_esp8266_image_format() {
+        let input_bytes = fs::read("tests/resources/esp8266_hal_blinky").unwrap();
+        let expected_bin = fs::read("tests/resources/esp8266_hal_blinky.bin").unwrap();
+
+        let image = ElfFirmwareImage::try_from(input_bytes.as_slice()).unwrap();
+        let flash_image = Esp8266Format::new(&image, None, None, None).unwrap();
+
+        let segments = flash_image.flash_segments().collect::<Vec<_>>();
+        let buf = segments[0].data.as_ref();
+
+        assert_eq!(expected_bin.len(), buf.len());
+        assert_eq!(expected_bin.as_slice(), buf);
+    }
+}

espflash/src/image_format/idf_bootloader.rs

@@ -327,3 +327,38 @@ fn save_segment(data: &mut Vec<u8>, segment: &CodeSegment, checksum: u8) -> Resu
 
     Ok(update_checksum(segment.data(), checksum))
 }
+
+#[cfg(test)]
+pub mod tests {
+    use std::fs;
+
+    use super::*;
+    use crate::elf::ElfFirmwareImage;
+
+    // Copied from: src/targets/esp32.rs
+    const PARAMS: Esp32Params = Esp32Params::new(
+        0x1000,
+        0x1_0000,
+        0x3f_0000,
+        0,
+        include_bytes!("../../resources/bootloaders/esp32-bootloader.bin"),
+    );
+
+    #[test]
+    fn test_idf_bootloader_format() {
+        let input_bytes = fs::read("tests/resources/esp32_hal_blinky").unwrap();
+        let expected_bin = fs::read("tests/resources/esp32_hal_blinky.bin").unwrap();
+
+        let image = ElfFirmwareImage::try_from(input_bytes.as_slice()).unwrap();
+        let flash_image =
+            IdfBootloaderFormat::new(&image, Chip::Esp32, PARAMS, None, None, None, None, None)
+                .unwrap();
+
+        let segments = flash_image.flash_segments().collect::<Vec<_>>();
+        assert_eq!(segments.len(), 3);
+
+        let buf = segments[2].data.as_ref();
+        assert_eq!(expected_bin.len(), buf.len());
+        assert_eq!(expected_bin.as_slice(), buf);
+    }
+}

espflash/tests/README.md

@@ -0,0 +1,31 @@
+# Test Resources
+
+This document describes how the test files under `tests/resources` were generated, so that they can be re-generated in the future if needed.
+
+## IDF Bootloader
+
+```bash
+$ git clone https://github.com/esp-rs/esp-hal
+$ cd esp32-hal/
+$ cargo build --release --example=blinky
+```
+
+The ELF file is located at `target/xtensa-esp32-none-elf/examples/blinky`
+
+```bash
+$ espflash save-image --chip=esp32 esp32_hal_blinky.bin esp32_hal_blinky
+```
+
+## ESP8266
+
+```bash
+$ git clone https://github.com/esp-rs/esp8266-hal
+$ cd esp8266-hal/
+$ cargo build --release --example=blinky
+```
+
+The ELF file is located at `target/xtensa-esp8266-none-elf/examples/blinky`
+
+```bash
+$ espflash save-image --chip=esp8266 esp8266_hal_blinky.bin esp8266_hal_blinky
+```