Selenium with JBehave

A guide to running Selenium Webdriver tests with JBehave on BrowserStack.

Note: Code samples in this guide can be found in the jbehave-browserstack sample repo on GitHub

Introduction

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

  1. Running your first test
  2. Integrating your tests with BrowserStack
  3. Marking tests as passed or failed
  4. Debugging your app

Prerequisites

Before you can start running your Selenium tests with JBehave, ensure you have the JBehave libraries installed. Ensure it is included in the pom.xml, as shown below (It is already included in the sample repo that we will use in this guide):

pom.xml
<!-- Install using maven -->
<dependency>
    <groupId>org.jbehave</groupId>
    <artifactId>jbehave-core</artifactId>
    <version>3.8</version>
</dependency>

Running your first test

Note: Testing on BrowserStack requires username and access key that can be found in account settings.
If you have not created an account yet, you can sign up for a Free Trial or purchase a plan.

To run your first JBehave test on BrowserStack, follow the steps below:

  1. Clone the jbehave-browserstack sample repo on GitHub using the following command:

    git clone https://github.com/browserstack/jbehave-browserstack.git
    cd jbehave-browserstack
    
  2. Install the dependencies using mvn install
  3. Setup your credentials in the jbehave-browserstack/src/test/resources/conf/single.conf.json file as shown below:

    single.conf.json
    {
       "server": "hub-cloud.browserstack.com",
       "user": "YOUR_USERNAME",
       "key": "YOUR_ACCESS_KEY",
    
       "capabilities": {
           "build": "jbehave-browserstack",
           "name": "single_test",
           "browserstack.debug": true
       },
    
       "environments": [{
           "browser": "chrome"
       }]
      }
    
  4. Run your first test using the following command:

    mvn test -P single
    
  5. You can visit BrowserStack Automate Dashboard and see your test there once it has successfully completed.
Protip: You can use our capability builder and select from a wide range of custom capabilities that BrowserStack supports.

Details of your first test

The sample test that you just ran can be found in jbehave-browserstack/src/test/resources/stories/single.story. The test case below searches for the string “BrowserStack” on Google, and checks if the title of the resulting page is “BrowserStack - Google Search”:

single.story
  Scenario: Google's Search Functionality

  When I type query as "BrowserStack"
  Then I submit
  Then I should see title "BrowserStack - Google Search"

You will also need to define the Page, Steps and Embedder (already exists in the sample repo):

jbehave-browserstack/src/test/java/com/browserstack/single/pages/GooglePage.java
// Google Page
public class GooglePage {
    private String DEFAULT_GOOGLE_URL = "https://www.google.com/ncr";
    private WebDriver driver;
    private WebElement element;

    public GooglePage(WebDriver driver) {
       this.driver = driver;
    }

    public String getTitle(){
        return driver.getTitle();
    }

    public void searchOnGoogle(String keyword) {
        driver.get(DEFAULT_GOOGLE_URL);
        element = driver.findElement(By.name("q"));
        element.sendKeys(keyword);
    }

    public void submitSearch() throws Exception {
        element.submit();
        Thread.sleep(5000);
    }
}
jbehave-browserstack/src/test/java/com/browserstack/single/GoogleSteps.java
// Google Steps
public class GoogleSteps {
    private GooglePage page;

    public GoogleSteps(WebDriver driver) {
       page = new GooglePage(driver);
    }

    @When("I type query as \"$keyword\"")
    public void searchGoogle(String keyword) {
        page.searchOnGoogle(keyword);
    }

    @Then("I submit")
    public void submit() throws Exception {
        page.submitSearch();
    }

    @Then("I should see title \"$keyword\"")
    public void titleShouldContain(String keyword) {
        Assert.assertEquals(keyword, page.getTitle());
    }
}
jbehave-browserstack/src/test/java/com/browserstack/single/SingleEmbedder.java
// Embedder
public class SingleEmbedder extends Embedder {
    private WebDriver driver;

    public SingleEmbedder(WebDriver driver) {
        this.driver = driver;
    }

    @Override
    public EmbedderControls embedderControls() {
        return new EmbedderControls().doIgnoreFailureInStories(true).doIgnoreFailureInView(true);
    }

    @Override
    public Configuration configuration() {
        Class<? extends SingleEmbedder> embedderClass = this.getClass();
        return new MostUsefulConfiguration()
            .useStoryLoader(new LoadFromClasspath(embedderClass.getClassLoader()))
            .useStoryReporterBuilder(new StoryReporterBuilder()
                .withCodeLocation(CodeLocations.codeLocationFromClass(embedderClass))
                .withDefaultFormats()
                .withCrossReference(new CrossReference()))
            .useParameterConverters(new ParameterConverters()
                .addConverters(new DateConverter(new SimpleDateFormat("yyyy-MM-dd"))))
            .useParameterControls(new ParameterControls().useNameDelimiterLeft("<").useNameDelimiterRight(">"))
            .useStepPatternParser(new RegexPrefixCapturingPatternParser(
                  "$"))
            .useStepMonitor(new SilentStepMonitor());
    }

    @Override
    public InjectableStepsFactory stepsFactory() {
        return new InstanceStepsFactory(configuration(), new GoogleSteps(driver));
    }

}

Integrating your tests with BrowserStack

The integration of your test with BrowserStack is working with the help of BrowserStackJBehaveRunner.java file which contains the methods to configure and create the connection with BrowserStack as shown below. You can use the same code for teh integration of your tests with BrowserStack.

jbehave-browserstack/src/test/java/com/browserstack/BrowserStackJBehaveRunner.java
@RunWith(Parameterized.class)
public class BrowserStackJBehaveRunner {

    public WebDriver driver;
    private Local l;

    private static JSONObject config;

    @Parameter(value = 0)
    public int taskID;

    @Parameters
    public static Collection<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<Object[]> taskIDs = new ArrayList<Object[]>();
        for(int i=0; i<envs; i++) {
            taskIDs.add(new Object[] {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");
        }

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

    @Test
    public void runStories() throws Exception {
        Class<?> c = Class.forName(System.getProperty("embedder"));
        Constructor<?> cons = c.getConstructor(WebDriver.class);
        Embedder storyEmbedder = (Embedder) cons.newInstance(driver);

        List<String> storyPaths = Arrays.asList(System.getProperty("stories"));
        storyEmbedder.runStoriesAsPaths(storyPaths);
    }
}

Marking 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 JBehave 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);
}

Debugging 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 JBehave 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: BrowserStack Automate Visual Logs

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.

Note: Video recording increases test execution time slightly. You can disable this feature by setting the browserstack.video capability to false.

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:

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

Is this page helping you?

Yes
No

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!

Talk to automation expert
Talk to an Expert