Test your apps with API servers locally staged with BrowserStack
BrowserStack can integrate with test suites and app pointing to your local API server. This is done using BrowserStack Local - a tunneling feature that establishes a secure connection between your device and the BrowserStack Cloud.
Prerequisites
-
You need to have BrowserStack Username and Access key, which you can find in your account settings. If you have not created an account yet, you can sign up for a Free Trial or purchase a plan.
-
BrowserStack Java SDK is installed in your automation test suite.
Configure BrowserStack Local
Once you have installed the BrowserStack SDK, ensure the browserstackLocal
property is set to true
in your browserstack.yml
config file. You can now test your local apps on BrowserStack.
Check connectivity
Run this sample test to check if BrowserStack Local is working as expected and can connect to BrowserStack servers.
Clone sample git repository
Clone the sample testng-appium-app-browserstack repository using the following command:
Set BrowserStack credentials
Set userName
and accessKey
in the browserstack.yml
config file. Skip this step if you have already set credentials as env
variables.
Set path to local sample app
Set app
value as path to your Android (.apk
and .aab
) or iOS(.ipa
) file in browserstack.yml
config file. The path value can be relative or absolute.
Execute build on BrowserStack
Based on the devices and app selected, cd to the right project, and run the following command:
cd android/testng-examples
mvn test -P sample-local-test
cd ios/testng-examples
mvn test -P sample-local-test
If the status check fails, refer to the sections below for additional configuration that may be needed.
Additional configuration
BrowserStack Local works out of the box in most cases, but depending on the API servers being tested and your network configuration, additional configuration may be required. Here are the most frequently occurring scenarios:
The API servers you’re testing are accessible via the internet, but they serve different content within your internal network.
This is common with staging environments set up as sub-domains and configured to work only in your private/VPN network. In this case, add the following entry in your browserstack.yml
file.
The forceLocal
capability will resolve all network traffic through the BrowserStack Local tunnel.
Bypass invalid certificate warnings
To avoid invalid certificate errors while testing, set the acceptInsecureCerts
capability at the root level in your browserstack.yml
file.
After you run your test, visit the App Automate dashboard to view your test results.
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!