Add godot_itest! macro to be used in test crate; add #[must_use]

Author: Bromeon

gdnative-core/src/macros.rs

@@ -208,12 +208,15 @@ macro_rules! impl_basic_traits_as_sys {
     )
 }
 
-macro_rules! godot_test {
-    ($($test_name:ident $body:block)*) => {
+#[doc(hidden)]
+#[macro_export]
+macro_rules! godot_test_impl {
+    ( $( $test_name:ident $body:block $($attrs:tt)* )* ) => {
         $(
-            #[cfg(feature = "gd-test")]
+            $($attrs)*
             #[doc(hidden)]
             #[inline]
+            #[must_use]
             pub fn $test_name() -> bool {
                 let str_name = stringify!($test_name);
                 println!("   -- {}", str_name);
@@ -231,3 +234,35 @@ macro_rules! godot_test {
         )*
     }
 }
+
+/// Declares a test to be run with the Godot engine (i.e. not a pure Rust unit test).
+///
+/// Creates a wrapper function that catches panics, prints errors and returns true/false.
+/// To be manually invoked in higher-level test routine.
+///
+/// This macro is designed to be used within the current crate only, hence the #[cfg] attribute.
+#[doc(hidden)]
+macro_rules! godot_test {
+    ($($test_name:ident $body:block)*) => {
+        $(
+            godot_test_impl!($test_name $body #[cfg(feature = "gd-test")]);
+        )*
+    }
+}
+
+
+/// Declares a test to be run with the Godot engine (i.e. not a pure Rust unit test).
+///
+/// Creates a wrapper function that catches panics, prints errors and returns true/false.
+/// To be manually invoked in higher-level test routine.
+///
+/// This macro is designed to be used within the `test` crate, hence the method is always declared (not only in certain features).
+#[doc(hidden)]
+#[macro_export]
+macro_rules! godot_itest {
+    ($($test_name:ident $body:block)*) => {
+        $(
+            $crate::godot_test_impl!($test_name $body);
+        )*
+    }
+}

impl/proc-macros/src/lib.rs

@@ -12,14 +12,14 @@ mod pool_array_element;
 
 #[proc_macro]
 pub fn impl_typed_array_element(input: TokenStream) -> TokenStream {
-    self::pool_array_element::impl_element(input)
+    pool_array_element::impl_element(input)
         .unwrap_or_else(to_compile_errors)
         .into()
 }
 
 #[proc_macro]
 pub fn decl_typed_array_element(input: TokenStream) -> TokenStream {
-    self::pool_array_element::decl_element(input)
+    pool_array_element::decl_element(input)
         .unwrap_or_else(to_compile_errors)
         .into()
 }

test/Cargo.toml

@@ -17,6 +17,7 @@ custom-godot = ["gdnative/custom-godot"]
 
 [dependencies]
 gdnative = { path = "../gdnative", features = ["gd-test", "serde", "async"] }
+gdnative-core = { path = "../gdnative-core" }
 approx = "0.5"
 ron = "0.7"
 serde = "1"

test/src/lib.rs

@@ -79,7 +79,7 @@ pub extern "C" fn run_tests(
     status &= test_variant_call_args::run_tests();
     status &= test_variant_ops::run_tests();
 
-    gdnative::core_types::Variant::new(status).leak()
+    Variant::new(status).leak()
 }
 
 fn test_underscore_method_binding() -> bool {

test/src/test_vararray_return.rs

@@ -1,6 +1,8 @@
 use gdnative::api::Camera;
 use gdnative::prelude::*;
 
+use gdnative_core::godot_itest;
+
 pub(crate) fn run_tests() -> bool {
     let mut status = true;
 
@@ -11,24 +13,11 @@ pub(crate) fn run_tests() -> bool {
 
 pub(crate) fn register(_handle: InitHandle) {}
 
-fn test_vararray_return_crash() -> bool {
-    println!(" -- test_vararray_return_crash");
-
-    let ok = std::panic::catch_unwind(|| {
-        // See https://github.com/godot-rust/godot-rust/issues/422
-        let camera = Camera::new();
-
-        camera.set_frustum(5.0, Vector2::new(1.0, 2.0), 0.0, 1.0);
-
-        camera.get_frustum(); // this should not crash!
+godot_itest! { test_vararray_return_crash {
+    // See https://github.com/godot-rust/godot-rust/issues/422
+    let camera = Camera::new();
 
-        camera.free();
-    })
-    .is_ok();
-
-    if !ok {
-        godot_error!("   !! Test test_vararray_return_crash failed");
-    }
-
-    ok
-}
+    camera.set_frustum(5.0, Vector2::new(1.0, 2.0), 0.0, 1.0);
+    camera.get_frustum(); // this should not crash!
+    camera.free();
+}}