feat(core): expose test utils (#4752)

Author: lucasfernog

.changes/expose-test.md

@@ -0,0 +1,5 @@
+---
+"tauri": patch
+---
+
+Expose the `test` module behind the `test` Cargo feature.

.github/workflows/lint-core.yml

@@ -50,7 +50,7 @@ jobs:
         clippy:
           - { args: '', key: 'empty' }
           - {
-              args: '--features compression,wry,linux-protocol-headers,isolation,custom-protocol,api-all,cli,updater,system-tray,windows7-compat,http-multipart',
+              args: '--features compression,wry,linux-protocol-headers,isolation,custom-protocol,api-all,cli,updater,system-tray,windows7-compat,http-multipart,test',
               key: 'all'
             }
           - { args: '--features custom-protocol', key: 'custom-protocol' }

.github/workflows/test-core.yml

@@ -56,7 +56,7 @@ jobs:
               key: api-all
             }
           - {
-              args: --features compression,wry,linux-protocol-headers,isolation,custom-protocol,api-all,cli,updater,system-tray,windows7-compat,http-multipart,
+              args: --features compression,wry,linux-protocol-headers,isolation,custom-protocol,api-all,cli,updater,system-tray,windows7-compat,http-multipart,test,
               key: all
             }
 

core/tauri/Cargo.toml

@@ -26,6 +26,7 @@ features = [
   "devtools",
   "http-multipart",
   "icon-png",
+  "test",
   "dox"
 ]
 rustdoc-args = [ "--cfg", "doc_cfg" ]
@@ -126,6 +127,7 @@ cargo_toml = "0.11"
 
 [features]
 default = [ "wry", "compression", "objc-exception" ]
+test = []
 compression = [ "tauri-macros/compression", "tauri-utils/compression" ]
 wry = [ "tauri-runtime-wry" ]
 objc-exception = [ "tauri-runtime-wry/objc-exception" ]

core/tauri/src/app.rs

@@ -990,7 +990,7 @@ pub struct Builder<R: Runtime> {
   invoke_handler: Box<InvokeHandler<R>>,
 
   /// The JS message responder.
-  invoke_responder: Arc<InvokeResponder<R>>,
+  pub(crate) invoke_responder: Arc<InvokeResponder<R>>,
 
   /// The script that initializes the `window.__TAURI_POST_MESSAGE__` function.
   invoke_initialization_script: String,

core/tauri/src/lib.rs

@@ -11,6 +11,7 @@
 //! The following are a list of [Cargo features](https://doc.rust-lang.org/stable/cargo/reference/manifest.html#the-features-section) that can be enabled or disabled:
 //!
 //! - **wry** *(enabled by default)*: Enables the [wry](https://github.com/tauri-apps/wry) runtime. Only disable it if you want a custom runtime.
+//! - **test**: Enables the [`test`] module exposing unit test helpers.
 //! - **dox**: Internal feature to generate Rust documentation without linking on Linux.
 //! - **objc-exception**: Wrap each msg_send! in a @try/@catch and panics if an exception is caught, preventing Objective-C from unwinding into Rust.
 //! - **linux-protocol-headers**: Enables headers support for custom protocol requests on Linux. Requires webkit2gtk v2.36 or above.
@@ -839,8 +840,8 @@ pub(crate) mod sealed {
   }
 }
 
-/// Utilities for unit testing on Tauri applications.
-#[cfg(test)]
+#[cfg(any(test, feature = "test"))]
+#[cfg_attr(doc_cfg, doc(cfg(feature = "test")))]
 pub mod test;
 
 #[cfg(test)]

core/tauri/src/scope/ipc.rs

@@ -171,12 +171,16 @@ impl Scope {
 #[cfg(test)]
 mod tests {
   use super::RemoteDomainAccessScope;
-  use crate::{api::ipc::CallbackFn, test::MockRuntime, App, InvokePayload, Manager, Window};
+  use crate::{
+    api::ipc::CallbackFn,
+    test::{assert_ipc_response, mock_app, MockRuntime},
+    App, InvokePayload, Manager, Window,
+  };
 
   const PLUGIN_NAME: &str = "test";
 
   fn test_context(scopes: Vec<RemoteDomainAccessScope>) -> (App<MockRuntime>, Window<MockRuntime>) {
-    let app = crate::test::mock_app();
+    let app = mock_app();
     let window = app.get_window("main").unwrap();
 
     for scope in scopes {
@@ -186,44 +190,6 @@ mod tests {
     (app, window)
   }
 
-  fn assert_ipc_response(
-    window: &Window<MockRuntime>,
-    payload: InvokePayload,
-    expected: Result<&str, &str>,
-  ) {
-    let callback = payload.callback;
-    let error = payload.error;
-    window.clone().on_message(payload).unwrap();
-
-    let mut num_tries = 0;
-    let evaluated_script = loop {
-      std::thread::sleep(std::time::Duration::from_millis(50));
-      let evaluated_script = window.dispatcher().last_evaluated_script();
-      if let Some(s) = evaluated_script {
-        break s;
-      }
-      num_tries += 1;
-      if num_tries == 20 {
-        panic!("Response script not evaluated");
-      }
-    };
-    let (expected_response, fn_name) = match expected {
-      Ok(payload) => (payload, callback),
-      Err(payload) => (payload, error),
-    };
-    let expected = format!(
-      "window[\"_{}\"]({})",
-      fn_name.0,
-      crate::api::ipc::serialize_js(&expected_response).unwrap()
-    );
-
-    println!("Last evaluated script:");
-    println!("{evaluated_script}");
-    println!("Expected:");
-    println!("{expected}");
-    assert!(evaluated_script.contains(&expected));
-  }
-
   fn app_version_payload() -> InvokePayload {
     let callback = CallbackFn(0);
     let error = CallbackFn(1);