feat: add the grip unit test crate (#32)

Adds the `#[grip::test]` proc macro to hide implementation details from users and make writing unit tests seamless.
OpenZeppelin · Apr 4, 2024 · 1934d3d · 1934d3d
1 parent 3df4d8a
commit 1934d3d
Show file tree

Hide file tree

Showing 18 changed files with 525 additions and 287 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,5 +1,5 @@
 [workspace]
-members = ["contracts", "lib/*"]
+members = ["contracts", "lib/crypto", "lib/grip", "lib/grip-proc"]
 # Explicitly set the resolver to version 2, which is the default for packages
 # with edition >= 2021.
 # https://doc.rust-lang.org/edition-guide/rust-2021/default-cargo-resolver.html

diff --git a/contracts/Cargo.toml b/contracts/Cargo.toml
@@ -17,7 +17,7 @@ stylus-proc = { version = "0.4.3", default-features = false }
 mini-alloc = "0.4.2"
 
 [dev-dependencies]
-wavm-shims = { path = "../lib/wavm-shims" }
+grip = { path = "../lib/grip" }
 
 [features]
 default = []

diff --git a/contracts/src/erc20/extensions/metadata.rs b/contracts/src/erc20/extensions/metadata.rs
@@ -93,8 +93,6 @@ mod tests {
     use stylus_sdk::storage::{StorageBool, StorageString, StorageType};
 
     use super::{Metadata, DEFAULT_DECIMALS};
-    #[allow(unused_imports)]
-    use crate::test_utils;
 
     impl Default for Metadata {
         fn default() -> Self {
@@ -111,50 +109,46 @@ mod tests {
         }
     }
 
-    #[test]
-    fn constructs() {
-        test_utils::with_storage::<Metadata>(|meta| {
-            let name = meta.name();
-            let symbol = meta.symbol();
-            let decimals = meta.decimals();
-            let initialized = meta._initialized.get();
-            assert_eq!(name, "");
-            assert_eq!(symbol, "");
-            assert_eq!(decimals, DEFAULT_DECIMALS);
-            assert_eq!(initialized, false);
-
-            const NAME: &str = "Meta";
-            const SYMBOL: &str = "Symbol";
-            meta.constructor(NAME.to_owned(), SYMBOL.to_owned());
-
-            let name = meta.name();
-            let symbol = meta.symbol();
-            let decimals = meta.decimals();
-            let initialized = meta._initialized.get();
-            assert_eq!(name, NAME);
-            assert_eq!(symbol, SYMBOL);
-            assert_eq!(decimals, DEFAULT_DECIMALS);
-            assert_eq!(initialized, true);
-        })
+    #[grip::test]
+    fn constructs(meta: Metadata) {
+        let name = meta.name();
+        let symbol = meta.symbol();
+        let decimals = meta.decimals();
+        let initialized = meta._initialized.get();
+        assert_eq!(name, "");
+        assert_eq!(symbol, "");
+        assert_eq!(decimals, DEFAULT_DECIMALS);
+        assert_eq!(initialized, false);
+
+        const NAME: &str = "Meta";
+        const SYMBOL: &str = "Symbol";
+        meta.constructor(NAME.to_owned(), SYMBOL.to_owned());
+
+        let name = meta.name();
+        let symbol = meta.symbol();
+        let decimals = meta.decimals();
+        let initialized = meta._initialized.get();
+        assert_eq!(name, NAME);
+        assert_eq!(symbol, SYMBOL);
+        assert_eq!(decimals, DEFAULT_DECIMALS);
+        assert_eq!(initialized, true);
     }
 
-    #[test]
-    fn constructs_only_once() {
-        test_utils::with_storage::<Metadata>(|meta| {
-            const NAME: &str = "Meta";
-            const SYMBOL: &str = "Symbol";
-            meta.constructor(NAME.to_owned(), SYMBOL.to_owned());
-
-            meta.constructor("Invalid".to_owned(), "Invalid".to_owned());
-
-            let name = meta.name();
-            let symbol = meta.symbol();
-            let decimals = meta.decimals();
-            let initialized = meta._initialized.get();
-            assert_eq!(name, NAME);
-            assert_eq!(symbol, SYMBOL);
-            assert_eq!(decimals, DEFAULT_DECIMALS);
-            assert_eq!(initialized, true);
-        })
+    #[grip::test]
+    fn constructs_only_once(meta: Metadata) {
+        const NAME: &str = "Meta";
+        const SYMBOL: &str = "Symbol";
+        meta.constructor(NAME.to_owned(), SYMBOL.to_owned());
+
+        meta.constructor("Invalid".to_owned(), "Invalid".to_owned());
+
+        let name = meta.name();
+        let symbol = meta.symbol();
+        let decimals = meta.decimals();
+        let initialized = meta._initialized.get();
+        assert_eq!(name, NAME);
+        assert_eq!(symbol, SYMBOL);
+        assert_eq!(decimals, DEFAULT_DECIMALS);
+        assert_eq!(initialized, true);
     }
 }