Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/basics/integrations/evinced.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,4 +82,4 @@

Check out the [Evinced](https://www.evinced.com/) and [Sauce Labs](https://saucelabs.com/sign-up) pages for more information on getting started!

This page was developed with the generous help of the Evinced team, from [their own documentation](https://get-evinced.com/blog/evinced-flow-analyzer-for-mobile-sauce-labs/).
This page was developed with the generous help of the Evinced team, from [their own documentation](https://www.evinced.com/blog/evinced-flow-analyzer-for-mobile-sauce-labs).

Check warning on line 85 in docs/basics/integrations/evinced.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/basics/integrations/evinced.md#L85

[sauce.MeaningfulLinkWords] Improve SEO and accessibility by rewriting 'This page' in the link text.
Raw output
{"message": "[sauce.MeaningfulLinkWords] Improve SEO and accessibility by rewriting 'This page' in the link text.", "location": {"path": "docs/basics/integrations/evinced.md", "range": {"start": {"line": 85, "column": 1}}}, "severity": "WARNING"}
2 changes: 1 addition & 1 deletion docs/basics/integrations/uipath.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Before introducing Sauce Labs devices, it might be helpful to show an example of
- **Platform** - Select **Android** or **iOS** from the dropdown.
- **Device Name** - Enter the device name.
- **Platform Version** - Add the version number of your Android OS.
- **Additional Desired Capabilities** (_Optional_) - Add specific capabilities to customize your automation session. For more information, see [Appium Desired Capabilities](http://appium.io/docs/en/writing-running-appium/caps/#appium-desired-capabilities).
- **Additional Desired Capabilities** (_Optional_) - Add specific capabilities to customize your automation session. For more information, see [Appium Desired Capabilities](https://appium.io/docs/en/latest/guides/caps/).
- **Set Geo Location** (_Optional_) - Set your device location to test applications that use Location Services to generate location data. <br/>
<img src={useBaseUrl('img/integrations/uipath 2.png')} alt="UiPath Mobile Device Manager configuration form" width="700" />
1. _Optional_ - From the **Logging** tab, configure logging and video recording settings.
Expand Down
3 changes: 1 addition & 2 deletions docs/basics/quickstarts.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,9 @@ Below you will find links to our quickstart guides and demo repos, listed by fra
| Espresso | <img src={useBaseUrl('/img/desktop-icon.png')} alt="Desktop" width="20"/> | Java | [GitHub](https://github.com/saucelabs/saucectl-espresso-example) |
| Nightwatch | <img src={useBaseUrl('/img/mobile-icon.png')} alt="Mobile" width="15"/><img src={useBaseUrl('/img/desktop-icon.png')} alt="Desktop" width="20"/> | JavaScript | [GitHub](https://github.com/saucelabs-training/demo-js/tree/master/nightwatch) |
| Playwright | <img src={useBaseUrl('/img/mobile-icon.png')} alt="Mobile" width="15"/> | JavaScript | [Quickstart Guide](/web-apps/automated-testing/playwright/quickstart)<br/>[GitHub](https://github.com/saucelabs/saucectl-playwright-example) |
| Protractor | <img src={useBaseUrl('/img/desktop-icon.png')} alt="Desktop" width="20"/> | JavaScript | [GitHub](https://github.com/saucelabs-training/demo-js/tree/master/protractor/) |
| Selenium | <img src={useBaseUrl('/img/mobile-icon.png')} alt="Mobile" width="15"/><img src={useBaseUrl('/img/desktop-icon.png')} alt="Desktop" width="20"/> | Java | [Quickstart Guide](/web-apps/automated-testing/selenium/quickstart)<br/>[GitHub](https://github.com/saucelabs-training/demo-java) |
| TestCafe | <img src={useBaseUrl('/img/mobile-icon.png')} alt="Mobile" width="15"/> | JavaScript | [Quickstart Guide](/web-apps/automated-testing/testcafe/quickstart)<br/>[GitHub](https://github.com/saucelabs/saucectl-testcafe-example) |
| WebdriverIO | <img src={useBaseUrl('/img/desktop-icon.png')} alt="Desktop" width="20"/> | JavaScript | [GitHub](https://github.com/saucelabs-training/demo-js/tree/master/webdriverio/appium-app) |
| WebdriverIO | <img src={useBaseUrl('/img/desktop-icon.png')} alt="Desktop" width="20"/> | JavaScript | [GitHub](https://github.com/saucelabs-training/demo-js/tree/main/webdriverio/mobile-app) |
| XCUITest | <img src={useBaseUrl('/img/desktop-icon.png')} alt="Desktop" width="20"/> | Swift | [GitHub](https://github.com/saucelabs-training/demo-xcuitest) |

## Sample Code by Language
Expand Down
2 changes: 1 addition & 1 deletion docs/basics/sso/configuring-sso-in-okta.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Complete the following steps to set up SAML SSO integration between Okta and Sau
1. Log into **Okta** administrator panel, go to **Applications** and click **Browse App Catalog**.
<img src={useBaseUrl('img/basics/sso/idp-config/okta/browse-app-catalog.png')} alt="Browse App Catalog" width="850" />

2. Search for **Sauce Labs**, then select the [**Sauce Labs**](https://www.okta.com/integrations/sauce-labs-0/) app.
2. Search for **Sauce Labs**, then select the [**Sauce Labs**](https://www.okta.com/integrations/sauce-labs/) app.
:::caution
Ensure that you install the new Sauce Labs app featuring the green logo. The app with the previous red logo is considered a legacy version and should not be used for new SSO integrations. It is integrated with the deprecated SSO implementation.
:::
Expand Down
2 changes: 1 addition & 1 deletion docs/basics/test-config-annotation/test-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ name:'S5 real device google.com'

### Examples for Mobile Native Application Tests

This following includes tips and examples of how to configure your mobile native app tests with Appium. For more detailed descriptions about the capabilities of Appium tests, check out the [Server Capabilities](http://appium.io/slate/en/master/?python#appium-server-capabilities) section of the official Appium website. All examples are for Java, but you can use the [Platform Configurator](https://saucelabs.com/platform/platform-configurator#/) to set the capabilities in the language of your choice.
This following includes tips and examples of how to configure your mobile native app tests with Appium. For more detailed descriptions about the capabilities of Appium tests, check out the [Server Capabilities](https://appium.io/docs/en/latest/guides/caps/) section of the official Appium website. All examples are for Java, but you can use the [Platform Configurator](https://saucelabs.com/platform/platform-configurator/) to set the capabilities in the language of your choice.

### Mobile Native Application Test Configuration Tips

Expand Down
2 changes: 1 addition & 1 deletion docs/dev/api/connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -360,7 +360,7 @@ curl -u "$SAUCE_USERNAME:$SAUCE_ACCESS_KEY" --location \
"sha1" : "<hash>"
},
"osx" : {
"download_url" : "https://saucelabs.com/downloads/sc-4.9.2-osx.zip",
"download_url" : "https://docs.saucelabs.com/secure-connections/sauce-connect-5/installation/",
"sha1" : "<hash>"
},
"win32" : {
Expand Down
2 changes: 1 addition & 1 deletion docs/dev/cli/saucectl/usage/ide/intellij.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ IntelliJ can help you edit the `saucectl` configuration files by providing helpf

## JSON Schema Validation

Our JSON schema is published to the [JSON Schema Store](https://www.schemastore.org/json/), which is made available to IntelliJ. To proceed, open your `saucectl` config yaml in IntelliJ and select the `SauceCTL Configuration` schema [per the IDEA instructions](https://www.jetbrains.com/help/idea/json.html#ws_json_using_schemas).
Our JSON schema is published to the [JSON Schema Store](https://www.schemastore.org/), which is made available to IntelliJ. To proceed, open your `saucectl` config yaml in IntelliJ and select the `SauceCTL Configuration` schema [per the IDEA instructions](https://www.jetbrains.com/help/idea/json.html#ws_json_using_schemas).

<img src={useBaseUrl('img/stt/intellij-saucectl-schema-dropdown.png')} alt="IntelliJ Schema Dropdown" />

Expand Down
2 changes: 1 addition & 1 deletion docs/dev/cli/saucectl/usage/ide/vscode.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Visual Studio Code can help you edit the `saucectl` configuration files by provi

## JSON Schema Validation

Our JSON schema is published to the [JSON Schema Store](https://www.schemastore.org/json/), which is made available to Visual Studio Code.
Our JSON schema is published to the [JSON Schema Store](https://www.schemastore.org/), which is made available to Visual Studio Code.

:::caution Default Limitations
By default, JSON Schema validation _only_ works with JSON files, not YAML. So make sure to have the YAML extension installed or this will not work.
Expand Down
2 changes: 1 addition & 1 deletion docs/dev/cli/saucectl/usage/ide/zed.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Zed can help you edit the `saucectl` configuration files by providing helpful su

## JSON Schema Validation

Our JSON schema is published to the [JSON Schema Store](https://www.schemastore.org/json/), which is made available to Zed.
Our JSON schema is published to the [JSON Schema Store](https://www.schemastore.org/), which is made available to Zed.

If your `saucectl` config YAML is stored in a `.sauce/` folder, Zed will automatically apply the schema to all YAML files contained in that folder and no further action is required.

Expand Down
10 changes: 5 additions & 5 deletions docs/dev/test-configuration-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@

<p><small>| BOOLEAN | <span className="sauceGreen">Desktop Only</span> | <span className="sauceGreen">BETA</span> |</small></p>

Enables [W3C WebDriver BiDi](https://w3c.github.io/webdriver-bidi/) support. This allows Selenium 4 clients to use [Bi-Directional functionality](https://www.selenium.dev/documentation/webdriver/bidirectional/). It also enables BiDi for other test frameworks, like [WebDriverIO](https://webdriver.io/docs/api/webdriverBidi/). In particular, this capability exposes the WebSocket endpoint which is available under `webSocketUrl` field in session startup response body. This endpoint can be used to issue WebDriver BiDi commands as described by the [specification](https://w3c.github.io/webdriver-bidi/). The default value is `false`.
Enables [W3C WebDriver BiDi](https://w3c.github.io/webdriver-bidi/) support. This allows Selenium 4 clients to use [Bi-Directional functionality](https://www.selenium.dev/documentation/webdriver/bidi/). It also enables BiDi for other test frameworks, like [WebDriverIO](https://webdriver.io/docs/api/webdriverBidi/). In particular, this capability exposes the WebSocket endpoint which is available under `webSocketUrl` field in session startup response body. This endpoint can be used to issue WebDriver BiDi commands as described by the [specification](https://w3c.github.io/webdriver-bidi/). The default value is `false`.

The `webSocketUrl` capability is **not compatible** with [`extendedDebugging`](#extendeddebugging) capability.

Expand Down Expand Up @@ -370,7 +370,7 @@

<p><small>| OPTIONAL | BOOLEAN | <span className="sauceGreen">Desktop Only</span> | <span className="sauceGreen">BETA</span> | </small></p>

Enables [Chrome DevTools Protocol](https://chromedevtools.github.io/devtools-protocol/) support, which is disabled by default on Sauce Labs platform. This allows Selenium 4 clients to use [Bi-Directional functionality](https://www.selenium.dev/documentation/webdriver/bidirectional/). In particular, this capability exposes the WebSocket endpoint which is available under `se:cdp` field in session startup response body. This endpoint can be used to issue Chrome DevTools Protocol commands as described by the [specification](https://chromedevtools.github.io/devtools-protocol/). The default value is `false`.
Enables [Chrome DevTools Protocol](https://chromedevtools.github.io/devtools-protocol/) support, which is disabled by default on Sauce Labs platform. This allows Selenium 4 clients to use [Bi-Directional functionality](https://www.selenium.dev/documentation/webdriver/bidi/). In particular, this capability exposes the WebSocket endpoint which is available under `se:cdp` field in session startup response body. This endpoint can be used to issue Chrome DevTools Protocol commands as described by the [specification](https://chromedevtools.github.io/devtools-protocol/). The default value is `false`.

The `devTools` capability is **not compatible** with [`extendedDebugging`](#extendeddebugging) capability.

Expand Down Expand Up @@ -650,7 +650,7 @@
:::

:::tip
You can get the current activity by using the Appium [`currentActivity`](https://appium.io/docs/en/commands/device/activity/current-activity/) command. This is the Appium 1 command, but will also work with Appium 2.
You can get the current activity by using the Appium [`currentActivity`](https://appium.io/docs/en/latest/) command. This is the Appium 1 command, but will also work with Appium 2.

Check warning on line 653 in docs/dev/test-configuration-options.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/dev/test-configuration-options.md#L653

[sauce.UnclearAntecedent] Instead of 'This is', try starting this sentence with a specific subject and verb.
Raw output
{"message": "[sauce.UnclearAntecedent] Instead of 'This is', try starting this sentence with a specific subject and verb.", "location": {"path": "docs/dev/test-configuration-options.md", "range": {"start": {"line": 653, "column": 118}}}, "severity": "WARNING"}
:::

```java
Expand Down Expand Up @@ -894,8 +894,8 @@

As with Selenium Tests, Appium also supports different types of timeouts like:

- [Implicit Wait Timeout](https://appium.io/docs/en/commands/session/timeouts/implicit-wait/#set-implicit-wait-timeout): Set the amount of time the driver should wait when searching for elements
- [Script Timeouts](https://appium.io/docs/en/commands/session/timeouts/async-script/index.html): Sets the amount of time, in milliseconds, that asynchronous scripts executed by [execute async](https://appium.io/docs/en/commands/web/execute-async/index.html) are permitted to run before they are cancelled (Web context only)
- [Implicit Wait Timeout](https://appium.io/docs/en/latest/): Set the amount of time the driver should wait when searching for elements
- [Script Timeouts](https://appium.io/docs/en/latest/): Sets the amount of time, in milliseconds, that asynchronous scripts executed by **[execute async](https://appium.io/docs/en/latest/)** are permitted to run before they are cancelled (Web context only)

Check warning on line 898 in docs/dev/test-configuration-options.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/dev/test-configuration-options.md#L898

[sauce.Inclusivity] Avoid problematic language. Use 'run' instead of 'execute'.
Raw output
{"message": "[sauce.Inclusivity] Avoid problematic language. Use 'run' instead of 'execute'.", "location": {"path": "docs/dev/test-configuration-options.md", "range": {"start": {"line": 898, "column": 140}}}, "severity": "WARNING"}

These timeouts can be controlled by the driver during the test session. There are timeouts that can be set as a capability for when you start the driver and can be driver specific.

Expand Down
2 changes: 1 addition & 1 deletion docs/error-reporting/advanced/client-tools-unix.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,4 +89,4 @@
$ apt-get install backtrace-hydra
```

Once installed, you may want to [configure Hydra](https://help.backtrace.io/advanced/component-hydra/hydra-setup).
Once installed, you may want to [configure Hydra](https://docs.saucelabs.com/error-reporting/advanced/hydra/setup/).

Check warning on line 92 in docs/error-reporting/advanced/client-tools-unix.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/error-reporting/advanced/client-tools-unix.md#L92

[sauce.RelativeLinks] Use a relative link instead of a URL.
Raw output
{"message": "[sauce.RelativeLinks] Use a relative link instead of a URL.", "location": {"path": "docs/error-reporting/advanced/client-tools-unix.md", "range": {"start": {"line": 92, "column": 33}}}, "severity": "WARNING"}
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
:::

:::note
The iOS SDK contains a privacy manifest to declare the types of data accessed on the device. Please refer to this [source document](https://github.com/backtrace-labs/backtrace-unity/blob/master/iOS/PrivacyInfo.xcprivacy) for the specific types of data collected by the SDK.
The iOS SDK contains a privacy manifest to declare the types of data accessed on the device. Please refer to this [source document](https://github.com/backtrace-labs/backtrace-unity/blob/master/iOS/CrashReporter.xcframework/PrivacyInfo.xcprivacy) for the specific types of data collected by the SDK.

Check notice on line 50 in docs/error-reporting/platform-integrations/unity/setup.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/error-reporting/platform-integrations/unity/setup.md#L50

[sauce.WordsToAvoid] Avoid usage of 'Please'.
Raw output
{"message": "[sauce.WordsToAvoid] Avoid usage of 'Please'.", "location": {"path": "docs/error-reporting/platform-integrations/unity/setup.md", "range": {"start": {"line": 50, "column": 94}}}, "severity": "INFO"}
:::

## What You'll Need
Expand Down
2 changes: 1 addition & 1 deletion docs/insights/debug.md
Original file line number Diff line number Diff line change
Expand Up @@ -456,7 +456,7 @@ The JS console collects security errors, warnings, and messages that are explici

```
{
"http://webdriver.io/api/action/click.html":[
"https://webdriver.io/docs/api/element/click":[
{
"level":"error",
"column":0,
Expand Down
2 changes: 1 addition & 1 deletion docs/mobile-apps/automated-testing/appium.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ npm install -g appium

### Installing a Client

The Appium client is the app in which you write your test scripts and instruct Appium how and where to run them. Appium provides [client libraries](http://appium.io/downloads) for a variety of programming languages, so choose your favorite and download it to start creating tests for your mobile app or mobile browser app. Many of the examples throughout this documentation use the [JavaScript WebDriverIO client](https://webdriver.io/).
The Appium client is the app in which you write your test scripts and instruct Appium how and where to run them. Appium provides [client libraries](https://appium.io/docs/en/latest/quickstart/install/) for a variety of programming languages, so choose your favorite and download it to start creating tests for your mobile app or mobile browser app. Many of the examples throughout this documentation use the [JavaScript WebDriverIO client](https://webdriver.io/).

:::tip Appium Doctor
Use Appium's dependency validator CLI `appium-doctor` to ensure your installation is ready to go for your Android or iOS tests.
Expand Down
6 changes: 3 additions & 3 deletions docs/mobile-apps/automated-testing/appium/real-devices.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ values={[
</Tabs>

:::note
You can avoid having to add the `appium:` prefix to Appium specific capabilities by upgrading your [Appium client library](http://appium.io/docs/en/about-appium/appium-clients/) to a version that automatically applies the prefix.
You can avoid having to add the `appium:` prefix to Appium specific capabilities by upgrading your **[Appium client library](https://appium.io/docs/en/latest/ecosystem/clients/)** to a version that automatically applies the prefix.
:::

## Configuring Appium Tests for Real Devices
Expand Down Expand Up @@ -154,7 +154,7 @@ You can also install a dependent app or an app upgrade during a test by using th

```js title=Driver App Example
driver.installApp(
'https://github.com/saucelabs/my-demo-app-rn/releases/download/v1.3.0/Android-MyDemoAppRN.apk'
'https://github.com/saucelabs/my-demo-app-rn/releases/download/v1.3.0/Android-MyDemoAppRN.1.3.0.build-244.apk'
)
```

Expand All @@ -167,7 +167,7 @@ driver.installApp(

:::

For more information about this command, see the [Appium documentation](http://appium.io/docs/en/commands/device/app/install-app/).
For more information about this command, see the [Appium documentation](https://appium.io/docs/en/latest/reference/api/appium/#installapp).

### Excluding the `browserName`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

But app upgrades aren't the only scenario where you might need to install apps during a running session. Sometimes, your app's functionality might rely on other dependent applications. In such cases, testing your app's interplay with these dependencies becomes essential. For instance, if your application pulls data from or interacts with another app, you'd want to ensure that this interaction remains smooth even after an upgrade. This makes the ability to install dependent apps during a run an invaluable feature for comprehensive testing.

There are scenarios where you might want to delete an app and reinstall it again during a running session. For example, if you want to test the app's behavior when a user deletes and reinstalls it, you can use the mid-session install feature to accomplish this task. (Deleting apps can be done for [Android](https://github.com/appium/appium-uiautomator2-driver#mobile-removeapp) and [iOS](https://appium.github.io/appium-xcuitest-driver/4.32/execute-methods/#mobile-removeapp) command.)
There are scenarios where you might want to delete an app and reinstall it again during a running session. For example, if you want to test the app's behavior when a user deletes and reinstalls it, you can use the mid-session install feature to accomplish this task. (Deleting apps can be done for [Android](https://github.com/appium/appium-uiautomator2-driver#mobile-removeapp) and [iOS](https://appium.github.io/appium-xcuitest-driver/latest/reference/execute-methods/#mobile-removeapp) command.)

Check warning on line 16 in docs/mobile-apps/automated-testing/appium/test-app-upgrades.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/mobile-apps/automated-testing/appium/test-app-upgrades.md#L16

[sauce.UnclearAntecedent] Instead of 'There are', try starting this sentence with a specific subject and verb.
Raw output
{"message": "[sauce.UnclearAntecedent] Instead of 'There are', try starting this sentence with a specific subject and verb.", "location": {"path": "docs/mobile-apps/automated-testing/appium/test-app-upgrades.md", "range": {"start": {"line": 16, "column": 1}}}, "severity": "WARNING"}

:::caution Important
Installing apps mid-session from the Sauce Storage is only supported in our Real Device Cloud.
Expand Down
Loading
Loading