Integration test framework: Initial PR (#471)

Co-authored-by: raulk <[email protected]>x
Co-authored-by: Raúl Kripalani <[email protected]>

Author: tchataigner

.gitignore

@@ -2,4 +2,5 @@ target
 Cargo.lock
 *.wat
 *.wasm
+!testing/integration/tests/assets/*
 .idea/

Cargo.toml

@@ -4,6 +4,7 @@ members = [
     "sdk",
     "shared",
     "testing/conformance",
+    "testing/integration",
     "ipld/*",
 ]
 

fvm/CHANGELOG.md

@@ -3,6 +3,10 @@
 Changes to the reference FVM implementation.
 
 ## Unreleased
+ 
+- Added `testing` feature to change module visibility 
+- Changed visibility of `account_actor`, `init_actor` and `system_actor` to public to use them in the integration test
+framework.
 
 ## 0.7.1 [2022-04-18]
 
@@ -33,4 +37,4 @@ BREAKING: Updates the FVM to the latest syscall struct alignment
      - `StateTree::consume` -> `StateTree::into_store`
 - BREAKING: remove unused (by the FVM) `verify_post_discount` from the FVM PriceList.
 
-[FIP0032]: https://github.com/filecoin-project/FIPs/blob/master/FIPS/fip-0032.md
+[FIP0032]: https://github.com/filecoin-project/FIPs/blob/master/FIPS/fip-0032.md

fvm/Cargo.toml

@@ -49,3 +49,5 @@ features = ["cranelift", "pooling-allocator", "parallel-compilation"]
 default = ["opencl"]
 opencl = ["filecoin-proofs-api/opencl"]
 cuda = ["filecoin-proofs-api/cuda"]
+testing = []
+

fvm/src/lib.rs

@@ -23,12 +23,23 @@ pub mod state_tree;
 
 mod blockstore;
 
+#[cfg(not(feature = "testing"))]
 mod account_actor;
+#[cfg(not(feature = "testing"))]
 mod init_actor;
+#[cfg(not(feature = "testing"))]
+mod system_actor;
+
+#[cfg(feature = "testing")]
+pub mod account_actor;
+#[cfg(feature = "testing")]
+pub mod init_actor;
+#[cfg(feature = "testing")]
+pub mod system_actor;
+
 mod market_actor;
 mod power_actor;
 mod reward_actor;
-mod system_actor;
 
 pub mod trace;
 

sdk/CHANGELOG.md

@@ -2,11 +2,14 @@
 
 ## [Unreleased]
 
+- Added _cfg = "testing"_ on `testing` module.
+- Added a `testing` module to access `assert_*` macros to be able to do assertions in actors code.
+
 ## 0.6.0 [2022-04-14]
 
 BREAKING: Upgrades to fvm_shared 0.6.0, and the new syscall struct alignment.
 https://github.com/filecoin-project/fvm-specs/issues/63
 
 ## 0.5.0 [2022-04-11]
 
-Upgrades the SDK to fvm_shared 0.5.0. This release includes a significant breaking change to exit codes.
+Upgrades the SDK to fvm_shared 0.5.0. This release includes a significant breaking change to exit codes.

sdk/Cargo.toml

@@ -23,3 +23,4 @@ fvm_ipld_encoding = { version = "0.1", path = "../ipld/encoding" }
 [features]
 default = ["debug"]
 debug = ["lazy_static"]
+testing = []

sdk/src/lib.rs

@@ -12,6 +12,9 @@ pub mod sself;
 pub mod sys;
 pub mod vm;
 
+#[cfg(feature = "testing")]
+pub mod testing;
+
 /// The maximum supported CID size. (SPEC_AUDIT)
 pub const MAX_CID_LEN: usize = 100;
 

sdk/src/testing.rs

@@ -0,0 +1,72 @@
+// Wrapper around the assert macro to have a hand on which exit code we want to give to our failed
+// assertion
+#[macro_export]
+macro_rules! assert {
+    ($cond:expr, $(,)?) => {{
+        let res = std::panic::catch_unwind(|| {
+            core::assert!($cond);
+        });
+        if res.is_err() {
+            let panic_msg = match res.err() {
+                Some(err) => match err.downcast::<String>() {
+                    Ok(panic_msg_box) => Some(panic_msg_box.as_str()),
+                    Err(err) => None,
+                },
+                None => unreachable!(),
+            };
+
+            $crate::vm::abort(
+                fvm_shared::error::ExitCode::USR_ASSERTION_FAILED.value(),
+                panic_msg,
+            );
+        }
+    }};
+}
+
+// Utility macro to generate macro code for assert_eq and assert_ne
+macro_rules! assert2 {
+    ($assert_macro:ident) => {
+        with_dollar_sign! {
+            ($d:tt) => {
+                #[macro_export]
+                macro_rules! $assert_macro {
+                    ($d left:expr, $d right:expr $d(,$d arg:tt)*) => {
+                        let res = std::panic::catch_unwind(|| {
+                            core::$assert_macro!($d left, $d right);
+                        });
+                        if res.is_err() {
+                            let panic_msg = match res.err() {
+                                Some(err) => match err.downcast::<String>() {
+                                    Ok(panic_msg_box) => Some(panic_msg_box.as_str()),
+                                    Err(err) => None,
+                                },
+                                None => unreachable!(),
+                            };
+
+                            $crate::vm::abort(
+                                fvm_shared::error::ExitCode::USR_ASSERTION_FAILED.value(),
+                                panic_msg,
+                            );
+                        }
+                    };
+                }
+            }
+        }
+    };
+}
+
+// Utility macro to allow for nested repetition
+macro_rules! with_dollar_sign {
+    ($($body:tt)*) => {
+        macro_rules! __with_dollar_sign { $($body)* }
+        __with_dollar_sign!($);
+    }
+}
+
+// Wrapper around the assert_eq macro to have a hand on which exit code we want to give to our failed
+// assertion
+assert2!(assert_eq);
+
+// Wrapper around the assert_ne macro to have a hand on which exit code we want to give to our failed
+// assertion
+assert2!(assert_ne);

shared/CHANGELOG.md

@@ -1,12 +1,19 @@
 # Changelog
 
+## Unreleased
+
+- Added `testing` feature to have `Default` derive on `Message`. Extended this feature to `Address` and `Payload`. 
+
 ## 0.6.0 [2022-04-14]
 
 BREAKING: Switch syscall struct alignment: https://github.com/filecoin-project/fvm-specs/issues/63
 
 Actors built against this new version of fvm_shared will be incompatible with prior FVM versions,
 and vice-versa.
 
+- Added `Display` trait to `Type` for error printing. 
+- Added _cfg = "testing"_ on `Default` trait for `Message` structure.
+
 ## 0.5.1  [2022-04-11]
 
 Add the `USR_ASSERTION_FAILED` exit code.