chore: use insta crate for testing macro generated code (#1090)

near · Oct 4, 2023 · e4c9240 · e4c9240
1 parent 185fd6b
commit e4c9240
Show file tree

Hide file tree

Showing 48 changed files with 1,149 additions and 944 deletions.
diff --git a/near-sdk-macros/Cargo.toml b/near-sdk-macros/Cargo.toml
@@ -23,6 +23,10 @@ quote = "1.0"
 Inflector = { version = "0.11.4", default-features = false, features = [] }
 darling = { version = "0.20.3" }
 
+[dev-dependencies]
+insta = { version = "1.31.0", features = ["yaml"] }
+prettyplease = { version = "0.2.15" }
+
 [features]
 abi = []
 __abi-embed = ["abi"]

diff --git a/near-sdk-macros/src/core_impl/abi/abi_generator.rs b/near-sdk-macros/src/core_impl/abi/abi_generator.rs
@@ -295,10 +295,23 @@ pub fn parse_rustdoc(attrs: &[Attribute]) -> Option<String> {
 #[rustfmt::skip]
 #[cfg(test)]
 mod tests {
-    use quote::quote;
+    use proc_macro2::TokenStream;
     use syn::{parse_quote, Type};
     use crate::core_impl::ImplItemMethodInfo;
+    use crate::core_impl::utils::test_helpers::{local_insta_assert_snapshot, pretty_print_syn_str};
+    use quote::quote;
+
 
+    fn pretty_print_fn_body_syn_str(input: TokenStream) -> String {
+        let input =  quote!(
+            fn main() {
+            #input
+            }
+        );
+        let res = pretty_print_syn_str(&input).unwrap();
+       res.strip_prefix("fn main() {\n").unwrap().strip_suffix("}\n").unwrap().to_string()
+    }
+
     #[test]
     fn test_generate_abi_fallible_json() {
         let impl_type: Type = syn::parse_str("Test").unwrap();
@@ -309,34 +322,8 @@ mod tests {
         };
         let method_info = ImplItemMethodInfo::new(&mut method, false, impl_type).unwrap().unwrap();
         let actual = method_info.abi_struct();
-
-        let expected = quote! {
-            ::near_sdk::__private::AbiFunction {
-                name: ::std::string::String::from("f3"),
-                doc: ::std::option::Option::Some(::std::string::String::from(" I am a function.")),
-                kind: ::near_sdk::__private::AbiFunctionKind::Call,
-                modifiers: ::std::vec![],
-                params: ::near_sdk::__private::AbiParameters::Json {
-                    args: ::std::vec![
-                        ::near_sdk::__private::AbiJsonParameter {
-                            name: ::std::string::String::from("arg0"),
-                            type_schema: gen.subschema_for::<FancyStruct>(),
-                        },
-                        ::near_sdk::__private::AbiJsonParameter {
-                            name: ::std::string::String::from("arg1"),
-                            type_schema: gen.subschema_for::<u64>(),
-                        }
-                    ]
-                },
-                callbacks: ::std::vec![],
-                callbacks_vec: ::std::option::Option::None,
-                result: ::std::option::Option::Some(::near_sdk::__private::AbiType::Json {
-                    type_schema: gen.subschema_for::<IsOk>(),
-                })
-            }
-        };
-
-        assert_eq!(actual.to_string(), expected.to_string());
+
+        local_insta_assert_snapshot!(pretty_print_fn_body_syn_str(actual));
     }
 
     #[test]
@@ -351,29 +338,7 @@ mod tests {
         let method_info = ImplItemMethodInfo::new(&mut method, false, impl_type).unwrap().unwrap();
         let actual = method_info.abi_struct();
 
-        let expected = quote! {
-            ::near_sdk::__private::AbiFunction {
-                name: ::std::string::String::from("f3"),
-                doc: ::std::option::Option::None,
-                kind: ::near_sdk::__private::AbiFunctionKind::Call,
-                modifiers: ::std::vec![::near_sdk::__private::AbiFunctionModifier::Payable],
-                params: ::near_sdk::__private::AbiParameters::Borsh {
-                    args: ::std::vec![
-                        ::near_sdk::__private::AbiBorshParameter {
-                            name: ::std::string::String::from("arg0"),
-                            type_schema: <FancyStruct as ::near_sdk::borsh::BorshSchema>::schema_container(),
-                        }
-                    ]
-                },
-                callbacks: ::std::vec![],
-                callbacks_vec: ::std::option::Option::None,
-                result: ::std::option::Option::Some(::near_sdk::__private::AbiType::Borsh {
-                    type_schema: <IsOk as ::near_sdk::borsh::BorshSchema>::schema_container(),
-                })
-            }
-        };
-
-        assert_eq!(actual.to_string(), expected.to_string());
+        local_insta_assert_snapshot!(pretty_print_fn_body_syn_str(actual));
     }
 
     #[test]
@@ -388,27 +353,8 @@ mod tests {
         };
         let method_info = ImplItemMethodInfo::new(&mut method, false, impl_type).unwrap().unwrap();
         let actual = method_info.abi_struct();
-
-        let expected = quote! {
-           ::near_sdk::__private::AbiFunction { 
-                name: ::std::string::String::from("method"),
-                doc: ::std::option::Option::None, 
-                kind: ::near_sdk::__private::AbiFunctionKind::View , 
-                modifiers: ::std::vec! [::near_sdk::__private::AbiFunctionModifier::Private],
-                params: ::near_sdk::__private::AbiParameters::Json { 
-                    args: ::std::vec![]
-                }, 
-                callbacks: ::std::vec! [], 
-                callbacks_vec: ::std::option::Option::Some(::near_sdk::__private::AbiType::Json { 
-                    type_schema: gen.subschema_for::< String >() , 
-                }),
-                result: ::std::option::Option::Some(::near_sdk::__private::AbiType::Json {
-                    type_schema: gen.subschema_for::< bool >() ,
-                })
-            }
-        };
-
-        assert_eq!(actual.to_string(), expected.to_string());
+
+        local_insta_assert_snapshot!(pretty_print_fn_body_syn_str(actual));
     }
 
     #[test]
@@ -420,34 +366,7 @@ mod tests {
         let method_info = ImplItemMethodInfo::new(&mut method, false, impl_type).unwrap().unwrap();
         let actual = method_info.abi_struct();
 
-        let expected = quote! {
-           ::near_sdk::__private::AbiFunction { 
-                name: ::std::string::String::from("method"),
-                doc: ::std::option::Option::None, 
-                kind: ::near_sdk::__private::AbiFunctionKind::View , 
-                modifiers: ::std::vec! [],
-                params: ::near_sdk::__private::AbiParameters::Borsh {
-                    args: ::std::vec! [
-                        ::near_sdk::__private::AbiBorshParameter {
-                            name: ::std::string::String::from("y"),
-                            type_schema: < String as ::near_sdk::borsh::BorshSchema >::schema_container(),
-                        }
-                    ]
-                }, 
-                callbacks: ::std::vec! [
-                    ::near_sdk::__private::AbiType::Borsh { 
-                        type_schema: <u64 as ::near_sdk::borsh::BorshSchema>::schema_container(),
-                    },
-                    ::near_sdk::__private::AbiType::Json {
-                        type_schema: gen.subschema_for::< Vec<u8> >(),
-                    }
-                ],
-                callbacks_vec: ::std::option::Option::None,
-                result: ::std::option::Option::None 
-            }
-        };
-
-        assert_eq!(actual.to_string(), expected.to_string());
+        local_insta_assert_snapshot!(pretty_print_fn_body_syn_str(actual));
     }
 
     #[test]
@@ -460,24 +379,7 @@ mod tests {
         let method_info = ImplItemMethodInfo::new(&mut method, false, impl_type).unwrap().unwrap();
         let actual = method_info.abi_struct();
 
-        let expected = quote! {
-            ::near_sdk::__private::AbiFunction {
-                name: ::std::string::String::from("new"),
-                doc: ::std::option::Option::None,
-                kind: ::near_sdk::__private::AbiFunctionKind::Call,
-                modifiers: ::std::vec![
-                    ::near_sdk::__private::AbiFunctionModifier::Init
-                ],
-                params: ::near_sdk::__private::AbiParameters::Json {
-                    args: ::std::vec![]
-                },
-                callbacks: ::std::vec![],
-                callbacks_vec: ::std::option::Option::None,
-                result: ::std::option::Option::None
-            }
-        };
-
-        assert_eq!(actual.to_string(), expected.to_string());
+        local_insta_assert_snapshot!(pretty_print_fn_body_syn_str(actual));
     }
 
     #[test]
@@ -489,21 +391,6 @@ mod tests {
         let method_info = ImplItemMethodInfo::new(&mut method, false, impl_type).unwrap().unwrap();
         let actual = method_info.abi_struct();
 
-        let expected = quote! {
-            ::near_sdk::__private::AbiFunction {
-                name: ::std::string::String::from("method"),
-                doc: ::std::option::Option::None,
-                kind: ::near_sdk::__private::AbiFunctionKind::View,
-                modifiers: ::std::vec![],
-                params: ::near_sdk::__private::AbiParameters::Json {
-                    args: ::std::vec![]
-                },
-                callbacks: ::std::vec![],
-                callbacks_vec: ::std::option::Option::None,
-                result: ::std::option::Option::None
-            }
-        };
-
-        assert_eq!(actual.to_string(), expected.to_string());
+        local_insta_assert_snapshot!(pretty_print_fn_body_syn_str(actual));
     }
 }
diff --git a/near-sdk-macros/src/core_impl/abi/snapshots/generate_abi_callback_args.snap b/near-sdk-macros/src/core_impl/abi/snapshots/generate_abi_callback_args.snap
@@ -0,0 +1,26 @@
+---
+source: near-sdk-macros/src/core_impl/abi/abi_generator.rs
+expression: pretty_print_fn_body_syn_str(actual)
+---
+    ::near_sdk::__private::AbiFunction {
+        name: ::std::string::String::from("method"),
+        doc: ::std::option::Option::None,
+        kind: ::near_sdk::__private::AbiFunctionKind::View,
+        modifiers: ::std::vec![],
+        params: ::near_sdk::__private::AbiParameters::Borsh {
+            args: ::std::vec![
+                ::near_sdk::__private::AbiBorshParameter { name :
+                ::std::string::String::from("y"), type_schema : < String as
+                ::near_sdk::borsh::BorshSchema > ::schema_container(), }
+            ],
+        },
+        callbacks: ::std::vec![
+            ::near_sdk::__private::AbiType::Borsh { type_schema : < u64 as
+            ::near_sdk::borsh::BorshSchema > ::schema_container(), },
+            ::near_sdk::__private::AbiType::Json { type_schema : gen.subschema_for:: <
+            Vec < u8 > > (), }
+        ],
+        callbacks_vec: ::std::option::Option::None,
+        result: ::std::option::Option::None,
+    }
+
diff --git a/near-sdk-macros/src/core_impl/abi/snapshots/generate_abi_fallible_borsh.snap b/near-sdk-macros/src/core_impl/abi/snapshots/generate_abi_fallible_borsh.snap
@@ -0,0 +1,23 @@
+---
+source: near-sdk-macros/src/core_impl/abi/abi_generator.rs
+expression: pretty_print_fn_body_syn_str(actual)
+---
+    ::near_sdk::__private::AbiFunction {
+        name: ::std::string::String::from("f3"),
+        doc: ::std::option::Option::None,
+        kind: ::near_sdk::__private::AbiFunctionKind::Call,
+        modifiers: ::std::vec![::near_sdk::__private::AbiFunctionModifier::Payable],
+        params: ::near_sdk::__private::AbiParameters::Borsh {
+            args: ::std::vec![
+                ::near_sdk::__private::AbiBorshParameter { name :
+                ::std::string::String::from("arg0"), type_schema : < FancyStruct as
+                ::near_sdk::borsh::BorshSchema > ::schema_container(), }
+            ],
+        },
+        callbacks: ::std::vec![],
+        callbacks_vec: ::std::option::Option::None,
+        result: ::std::option::Option::Some(::near_sdk::__private::AbiType::Borsh {
+            type_schema: <IsOk as ::near_sdk::borsh::BorshSchema>::schema_container(),
+        }),
+    }
+
diff --git a/near-sdk-macros/src/core_impl/abi/snapshots/generate_abi_fallible_json.snap b/near-sdk-macros/src/core_impl/abi/snapshots/generate_abi_fallible_json.snap
@@ -0,0 +1,27 @@
+---
+source: near-sdk-macros/src/core_impl/abi/abi_generator.rs
+expression: pretty_print_fn_body_syn_str(actual)
+---
+    ::near_sdk::__private::AbiFunction {
+        name: ::std::string::String::from("f3"),
+        doc: ::std::option::Option::Some(
+            ::std::string::String::from(" I am a function."),
+        ),
+        kind: ::near_sdk::__private::AbiFunctionKind::Call,
+        modifiers: ::std::vec![],
+        params: ::near_sdk::__private::AbiParameters::Json {
+            args: ::std::vec![
+                ::near_sdk::__private::AbiJsonParameter { name :
+                ::std::string::String::from("arg0"), type_schema : gen.subschema_for:: <
+                FancyStruct > (), }, ::near_sdk::__private::AbiJsonParameter { name :
+                ::std::string::String::from("arg1"), type_schema : gen.subschema_for:: <
+                u64 > (), }
+            ],
+        },
+        callbacks: ::std::vec![],
+        callbacks_vec: ::std::option::Option::None,
+        result: ::std::option::Option::Some(::near_sdk::__private::AbiType::Json {
+            type_schema: gen.subschema_for::<IsOk>(),
+        }),
+    }
+
diff --git a/near-sdk-macros/src/core_impl/abi/snapshots/generate_abi_init_ignore_state.snap b/near-sdk-macros/src/core_impl/abi/snapshots/generate_abi_init_ignore_state.snap
@@ -0,0 +1,17 @@
+---
+source: near-sdk-macros/src/core_impl/abi/abi_generator.rs
+expression: pretty_print_fn_body_syn_str(actual)
+---
+    ::near_sdk::__private::AbiFunction {
+        name: ::std::string::String::from("new"),
+        doc: ::std::option::Option::None,
+        kind: ::near_sdk::__private::AbiFunctionKind::Call,
+        modifiers: ::std::vec![::near_sdk::__private::AbiFunctionModifier::Init],
+        params: ::near_sdk::__private::AbiParameters::Json {
+            args: ::std::vec![],
+        },
+        callbacks: ::std::vec![],
+        callbacks_vec: ::std::option::Option::None,
+        result: ::std::option::Option::None,
+    }
+
diff --git a/near-sdk-macros/src/core_impl/abi/snapshots/generate_abi_no_return.snap b/near-sdk-macros/src/core_impl/abi/snapshots/generate_abi_no_return.snap
@@ -0,0 +1,17 @@
+---
+source: near-sdk-macros/src/core_impl/abi/abi_generator.rs
+expression: pretty_print_fn_body_syn_str(actual)
+---
+    ::near_sdk::__private::AbiFunction {
+        name: ::std::string::String::from("method"),
+        doc: ::std::option::Option::None,
+        kind: ::near_sdk::__private::AbiFunctionKind::View,
+        modifiers: ::std::vec![],
+        params: ::near_sdk::__private::AbiParameters::Json {
+            args: ::std::vec![],
+        },
+        callbacks: ::std::vec![],
+        callbacks_vec: ::std::option::Option::None,
+        result: ::std::option::Option::None,
+    }
+
diff --git a/near-sdk-macros/src/core_impl/abi/snapshots/generate_abi_private_callback_vec.snap b/near-sdk-macros/src/core_impl/abi/snapshots/generate_abi_private_callback_vec.snap
@@ -0,0 +1,21 @@
+---
+source: near-sdk-macros/src/core_impl/abi/abi_generator.rs
+expression: pretty_print_fn_body_syn_str(actual)
+---
+    ::near_sdk::__private::AbiFunction {
+        name: ::std::string::String::from("method"),
+        doc: ::std::option::Option::None,
+        kind: ::near_sdk::__private::AbiFunctionKind::View,
+        modifiers: ::std::vec![::near_sdk::__private::AbiFunctionModifier::Private],
+        params: ::near_sdk::__private::AbiParameters::Json {
+            args: ::std::vec![],
+        },
+        callbacks: ::std::vec![],
+        callbacks_vec: ::std::option::Option::Some(::near_sdk::__private::AbiType::Json {
+            type_schema: gen.subschema_for::<String>(),
+        }),
+        result: ::std::option::Option::Some(::near_sdk::__private::AbiType::Json {
+            type_schema: gen.subschema_for::<bool>(),
+        }),
+    }
+