Skip to main content

Selenium with JBehave

A guide to run 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 3000+ real devices and desktop browsers. Running your Selenium tests with JBehave 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

Protip: Selenium 4 is now supported on BrowserStack. To use the Selenium 4 client bindings, modify your existing test scripts as follows:
  • Edit or add capabilities in the W3C format using our W3C capability generator.
  • Add the seleniumVersion capability in your test script and set the value to 4.0.0.

To run your first JBehave test on BrowserStack, complete the following steps:

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

    git clone https://github.com/browserstack/jbehave-browserstack.git
    
  2. Run the following command to install the dependencies:
     cd jbehave-browserstack
     mvn install
    
  3. Set your BrowserStack Username and Access Key in the jbehave-browserstack/src/test/resources/conf/parallel.conf.json file as follows:

    This file also contains the capabilities that define the browsers to run the test.
    parallel.conf.json
     {
         "server": "hub.browserstack.com",
         "user": "YOUR_USERNAME",
         "key": "YOUR_ACCESS_KEY",
    
         "capabilities": {
             "build": "jbehave-browserstack",
             "name": "parallel_test",
             "browserstack.debug": true
             },
    
         "environments": [{
             "browser": "chrome"
         },{
             "browser": "firefox"
         },{
             "browser": "safari"
         },{
             "browser": "internet explorer"
         }]
     }
    
  4. Run your first test using the following command:

     mvn test -P parallel
    
  5. Navigate to your Automate Dashboard and view the tests running in parallel on multiple browsers.
Protip: You can use our capability builder and select from a wide range of custom capabilities that BrowserStack supports.

Understand the details of your test

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

When the test is triggered, it searches for the string BrowserStack on www.google.com and checks whether the title of the resulting page is BrowserStack - Google Search.

jbehave-browserstack/src/test/resources/stories/single.story
  Scenario: Google's Search Functionality

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

The GooglePage.java file inside the /src/test/java/com/browserstack/single/pages/ directory defines the test functions. These test functions are used in the test script file.

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

The GoogleSteps.java file inside the /src/test/java/com/browserstack/single directory defines the test script. It uses the functions defined in the GooglePage.java file.

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

The embedder file, SingleEmbedder.java, is located in the /src/test/java/com/browserstack/single directory. It is the entry point for running the test script.

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

}

Integrate your tests with BrowserStack

The BrowserStackJBehaveRunner.java file helps in integrating tests with BrowserStack. This file contains methods to configure and create the connection with BrowserStack.

You can use the following code for integrating your existing 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);
    }
}

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

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 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 an Expert
Talk to an Expert