WDIO Electron Service

WebdriverIO service for testing Electron applications

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

Spiritual successor to Spectron (RIP).

Features

Makes testing Electron applications much easier via:

• 🚗 auto-setup of required Chromedriver (for Electron v26 and above)
• 📦 automatic path detection of your Electron application
  • supports Electron Forge, Electron Builder and unpackaged apps
• 🧩 access Electron APIs within your tests
• 🕵️ mocking of Electron APIs via a Vitest-like API

Installation

You will need to install WebdriverIO, instructions can be found here.

Quick Start

The recommended way to get up and running quickly is to use the WDIO configuration wizard.

Manual Quick Start

To get started without using the configuration wizard, you will need to install the service and @wdio/cli:

1npm install --dev @wdio/cli wdio-electron-service

Or use your package manager of choice - pnpm, yarn, etc.

Next, create your WDIO configuration file. If you need some inspiration for this, there is a working configuration in the example directory of this repository, as well as the WDIO configuration reference page.

You will need to add electron to your services array and set an Electron capability, e.g.:

wdio.conf.ts

1export const config = {
2  // ...
3  services: ['electron'],
4  capabilities: [
5    {
6      browserName: 'electron',
7    },
8  ],
9  // ...
10};

Finally, run some tests using your configuration file.

This will spin up an instance of your app in the same way that WDIO handles browsers such as Chrome or Firefox. The service works with WDIO (parallel) multiremote if you need to run additional instances simultaneously, e.g. multiple instances of your app or different combinations of your app and a Web browser.

If you use Electron Forge or Electron Builder to package your app then the service will automatically attempt to find the path to your bundled Electron application. You can provide a custom path to the binary via custom service capabilities, e.g.:

wdio.conf.ts

1export const config = {
2  // ...
3  capabilities: [
4    {
5      'browserName': 'electron',
6      'wdio:electronServiceOptions': {
7        appBinaryPath: './path/to/built/electron/app.exe',
8        appArgs: ['foo', 'bar=baz'],
9      },
10    },
11  ],
12  // ...
13};

Alternatively, you can point the service at an unpackaged app by providing the path to the main.js script. Electron will need to be installed in your node_modules. It is recommended to bundle unpackaged apps using a bundler such as Rollup, Parcel, Webpack, etc.

wdio.conf.ts

1export const config = {
2  // ...
3  capabilities: [
4    {
5      'browserName': 'electron',
6      'wdio:electronServiceOptions': {
7        appEntryPoint: './path/to/bundled/electron/main.bundle.js',
8        appArgs: ['foo', 'bar=baz'],
9      },
10    },
11  ],
12  // ...
13};

Chromedriver Configuration

If your app uses a version of Electron which is lower than v26 then you will need to manually configure Chromedriver.

This is because WDIO uses Chrome for Testing to download Chromedriver, which only provides Chromedriver versions of v115 or newer.

Documentation

Service Configuration
Chromedriver Configuration
Accessing Electron APIs
Mocking Electron APIs
Standalone Mode
Development
Common Issues & Debugging

Development

Read the development doc if you are interested in contributing.

Example Integrations

Check out our Electron boilerplate project that showcases how to integrate WebdriverIO in an example application. You can also have a look at the Example Apps and E2Es directories in this repository.

Support

If you are having issues running WDIO with the service you should check the documented Common Issues in the first instance, then open a discussion in the main WDIO forum.

The Electron service discussion forum is much less active than the WDIO one, but if the issue you are experiencing is specific to Electron or using the service then you can open a discussion here.