Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/webdriverio-community/wdio-electron-service

WebdriverIO service for testing Electron applications
https://github.com/webdriverio-community/wdio-electron-service

automation desktop-application e2e-testing electron electron-application electronjs webdriverio

Last synced: 5 days ago
JSON representation

WebdriverIO service for testing Electron applications

Awesome Lists containing this project

README 

        
# 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](https://github.com/electron-userland/spectron) ([RIP](https://github.com/electron-userland/spectron/issues/1045)).



### 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](https://www.electronforge.io/), [Electron Builder](https://www.electron.build/) 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](https://webdriver.io/docs/gettingstarted).



## Quick Start



The recommended way to get up and running quickly is to use the [WDIO configuration wizard](https://webdriver.io/docs/gettingstarted#initiate-a-webdriverio-setup).



### Manual Quick Start



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



```bash

npm 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](./example/wdio.conf.ts) of this repository, as well as the [WDIO configuration reference page](https://webdriver.io/docs/configuration).



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



_`wdio.conf.ts`_



```ts

export const config = {

  // ...

  services: ['electron'],

  capabilities: [

    {

      browserName: 'electron',

    },

  ],

  // ...

};

```



Finally, [run some tests](https://webdriver.io/docs/gettingstarted#run-test) 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](https://webdriver.io/docs/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](https://www.electronforge.io/) or [Electron Builder](https://www.electron.build/) 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`_



```ts

export const config = {

  // ...

  capabilities: [

    {

      'browserName': 'electron',

      'wdio:electronServiceOptions': {

        appBinaryPath: './path/to/built/electron/app.exe',

        appArgs: ['foo', 'bar=baz'],

      },

    },

  ],

  // ...

};

```



See the [configuration doc](./docs/configuration/service-configuration.md#appbinarypath) for how to find your `appBinaryPath` value for the different operating systems supported by Electron.



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`_



```ts

export const config = {

  // ...

  capabilities: [

    {

      'browserName': 'electron',

      'wdio:electronServiceOptions': {

        appEntryPoint: './path/to/bundled/electron/main.bundle.js',

        appArgs: ['foo', 'bar=baz'],

      },

    },

  ],

  // ...

};

```



## Chromedriver Configuration



**If your app uses a version of Electron which is lower than v26 then you will need to [manually configure Chromedriver](./docs/configuration/chromedriver-configuration.md#user-managed).**



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



## Documentation



**[Service Configuration](./docs/configuration/service-configuration.md)** \

**[Chromedriver Configuration](./docs/configuration/chromedriver-configuration.md)** \

**[Accessing Electron APIs](./docs/electron-apis/accessing-apis.md)** \

**[Mocking Electron APIs](./docs/electron-apis/mocking-apis.md)** \

**[Standalone Mode](./docs/standalone-mode.md)** \

**[Development](./docs/development.md)** \

**[Common Issues & Debugging](./docs/common-issues-debugging.md)**



## Development



Read the [development doc](./docs/development.md) if you are interested in contributing.



## Example Integrations



Check out our [Electron boilerplate](https://github.com/webdriverio/electron-boilerplate) project that showcases how to integrate WebdriverIO in an example application. You can also have a look at the [Example Apps](./apps/) and [E2Es](./e2e/) directories in this repository.



## Support



If you are having issues running WDIO with the service you should check the documented [Common Issues](./docs/common-issues.md) in the first instance, then open a discussion in the [main WDIO forum](https://github.com/webdriverio/webdriverio/discussions).



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](https://github.com/webdriverio-community/wdio-electron-service/discussions).