Selenium with Selenide

Your guide to run Selenium Webdriver tests with Selenide on BrowserStack.

Introduction

BrowserStack gives you instant access to our Selenium Grid of 3000+ real devices and desktop browsers. Running your Selenium tests with Selenide on BrowserStack is simple. This guide will help you:

1. Run your first test
2. Understand your tests with BrowserStack
3. Integrate your tests with BrowserStack
4. Mark tests as passed or failed
5. Debug your app

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.
• Maven is installed on your machine, Maven environment variables are set, and Maven bin is added to the system path $PATH. Check out the official website to download the latest version of Maven.
• Git is installed on your machine.

Run your first test

To run Selenium tests with Selenide on BrowserSatck Automate, follow the below steps:

1. Clone the selenide-browserstack repository using the following command:

    git clone https://github.com/browserstack/selenide-browserstack.git
    cd selenide-browserstack
   

2. Verify that the following Selenide libraries are included in the pom.xml of the cloned repository:
   pom.xml

    <dependency>
        <groupId>com.codeborne</groupId>
        <artifactId>selenide</artifactId>
        <version>4.2</version>
        <scope>test</scope>
    </dependency>
   

3. Install the dependencies using the following command:
   
   

    mvn compile
   

4. Set your BrowserStack Username and Access Key in the parallel.conf.json as follows:
   
   This file also contains the capabilities that define the browsers to run the test.

   selenide-browserstack/src/test/resources/conf/parallel.conf.json

    {
            "server": "hub.browserstack.com",
            "user": "YOUR_USERNAME",
            "key": "YOUR_ACCESS_KEY",
   
            "capabilities": {
                "build": "browserstack-build-1",
                "name": "selenide_parallel_test",
                "browserstack.debug": true
            },
   
            "environments": {
                "chrome": {
                    "browser": "chrome"
                },
                "firefox": {
                    "browser": "firefox"
                },
                "safari": {
                    "browser": "safari"
                }
            }
        }
   

5. Now, execute your first test on BrowserStack using the following command:
   
   

    mvn test -P parallel
   

6. Navigate to your Automate Dashboard) and view the tests running in parallel on multiple browsers.

Understand the details of your test

When you run the mvn test -P parallel command, the test case in the SingleTest.java file is executed on several browsers, namely Chrome, Firefox, and Safari.

When the test is triggered, it:

• Opens the bstackdemo.com website.
• Adds a product to the cart.
• Verifies whether the product is added to the cart.
• Marks the test as passed or failed based on whether the product is available in the cart.

public class SingleTest extends BrowserStackTest {

	@Test
	public void test() throws Exception {

		open("https://www.bstackdemo.com");
		sleep(2000);

		String selectedProduct = $(By.xpath("//*[@id=\"1\"]/p")).text();
		$(By.xpath("//*[@id=\"1\"]/div[4]")).click();
		sleep(2000);

		// waiting for cart to load
		while(!$(".float-cart__content").isDisplayed()) {
			sleep(1000);
		}

		String productInCart = $(
			By.xpath(
				"//*[@id=\"__next\"]/div/div/div[2]/div[2]/div[2]/div/div[3]/p[1]"
			)
		).text();

		// assert the product clicked has been added to cart
		Assert.assertEquals(selectedProduct, productInCart);
	}
}

The parallel.testng.xml file defines the test name to run for each environment.

	<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE suite SYSTEM "http://testng.org/testng-1.0.dtd">
<suite name="Parallel" thread-count="3" parallel="tests">
	<test name="SingleTestChrome">
    <parameter name="config" value="parallel.conf.json"/>
    <parameter name="environment" value="chrome"/>
    <classes>
      <class name="com.browserstack.SingleTest"/>
    </classes>
	</test>

	<test name="SingleTestFirefox">
    <parameter name="config" value="parallel.conf.json"/>
    <parameter name="environment" value="firefox"/>
    <classes>
      <class name="com.browserstack.SingleTest"/>
    </classes>
	</test>

	<test name="SingleTestSafari">
    <parameter name="config" value="parallel.conf.json"/>
    <parameter name="environment" value="safari"/>
    <classes>
      <class name="com.browserstack.SingleTest"/>
    </classes>
	</test>
</suite>

Integrate your tests with BrowserStack

Your Selenide test case has been integrated to run on BrowserStack using the snippet shown below. A class has been defined which contains the methods to configure and create the connection with BrowserStack. You can find the script in the Selenide BrowserStack sample repository.

public class BrowserStackTest {
	public RemoteWebDriver driver;
	private Local l;

	public static String username;
	public static String accessKey;
	public static String sessionId;

	@BeforeMethod(alwaysRun=true)
	@Parameters(value={"config", "environment"})
	public void setUp(String config_file, String environment) throws Exception {
		JSONParser parser = new JSONParser();
		JSONObject config = (JSONObject) parser.parse(new FileReader("src/test/resources/conf/" + config_file));
		JSONObject envs = (JSONObject) config.get("environments");

		DesiredCapabilities capabilities = new DesiredCapabilities();

		Map<String, String> envCapabilities = (Map<String, String>) envs.get(environment);
		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());
			}
		}

		username = System.getenv("BROWSERSTACK_USERNAME");
		if (username == null) {
			username = (String) config.get("user");
		}

		accessKey = System.getenv("BROWSERSTACK_ACCESS_KEY");
		if (accessKey == null) {
			accessKey = (String) config.get("key");
		}

		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);
		driver.manage().timeouts().implicitlyWait(10, TimeUnit.SECONDS);
		sessionId = driver.getSessionId().toString();

		WebDriverRunner.setWebDriver(driver);
	}

	@AfterMethod(alwaysRun=true)
	public void tearDown() throws Exception {
		driver.quit();
		if (l != null) l.stop();
	}
}

Mark tests as passed or failed

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 Selenide 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);
}

You can find the full reference to our REST API.

Debug your app

BrowserStack provides a range of debugging tools to help you quickly identify and fix bugs you discover through your automated tests.

Text Logs

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

Visual Logs automatically capture the screenshots generated at every Selenium command run through your Selenide 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:

Video recording

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.

To disable video recording, add the following code snippet:

"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. You can find the complete details to enable all the debugging options

Next steps

Once you have successfully run your first test on BrowserStack, you might want to do one of the following:

• Run multiple tests in parallel to speed up builds
• Test privately hosted websites
• Generate a list of capabilities that you want to use in tests
• Find information about your Projects, Builds and Sessions using our REST APIs
• Set up your CI/CD: Jenkins, Bamboo, TeamCity, Azure, CircleCI, BitBucket, TravisCI, GitHub Actions