Skip to main content

Gauge with Selenium: Tutorial to Run Your First Test on LambdaTest


In this topic, you will learn how to configure and run your Java automation testing scripts on LambdaTest Selenium cloud platform using Gauge framework. Like Selenium, Gauge also offers support for various languages such as JavaScript, C#, Ruby, Python, and Java.

Objective


By the end of this topic, you will be able to:

  1. Set up an environment for testing your hosted web pages using Gauge framework.
  2. Understand and configure the core capabilities required for your Selenium test suite.
  3. Run test cases in parallel using Gauge framework to reduce build times.
  4. Test your locally hosted pages on LambdaTest platform.
  5. Explore advanced features of LambdaTest.

Note: All the code samples in this documentation can be found in the LambdaTest's Repository on GitHub. You can either download or clone the repository to quickly run your tests.

Prerequisites For Running Gauge with Selenium


Before you can start performing Java automation testing with Selenium, you would need to:

  • Install the latest Java development environment i.e. JDK 1.6 or higher. We recommend using the latest version.

  • Download the latest Selenium Client and its WebDriver bindings from the official website. Latest versions of Selenium Client and WebDriver are ideal for running your automation script on LambdaTest Selenium cloud grid.

  • Install Maven. It can be downloaded and installed following the steps from the official website. Maven can also be installed easily on Linux/MacOS using Homebrew package manager.

  • Install the Gauge framework which can be downloaded from the official website of Gauge.

Installing Selenium Dependencies and tutorial repo

Step 1: Clone the LambdaTest’s gauge-selenium-sample repository and navigate to the code directory as shown below:

git clone https://github.com/LambdaTest/gauge-selenium-sample
cd gauge-selenium-sample

You may also want to run the command below to check for outdated dependencies.

mvn versions:display-dependency-updates

Step 2: Install the mandatory Selenium dependencies for Maven by running the below command:

mvn compile 

Setting up Your Authentication

Make sure you have your LambdaTest credentials with you to run test automation scripts on LambdaTest Selenium Grid. You can obtain these credentials from the LambdaTest Automation Dashboard or through LambdaTest Profile.

Step 3: Set LambdaTest Username and Access Key in environment variables.

  • For Linux/macOS:
    export LT_USERNAME="YOUR_USERNAME" export LT_ACCESS_KEY="YOUR ACCESS KEY"
  • For Windows:
    set LT_USERNAME="YOUR_USERNAME" set LT_ACCESS_KEY="YOUR ACCESS KEY"

Run Your First Test


Sample Test with Gauge

Let’s checkout sample Gauge code running LambdaTest Selenium grid.

package driver.driver;
import com.thoughtworks.gauge.Step;
import org.openqa.selenium.By;
import org.openqa.selenium.Keys;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.interactions.Actions;

import java.util.concurrent.TimeUnit;

import static org.junit.Assert.assertEquals;

public class StepImplementation_Google {

private final WebDriver driver;

public StepImplementation_Google() {
this.driver = DriverFactory.getDriver();
}

@Step("User is on Google home page")
public void googlePage() throws InterruptedException {

driver.get("https://www.google.com/");
driver.manage().timeouts().implicitlyWait(10,TimeUnit.SECONDS);
}

@Step("User search for <loginpage>")
public void searchLogin(String loginpage) throws InterruptedException {

WebElement input = driver.findElement(By.name("q"));
input.sendKeys(loginpage);

Actions action = new Actions(driver);
action.sendKeys(Keys.ENTER).build().perform();

Thread.sleep(2000);

}

@Step("Verify the page title")
public void loginTest() throws InterruptedException {

String title = driver.getTitle();
assertEquals(title,"lambdatest login - Google Search");
Thread.sleep(2000);

}
}

Configuration of Your Test Capabilities

Step 4: In the test script, you need to update your test capabilities. In this code, we are passing browser, browser version, and operating system information, along with LambdaTest Selenium grid capabilities via capabilities object. The capabilities object in the above code are defined as:

DesiredCapabilities capabilities = new DesiredCapabilities();
capabilities.setCapability("browserName", "chrome");
capabilities.setCapability("version", "70.0");
capabilities.setCapability("platform", "win10"); // If this cap isn't specified, it will just get the any available one
capabilities.setCapability("build", "LambdaTestSampleApp");
capabilities.setCapability("name", "LambdaTestJavaSample");
capabilities.setCapability("network", true); // To enable network logs
capabilities.setCapability("visual", true); // To enable step by step screenshot
capabilities.setCapability("video", true); // To enable video recording
capabilities.setCapability("console", true); // To capture console logs

Note: You can generate capabilities for your test requirements with the help of our inbuilt Capabilities Generator tool.

Executing the Test

Step 5: The tests can be executed in the terminal using either of the following commands:

mvn test 

or

mvn clean install

Your test results would be displayed on the test console (or command-line interface if you are using terminal/cmd) and on LambdaTest automation dashboard. LambdaTest Automation Dashboard will help you view all your text logs, screenshots and video recording for your entire automation tests.

Running Parallel Tests using Gauge


Gauge framework do support parallel test execution on the LambdaTest grid. To perform parallel testing, more than one browser specifications need to be updated in the env folder of the project. For instance, we have defined specifications for Chrome, Firefox, Safari and Edge in the below screenshot. Once the test is executed, all parallel browser specifications will hit on the LambdaTest grid and execute simultaneously to achieve parallelism.

cmd

In case you’d need to chuck out test for any browser, you would need to either delete the folder or comment out the code in it.

Executing Parallel Tests Using Gauge

To run parallel tests using Gauge, we would have to execute the same command we had used for single test which would be:

mvn test OR mvn clean install

Your test results would be displayed on the test console (or command-line interface if you are using terminal/cmd) and on LambdaTest automation dashboard.

Testing Locally Hosted or Privately Hosted Projects

You can test your locally hosted or privately hosted projects with LambdaTest Selenium grid cloud using LambdaTest Tunnel app. All you would have to do is set up an SSH tunnel using LambdaTest Tunnel app and pass toggle tunnel = True via desired capabilities. LambdaTest Tunnel establishes a secure SSH protocol based tunnel that allows you in testing your locally hosted or privately hosted pages, even before they are made live.

Refer our LambdaTest Tunnel documentation for more information.

Here’s how you can establish LambdaTest Tunnel.

Download the binary file of:

Open command prompt and navigate to the binary folder.

Run the following command:

LT -user {user’s login email} -key {user’s access key}

So if your user name is [email protected] and key is 123456, the command would be:

LT -user [email protected] -key 123456

Once you are able to connect LambdaTest Tunnel successfully, you would just have to pass on tunnel capabilities in the code shown below :

Tunnel Capability

 DesiredCapabilities capabilities = new DesiredCapabilities();        
capabilities.setCapability("tunnel", true);