Skip to content

Commit

Permalink
Merge branch 'refs/heads/main' into mb-MOBA-7494
Browse files Browse the repository at this point in the history
  • Loading branch information
bahrimootaz committed Aug 9, 2024
2 parents d5468f8 + 7014be2 commit 8a21ccd
Show file tree
Hide file tree
Showing 10 changed files with 307 additions and 41 deletions.
82 changes: 64 additions & 18 deletions docs/dev/test-configuration-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -284,9 +284,12 @@ Always use the latest Selenium version. The Selenium developers are very conscie

<p><small>| BOOLEAN |</small></p>

Allows the browser to communicate directly with servers without going through a proxy. By default, Sauce routes traffic from Internet Explorer and Safari through an HTTP proxy server so that HTTPS connections with self-signed certificates will work. The proxy server can cause problems for some users, and this setting allows you to avoid it.
Allows the browser to communicate directly with servers without going through a proxy that is shipped with Selenium versions prior to v3.
By default, Sauce routes traffic from Internet Explorer and Safari through an HTTP proxy server so that HTTPS connections with self-signed certificates will work.
The proxy server can cause problems for some users, and this setting allows you to avoid it.

:::note
This configuration is only relevant for Selenium versions 2.x and older.
Any test run with a Sauce Connect tunnel has to use the proxy and this flag will be ignored.
:::

