Skip to content

Commit

Permalink
add new allowed commands and appium alternatives
Browse files Browse the repository at this point in the history
  • Loading branch information
yuyi-sl committed Sep 4, 2024
1 parent f5affb0 commit 61afe04
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/dev/test-configuration-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -1702,7 +1702,7 @@ driver.executeScript("sauce: network-conditions", ImmutableMap.of(
Execute ADB shell commands, through Appium's `mobile: shell` capability.

:::note
Sauce Labs now supports ADB commands for Appium. To use ADB and `mobile: shell` commands, please [sign up for our BETA through this form](https://forms.gle/42qv8U1RukqC62x86) and indicate the desired ADB commands you would like to run. We will be supporting a limited list of ADB commands through `mobile: shell`. Please refer to the list of [allowed commands](https://docs.saucelabs.com/mobile-apps/mobile-faq/#im-encountering-errors-when-executing-adb-shell-commands-what-could-be-the-issue) or contact support for assistance.
Sauce Labs now supports ADB commands for Appium. We are supporting a limited list of ADB commands through `mobile: shell`. Please refer to the list of [allowed commands](/mobile-apps/mobile-faq/#im-encountering-errors-when-executing-adb-shell-commands-what-could-be-the-issue) or contact support for assistance.

Check notice on line 1705 in docs/dev/test-configuration-options.md

View workflow job for this annotation

GitHub Actions / vale

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

[sauce.WordsToAvoid] Avoid usage of 'Please'.
Raw output
{"message": "[sauce.WordsToAvoid] Avoid usage of 'Please'.", "location": {"path": "docs/dev/test-configuration-options.md", "range": {"start": {"line": 1705, "column": 124}}}, "severity": "INFO"}
:::


Expand Down
14 changes: 11 additions & 3 deletions docs/mobile-apps/mobile-faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Yes, by using virtual USB, but only on private Android devices. Currently, iOS d
#### **I'm encountering errors when executing ADB shell commands. What could be the issue?**

If you're facing challenges with ADB shell commands during your automated Appium tests, ensure that you are using the
[mobile: shell script](https://docs.saucelabs.com/dev/test-configuration-options/#mobile-shell) correctly.
[mobile: shell script](/dev/test-configuration-options/#mobile-shell) correctly.

We maintain an allowlist of commands that can be executed within our Real Device Cloud. Please refer to the list of allowed commands to ensure compatibility:
* am start
Expand All @@ -86,13 +86,21 @@ We maintain an allowlist of commands that can be executed within our Real Device
* getprop
* am compat enable
* cmd connectivity airplane-mode (enable|disable)
* settings put global (animator_duration_scale|transition_animation_scale|window_animation_scale) {`<value>`}
* setprop debug.firebase.analytics.app {`<value>`}
* settings put global (animator_duration_scale|transition_animation_scale|window_animation_scale) {`<VALUE>`}
* setprop debug.firebase.analytics.app {`<VALUE>`}
* setprop (log.tag.FA|log.tag.FA-SVC) (ERROR|WARN|INFO|DEBUG|VERBOSE)
* setprop (log.tag.FA|log.tag.FA-SVC|log.tag.GAv4|log.tag.GAv4-SVC) (ERROR|WARN|INFO|DEBUG|VERBOSE)

Check warning on line 92 in docs/mobile-apps/mobile-faq.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/mobile-apps/mobile-faq.md#L92

[sauce.SentenceSpacing] Remove the extra space.
Raw output
{"message": "[sauce.SentenceSpacing] Remove the extra space.", "location": {"path": "docs/mobile-apps/mobile-faq.md", "range": {"start": {"line": 92, "column": 18}}}, "severity": "WARNING"}

Check warning on line 92 in docs/mobile-apps/mobile-faq.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/mobile-apps/mobile-faq.md#L92

[sauce.SentenceSpacing] Remove the extra space.
Raw output
{"message": "[sauce.SentenceSpacing] Remove the extra space.", "location": {"path": "docs/mobile-apps/mobile-faq.md", "range": {"start": {"line": 92, "column": 29}}}, "severity": "WARNING"}

Check warning on line 92 in docs/mobile-apps/mobile-faq.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/mobile-apps/mobile-faq.md#L92

[sauce.SentenceSpacing] Remove the extra space.
Raw output
{"message": "[sauce.SentenceSpacing] Remove the extra space.", "location": {"path": "docs/mobile-apps/mobile-faq.md", "range": {"start": {"line": 92, "column": 44}}}, "severity": "WARNING"}

Check warning on line 92 in docs/mobile-apps/mobile-faq.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/mobile-apps/mobile-faq.md#L92

[sauce.SentenceSpacing] Remove the extra space.
Raw output
{"message": "[sauce.SentenceSpacing] Remove the extra space.", "location": {"path": "docs/mobile-apps/mobile-faq.md", "range": {"start": {"line": 92, "column": 57}}}, "severity": "WARNING"}
* appops set {`<PACKAGE_NAME>`} REQUEST_INSTALL_PACKAGES allow

If the command you require is not listed, you can submit a request through this [form](https://docs.google.com/forms/d/1t4MCf6ClHlLxX80RP5bNU9wVJBhQOd4ll6IjP0ecMgc)
or reach out to your Customer Success Manager or Sauce Labs Support for assistance.

:::note Appium alternatives

- am broadcast: use [mobile: broadcast](https://github.com/appium/appium-uiautomator2-driver?tab=readme-ov-file#mobile-broadcast)

:::

### Security

#### **Is my app safe in the Real Device Cloud?**
Expand Down

0 comments on commit 61afe04

Please sign in to comment.