chore: adding abi tests

examples/adder/abi.sh

@@ -0,0 +1,25 @@
+#!/bin/bash
+TARGET="${CARGO_TARGET_DIR:-../../target}"
+set -e
+cd "$(dirname $0)"
+
+# Build the lib
+CARGO_PROFILE_DEV_OPT_LEVEL=0 \
+    CARGO_PROFILE_DEV_DEBUG=0 \
+    CARGO_PROFILE_DEV_LTO=off \
+    RUSTFLAGS="-Awarnings" \
+    cargo build --features near-sdk/__abi-generate --release
+
+OS="$(uname)"
+if [[ "$OS" == "Linux" ]]; then
+    EXT=".so"
+elif [[ "$OS" == "Darwin" ]]; then
+    EXT=".dylib"
+elif [[ "$OS" == MINGW* ]] || [[ "$OS" == CYGWIN* ]] || [[ "$OS" == MSYS* ]]; then
+    EXT=".dll"
+else
+    echo "Unsupported OS: $OS"
+    exit 1
+fi
+
+cp "$TARGET/release/libadder$EXT" ./res/

near-sdk-macros/Cargo.toml

@@ -26,8 +26,10 @@ serde = { version = "1", features = ["derive"] }
 serde_json = "1"
 
 [dev-dependencies]
+near-abi = { version = "0.4.0", features = ["__chunked-entries"] }
 insta = { version = "1.31.0", features = ["yaml"] }
 prettyplease = { version = "0.2.15" }
+symbolic-debuginfo = "8.8"
 
 [features]
 abi = []

near-sdk-macros/src/core_impl/utils/test_helpers.rs

@@ -9,15 +9,6 @@ pub fn pretty_print_syn_str(input: &TokenStream) -> syn::Result<String> {
     Ok(prettyplease::unparse(&syn_file))
 }
 
-// macro_rules! local_insta_assert_debug_snapshot {
-//     ($value:expr) => {{
-
-//         insta::with_settings!({prepend_module_to_snapshot => false}, {
-//             insta::assert_debug_snapshot!($value);
-//         });
-//     }};
-// }
-
 macro_rules! local_insta_assert_snapshot {
     ($value:expr) => {{
 

near-sdk-macros/src/lib.rs

@@ -643,3 +643,63 @@ pub fn derive_event_attributes(item: TokenStream) -> TokenStream {
         )
     }
 }
+
+#[cfg(test)]
+mod tests {
+    use std::{collections::HashSet, fs, path::Path, process::Command};
+
+    // These methods are prepended to the contract internally, update this test list if they change
+    const PREPENDED_METHODS: [&str; 1] = ["contract_source_metadata"];
+    const PROJECT_PATH: &str = "../../near-sdk-rs/examples/adder";
+
+    #[test]
+    fn ensure_abi_for_prepended_functions() {
+        let contract_dir = Path::new(PROJECT_PATH);
+
+        let res = Command::new("bash")
+            .arg(contract_dir.join("abi.sh").to_str().expect("script path is valid"))
+            .output()
+            .unwrap();
+
+        assert!(
+            res.status.success(),
+            "failed to compile contract abi: {}",
+            String::from_utf8_lossy(&res.stderr)
+        );
+
+        let dylib_file = contract_dir.join(format!("res/libadder.{}", dylib_extension()));
+        assert!(dylib_file.exists(), "Dylib file should exist");
+
+        let dylib_file_contents =
+            fs::read(contract_dir.join(format!("res/libadder.{}", dylib_extension()))).unwrap();
+        let object = symbolic_debuginfo::Object::parse(&dylib_file_contents).unwrap();
+        let near_abi_symbols = object
+            .symbols()
+            .flat_map(|sym| sym.name)
+            .filter(|sym_name| sym_name.starts_with("__near_abi_"))
+            .collect::<HashSet<_>>();
+
+        // ensure methods are prepended
+        PREPENDED_METHODS.map(|method| {
+            assert!(
+                near_abi_symbols.iter().any(|f| f.eq(&format!("__near_abi_{}", method))),
+                "ABI should contain prepended method {}",
+                method
+            );
+        });
+    }
+
+    const fn dylib_extension() -> &'static str {
+        #[cfg(target_os = "linux")]
+        return "so";
+
+        #[cfg(target_os = "macos")]
+        return "dylib";
+
+        #[cfg(target_os = "windows")]
+        return "dll";
+
+        #[cfg(not(any(target_os = "macos", target_os = "linux", target_os = "windows")))]
+        compile_error!("Unsupported platform");
+    }
+}