How to run your Java Appium script in Perfecto

This section provides instructions on how to run Appium Driver tests with Java in Perfecto. It assumes that you are:

  • Familiar with Appium
  • Have existing tests to work with
  • Are a novice user of Perfecto

To run your tests in Perfecto, you need to modify your existing scripts to include:

  • What driver you want to use
  • Where your Perfecto instance is located 
  • Who you are
  • What device you want to work on

We provide two versions of the same script to help you understand how you can modify your existing scripts to run them in Perfecto: and

For information on running the final script, see the the file included with the sample project.

On this page:


Before you get started, make sure you have installed the following:

1 | Get started

The starting point is, a short Java script with Maven dependencies. The pom.xml file is institutional here because it holds all configurations and dependencies. In its initial state, the file is very simple.

Note: We have simplified the script intentionally. It only serves the purpose of showing you how to connect to Perfecto.

The script connects to an emulator, opens the calculator app on an Android device, and performs an addition validation (1+1=2).

To get started: 

  1. Access the sample project in GitHub and copy the clone URL:
  2. Open your IDE and check out the project from GitHub.
  3. Run the script to make sure it executes without any issues.

2 | Configure the script for Perfecto

In this step, we update the pom.xml file with the required Perfecto dependencies and modify the script from Step 1 to add in security information, the Perfecto cloud name, Smart Reporting information, and test data. We also want to make sure that the script exits gracefully.

The updated script is called The following procedure walks you through the configuration.

Expand a step to view its content.

Copy the dependencies in the pom.xml file and paste them into the pom.xml file of your own project. This step is essential because the imports in our final script only work when the dependencies specified in this file are available.

Generate your security token through the Perfecto UI. then define your security token as a system variable called securityToken. The script uses this variable to retrieve the security token:

String securityToken = System.getProperty("securityToken");
capabilities.setCapability("securityToken", securityToken);

This is the recommended way of including the security token, but of course you can also keep the token in Jenkins or even hard-code it in the script.

Use capabilities to select a device from the Perfecto lab. You can be as generic or specific as needed. In our script, we have included the these capabilities, as shown in the following code snippet:

  • model: The device model
  • openDeviceTimeout: The timeout, in minutes, to wait for a specific device in case it is not available at the start of the script (use with caution)
  • appPackage: The Java package of the Android app you want to run

For more information on capabilities, see:

DesiredCapabilities capabilities = new DesiredCapabilities(browserName, "", Platform.ANY);
capabilities.setCapability("model", "Galaxy S6");
capabilities.setCapability("openDeviceTimeout", 2);
capabilities.setCapability("appPackage", "");

You can use the Manual Testing view in the Perfecto UI to generate a code snippet with device-specific capabilities that you can then copy-paste into your script. 

To generate capabilities (for mobile or web devices) through the Perfecto UI:

  1. On the Perfecto landing page, under Manual Testing, click Open Device.
  2. In the Manual Testing view, do the following to generate capabilities:

As part of creating an instance of the RemoteWebDriver, you need to supply the URL of your Perfecto cloud. Define the name of your Perfecto cloud as a system variable called cloudName., for example: demo.

The general structure of the URL string is as follows:

"https://" + cloudName "/" 

Here are the respective lines from our sample script:

String cloudName = System.getProperty("cloudName");
RemoteWebDriver driver = new RemoteWebDriver(new URL("https://" + cloudName + ""), capabilities);

To get the most out of running your test in Perfecto, you need to create an instance of the Smart Reporting client (ReportiumClient). This will allow you to later retrieve and analyze the test report. The reporting client is responsible for gathering basic information about the test and transmitting it to the Smart Reporting system.

In our script, we show how to use the ReportiumClientFactory class' createPerfectoReportiumClient() method. Use the PerfectoExecutionContext class to supply the link to the factory class creating the client instance. Use the withWebDriver() method to supply the link of the driver instance.

Use the build() method to create the context object's instance and supply this to the createPerfectoReportiumClient() method when creating the ReportiumClient instance.

PerfectoExecutionContext perfectoExecutionContext;
if(System.getProperty("reportium-job-name") != null) {
		perfectoExecutionContext = new PerfectoExecutionContext.PerfectoExecutionContextBuilder()
				.withProject(new Project("My Project", "1.0"))
				.withJob(new Job(System.getProperty("reportium-job-name") , Integer.parseInt(System.getProperty("reportium-job-number"))))
} else {
		perfectoExecutionContext = new PerfectoExecutionContext.PerfectoExecutionContextBuilder()
				.withProject(new Project("My Project", "1.0"))
ReportiumClient reportiumClient = new ReportiumClientFactory().createPerfectoReportiumClient(perfectoExecutionContext);

In addition to supplying the driver link, the context supports optional settings, such as adding:

  • Reporting tags: Tags are used as a freestyle text for filtering the reports in the Reporting app. Use the withContextTags() method as shown in the following code snippet.
  • CI job information: Job information is used to add your test runs to the CI Dashboard view. Use the withJob() method of the PerfectoExecutionContext instance, supplying the job name and job number, when creating the ReportiumClient instance.
    Our sample script uses system variables to fetch the reportium-job-name and the reportium-job-number values . Both system variables are sent from CI tools like Jenkins as a Maven -D system property. For example:
    -Dreportium-job-name=${JOB_NAME} -Dreportium-job-number=${BUILD_NUMBER}
    The following figure illustrates how the reportium-job-name and the reportium-job-number system variables get their value from Jenkins. These variables are passed as -D parameters for install goals of Maven.

    Our script supports both local and CI-based executions (for more information, see Add reporting to Jenkins > Supply Maven or Ivy parameters).

Replace the existing test code in the try bock with your own test information.

try {
	reportiumClient.testStart("My Calculator Test", new TestContext("tag2", "tag3"));
	reportiumClient.stepStart("Perform addition");
	reportiumClient.stepStart("Verify Total");
	WebElement results=driver.findElement(By.xpath("//*[contains(@class,'EditText')]"));
	if (!results.getText().equals("2"))
		throw new RuntimeException("Actual calculated number is : \"+results.getText() + \". It did not match with expected value: 2");
	TestResult testResult = TestResultFactory.createSuccess();

In our example, the test is separated into logical groupings of actions as logical steps. Each step is labeled and appears in the Execution Report together with the component actions. The beginning of each logical step is indicated with the stepStart() method, providing the label of the step, and the end of each logical step with the stepEnd() method (for the report).

To end the test, supply an indication of the final outcome of the test by generating a TestResult instance.

    TestResult testResult = TestResultFactory.createSuccess();

} catch (Exception e) {
			TestResult testResult = TestResultFactory.createFailure(e);

In our example, the createSuccess method notifies the reporting server that the test resulted in a successful status. The createFailure method notifies the reporting server that the test resulted in an unsuccessful status and supports adding a notification message that is displayed in the test report. Our script also provides a failure reason, but this is optional. To learn more about failure reasons in reporting, see Work with failure reasons.

Last, make sure to close and quit the RemoteWebDriver and retrieve the Smart Reporting URL for the generated test report.

finally {
			// Retrieve the URL to the DigitalZoom Report 
			String reportURL = reportiumClient.getReportUrl();

Content here

Content here

Also in this section: