Serenity BDD LambdaTest Integration

The serenity-lambdatest plugin provides seamless integration with the Lambdatest online test automation platform.

Adding the Lambdatest plugin

To add the integrated support for LambdaTest to your project, you will need to add the serenity-lambdatest dependency to your project dependencies. For Mavenm, you would add the following:

    <dependency>
        <groupId>net.serenity-bdd</groupId>
        <artifactId>serenity-lambdatest</artifactId>
        <version>${serenity.version}</version>
    </dependency>

And for Gradle:

    testImplementation "net.serenity-bdd:serenity-lambdatest:${serenityVersion}"

Specifying your LambdaTest credentials and grid URL

Next, you will need a LambdaTest account (If you don't already have one you can set up a free lifetime account to experiment).

You can add your LambdaTest credentials in two ways. The simplest is to define the following system properties:

• LT_USERNAME - Lambdatest user name
• LT_ACCESS_KEY- Lambdatest access key

Alternatively, you can define your username and accesskey using the lt.user and lt.key properties respectively in your serenity.conf file:

lt.user=myuser
lt.key=XXXXXXXX

By default the standard LambdaTest grid URL ("hub.lambdatest.com") will be used to connect to the LambdaTest servers, but you can override this by setting the lt.grid property:

lt.grid = "mycustomhub.lambdatest.com"

Configuring the LambdaTest driver

Serenity interacts with LambdaTest via the RemoteDriver driver. A typical configuration looks like this:

webdriver {
  driver = remote
  remote.url = "https://${LT_USERNAME}:${LT_ACCESS_KEY}@hub.lambdatest.com/wd/hub"
}

You can either set up the remote.url value explicitly in your serenity.conf file like this, or let the LambdaTest plugin do it for you. If the remote.webdriver.url property is not defined, Serenity will use these values to build one for you if the LambdaTest plugin is active (see below).

Activating the LambdaTest plugin

The Serenity LambdaTest plugin will be invoked if Serenity can find a lambdatest section in your serenity.conf file, or if you specify a remote.webdriver.url that points to a LambdaTest server. If you have no LambdaTest-specific capabilities, simply set the lambdatest.active property to true like this:

lambdatest {
  active = true
}

Defining LamdbaTest Capabilities

You can specify the operating system and browser you want to run your tests on by customising the Selenium Capabilities in your serenity.conf file. You do this in the lambdatest section of the serenity.conf file, e.g.

lambdatest {
  platformName = "Windows 11"
  resolution = "1280x800"
  visual = true
}

The LambdaTest test name will be assigned automatically. You can also set the build name by assigning the lambdatest.build property. For example the following example shows how to create a build name from the Jenkins job name and build number environment variables:

lambdatest {
  build = "${JOB_NAME} - build ${BUILD_NUMBER}"
}

These properties will be placed in the LT:Options capability.

:::tip

LambdaTest provides a convenient Capabilities Generator that gives an idea of what options are available.

:::