1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
// SPDX-License-Identifier: Apache-2.0
// SPDX-License-Identifier: MIT
//! Utilities for unit testing on Tauri applications.
//!
//! # Stability
//!
//! This module is unstable.
//!
//! # Examples
//!
//! ```rust
//! #[tauri::command]
//! fn my_cmd() {}
//!
//! fn create_app<R: tauri::Runtime>(mut builder: tauri::Builder<R>) -> tauri::App<R> {
//! builder
//! .setup(|app| {
//! // do something
//! Ok(())
//! })
//! .invoke_handler(tauri::generate_handler![my_cmd])
//! // remove the string argument on your app
//! .build(tauri::generate_context!("test/fixture/src-tauri/tauri.conf.json"))
//! .expect("failed to build app")
//! }
//!
//! fn main() {
//! // Use `tauri::Builder::default()` to use the default runtime rather than the `MockRuntime`;
//! // let app = create_app(tauri::Builder::default());
//! let app = create_app(tauri::test::mock_builder());
//! // app.run(|_handle, _event| {});
//! }
//!
//! //#[cfg(test)]
//! mod tests {
//! use tauri::Manager;
//! //#[cfg(test)]
//! fn something() {
//! let app = super::create_app(tauri::test::mock_builder());
//! let window = app.get_window("main").unwrap();
//! // do something with the app and window
//! // in this case we'll run the my_cmd command with no arguments
//! tauri::test::assert_ipc_response(
//! &window,
//! tauri::InvokePayload {
//! cmd: "my_cmd".into(),
//! tauri_module: None,
//! callback: tauri::api::ipc::CallbackFn(0),
//! error: tauri::api::ipc::CallbackFn(1),
//! inner: serde_json::Value::Null,
//! invoke_key: Some(tauri::test::INVOKE_KEY.into()),
//! },
//! Ok(())
//! );
//! }
//! }
//! ```
#![allow(unused_variables)]
mod mock_runtime;
pub use mock_runtime::*;
use serde::de::DeserializeOwned;
use serde::Serialize;
use serde_json::Value as JsonValue;
use std::{
borrow::Cow,
collections::HashMap,
fmt::Debug,
hash::{Hash, Hasher},
sync::{
mpsc::{channel, Sender},
Arc, Mutex,
},
};
use crate::hooks::window_invoke_responder;
#[cfg(shell_scope)]
use crate::ShellScopeConfig;
use crate::{api::ipc::CallbackFn, App, Builder, Context, InvokePayload, Manager, Pattern, Window};
use tauri_utils::{
assets::{AssetKey, Assets, CspHash},
config::{CliConfig, Config, PatternKind, TauriConfig},
};
/// The invoke key used for tests.
pub const INVOKE_KEY: &str = "__invoke-key__";
/// A key for an [`Ipc`] call.
#[derive(Eq, PartialEq)]
struct IpcKey {
/// callback
callback: CallbackFn,
/// error callback
error: CallbackFn,
}
impl Hash for IpcKey {
fn hash<H: Hasher>(&self, state: &mut H) {
self.callback.0.hash(state);
self.error.0.hash(state);
}
}
/// Structure to retrieve result of a Tauri command
struct Ipc(Mutex<HashMap<IpcKey, Sender<std::result::Result<JsonValue, JsonValue>>>>);
/// An empty [`Assets`] implementation.
pub struct NoopAsset {
assets: HashMap<&'static str, &'static [u8]>,
csp_hashes: Vec<CspHash<'static>>,
}
impl Assets for NoopAsset {
fn get(&self, key: &AssetKey) -> Option<Cow<'_, [u8]>> {
None
}
fn iter(&self) -> Box<dyn Iterator<Item = (&&str, &&[u8])> + '_> {
Box::new(self.assets.iter())
}
fn csp_hashes(&self, html_path: &AssetKey) -> Box<dyn Iterator<Item = CspHash<'_>> + '_> {
Box::new(self.csp_hashes.iter().copied())
}
}
/// Creates a new empty [`Assets`] implementation.
pub fn noop_assets() -> NoopAsset {
NoopAsset {
assets: Default::default(),
csp_hashes: Default::default(),
}
}
/// Creates a new [`crate::Context`] for testing.
pub fn mock_context<A: Assets>(assets: A) -> crate::Context<A> {
Context {
config: Config {
schema: None,
package: Default::default(),
tauri: TauriConfig {
pattern: PatternKind::Brownfield,
windows: vec![Default::default()],
cli: Some(CliConfig {
description: None,
long_description: None,
before_help: None,
after_help: None,
args: None,
subcommands: None,
}),
bundle: Default::default(),
allowlist: Default::default(),
security: Default::default(),
updater: Default::default(),
system_tray: None,
macos_private_api: false,
},
build: Default::default(),
plugins: Default::default(),
},
assets: Arc::new(assets),
default_window_icon: None,
app_icon: None,
system_tray_icon: None,
package_info: crate::PackageInfo {
name: "test".into(),
version: "0.1.0".parse().unwrap(),
authors: "Tauri",
description: "Tauri test",
},
_info_plist: (),
pattern: Pattern::Brownfield(std::marker::PhantomData),
#[cfg(shell_scope)]
shell_scope: ShellScopeConfig {
open: None,
scopes: HashMap::new(),
},
}
}
/// Creates a new [`Builder`] using the [`MockRuntime`].
///
/// To use a dummy [`Context`], see [`mock_app`].
///
/// # Examples
///
/// ```rust
/// #[cfg(test)]
/// fn do_something() {
/// let app = tauri::test::mock_builder()
/// // remove the string argument to use your app's config file
/// .build(tauri::generate_context!("test/fixture/src-tauri/tauri.conf.json"))
/// .unwrap();
/// }
/// ```
pub fn mock_builder() -> Builder<MockRuntime> {
let mut builder = Builder::<MockRuntime>::new().manage(Ipc(Default::default()));
builder.invoke_key = INVOKE_KEY.to_string();
builder.invoke_responder = Arc::new(|window, response, callback, error| {
let window_ = window.clone();
let ipc = window_.state::<Ipc>();
let mut ipc_ = ipc.0.lock().unwrap();
if let Some(tx) = ipc_.remove(&IpcKey { callback, error }) {
tx.send(response.into_result()).unwrap();
} else {
window_invoke_responder(window, response, callback, error)
}
});
builder
}
/// Creates a new [`App`] for testing using the [`mock_context`] with a [`noop_assets`].
pub fn mock_app() -> App<MockRuntime> {
mock_builder().build(mock_context(noop_assets())).unwrap()
}
/// Executes the given IPC message and assert the response matches the expected value.
///
/// # Examples
///
/// ```rust
/// #[tauri::command]
/// fn ping() -> &'static str {
/// "pong"
/// }
///
/// fn create_app<R: tauri::Runtime>(mut builder: tauri::Builder<R>) -> tauri::App<R> {
/// builder
/// .invoke_handler(tauri::generate_handler![ping])
/// // remove the string argument on your app
/// .build(tauri::generate_context!("test/fixture/src-tauri/tauri.conf.json"))
/// .expect("failed to build app")
/// }
///
/// use tauri::Manager;
/// use tauri::test::mock_builder;
/// fn main() {
/// // app createion with a `MockRuntime`
/// let app = create_app(mock_builder());
/// let window = app.get_window("main").unwrap();
///
/// // run the `ping` command and assert it returns `pong`
/// tauri::test::assert_ipc_response(
/// &window,
/// tauri::InvokePayload {
/// cmd: "ping".into(),
/// tauri_module: None,
/// callback: tauri::api::ipc::CallbackFn(0),
/// error: tauri::api::ipc::CallbackFn(1),
/// inner: serde_json::Value::Null,
/// invoke_key: Some(tauri::test::INVOKE_KEY.into()),
/// },
/// // the expected response is a success with the "pong" payload
/// // we could also use Err("error message") here to ensure the command failed
/// Ok("pong")
/// );
/// }
/// ```
pub fn assert_ipc_response<T: Serialize + Debug>(
window: &Window<MockRuntime>,
payload: InvokePayload,
expected: Result<T, T>,
) {
assert_eq!(
get_ipc_response(window, payload),
expected
.map(|e| serde_json::to_value(e).unwrap())
.map_err(|e| serde_json::to_value(e).unwrap())
);
}
/// The application processes the command and stops.
///
/// # Examples
///
/// ```rust
///
/// #[tauri::command]
/// fn ping() -> &'static str {
/// "pong"
/// }
///
/// fn create_app<R: tauri::Runtime>(mut builder: tauri::Builder<R>) -> tauri::App<R> {
/// builder
/// .invoke_handler(tauri::generate_handler![ping])
/// // remove the string argument on your app
/// .build(tauri::generate_context!("test/fixture/src-tauri/tauri.conf.json"))
/// .expect("failed to build app")
/// }
///
/// use tauri::test::*;
/// use tauri::Manager;
/// let app = create_app(mock_builder());
/// let window = app.get_window("main").unwrap();
///
/// // run the `ping` command and assert it returns `pong`
/// let res = tauri::test::get_ipc_response::<String>(
/// &window,
/// tauri::InvokePayload {
/// cmd: "ping".into(),
/// tauri_module: None,
/// callback: tauri::api::ipc::CallbackFn(0),
/// error: tauri::api::ipc::CallbackFn(1),
/// inner: serde_json::Value::Null,
/// invoke_key: Some(tauri::test::INVOKE_KEY.into()),
/// });
/// assert_eq!(res, Ok("pong".into()))
/// ```
pub fn get_ipc_response<T: DeserializeOwned + Debug>(
window: &Window<MockRuntime>,
payload: InvokePayload,
) -> Result<T, T> {
let callback = payload.callback;
let error = payload.error;
let ipc = window.state::<Ipc>();
let (tx, rx) = channel();
ipc.0.lock().unwrap().insert(IpcKey { callback, error }, tx);
window.clone().on_message(payload).unwrap();
let res: Result<JsonValue, JsonValue> = rx.recv().expect("Failed to receive result from command");
res
.map(|v| serde_json::from_value(v).unwrap())
.map_err(|e| serde_json::from_value(e).unwrap())
}
#[cfg(test)]
pub(crate) fn mock_invoke_context() -> crate::endpoints::InvokeContext<MockRuntime> {
let app = mock_app();
crate::endpoints::InvokeContext {
window: app.get_window("main").unwrap(),
config: app.config(),
package_info: app.package_info().clone(),
}
}
#[cfg(test)]
mod tests {
use crate::Manager;
use std::time::Duration;
use super::mock_app;
#[test]
fn run_app() {
let app = mock_app();
let w = app.get_window("main").unwrap();
std::thread::spawn(move || {
std::thread::sleep(Duration::from_secs(1));
w.close().unwrap();
});
app.run(|_app, event| {
println!("{:?}", event);
});
}
}