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.

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

MOBA-7501: Update the documentation related to time zone-related capabilities #2878

Merged
merged 3 commits into from
Aug 9, 2024
Merged
Changes from 1 commit
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
20 changes: 3 additions & 17 deletions docs/dev/test-configuration-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -1556,7 +1556,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 +2047,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. Also, since XCUITest driver version 7.10.0 it is possible to update the per-application time zone on real and virtual devices via the [appium:appTimeZone](https://github.com/appium/appium-xcuitest-driver/blob/master/docs/reference/capabilities.md#app) capability.
- **For Android Virtual Devices**: This capability is not supported for virtual Android devices. Although, since UiAutomator2 driver version 3.1.0 it is possible to update the device-wide time zone on real and virtual devices via the [appium:timeZone](https://github.com/appium/appium-uiautomator2-driver?tab=readme-ov-file#other) capability.

:::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 +2158,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.
:::
Loading