feat: migrate size tests to proptest

Author: alanpq

crates/league-modpkg/Cargo.toml

@@ -12,3 +12,7 @@ rmp-serde = "1.3.0"
 twox-hash = { version = "2.0.1", features = ["xxhash64"] }
 binrw = "0.14.1"
 itertools = "0.14.0"
+proptest = "1.6.0"
+
+[dev-dependencies]
+proptest-derive = "0.5.1"

crates/league-modpkg/src/license.rs

@@ -1,4 +1,3 @@
-use binrw::{binrw, NullString};
 use binrw::binrw;
 
 use crate::utils::{nullstr_read, nullstr_write};
@@ -40,59 +39,15 @@ impl ModpkgLicense {
     }
 }
 
-// TODO: use proptest here
 #[cfg(test)]
 mod tests {
-    use std::io::Cursor;
-
-    use binrw::BinWrite;
-
     use super::*;
-
-    #[test]
-    fn test_none_size() {
-        let license = ModpkgLicense::default();
-        let mut buf = Cursor::new(Vec::with_capacity(license.size() + 512));
-        license.write(&mut buf).unwrap();
-        println!("{:x?}", buf.clone().into_inner());
-
-        assert_eq!(
-            license.size(),
-            buf.into_inner().len(),
-            "comparing reported size with real size"
-        );
-    }
-
+    use crate::utils::test;
+    use proptest::prelude::*;
+    proptest! {
     #[test]
-    fn test_spdx_size() {
-        let license = ModpkgLicense::Spdx {
-            spdx_id: "test".to_string().into(),
-        };
-
-        let mut buf = Cursor::new(Vec::with_capacity(license.size() + 512));
-        license.write(&mut buf).unwrap();
-
-        assert_eq!(
-            license.size(),
-            buf.into_inner().len(),
-            "comparing reported size with real size"
-        );
-    }
-    #[test]
-    fn test_custom_size() {
-        let license = ModpkgLicense::Custom {
-            name: "customName".into(),
-            url: "http://fake.url/".into(),
-        };
-        let mut buf = Cursor::new(Vec::with_capacity(license.size() + 512));
-        license.write(&mut buf).unwrap();
-
-        println!("{:x?}", buf.clone().into_inner());
-
-        assert_eq!(
-            license.size(),
-            buf.into_inner().len(),
-            "comparing reported size with real size"
-        );
+        fn test_license_size(license: ModpkgLicense) {
+            test::written_size(&license, license.size());
+        }
     }
 }

crates/league-modpkg/src/metadata.rs

@@ -9,6 +9,7 @@ use serde::{Deserialize, Serialize};
 #[binrw]
 #[brw(little)]
 #[derive(Debug, PartialEq, Default)]
+#[cfg_attr(test, derive(proptest_derive::Arbitrary))]
 pub struct ModpkgMetadata {
     #[br(temp)]
     #[bw(calc = name.len() as u32)]
@@ -95,6 +96,7 @@ impl ModpkgMetadata {
 #[binrw]
 #[brw(little)]
 #[derive(Debug, PartialEq, Serialize, Deserialize)]
+#[cfg_attr(test, derive(proptest_derive::Arbitrary))]
 pub struct ModpkgAuthor {
     #[br(temp)]
     #[bw( calc = name.len() as u32 )]
@@ -128,61 +130,19 @@ impl ModpkgAuthor {
     }
 }
 
-// TODO: use proptest here
 #[cfg(test)]
 mod tests {
-    use std::io::Cursor;
-
-    use binrw::BinWrite;
+    use crate::utils::test;
 
     use super::*;
-
-    #[test]
-    fn test_empty_metadata_size() {
-        let metadata = ModpkgMetadata::default();
-
-        let mut buf = Cursor::new(Vec::with_capacity(metadata.size() + 512));
-        metadata.write(&mut buf).unwrap();
-
-        assert_eq!(
-            metadata.size(),
-            buf.into_inner().len(),
-            "comparing reported size with real size"
-        );
-    }
-
+    use proptest::prelude::*;
+    proptest! {
     #[test]
-    fn test_metadata_size() {
-        let mod_name = "test".to_string();
-        let display_name = "test".to_string();
-        let description = "test".to_string();
-        let version = "test".to_string();
-        let distributor = "test".to_string();
-        let author_name = "test".to_string();
-        let author_role = "test".to_string();
-        let license = ModpkgLicense::Spdx {
-            spdx_id: "test".to_string().into(),
-        };
-
-        let metadata = ModpkgMetadata {
-            name: mod_name,
-            display_name,
-            description: Some(description),
-            version,
-            distributor: Some(distributor),
-            authors: vec![ModpkgAuthor {
-                name: author_name,
-                role: Some(author_role),
-            }],
-            license,
-        };
-        let mut buf = Cursor::new(Vec::with_capacity(metadata.size() + 512));
-        metadata.write(&mut buf).unwrap();
-
-        assert_eq!(
-            metadata.size(),
-            buf.into_inner().len(),
-            "comparing reported size with real size"
-        );
+        fn test_metadata_size(metadata: ModpkgMetadata) {
+            test::written_size(&metadata, metadata.size());
+        }
+        fn test_author_size(author: ModpkgAuthor) {
+            test::written_size(&author, author.size());
+        }
     }
 }

crates/league-modpkg/src/utils.rs

@@ -18,3 +18,23 @@ pub fn nullstr_read(s: NullString) -> Result<String, std::string::FromUtf8Error>
 pub fn nullstr_write<'a>(s: impl Into<&'a String>) -> NullString {
     NullString::from(s.into().as_str())
 }
+
+#[cfg(test)]
+pub mod test {
+    use binrw::{meta, BinWrite};
+    use std::io::Cursor;
+
+    pub fn written_size<I>(item: &I, expected_size: usize)
+    where
+        for<'a> I: BinWrite<Args<'a> = ()> + meta::WriteEndian,
+    {
+        let mut buf = Cursor::new(Vec::with_capacity(expected_size + 64));
+        item.write(&mut buf).unwrap();
+
+        assert_eq!(
+            expected_size,
+            buf.into_inner().len(),
+            "comparing reported size with real size"
+        );
+    }
+}