Expand Down Expand Up @@ -840,6 +843,63 @@ Using Appium 2? Prevent `appium:`-prefix repetitiveness and start using [`appium

---

### `appium:timeZone`

<p><small>| OPTIONAL | BOOLEAN | <span className="sauceGreen">Virtual and Real Devices</span> | <span className="sauceGreen">Android Only</span> |</small></p>

Overrides the current device's time zone. This change is done on per-device basis and is
preserved for the whole duration of the test session. The time zone identifier must be a
valid name from [the list of available time zone identifiers](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones),
for example `Europe/Paris`.

:::note
The iOS equivalent is [`appium:appTimeZone`](#appiumapptimezone).
:::

:::note
This capability is only supported since UiAutomator2 driver version 3.1.0.
:::

```java
MutableCapabilities capabilities = new MutableCapabilities();
capabilities.setCapability("appium:timeZone", "Europe/Paris");
```

:::tip
Using Appium 2? Prevent `appium:`-prefix repetitiveness and start using [`appium:options`](#appiumoptions) for Real Devices instead.
:::

---

### `appium:appTimeZone`

<p><small>| OPTIONAL | BOOLEAN | <span className="sauceGreen">Virtual and Real Devices</span> | <span className="sauceGreen">iOS Only</span> |</small></p>

Defines the custom time zone override for the application under test.
You can use `UTC`, `PST`, `EST`, as well as place-based timezone names such as `America/Los_Angeles`.
See [the list of available time zone identifiers](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) f
or more details. The same behavior could be achieved by providing a custom
value to the `TZ` environment variable via the `appium:processArguments` capability.

:::note
The Android equivalent is [`appium:timeZone`](#appiumtimezone).
:::

:::note
This capability is only supported since XCUITest driver version 7.10.0.
:::

```java
MutableCapabilities capabilities = new MutableCapabilities();
capabilities.setCapability("appium:appTimeZone", "America/Los_Angeles");
```

:::tip
Using Appium 2? Prevent `appium:`-prefix repetitiveness and start using [`appium:options`](#appiumoptions) for Real Devices instead.
:::

---

## Mobile Appium Timeout Capabilities

As with Selenium Tests, Appium also supports different types of timeouts like:
Expand Down Expand Up @@ -1556,7 +1616,7 @@ capabilities.setCapability("sauce:options", sauceOptions);

<p><small>| OPTIONAL | STRING | <span className="sauceGreen">Real Devices Only</span> | <span className="sauceGreen">BETA</span> |</small></p>

Set a network profile with predefined network conditions at the beginning of the session.
Set a network profile with predefined network conditions at the beginning of the session.
Please refer to the [list of network profiles](https://docs.saucelabs.com/mobile-apps/features/network-throttling/#predefined-network-profiles) for more information about each profile's network conditions.

```java
Expand Down Expand Up @@ -2047,15 +2107,8 @@ capabilities.setCapability("sauce:options", sauceOptions);
Allows you to set a custom time zone for your test based on a city name. Most major cities are supported.

- **For Desktop VMs**: can be configured with custom time zones. This feature should work on all operating systems, however, time zones on Windows VMs are approximate. The time zone defaults to UTC. Look for the "principal cities" examples on this [list of UTC time offsets](https://en.wikipedia.org/wiki/List_of_UTC_time_offsets).
- **For iOS Virtual Devices**: you can use this capability to change the time on the Mac OS X VM, which will be picked up by the iOS simulator.
- **For Android Virtual Devices**: this capability is not supported for Android devices, but for Android 7.2 or later, there is a workaround. Use the following ADB command to grant Appium notification read permission in order to use the time zone capability:

```java
adb shell cmd notification allow_listener
io.appium.settings/io.appium.settings.NLService
```

* See the [Appium Android documentation](http://appium.io/docs/en/writing-running-appium/android/android-shell/#mobile-shell) for additional support.
- **For iOS Virtual Devices**: You can use this capability to change the time on the Mac OS X VM, which will be picked up by the iOS simulator.
- **For Android Virtual Devices**: This capability is not supported for virtual Android devices. Consider using [appium:timeZone](#appiumtimezone) instead.

:::note
Most web apps serve localization content based on the computer's IP Address, not the time zone set
Expand Down Expand Up @@ -2165,13 +2218,6 @@ While [Visual Testing](/visual) runs on Sauce Labs servers, the URL gets sent to

See [Visual Testing with WebDriver](/visual/e2e-testing/setup) and [Visual Commands and Options](/visual/e2e-testing/commands-options).

### Unsupported Appium Capabilities

These are currently not supported for real devices:

- `Edit Timezone`: Appium does not provide a capability to edit the timezone of a device in automated testing on real devices.
- See [Virtual Device Capabilities](#virtual-device-capabilities-sauce-specific--optional) for information about timezone capabilities in a virtual device testing.

:::caution Limitations
When running a test on a Virtual Device, be aware that each capability value has a 100 characters limitation. If the value exceeds this limit, it will be truncated, which can lead to further side effects or prevent a job from starting.
:::
20 changes: 10 additions & 10 deletions docs/secure-connections/sauce-connect-5/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Visit the following pages for installation instructions for your platform:

If you prefer to do custom installation, you can download Sauce Connect binaries from the following links.

SHA256 checksums are available [here](https://saucelabs.com/downloads/sauce-connect/5.1.1/checksums).
SHA256 checksums are available [here](https://saucelabs.com/downloads/sauce-connect/5.1.2/checksums).

<table>
<tr>
Expand All @@ -27,51 +27,51 @@ SHA256 checksums are available [here](https://saucelabs.com/downloads/sauce-conn
<tr>
<td rowspan="3">Linux x86_64</td>
<td>
<a href="https://saucelabs.com/downloads/sauce-connect/5.1.1/sauce-connect-5.1.1_linux.x86_64.tar.gz">https://saucelabs.com/downloads/sauce-connect/5.1.1/sauce-connect-5.1.1_linux.x86_64.tar.gz</a>
<a href="https://saucelabs.com/downloads/sauce-connect/5.1.2/sauce-connect-5.1.2_linux.x86_64.tar.gz">https://saucelabs.com/downloads/sauce-connect/5.1.2/sauce-connect-5.1.2_linux.x86_64.tar.gz</a>
</td>
</tr>
<tr>
<td>
<a href="https://saucelabs.com/downloads/sauce-connect/5.1.1/sauce-connect_5.1.1.linux_amd64.deb">https://saucelabs.com/downloads/sauce-connect/5.1.1/sauce-connect_5.1.1.linux_amd64.deb</a>
<a href="https://saucelabs.com/downloads/sauce-connect/5.1.2/sauce-connect_5.1.2.linux_amd64.deb">https://saucelabs.com/downloads/sauce-connect/5.1.2/sauce-connect_5.1.2.linux_amd64.deb</a>
</td>
</tr>
<tr>
<td>
<a href="https://saucelabs.com/downloads/sauce-connect/5.1.1/sauce-connect-5.1.1_linux.x86_64.rpm">https://saucelabs.com/downloads/sauce-connect/5.1.1/sauce-connect-5.1.1_linux.x86_64.rpm</a>
<a href="https://saucelabs.com/downloads/sauce-connect/5.1.2/sauce-connect-5.1.2_linux.x86_64.rpm">https://saucelabs.com/downloads/sauce-connect/5.1.2/sauce-connect-5.1.2_linux.x86_64.rpm</a>
</td>
</tr>
<tr>
<td rowspan="3">Linux arm64</td>
<td>
<a href="https://saucelabs.com/downloads/sauce-connect/5.1.1/sauce-connect-5.1.1_linux.aarch64.tar.gz">https://saucelabs.com/downloads/sauce-connect/5.1.1/sauce-connect-5.1.1_linux.aarch64.tar.gz</a>
<a href="https://saucelabs.com/downloads/sauce-connect/5.1.2/sauce-connect-5.1.2_linux.aarch64.tar.gz">https://saucelabs.com/downloads/sauce-connect/5.1.2/sauce-connect-5.1.2_linux.aarch64.tar.gz</a>
</td>
</tr>
<tr>
<td>
<a href="https://saucelabs.com/downloads/sauce-connect/5.1.1/sauce-connect_5.1.1.linux_arm64.deb">https://saucelabs.com/downloads/sauce-connect/5.1.1/sauce-connect_5.1.1.linux_arm64.deb</a>
<a href="https://saucelabs.com/downloads/sauce-connect/5.1.2/sauce-connect_5.1.2.linux_arm64.deb">https://saucelabs.com/downloads/sauce-connect/5.1.2/sauce-connect_5.1.2.linux_arm64.deb</a>
</td>
</tr>
<tr>
<td>
<a href="https://saucelabs.com/downloads/sauce-connect/5.1.1/sauce-connect-5.1.1_linux.aarch64.rpm">https://saucelabs.com/downloads/sauce-connect/5.1.1/sauce-connect-5.1.1_linux.aarch64.rpm</a>
<a href="https://saucelabs.com/downloads/sauce-connect/5.1.2/sauce-connect-5.1.2_linux.aarch64.rpm">https://saucelabs.com/downloads/sauce-connect/5.1.2/sauce-connect-5.1.2_linux.aarch64.rpm</a>
</td>
</tr>
<tr>
<td>macOS</td>
<td>
<a href="https://saucelabs.com/downloads/sauce-connect/5.1.1/sauce-connect-5.1.1_darwin.all.zip">https://saucelabs.com/downloads/sauce-connect/5.1.1/sauce-connect-5.1.1_darwin.all.zip</a>
<a href="https://saucelabs.com/downloads/sauce-connect/5.1.2/sauce-connect-5.1.2_darwin.all.zip">https://saucelabs.com/downloads/sauce-connect/5.1.2/sauce-connect-5.1.2_darwin.all.zip</a>
</td>
</tr>
<tr>
<td>Windows x86_64</td>
<td>
<a href="https://saucelabs.com/downloads/sauce-connect/5.1.1/sauce-connect-5.1.1_windows.x86_64.zip">https://saucelabs.com/downloads/sauce-connect/5.1.1/sauce-connect-5.1.1_windows.x86_64.zip</a>
<a href="https://saucelabs.com/downloads/sauce-connect/5.1.2/sauce-connect-5.1.2_windows.x86_64.zip">https://saucelabs.com/downloads/sauce-connect/5.1.2/sauce-connect-5.1.2_windows.x86_64.zip</a>
</td>
</tr>
<tr>
<td>Windows arm64</td>
<td>
<a href="https://saucelabs.com/downloads/sauce-connect/5.1.1/sauce-connect-5.1.1_windows.aarch64.zip">https://saucelabs.com/downloads/sauce-connect/5.1.1/sauce-connect-5.1.1_windows.aarch64.zip</a>
<a href="https://saucelabs.com/downloads/sauce-connect/5.1.2/sauce-connect-5.1.2_windows.aarch64.zip">https://saucelabs.com/downloads/sauce-connect/5.1.2/sauce-connect-5.1.2_windows.aarch64.zip</a>
</td>
</tr>
</table>
12 changes: 6 additions & 6 deletions docs/secure-connections/sauce-connect-5/installation/linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,15 @@ defaultValue="ARM64"
<TabItem value="ARM64">

```bash
curl -L -o sauce-connect.deb https://saucelabs.com/downloads/sauce-connect/5.1.1/sauce-connect_5.1.1.linux_arm64.deb
curl -L -o sauce-connect.deb https://saucelabs.com/downloads/sauce-connect/5.1.2/sauce-connect_5.1.2.linux_arm64.deb
sudo dpkg -i sauce-connect.deb
```
</TabItem>

<TabItem value="x86-64">

```bash
curl -L -o sauce-connect.deb https://saucelabs.com/downloads/sauce-connect/5.1.1/sauce-connect_5.1.1.linux_amd64.deb
curl -L -o sauce-connect.deb https://saucelabs.com/downloads/sauce-connect/5.1.2/sauce-connect_5.1.2.linux_amd64.deb
sudo dpkg -i sauce-connect.deb
```

Expand Down Expand Up @@ -81,14 +81,14 @@ defaultValue="ARM64"
<TabItem value="ARM64">

```bash
sudo rpm -i https://saucelabs.com/downloads/sauce-connect/5.1.1/sauce-connect-5.1.1_linux.aarch64.rpm
sudo rpm -i https://saucelabs.com/downloads/sauce-connect/5.1.2/sauce-connect-5.1.2_linux.aarch64.rpm
```
</TabItem>

<TabItem value="x86-64">

```bash
sudo rpm -i https://saucelabs.com/downloads/sauce-connect/5.1.1/sauce-connect-5.1.1_linux.x86_64.rpm
sudo rpm -i https://saucelabs.com/downloads/sauce-connect/5.1.2/sauce-connect-5.1.2_linux.x86_64.rpm
```

</TabItem>
Expand Down Expand Up @@ -132,7 +132,7 @@ defaultValue="ARM64"
<TabItem value="ARM64">

```bash
curl -L -o sauce-connect.tar.gz https://saucelabs.com/downloads/sauce-connect/5.1.1/sauce-connect-5.1.1_linux.aarch64.tar.gz
curl -L -o sauce-connect.tar.gz https://saucelabs.com/downloads/sauce-connect/5.1.2/sauce-connect-5.1.2_linux.aarch64.tar.gz
sudo mkdir -p /opt/sauce-connect
sudo tar -C /opt/sauce-connect -xzf sauce-connect.tar.gz
```
Expand All @@ -141,7 +141,7 @@ sudo tar -C /opt/sauce-connect -xzf sauce-connect.tar.gz
<TabItem value="x86-64">

```bash
curl -L -o sauce-connect.tar.gz https://saucelabs.com/downloads/sauce-connect/5.1.1/sauce-connect-5.1.1_linux.x86_64.tar.gz
curl -L -o sauce-connect.tar.gz https://saucelabs.com/downloads/sauce-connect/5.1.2/sauce-connect-5.1.2_linux.x86_64.tar.gz
sudo mkdir -p /opt/sauce-connect
sudo tar -C /opt/sauce-connect -xzf sauce-connect.tar.gz
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Sauce Connect provides `.zip` package with a signed binary that can be used on a
### Unpack the zip file

```bash
curl -L -o sauce-connect.zip https://saucelabs.com/downloads/sauce-connect/5.1.1/sauce-connect-5.1.1_darwin.all.zip
curl -L -o sauce-connect.zip https://saucelabs.com/downloads/sauce-connect/5.1.2/sauce-connect-5.1.2_darwin.all.zip
sudo mkdir -p /opt/sauce-connect
sudo unzip -d /opt/sauce-connect sauce-connect.zip
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ defaultValue="ARM64"

```bash
mkdir C:\sauce-connect
Invoke-WebRequest -Uri https://saucelabs.com/downloads/sauce-connect/5.1.1/sauce-connect-5.1.1_windows.aarch64.zip -OutFile sauce-connect.zip
Invoke-WebRequest -Uri https://saucelabs.com/downloads/sauce-connect/5.1.2/sauce-connect-5.1.2_windows.aarch64.zip -OutFile sauce-connect.zip
Expand-Archive -Path sauce-connect.zip -DestinationPath C:\sauce-connect
```
</TabItem>
Expand All @@ -29,7 +29,7 @@ Expand-Archive -Path sauce-connect.zip -DestinationPath C:\sauce-connect

```bash
mkdir C:\sauce-connect
Invoke-WebRequest -Uri https://saucelabs.com/downloads/sauce-connect/5.1.1/sauce-connect-5.1.1_windows.x86_64.zip -OutFile sauce-connect.zip
Invoke-WebRequest -Uri https://saucelabs.com/downloads/sauce-connect/5.1.2/sauce-connect-5.1.2_windows.x86_64.zip -OutFile sauce-connect.zip
Expand-Archive -Path sauce-connect.zip -DestinationPath C:\sauce-connect
```

Expand Down
Loading

0 comments on commit 8a21ccd

Please sign in to comment.