Your guide to running Selenium Webdriver tests with JUnit on BrowserStack.
BrowserStack gives you instant access to our Selenium Grid of 2000+ real devices and desktop browsers. Running your Selenium tests with JUnit on BrowserStack is simple. This guide will help you in:
To run Selenium tests with JUnit on BrowserSatck Automate, follow the below steps:
Clone the junit-browserstack repo on GitHub with BrowserStack’s sample test, using the following command:
git clone https://github.com/browserstack/junit-browserstack.git
cd junit-browserstack
Install the dependencies using the following command:
mvn install
Update single.conf.json
files within the junit-browserstack/src/test/resources/conf
directory with your BrowserStack credentials as shown below:
{
"server": "hub-cloud.browserstack.com",
"user": "YOUR_USERNAME",
"key": "YOUR_ACCESS_KEY",
"capabilities": {
"build": "junit-browserstack",
"name": "single_test",
"browserstack.debug": true
},
"environments": [{
"browser": "chrome"
}]
}
Now, execute your first test on BrowserStack using the following command:
mvn test -P single
View your test results on the BrowserStack Automate dashboard.
Following is the sample JUnit test case that you ran above. The test searches for “BrowserStack” on Google, and checks if the title of the resulting page is “BrowserStack - Google Search”.
public class SingleTest extends BrowserStackJUnitTest {
@Test
public void test() throws Exception {
driver.get("https://www.google.com/ncr");
WebElement element = driver.findElement(By.name("q"));
element.sendKeys("BrowserStack");
element.submit();
Thread.sleep(5000);
assertEquals("BrowserStack - Google Search", driver.getTitle());
}
}
The integration of your test with BrowserStack is working with the help of BrowserStackJUnitTest.java
file which contains the methods to configure and create the connection with BrowserStack as shown below:
@RunWith(Parallelized.class)
public class BrowserStackJUnitTest {
public WebDriver driver;
private Local l;
private static JSONObject config;
@Parameter(value = 0)
public int taskID;
@Parameters
public static Iterable<? extends Object> data() throws Exception {
JSONParser parser = new JSONParser();
config = (JSONObject) parser.parse(new FileReader("src/test/resources/conf/" + System.getProperty("config")));
int envs = ((JSONArray)config.get("environments")).size();
List<Integer> taskIDs = new ArrayList<Integer>();
for(int i=0; i<envs; i++) {
taskIDs.add(i);
}
return taskIDs;
}
@Before
public void setUp() throws Exception {
JSONArray envs = (JSONArray) config.get("environments");
DesiredCapabilities capabilities = new DesiredCapabilities();
Map<String, String> envCapabilities = (Map<String, String>) envs.get(taskID);
Iterator it = envCapabilities.entrySet().iterator();
while (it.hasNext()) {
Map.Entry pair = (Map.Entry)it.next();
capabilities.setCapability(pair.getKey().toString(), pair.getValue().toString());
}
Map<String, String> commonCapabilities = (Map<String, String>) config.get("capabilities");
it = commonCapabilities.entrySet().iterator();
while (it.hasNext()) {
Map.Entry pair = (Map.Entry)it.next();
if(capabilities.getCapability(pair.getKey().toString()) == null){
capabilities.setCapability(pair.getKey().toString(), pair.getValue().toString());
}
}
String username = System.getenv("BROWSERSTACK_USERNAME");
if(username == null) {
username = (String) config.get("user");
}
String accessKey = System.getenv("BROWSERSTACK_ACCESS_KEY");
if(accessKey == null) {
accessKey = (String) config.get("key");
}
String app = System.getenv("BROWSERSTACK_APP_ID");
if(app != null && !app.isEmpty()) {
capabilities.setCapability("app", app);
}
if(capabilities.getCapability("browserstack.local") != null && capabilities.getCapability("browserstack.local") == "true"){
l = new Local();
Map<String, String> options = new HashMap<String, String>();
options.put("key", accessKey);
l.start(options);
}
driver = new RemoteWebDriver(new URL("https://"+username+":"+accessKey+"@"+config.get("server")+"/wd/hub"), capabilities);
}
@After
public void tearDown() throws Exception {
driver.quit();
if(l != null) l.stop();
}
}
BrowserStack provides a comprehensive REST API to access and update information about your tests. Shown below is a sample code snippet which allows you to mark your tests as pass or fail based on the assertions in your JUnit test cases.
// Mark test as pass / fail
public static void mark() throws URISyntaxException, UnsupportedEncodingException, IOException {
URI uri = new URI("https://YOUR_USERNAME:YOUR_ACCESS_KEY@api.browserstack.com/automate/sessions/<session-id>.json");
HttpPut putRequest = new HttpPut(uri);
ArrayList<NameValuePair> nameValuePairs = new ArrayList<NameValuePair>();
nameValuePairs.add((new BasicNameValuePair("status", "completed")));
nameValuePairs.add((new BasicNameValuePair("reason", "")));
putRequest.setEntity(new UrlEncodedFormEntity(nameValuePairs));
HttpClientBuilder.create().build().execute(putRequest);
}
A full reference of our REST API can be found here.
BrowserStack provides a range of debugging tools to help you quickly identify and fix bugs you discover through your automated tests.
Text Logs are a comprehensive record of your test. They are used to identify all the steps executed in the test and troubleshoot errors for the failed step. Text Logs are accessible from the Automate dashboard or via our REST API.
Visual Logs automatically capture the screenshots generated at every Selenium command run through your JUnit tests. Visual Logs help with debugging the exact step and the page where failure occurred. They also help identify any layout or design related issues with your web pages on different browsers.
Visual Logs are disabled by default. In order to enable Visual Logs you will need to set browserstack.debug
capability to true
.
"capabilities": {
"browserstack.debug": true
}
Sample Visual Logs from Automate Dashboard:
Every test run on the BrowserStack Selenium grid is recorded exactly as it is executed on our remote machine. This feature is particularly helpful whenever a browser test fails. You can access videos from Automate Dashboard for each session. You can also download the videos from the Dashboard or retrieve a link to download the video using our REST API.
browserstack.video
capability to false
.
"capabilities": {
"browserstack.video": false
}
In addition to these logs BrowserStack also provides Raw Logs, Network Logs, Console Logs, Selenium Logs, Appium Logs and Interactive session. Complete details to enable all the debugging options can be found here.
Once you have successfully run your first test on BrowserStack, you might want to do one of the following:
Contact our Support team for immediate help while we work on improving our docs.
Contact our Support team for immediate help while we work on improving our docs.