Skip to content

README.md

Latest commit

 

History

History
145 lines (102 loc) · 4.74 KB

README.md

File metadata and controls

145 lines (102 loc) · 4.74 KB

@wdio/tauri-service

@wdio/tauri-service Version Downloads

WebdriverIO service for testing Tauri applications on Windows, Linux, and macOS.

Enables cross-platform E2E testing of Tauri apps via the extensive WebdriverIO ecosystem.

Features

  • 🚗 Automatic tauri-driver installation and management
  • 🔧 Automatic Edge WebDriver management on Windows
  • 📦 Automatic Tauri binary path detection
  • 🌐 Cross-platform support (Windows, Linux, macOS)
  • 🔗 Full Tauri API access via browser.tauri.execute()
  • 🧩 Mocking support for Tauri's invoke API
  • 📊 Backend and frontend log capture
  • 🖥️ Multiremote testing support
  • 🏃 Per-worker driver spawning for parallel testing

Installation

Install the service via npm:

npm install --save-dev @wdio/tauri-service

Or with pnpm:

pnpm add -D @wdio/tauri-service

Quick Start

Get started in minutes with the Quick Start Guide.

Minimal Configuration

Add to your wdio.conf.ts:

export const config = {
  services: ['@wdio/tauri-service'],

  capabilities: [
    {
      browserName: 'tauri',
      'tauri:options': {
        application: './src-tauri/target/release/my-app.exe'
      }
    }
  ]
};

See Configuration Reference for all options.

Documentation

Getting Started

Reference

Guides

Help & Support

Platform Support

Platform Supported Driver Providers Notes
Windows ✅ Yes official, crabnebula, embedded Edge WebDriver auto-managed
Linux ✅ Yes official, crabnebula, embedded Requires webkit2gtk-driver
macOS ✅ Yes embedded, crabnebula Native via embedded, or CrabNebula

See Platform Support for detailed information including distribution support and troubleshooting.

Choosing a driver provider:

  • embedded (recommended) — Native support on all platforms, no external driver needed
  • official — Community driver, Windows/Linux only
  • crabnebula — All platforms, requires subscription (CN_API_KEY for macOS)

Example Projects

Check out the E2E test fixtures in the desktop-mobile repository for complete working examples.

Support

Having trouble? Here are some resources:

  1. Troubleshooting Guide - Solutions for common issues
  2. Platform Support - Platform-specific information
  3. GitHub Issues - Bug reports and feature requests for tauri-service
  4. WebdriverIO Forum - General community help and discussions

Contributing

We welcome contributions! Please see our Development Guide for:

  • Setting up your development environment
  • Running tests
  • Code style guidelines
  • Pull request process

Quick start for contributors:

# Clone and install
git clone https://github.com/webdriverio/desktop-mobile.git
cd desktop-mobile
pnpm install

# Make your changes
# ...

# Run tests
pnpm test

# Submit a pull request

License

MIT License. See LICENSE file for details.

See Also