Fix release test; add guidance to re-enable itests panic messages

Author: Bromeon

godot-core/src/private.rs

@@ -225,7 +225,6 @@ pub fn extract_panic_message(err: &(dyn Send + std::any::Any)) -> String {
     }
 }
 
-#[doc(hidden)]
 pub fn format_panic_message(panic_info: &std::panic::PanicHookInfo) -> String {
     let mut msg = extract_panic_message(panic_info.payload());
 

itest/rust/src/framework/mod.rs

@@ -171,16 +171,24 @@ pub fn passes_filter(filters: &[String], test_name: &str) -> bool {
 
 // ----------------------------------------------------------------------------------------------------------------------------------------------
 // Toolbox for tests
+
+/// Swaps panic hooks, to disable printing during expected panics. Also disables gdext's panic printing.
 pub fn suppress_panic_log<R>(callback: impl FnOnce() -> R) -> R {
-    // Exchange panic hook, to disable printing during expected panics. Also disable gdext's panic printing.
+    // DISABLE following lines to *temporarily* debug panics.
+    // Note that they currently print "itest `{}` failed", even if the test doesn't fail (which isn't usually relevant in suppressed mode).
     let prev_hook = panic::take_hook();
     panic::set_hook(Box::new(
         |_panic_info| { /* suppress panic hook; do nothing */ },
     ));
+
+    // Keep following lines.
     let prev_print_level = godot::private::set_error_print_level(0);
     let res = callback();
-    panic::set_hook(prev_hook);
     godot::private::set_error_print_level(prev_print_level);
+
+    // DISABLE following line to *temporarily* debug panics.
+    panic::set_hook(prev_hook);
+
     res
 }
 

itest/rust/src/framework/runner.rs

@@ -444,8 +444,11 @@ fn run_rust_test(test: &RustTestCase, ctx: &TestContext) -> TestOutcome {
         return TestOutcome::Skipped;
     }
 
-    // Explicit type to prevent tests from returning a value
+    // This will appear in all panics, but those inside expect_panic() are suppressed.
+    // So the "itest failed" message will only appear for unexpected panics, where tests indeed fail.
     let err_context = || format!("itest `{}` failed", test.name);
+
+    // Explicit type to prevent tests from returning a value.
     let success: Result<(), _> = godot::private::handle_panic(err_context, || (test.function)(ctx));
 
     TestOutcome::from_bool(success.is_ok())

itest/rust/src/object_tests/dynamic_call_test.rs

@@ -140,6 +140,8 @@ fn dynamic_call_parameter_mismatch() {
     obj.free();
 }
 
+// There seems to be a weird bug where running *only* this test with #[itest(focus)] causes panic, which then causes a
+// follow-up failure of Gd::bind_mut(), preventing benchmarks from being run. Doesn't happen with #[itest], when running all.
 #[itest]
 fn dynamic_call_with_panic() {
     let panic_message = Arc::new(Mutex::new(None));
@@ -176,13 +178,20 @@ fn dynamic_call_with_panic() {
     if cfg!(target_os = "windows") {
         path = path.replace('/', "\\")
     }
-    // Obtain line number dynamically, avoids tedious maintenance on code reorganization.
+
+    // Obtain line number dynamically -- avoids tedious maintenance on code reorganization.
     let line = ObjPayload::get_panic_line();
     let context = error_context
         .map(|context| format!("\n  Context: {context}"))
         .unwrap_or_default();
 
-    let expected_panic_message = format!("[panic {path}:{line}]\n  do_panic exploded{context}");
+    // In Debug, there is a context -> message is multi-line -> '\n' is inserted after [panic ...].
+    // In Release, simpler message -> single line -> no '\n'.
+    let expected_panic_message = if cfg!(debug_assertions) {
+        format!("[panic {path}:{line}]\n  do_panic exploded{context}")
+    } else {
+        format!("[panic {path}:{line}]  do_panic exploded")
+    };
 
     assert_eq!(panic_message, expected_panic_message);