tests: add some test cases for check and process functions.

Signed-off-by: DongQing <placebo27@hust.edu.cn>

Author: Placebo27

sophgo-rom-tool/src/lib.rs

@@ -1,34 +1,26 @@
 use core::mem::{size_of, size_of_val};
 use crc::{Crc, CRC_16_XMODEM};
 
-#[derive(Debug)]
+#[derive(Clone, Debug, PartialEq, Eq)]
 pub enum Error {
-    HeadLength {
-        wrong_length: usize,
-    },
-    MagicNumber {
-        wrong_magic: u32,
-    },
-    RawBlobMagic {
-        wrong_magic: [u8; 32],
-    },
-    ImageContentLength {
-        wrong_content_length: usize,
-        wrong_full_length: usize,
-    },
-    OutputBufferLength {
-        wrong_length: usize,
-    },
+    HeadLength { wrong_length: usize },
+    MagicNumber { wrong_magic: u32 },
+    RawBlobMagic { wrong_magic: [u8; 32] },
+    ImageFullLength { wrong_full_length: usize },
+    ImageContentLength { wrong_content_length: usize },
+    OutputBufferLength { wrong_length: usize },
 }
 
 pub type Result<T> = core::result::Result<T, Error>;
 
+#[derive(Clone, Debug, PartialEq, Eq)]
 pub struct Operations<'a> {
     pub refill_header: Option<HeaderInfo>,
     pub set_image_content: Option<&'a [u8]>,
     pub resize_image_full_length: usize,
 }
 
