Skip to content

Latest commit

 

History

History
208 lines (156 loc) · 7.43 KB

README.md

File metadata and controls

208 lines (156 loc) · 7.43 KB

WebdriverIO Desktop & Mobile Testing Services

Specialized WebdriverIO services for testing Electron and Tauri applications

Overview

This monorepo provides specialized WebdriverIO services for testing desktop and mobile applications across modern frameworks. Our services enable comprehensive end-to-end testing with automatic binary management, API mocking, and seamless integration with WebdriverIO's testing ecosystem.

Current Services

  • Electron Service - Production-ready testing for Electron applications with automatic binary detection, CDP bridge for main process access, comprehensive API mocking, and window management
  • Tauri Service - Full-featured testing for Tauri applications with official tauri-driver integration, multiremote support, and plugin-based architecture

Future Services

We aim to add Flutter and Neutralino integrations in the near future to expand cross-platform testing capabilities.

Quick Start

# Install dependencies
pnpm install

# Build all packages
pnpm build

# Run tests
pnpm test

# Run linting
pnpm lint

Project Structure

desktop-mobile-testing/
├── packages/                    # Service packages
│   ├── electron-service/        # Electron service implementation
│   ├── tauri-service/           # Tauri service implementation
│   ├── electron-cdp-bridge/     # Chrome DevTools Protocol bridge
│   ├── native-utils/            # Cross-platform utilities
│   ├── native-types/            # TypeScript type definitions
│   ├── bundler/                 # Build tool for packaging
│   └── tauri-plugin/            # Tauri plugin for backend access
├── fixtures/                   # Test fixtures and example apps
│   ├── e2e-apps/               # E2E test applications
│   ├── package-tests/          # Package integration tests
│   └── config-formats/         # Configuration format test fixtures
├── e2e/                        # End-to-end test suites
│   ├── test/                   # Test specifications
│   │   ├── electron/           # Electron E2E tests
│   │   └── tauri/              # Tauri E2E tests
│   └── scripts/                # Test execution scripts
├── docs/                       # Documentation
└── scripts/                    # Build and utility scripts

Services

Electron Service

Production-ready WebdriverIO service for testing Electron applications with advanced features.

  • 📦 Package: @wdio/electron-service
  • 📖 Docs: packages/electron-service/README.md
  • ✨ Features:
    • Automatic Electron binary detection and management
    • CDP bridge for main process API access
    • Comprehensive API mocking and stubbing
    • Window management and lifecycle control
    • Deep link testing support
    • Multi-instance testing capabilities

Tauri Service

Full-featured WebdriverIO service for testing Tauri applications with native integration.

  • 📦 Package: @wdio/tauri-service
  • 📖 Docs: packages/tauri-service/README.md
  • ✨ Features:
    • Official tauri-driver integration
    • Multiremote testing support
    • Plugin-based architecture
    • Automatic binary detection
    • Advanced execute capabilities

Supporting Packages

  • @wdio/native-utils - Cross-platform utilities for binary detection and config parsing
  • @wdio/native-types - TypeScript type definitions for Electron and Tauri APIs
  • @wdio/electron-cdp-bridge - Chrome DevTools Protocol bridge for main process communication
  • @wdio/bundler - Build tool for packaging and bundling service packages
  • @wdio/tauri-plugin - Tauri plugin providing backend access capabilities for testing

Development

Requirements

  • Node.js 18 LTS or 20 LTS
  • pnpm 10.27.0+

Setup

# Install dependencies
pnpm install

# Build all packages
pnpm build

Commands

# Development
pnpm build                 # Build all packages
pnpm dev                   # Watch mode for development
pnpm clean                 # Clean all build artifacts

# Testing
pnpm test                  # Run all tests
pnpm test:unit             # Run unit tests only
pnpm test:integration      # Run integration tests
pnpm test:coverage         # Run tests with coverage
pnpm test:package          # Run package integration tests
pnpm test:package:electron # Test Electron package integration
pnpm test:package:tauri    # Test Tauri package integration

# Code Quality
pnpm lint                  # Lint and format check
pnpm lint:fix              # Auto-fix linting issues
pnpm format                # Format code with Biome
pnpm typecheck             # Type check all packages

# E2E Testing
pnpm e2e                   # Run all E2E tests
pnpm e2e:electron-builder  # Electron builder E2E tests
pnpm e2e:electron-forge    # Electron forge E2E tests
pnpm e2e:electron-no-binary # Electron no-binary E2E tests
pnpm e2e:tauri             # Tauri E2E tests
pnpm e2e:standalone        # Standalone mode tests
pnpm e2e:multiremote       # Multiremote tests

# Package Management
pnpm release               # Release packages
pnpm catalog:update        # Update dependency catalogs
pnpm backport              # Run backport script

Testing

Test Commands

# Core Testing
pnpm test                  # Run all unit and integration tests
pnpm test:unit             # Unit tests only
pnpm test:integration      # Integration tests only
pnpm test:coverage         # Run with coverage reporting

# Package Integration Testing
pnpm test:package          # Test published packages in isolation
pnpm test:package:electron # Electron package integration tests
pnpm test:package:tauri    # Tauri package integration tests

# End-to-End Testing
pnpm e2e                   # All E2E test suites
pnpm e2e:electron-builder  # Electron builder applications
pnpm e2e:electron-forge    # Electron forge applications
pnpm e2e:electron-no-binary # Electron without pre-built binaries
pnpm e2e:tauri             # Tauri applications
pnpm e2e:standalone        # Standalone mode testing
pnpm e2e:multiremote       # Multiremote browser testing

Contributing

We welcome contributions! Please see CONTRIBUTING.md for detailed guidelines.

Architecture

This monorepo is built with modern development tools and practices:

Tech Stack

  • 📦 pnpm workspaces - Efficient monorepo package management
  • ⚡ Turborepo - Fast, incremental builds with intelligent caching
  • 🔷 TypeScript - Type-safe development with dual ESM/CJS builds
  • 🧪 Vitest - Fast unit and integration testing framework
  • 🎨 Biome - High-performance formatting and linting
  • 🤖 GitHub Actions - Comprehensive CI/CD with multi-platform testing

License

MIT License - see LICENSE for details.

Community & Support

Related Projects