Tauri Plugin

Test a Tauri app’s real window with seleniumbase-rs (BaseCase and the sbrs CLI) on macOS, Windows and Linux.

Tauri apps use the system webview. Windows (WebView2) and Linux (WebKitGTK) have WebDriver drivers, but macOS (WKWebView) has none. This plugin runs a small W3C WebDriver endpoint inside your app, so the same tests drive the app everywhere.

Set up your app#

[features]e2e = ["dep:tauri-plugin-sbrs-automation"][dependencies]tauri-plugin-sbrs-automation = { git = "https://github.com/MustCodeAl/tauri-plugin-sbrs-automation", optional = true }

let mut builder = tauri::Builder::default();#[cfg(feature = "e2e")]{    builder = builder.plugin(tauri_plugin_sbrs_automation::init());}

{  "identifier": "e2e-automation",  "windows": ["main"],  "permissions": ["sbrs-automation:default"]}

fn main() {    let capabilities = if std::env::var_os("CARGO_FEATURE_E2E").is_some() {        "./capabilities/**/*"    } else {        "./capabilities/*.json"    };    println!("cargo:rerun-if-changed=capabilities");    let attributes = tauri_build::Attributes::new().capabilities_path_pattern(capabilities);    if let Err(error) = tauri_build::try_build(attributes) {        panic!("{error:#}");    }}

Run a test#

Start the app with a token of your choice (or read the random one it prints):

SBRS_AUTOMATION_TOKEN=secret cargo tauri dev --features e2e

Then point BaseCase at it. The URL ends with /: WebDriver clients join each command path (session, …) to the server URL as a relative URL, so without the slash the token is replaced and every request is refused with the URL does not start with the token.

use seleniumbase_rs::{BaseCase, BrowserConfig};#[tokio::test]async fn saving_a_profile() -> Result<(), seleniumbase_rs::SeleniumBaseError> {    let config = BrowserConfig::default().with_webdriver_url("http://127.0.0.1:4445/secret/");    let mut sb = BaseCase::new(config).await?;    sb.type_text("#name", "Work").await?;    sb.click("#save").await?;    sb.assert_text("Saved", "#status").await?;    sb.quit().await}

Any WebDriver client works the same way with http://127.0.0.1:4445/secret/ as its server URL. A new session waits until the app’s window has loaded its page, so a test can start one as soon as the endpoint answers GET /secret/status. For a test that starts the app itself, see examples/tauri-profile-manager/src-tauri/tests/e2e_automation.rs in seleniumbase-rs.

Settings#

The plugin reads these environment variables once, when the app starts.

Supported commands#

Every path starts with /<token>; session commands with /session/{id}. The API reference gives each command’s fields, replies and errors, with request and response examples.

Details#

Changing the page script#

The page script is written in TypeScript in src/bridge.ts. src/bridge.js is generated from it and is what the plugin embeds, so apps that use the plugin build without Node or Bun.

How it works#

The server turns each WebDriver command into an operation of an injected script (src/bridge.js), which runs it in the page and sends the result back through Tauri’s IPC. The window commands and screenshots ask the native window instead: the page cannot tell the window’s outer size (WKWebView reports it as 0), and WebKit draws the page out of process.

Security#

License#

MIT.