Skip to content

Debugging WebDriver tests in real-time with support for Selenium, WebdriverIO and Nightwatch

License

Notifications You must be signed in to change notification settings

webdriverio/devtools

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

WebdriverIO DevTools

A powerful browser devtools extension for debugging, visualizing, and controlling WebdriverIO test executions in real-time.

Features

๐ŸŽฏ Interactive Test Execution

  • Selective Test Rerun: Click play buttons on individual test cases, test suites, or Cucumber scenario examples to re-execute them instantly
  • Smart Browser Reuse: Tests rerun in the same browser window without opening new tabs, improving performance and user experience
  • Stop Test Execution: Terminate running tests with proper process cleanup using the stop button
  • Test List Preservation: All tests remain visible in the sidebar during reruns, maintaining full context

๐ŸŽญ Multi-Framework Support

  • Mocha: Full support with grep-based filtering for test/suite execution
  • Jasmine: Complete integration with grep-based filtering
  • Cucumber: Scenario-level and example-specific execution with feature:line targeting

๐Ÿ“Š Real-Time Visualization

  • Live Browser Preview: View the application under test in a scaled iframe with automatic screenshot updates
  • Actions Timeline: Command-by-command execution log with timestamps and parameters
  • Test Hierarchy: Nested test suite and test case tree view with status indicators
  • Live Status Updates: Immediate spinner icons and visual feedback when tests start/stop

๐Ÿ” Debugging Capabilities

  • Command Logging: Detailed capture of all WebDriver commands with arguments and results
  • Screenshot Capture: Automatic screenshots after each command for visual debugging
  • Source Code Mapping: View the exact line of code that triggered each command
  • Console Logs: Capture and display application console output
  • Error Tracking: Full error messages and stack traces for failed tests

๐ŸŽฎ Execution Controls

  • Global Test Running State: All play buttons automatically disable during test execution to prevent conflicts
  • Immediate Feedback: Spinner icons update instantly when tests start
  • Actions Tab Auto-Clear: Execution data automatically clears and refreshes on reruns
  • Metadata Tracking: Test duration, status, and execution timestamps

๐Ÿ—๏ธ Architecture

  • Frontend: Lit web components with reactive state management (@lit/context)
  • Backend: Fastify server with WebSocket streaming for real-time updates
  • Service: WebdriverIO reporter integration with stable UID generation
  • Process Management: Tree-kill for proper cleanup of spawned processes

Installation

npm install @wdio/devtools-service

Configuration

Add the service to your wdio.conf.js:

export const config = {
    // ...
    services: ['devtools']
}

Usage

  1. Run your WebdriverIO tests
  2. The devtools UI automatically opens in an external browser window at http://localhost:3000
  3. Tests begin executing immediately with real-time visualization
  4. View live browser preview, test progress, and command execution
  5. After initial run completes, use play buttons to rerun individual tests or suites
  6. Click stop button anytime to terminate running tests
  7. Explore actions, metadata, console logs, and source code in the workbench tabs

Development

# Install dependencies
pnpm install

# Build all packages
pnpm build

# Run demo
pnpm demo

Project Structure

packages/
โ”œโ”€โ”€ app/          # Frontend Lit-based UI application
โ”œโ”€โ”€ backend/      # Fastify server with test runner management
โ”œโ”€โ”€ service/      # WebdriverIO service and reporter
โ””โ”€โ”€ script/       # Browser-injected trace collection script

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

๐Ÿ“„ License

MIT

About

Debugging WebDriver tests in real-time with support for Selenium, WebdriverIO and Nightwatch

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Sponsor this project

Packages

No packages published