Appium plugin support on BrowserStack
Use official Appium plugins like wait, gestures, and images on BrowserStack to extend Appium’s functionality and improve test reliability across platforms.
BrowserStack App Automate provides official support for key Appium plugins, enabling you to extend core Appium functionality for more powerful and reliable tests. This allows for greater parity between local and cloud execution environments.
Configuration
To use Appium plugins in your BrowserStack tests, you must specify them in your BrowserStack capabilities:
- Set the Appium version to
2.15.0
or higher. - Add the
appiumPlugins
capability, listing the required plugins in an array.
By default, the Appium images plugin is active.
Example: To use a single plugin:
{
"appium:version": "2.15.0",
"appiumPlugins": ["wait"]
}
Example: To use multiple plugins:
{
"appium:version": "2.15.0",
"appiumPlugins": ["wait", "gestures"]
}
Supported plugins
BrowserStack’s implementation uses the native plugin functionality without any custom modifications.
The following plugins are supported on BrowserStack:
Plugin | Description |
---|---|
Wait plugin | The Appium wait plugin automatically waits for UI elements to become actionable before performing interactions. This reduces test flakiness caused by timing issues and makes your tests more resilient by replacing hardcoded waits. |
Gestures plugin | The Appium gestures plugin provides simple, high-level commands for complex and cross-platform gestures like swipe, pinch, and zoom. This is essential for testing gesture-heavy apps like maps or media galleries consistently across Android and iOS. |
Images plugin | The Appium images plugin is an existing, default plugin, enables visual testing by comparing images and allows you to find and interact with UI elements using an image template. This is useful for testing visually-driven components or when elements lack stable locators. |
Scope of support
- Native functionality: BrowserStack supports the native, unmodified Appium plugins without custom patches.
- Plugin issues: Please report bugs inherent to a plugin to its official source repository.
- Existing plugins: This does not impact existing integrations, such as the images plugin.
We're sorry to hear that. Please share your feedback so we can do better
Contact our Support team for immediate help while we work on improving our docs.
We're continuously improving our docs. We'd love to know what you liked
We're sorry to hear that. Please share your feedback so we can do better
Contact our Support team for immediate help while we work on improving our docs.
We're continuously improving our docs. We'd love to know what you liked
Thank you for your valuable feedback!