Skip to content

Commit

Permalink
Merge branch 'main' into peter/session-replay
Browse files Browse the repository at this point in the history
  • Loading branch information
rick-bt authored Aug 1, 2024
2 parents e17bde0 + 7d84c6a commit 23b124b
Showing 1 changed file with 14 additions and 7 deletions.
21 changes: 14 additions & 7 deletions docs/web-apps/automated-testing/electron.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,15 @@ import useBaseUrl from '@docusaurus/useBaseUrl';

Sauce Labs currently supports the following test configurations for Electron.
- Platforms
- Windows 10,
- Windows 11
- (Linux and MacOS 13 support to come)
- Windows 10
- Windows 11
- MacOS 10.15
- MacOS 11
- MacOS 12
- MacOS 13
- (Linux support to be decided)
- Electron versions
- versions 5 - 25
- versions 5 - 31 inclusive

## How to Get Started

Expand Down Expand Up @@ -48,12 +52,15 @@ then the `binary` value is `'Sauce Labs Test\SauceLabsElecronApp.exe'`.
### Configuring your tests

You need to specify Electron as the [`browserName`](https://docs.saucelabs.com/dev/test-configuration-options/#browsername) along with the Electron version needed as the [`browserVersion`](https://docs.saucelabs.com/dev/test-configuration-options/#browserversion). You will also need to include either the file ID or file name of your uploaded zip file containing your Electron app, with the path to the binary inside that zip.
Example written in Python with an Electron app test running on Windows 11 with Chromedriver 19 at US West:

Because Electron is based on the Chromium browser, you need to specify the options using the `ChromeOptions` class.

Example written in Python with an Electron app test running on Windows 11 with Electron 29 at US West:

```python
options = ChromeOptions()
options.set_capability('browserName', 'electron')
options.browser_version = '19'
options.browser_version = '29'
options.platform_name = 'Windows 11'
options.binary_location='<app_folder_name>\<app_file_name.exe>'
sauce_options = {}
Expand All @@ -71,6 +78,6 @@ Test results are visible on the UI under “Automated Tests > Test Results.’ Y

## Limitations

- Electron support is currently enabled only for automated testing on Windows 10 and 11.
- Electron support is currently enabled only for automated testing on Windows 10 and 11, and MacOS 10.15, 11, 12 and 13.
- Electron apps uploaded via REST API are not currently visible within the App Management of the UI.
- Live testing and UI enhancements to come in a future release.

0 comments on commit 23b124b

Please sign in to comment.