+#[derive(Clone, Debug, PartialEq, Eq)]
 pub struct HeaderInfo {
     pub blcp_image_checksum: u32,
     pub bl2_image_checksum: u32,
@@ -124,15 +116,19 @@ pub fn process(buf: &mut [u8], ops: &Operations) -> Result<()> {
         let param_checksum = 0xCAFE0000u32 + crc.checksum(&buf[0x10..0x800]) as u32;
         buf[0xC..0x10].copy_from_slice(&param_checksum.to_le_bytes())
     }
+    if ops.resize_image_full_length > u32::MAX as usize
+        || ops.resize_image_full_length < HEADER_LENGTH
+    {
+        return Err(Error::ImageFullLength {
+            wrong_full_length: ops.resize_image_full_length,
+        });
+    }
     if let Some(image) = &ops.set_image_content {
         if image.len() > u32::MAX as usize
-            || ops.resize_image_full_length > u32::MAX as usize
-            || ops.resize_image_full_length < HEADER_LENGTH
             || image.len() + HEADER_LENGTH > ops.resize_image_full_length
         {
             return Err(Error::ImageContentLength {
                 wrong_content_length: image.len(),
-                wrong_full_length: ops.resize_image_full_length,
             });
         }
         buf[HEADER_LENGTH..][..image.len()].copy_from_slice(image);

sophgo-rom-tool/tests/check-test.rs

@@ -0,0 +1,68 @@
+use sophgo_rom_tool::Error;
+
+#[test]
+fn check_success_raw_blob() {
+    let content = vec![
+        0x6F, 0x00, 0x00, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+        0x00, 0x00, 0x11, 0x22, 0x33, 0x44, 0x55, 0x66,
+    ];
+    let ans = sophgo_rom_tool::check(&content).unwrap();
+    assert_eq!(
+        ans.refill_header,
+        Some(sophgo_rom_tool::HeaderInfo {
+            blcp_image_checksum: 0xCAFE0000,
+            bl2_image_checksum: 0xCAFE8761,
+            bl2_image_size: 512
+        })
+    );
+    assert_eq!(ans.resize_image_full_length, 4608);
+}
+
+#[test]
+fn check_error_head_length() {
+    let content = vec![0x6F, 0x00, 0x00];
+    let ans = sophgo_rom_tool::check(&content);
+    assert_eq!(ans, Err(Error::HeadLength { wrong_length: 3 }))
+}
+
+#[test]
+fn check_error_magic_number() {
+    let content = vec![0x44, 0x33, 0x22, 0x11];
+    let ans = sophgo_rom_tool::check(&content);
+    assert_eq!(
+        ans,
+        Err(Error::MagicNumber {
+            wrong_magic: 0x11223344
+        })
+    )
+}
+
+#[test]
+fn check_error_raw_blob_head_length() {
+    let content = vec![
+        0x6F, 0x00, 0x00, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x6F, 0x00, 0x00, 0x02, 0x00,
+        0x00, 0x00, 0x00, 0x00, 0x00,
+    ];
+    let ans = sophgo_rom_tool::check(&content);
+    assert_eq!(ans, Err(Error::HeadLength { wrong_length: 20 }))
+}
+
+#[test]
+fn check_error_raw_blob_magic() {
+    let content = vec![
+        0x6F, 0x00, 0x00, 0x02, 0x11, 0x45, 0x14, 0x19, 0x19, 0x81, 0x11, 0x45, 0x14, 0x19, 0x19,
+        0x81, 0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8, 0x11, 0x45, 0x14, 0x19, 0x19, 0x81, 0x0, 0x1,
+    ];
+    let ans = sophgo_rom_tool::check(&content);
+    assert_eq!(
+        ans,
+        Err(Error::RawBlobMagic {
+            wrong_magic: [
+                0x6F, 0x00, 0x00, 0x02, 0x11, 0x45, 0x14, 0x19, 0x19, 0x81, 0x11, 0x45, 0x14, 0x19,
+                0x19, 0x81, 0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8, 0x11, 0x45, 0x14, 0x19, 0x19,
+                0x81, 0x0, 0x1
+            ]
+        })
+    )
+}

sophgo-rom-tool/tests/process-test.rs

@@ -0,0 +1,86 @@
+use sophgo_rom_tool::{Error, HeaderInfo};
+
+#[test]
+fn process_success() {
+    let mut content = vec![0u8; 4098];
+    let ops = sophgo_rom_tool::Operations {
+        refill_header: None,
+        set_image_content: Some(&[0x11, 0x22]),
+        resize_image_full_length: 4098,
+    };
+    let ans = sophgo_rom_tool::process(&mut content, &ops);
+    assert_eq!(ans, Ok(()));
+    let mut expected = vec![0u8; 4096];
+    expected.push(0x11);
+    expected.push(0x22);
+    assert_eq!(content, expected);
+    let mut content = vec![0u8; 4098];
+    let ops = sophgo_rom_tool::Operations {
+        refill_header: Some(HeaderInfo {
+            blcp_image_checksum: 0x11112222,
+            bl2_image_checksum: 0x33334444,
+            bl2_image_size: 0x55556666,
+        }),
+        set_image_content: Some(&[0x11, 0x22]),
+        resize_image_full_length: 4098,
+    };
+    let ans = sophgo_rom_tool::process(&mut content, &ops);
+    assert_eq!(ans, Ok(()));
+    let mut expected = vec![0u8; 4098];
+    expected[..12].copy_from_slice(&[
+        0x43, 0x56, 0x42, 0x4C, 0x30, 0x31, 0x0A, 0x00, 0x00, 0x00, 0x00, 0x00,
+    ]);
+    expected[0xBC..0xC0].copy_from_slice(&[0xF8, 0x02, 0x00, 0x00]);
+    expected[0xC0..0xC4].copy_from_slice(&[0x22, 0x22, 0x11, 0x11]);
+    expected[0xD4..0xD8].copy_from_slice(&[0x44, 0x44, 0x33, 0x33]);
+    expected[0xD8..0xDC].copy_from_slice(&[0x66, 0x66, 0x55, 0x55]);
+    expected[0xC..0x10].copy_from_slice(&[0xA5, 0xAC, 0xFE, 0xCA]);
+    expected[4096..].copy_from_slice(&[0x11, 0x22]);
+    assert_eq!(content, expected);
+}
+
+#[test]
+fn process_error_output_buffer_length() {
+    let mut content = vec![0u8; 50];
+    let ops = sophgo_rom_tool::Operations {
+        refill_header: None,
+        set_image_content: None,
+        resize_image_full_length: 100,
+    };
+    let ans = sophgo_rom_tool::process(&mut content, &ops);
+    assert_eq!(ans, Err(Error::OutputBufferLength { wrong_length: 50 }))
+}
+
+#[test]
+fn process_error_image_full_length() {
+    let mut content = vec![0u8; 501];
+    let ops = sophgo_rom_tool::Operations {
+        refill_header: None,
+        set_image_content: None,
+        resize_image_full_length: 500,
+    };
+    let ans = sophgo_rom_tool::process(&mut content, &ops);
+    assert_eq!(
+        ans,
+        Err(Error::ImageFullLength {
+            wrong_full_length: 500
+        })
+    );
+}
+
+#[test]
+fn process_error_image_content_length() {
+    let mut content = vec![0u8; 5000];
+    let ops = sophgo_rom_tool::Operations {
+        refill_header: None,
+        set_image_content: Some(&[0x11, 0x22]),
+        resize_image_full_length: 600,
+    };
+    let ans = sophgo_rom_tool::process(&mut content, &ops);
+    assert_eq!(
+        ans,
+        Err(Error::ImageFullLength {
+            wrong_full_length: 600
+        })
+    );
+}