feat: This implements a serde_test macro that can generate round-trip serialization tests pegged on an implementation of proptest::prelude::Arbitrary. This macro:

- supports generic arguments passed as attributes,
- uses bincode as the test serializer (I expect this will be replaced by #2130)

=> no more boilerplate tests! (and future tests are easier to define)

Author: huitseeker

Cargo.lock

@@ -46,6 +46,7 @@ miden-core = { path = "./core", version = "0.18", default-features = false }
 miden-debug-types = { path = "./crates/debug/types", version = "0.18", default-features = false }
 miden-mast-package = { path = "./package", version = "0.18", default-features = false }
 miden-processor = { path = "./processor", version = "0.18", default-features = false }
+miden-serde-test-macros = { path = "./crates/utils/serde-test-macros", version = "0.1.0", default-features = false }
 miden-prover = { path = "./prover", version = "0.18", default-features = false }
 miden-stdlib = { path = "./stdlib", version = "0.18", default-features = false }
 miden-utils-diagnostics = { path = "./crates/utils/diagnostics", version = "0.18", default-features = false }
@@ -59,6 +60,8 @@ miden-formatting = { version = "0.1", default-features = false }
 midenc-hir-type = { version = "0.1", default-features = false }
 
 # Third-party crates
+# used in miden-serde-test macros, should be replaced with miden-bite
+bincode = { version = "1.3" }
 insta = { version = "1.43", default-features = false, features = [
     "colors",
 ] }

Cargo.toml

@@ -22,6 +22,7 @@ std = [
     "miden-debug-types/std",
     "miden-utils-diagnostics/std",
     "thiserror/std",
+    "proptest/std",
 ]
 serde = [
     "dep:serde",
@@ -31,7 +32,7 @@ serde = [
     "semver/serde",
     "smallvec/serde",
 ]
-arbitrary = ["dep:proptest", "dep:proptest-derive"]
+arbitrary = ["dep:proptest", "dep:proptest-derive", "miden-core/arbitrary"]
 testing = ["arbitrary", "logging"]
 logging = ["dep:env_logger"]
 
@@ -44,6 +45,7 @@ miden-core.workspace = true
 miden-debug-types.workspace = true
 miden-utils-diagnostics.workspace = true
 midenc-hir-type.workspace = true
+miden-serde-test-macros = { workspace = true }
 proptest = { workspace = true, optional = true }
 proptest-derive = { workspace = true, optional = true }
 regex = { version = "1.10", default-features = false, features = [
@@ -57,6 +59,7 @@ smallvec.workspace = true
 thiserror.workspace = true
 
 [dev-dependencies]
+bincode.workspace = true
 env_logger = "0.11"
 proptest.workspace = true
 pretty_assertions = "1.4"

assembly-syntax/Cargo.toml

@@ -31,6 +31,10 @@ use crate::{
 /// to an imported
 #[derive(Clone)]
 #[cfg_attr(feature = "arbitrary", derive(proptest_derive::Arbitrary))]
+#[cfg_attr(
+    all(feature = "serde", feature = "arbitrary"),
+    miden_serde_test_macros::serde_test
+)]
 pub struct QualifiedProcedureName {
     /// The source span associated with this identifier.
     #[cfg_attr(feature = "arbitrary", proptest(value = "SourceSpan::default()"))]
@@ -297,6 +301,10 @@ impl<'de> serde::Deserialize<'de> for QualifiedProcedureName {
 #[derive(Debug, Clone)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 #[cfg_attr(feature = "serde", serde(transparent))]
+#[cfg_attr(
+    all(feature = "serde", feature = "arbitrary"),
+    miden_serde_test_macros::serde_test
+)]
 pub struct ProcedureName(Ident);
 
 impl ProcedureName {
@@ -518,24 +526,3 @@ impl proptest::prelude::Arbitrary for ProcedureName {
 
     type Strategy = proptest::prelude::BoxedStrategy<Self>;
 }
-
-// TESTS
-// ================================================================================================
-
-/// Tests
-#[cfg(test)]
-mod tests {
-    use miden_core::utils::{Deserializable, Serializable};
-    use proptest::prelude::*;
-
-    use super::ProcedureName;
-
-    proptest! {
-        #[test]
-        fn procedure_name_serialization_roundtrip(path in any::<ProcedureName>()) {
-            let bytes = path.to_bytes();
-            let deserialized = ProcedureName::read_from_bytes(&bytes).unwrap();
-            assert_eq!(path, deserialized);
-        }
-    }
-}