Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DVI-5212 Add newer Electron versions and update notes. #2873

Merged
merged 3 commits into from
Aug 1, 2024
Merged

DVI-5212 Add newer Electron versions and update notes. #2873

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b055c96
Add newer Electron versions and update notes.
jasonrossatsauce Aug 1, 2024
a37917c
Added MacOS 10.15
jasonrossatsauce Aug 1, 2024
2cb721a
Update example
jasonrossatsauce Aug 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 14 additions & 7 deletions docs/web-apps/automated-testing/electron.md
View file
Open in desktop
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.
Loading