Quick start guide to integrate BrowserStack Test Observability with Cucumber-TestNG
Prerequisites
You have an account with BrowserStack (even a free trial works) and can get the Username and Access Key from your account profile.
You have a Cucumber-TestNG test suite which may be unit tests or functional tests (it’s okay even if you do not run your tests on BrowserStack infrastructure).
Integrate your Cucumber-TestNG test suite with Test Observability
You can use BrowserStack Test Observability both when you’re using BrowserStack’s devices and browsers to run your functional end-to-end tests and also if you’re running tests locally on your laptop/CI system or even when you’re using some other cloud provider.
Not only that, Test Observability is agnostic to the type of testing and hence you could also integrate it with your unit or integration test suite written using TestNG.
Please select your setup below to get started with an awesome debugging experience with Test Observability:
To start using BrowserStack Test Observability with your existing setup of TestNG - Cucumber tests running on BrowserStack Automate or App Automate, you’d need to integrate with the browserstack-java-sdk (if not already done). Use one of the following methods to integrate the SDK and start using Test Observability:
If you’re an existing browserstack-java-sdk user, you can skip the steps below. However, ensure that you’ve specified static names (names should not change across build runs) for projectName and buildName in the browserstack.yml file in your project. Also, restrict the characters in your projectName and buildName to alphanumeric characters (A-Z, a-z, 0-9), underscores (_), colons (:), and hyphens (-). Any other character will be replaced with a space.
On the Eclipse toolbar, click Help > Eclipse Marketplace. In the Eclipse Marketplace, search for BrowserStack > click Install > Finish.
Configure your test suite with BrowserStack SDK
BrowserStack plugin automatically adds the browserstack-java-sdk dependency to your pom.xml file and generates a browserstack.yml configuration file.
Right-click on your project folder > BrowserStack > select Integrate with Automate SDK.
Select your Project Folder, Framework, and other BrowserStack Parameters, and then click Integrate.
Update browserstack.yml file
Update the browserstack.yml file in the root folder of your test suite.
```yml
userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
buildName: "Your static build/job name goes here"
projectName: "Your static project name goes here"
CUSTOM_TAG_1: "You can set a custom Build Tag here"
# Use CUSTOM_TAG_<N> and set more build tags as you need.
framework: cucumber-testng
testObservability: true
browserstackAutomation: false # Set to true for tests on BrowserStack products.
```
userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
buildName:"Your static build/job name goes here"projectName:"Your static project name goes here"CUSTOM_TAG_1:"You can set a custom Build Tag here"# Use CUSTOM_TAG_<N> and set more build tags as you need.framework: cucumber-testng
testObservability:truebrowserstackAutomation:false# Set to true for tests on BrowserStack products.
The projectName and buildName config must be static and not change across different runs of the same build. This is a deviation in approach as specified by BrowserStack Automate or App Automate as Test Observability will automatically identify different build runs.
Restrict the characters in your projectName and buildName to alphanumeric characters (A-Z, a-z, 0-9), underscores (_), colons (:), and hyphens (-). Any other character will be replaced with a space.
BrowserStack SDK is a very powerful tool that you can use to set the different browser/device combinations and parallelization. For more details, check out the Automate Integration guide.
Run your test suite
Run your tests as usual.
View results and insights on Test Observability dashboards
Post build run completion, you’ll be able to see the build run report along with all necessary debugging information right on this dashboard.
Click IntelliJ IDEA > Preferences > Plugins. Search for BrowserStack and click Install.
Configure your test suite with BrowserStack SDK
BrowserStack plugin automatically adds the browserstack-java-sdk dependency to your pom.xml file and generates a browserstack.yml configuration file.
Right-click on your project folder > BrowserStack > select Integrate with Automate SDK.
Select your Project Folder, Framework, and other BrowserStack Parameters, and then click Integrate.
Update browserstack.yml file
Update the browserstack.yml file in the root folder of your test suite.
```yml
userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
buildName: "Your static build/job name goes here"
projectName: "Your static project name goes here"
CUSTOM_TAG_1: "You can set a custom Build Tag here"
# Use CUSTOM_TAG_<N> and set more build tags as you need.
framework: cucumber-testng
testObservability: true
browserstackAutomation: false # Set to true for tests on BrowserStack products.
```
userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
buildName:"Your static build/job name goes here"projectName:"Your static project name goes here"CUSTOM_TAG_1:"You can set a custom Build Tag here"# Use CUSTOM_TAG_<N> and set more build tags as you need.framework: cucumber-testng
testObservability:truebrowserstackAutomation:false# Set to true for tests on BrowserStack products.
The projectName and buildName config must be static and not change across different runs of the same build. This is a deviation in approach as specified by BrowserStack Automate or App Automate as Test Observability will automatically identify different build runs.
Restrict the characters in your projectName and buildName to alphanumeric characters (A-Z, a-z, 0-9), underscores (_), colons (:), and hyphens (-). Any other character will be replaced with a space.
BrowserStack SDK is a very powerful tool that you can use to set the different browser/device combinations and parallelization. For more details, check out the Automate Integration guide.
Run your test suite
Run your tests as usual.
View results and insights on Test Observability dashboards
Post build run completion, you’ll be able to see the build run report along with all necessary debugging information right on this dashboard.
```bash
# Set these values in your ~/.zprofile (zsh) or ~/.profile (bash)
export BROWSERSTACK_USERNAME="YOUR_USERNAME"
export BROWSERSTACK_ACCESS_KEY="YOUR_ACCESS_KEY"
```
# Set these values in your ~/.zprofile (zsh) or ~/.profile (bash)exportBROWSERSTACK_USERNAME="YOUR_USERNAME"exportBROWSERSTACK_ACCESS_KEY="YOUR_ACCESS_KEY"
```bash
setx BROWSERSTACK_USERNAME "YOUR_USERNAME"
setx BROWSERSTACK_ACCESS_KEY "YOUR_ACCESS_KEY"
set BROWSERSTACK_USERNAME=YOUR_USERNAME
set BROWSERSTACK_ACCESS_KEY=YOUR_ACCESS_KEY
```
Maven Archetype provides a template to quickly configure your project. Copy & run the following command on your terminal/command prompt to add browserstack-java-sdk dependency in your pom.xml and browserstack.yml config file in your project.
Please ensure that you now have at least browserstack-java-sdk v1.13.10 before proceeding.
Make changes in your browserstack.yml config file
Once you have installed the SDK, a browserstack.yml config file will be created at the root level of your project. This file holds all the required capabilities to run tests on BrowserStack.
BrowserStack SDK is a very powerful tool that you can use to set the different browser/device combinations and parallelization. For more details, check out the Automate Integration guide.
Make sure you copy the contents of the following config file and set it in your project’s browserstack.yml file:
```yml
userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
buildName: "Your static build/job name of CI goes here"
projectName: "Your static project name goes here"
CUSTOM_TAG_1: "You can set a custom Build Tag here"
# Use CUSTOM_TAG_<N> and set more build tags as you need.
browserstackAutomation: false # Set to true for tests on BrowserStack products.
framework: cucumber-testng
```
userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
buildName:"Your static build/job name of CI goes here"projectName:"Your static project name goes here"CUSTOM_TAG_1:"You can set a custom Build Tag here"# Use CUSTOM_TAG_<N> and set more build tags as you need.browserstackAutomation:false# Set to true for tests on BrowserStack products.framework: cucumber-testng
The projectName and buildName config must be static and not change across different runs of the same build. This is a deviation in approach as specified by BrowserStack Automate or App Automate as Test Observability will automatically identify different build runs.
Restrict the characters in your projectName and buildName to alphanumeric characters (A-Z, a-z, 0-9), underscores (_), colons (:), and hyphens (-). Any other character will be replaced with a space.
Run your test suite with Test Observability
Run the following command from the project’s root directory to run your test suite with BrowserStack.
Since you’re an existing browserstack-java-sdk user, you must already have the following entry in your pom.xml file of your project. Please verify that the following exists:
The previous step outlines that your pom.xml must have the LATEST tag against the browserstack-java-sdk. Now, run the below command to ensure that the latest version is installed:
Please ensure that you now have at least browserstack-java-sdk v1.13.10 before proceeding.
Verify your browserStack.yml config file
Since you’re an existing browserstack-java-sdk user, you must already be having a browserstack.yml config file at the root level of your project.
Test Observability mandatorily needs the following four configurations in the file. You need not change anything but you have to ensure that the values of the buildName and projectName variables are not changing across different build runs.
```yml
userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
buildName: "Your static build/job name of CI goes here"
projectName: "Your static project name goes here"
CUSTOM_TAG_1: "You can set a custom Build Tag here"
# Use CUSTOM_TAG_<N> and set more build tags as you need.
framework: cucumber-testng
...
```
userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
buildName:"Your static build/job name of CI goes here"projectName:"Your static project name goes here"CUSTOM_TAG_1:"You can set a custom Build Tag here"# Use CUSTOM_TAG_<N> and set more build tags as you need.framework: cucumber-testng
...
The projectName and buildName config must be static and not change across different runs of the same build. This is a deviation in approach as specified by BrowserStack Automate or App Automate as Test Observability will automatically identify different build runs.
Restrict the characters in your projectName and buildName to alphanumeric characters (A-Z, a-z, 0-9), underscores (_), colons (:), and hyphens (-). Any other character will be replaced with a space.
Run your test suite with Test Observability
Run the following command from the project’s root directory to run your test suite with BrowserStack.
To start using BrowserStack Test Observability with your existing setup of TestNG - Cucumber tests running on your local laptop or CI or even on any other cloud provider, you’d need to integrate the browserstack-java-sdk. Use one of the following methods to integrate the SDK and start using Test Observability:
BrowserStack Test Observability works with any kind of automation tests. Use it with your unit or integration test suites and also your end-to-end functional test suite.
On the Eclipse toolbar, click Help > Eclipse Marketplace. In the Eclipse Marketplace, search for BrowserStack > click Install > Finish.
Configure your test suite with BrowserStack SDK
BrowserStack plugin automatically adds the browserstack-java-sdk dependency to your pom.xml file and generates a browserstack.yml configuration file.
Right-click on your project folder > BrowserStack > select Integrate with Automate SDK.
Select your Project Folder, Framework, and other BrowserStack Parameters, and then click Integrate.
Update browserstack.yml file
Update the browserstack.yml file in the root folder of your test suite.
```yml
userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
buildName: "Your static build/job name goes here"
projectName: "Your static project name goes here"
CUSTOM_TAG_1: "You can set a custom Build Tag here"
# Use CUSTOM_TAG_<N> and set more build tags as you need.
framework: cucumber-testng
testObservability: true
browserstackAutomation: false # Set to true for tests on BrowserStack products.
```
userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
buildName:"Your static build/job name goes here"projectName:"Your static project name goes here"CUSTOM_TAG_1:"You can set a custom Build Tag here"# Use CUSTOM_TAG_<N> and set more build tags as you need.framework: cucumber-testng
testObservability:truebrowserstackAutomation:false# Set to true for tests on BrowserStack products.
The projectName and buildName config must be static and not change across different runs of the same build. This is a deviation in approach as specified by BrowserStack Automate or App Automate as Test Observability will automatically identify different build runs.
Restrict the characters in your projectName and buildName to alphanumeric characters (A-Z, a-z, 0-9), underscores (_), colons (:), and hyphens (-). Any other character will be replaced with a space.
BrowserStack SDK is a very powerful tool that you can use to set the different browser/device combinations and parallelization. For more details, check out the Automate Integration guide.
Run your test suite
Run your tests as usual.
View results and insights on Test Observability dashboards
Post build run completion, you’ll be able to see the build run report along with all necessary debugging information right on this dashboard.
Click IntelliJ IDEA > Preferences > Plugins. Search for BrowserStack and click Install.
Configure your test suite with BrowserStack SDK
BrowserStack plugin automatically adds the browserstack-java-sdk dependency to your pom.xml file and generates a browserstack.yml configuration file.
Right-click on your project folder > BrowserStack > select Integrate with Automate SDK.
Select your Project Folder, Framework, and other BrowserStack Parameters, and then click Integrate.
Update browserstack.yml file
Update the browserstack.yml file in the root folder of your test suite.
```yml
userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
buildName: "Your static build/job name goes here"
projectName: "Your static project name goes here"
CUSTOM_TAG_1: "You can set a custom Build Tag here"
# Use CUSTOM_TAG_<N> and set more build tags as you need.
framework: cucumber-testng
testObservability: true
browserstackAutomation: false # Set to true for tests on BrowserStack products.
```
userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
buildName:"Your static build/job name goes here"projectName:"Your static project name goes here"CUSTOM_TAG_1:"You can set a custom Build Tag here"# Use CUSTOM_TAG_<N> and set more build tags as you need.framework: cucumber-testng
testObservability:truebrowserstackAutomation:false# Set to true for tests on BrowserStack products.
The projectName and buildName config must be static and not change across different runs of the same build. This is a deviation in approach as specified by BrowserStack Automate or App Automate as Test Observability will automatically identify different build runs.
Restrict the characters in your projectName and buildName to alphanumeric characters (A-Z, a-z, 0-9), underscores (_), colons (:), and hyphens (-). Any other character will be replaced with a space.
BrowserStack SDK is a very powerful tool that you can use to set the different browser/device combinations and parallelization. For more details, check out the Automate Integration guide.
Run your test suite
Run your tests as usual.
View results and insights on Test Observability dashboards
Post build run completion, you’ll be able to see the build run report along with all necessary debugging information right on this dashboard.
```bash
# Set these values in your ~/.zprofile (zsh) or ~/.profile (bash)
export BROWSERSTACK_USERNAME="YOUR_USERNAME"
export BROWSERSTACK_ACCESS_KEY="YOUR_ACCESS_KEY"
```
# Set these values in your ~/.zprofile (zsh) or ~/.profile (bash)exportBROWSERSTACK_USERNAME="YOUR_USERNAME"exportBROWSERSTACK_ACCESS_KEY="YOUR_ACCESS_KEY"
```bash
setx BROWSERSTACK_USERNAME "YOUR_USERNAME"
setx BROWSERSTACK_ACCESS_KEY "YOUR_ACCESS_KEY"
set BROWSERSTACK_USERNAME=YOUR_USERNAME
set BROWSERSTACK_ACCESS_KEY=YOUR_ACCESS_KEY
```
Maven Archetype provides a template to quickly configure your project. Copy & run the following command on your terminal/command prompt to add browserstack-java-sdk dependency in your pom.xml and browserstack.yml config file in your project along with the required variables.
Please ensure that you now have at least browserstack-java-sdk v1.13.10 before proceeding.
Make changes in your browserstack.yml config file
Once you have installed the SDK, a browserstack.yml config file will be created at the root level of your project. This file holds all the required capabilities to run tests on BrowserStack.
Make sure you copy the contents of the below config file and set it in your project’s browserstack.yml file:
```yml
userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
buildName: "Your static build/job name of CI goes here"
projectName: "Your static project name goes here"
CUSTOM_TAG_1: "You can set a custom Build Tag here"
# Use CUSTOM_TAG_<N> and set more build tags as you need.
framework: cucumber-testng
browserstackAutomation: false # Set to true for tests on BrowserStack products.
testObservability: true
...
```
userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
buildName:"Your static build/job name of CI goes here"projectName:"Your static project name goes here"CUSTOM_TAG_1:"You can set a custom Build Tag here"# Use CUSTOM_TAG_<N> and set more build tags as you need.framework: cucumber-testng
browserstackAutomation:false# Set to true for tests on BrowserStack products.testObservability:true...
The projectName and buildName config must be static and not change across different runs of the same build. Different runs of the same build/job would be automatically identified by Test Observability.
Restrict the characters in your projectName and buildName to alphanumeric characters (A-Z, a-z, 0-9), underscores (_), colons (:), and hyphens (-). Any other character will be replaced with a space.
Run your test suite with Test Observability
Run the following command from the project’s root directory to run your test suite with BrowserStack.
