Java test reporting

The Tesults Java API Library is available from the JCenter and Maven Central repositories or as a JAR.

Option 1: Gradle

If you are using Gradle add this dependency snippet to your build.gradle file:

dependencies {
  compile 'com.tesults:tesults:1.0.3'
}

Also ensure you have the JCenter or Maven Central repository referenced in your build.gradle file.

Option 2: Maven

If you are using Maven add this dependency snippet to your pom.xml file:

<dependency>
  <groupId>com.tesults</groupId>
  <artifactId>tesults</artifactId>
  <version>1.0.3</version>
</dependency>

Option 3: JAR

Download here and reference in your project.

Use one of the three methods described above to make the Tesults Java API available as a library and then import the com.tesults.tesults package in your code:

import com.tesults.tesults.*;

Upload results using the upload method in the Results class. This is the single point of contact between your code and Tesults.

Results.upload(data);

The upload method returns a Map indicating success or failure:

Map<String, Object> response = Results.upload(data);

// Response output:
System.out.println("success: " + response.get("success"));
System.out.println("message: " + response.get("message"));
System.out.println("warnings: " + ((List<String>) response.get("warnings")).size());
System.out.println("errors: " + ((List<String>) response.get("errors")).size());

The upload method returns a response of type Map<String, Object> that you can use to check whether the upload was a success.

• Value for key "success" is a Boolean: true if results successfully uploaded, false otherwise.
• Value for key "message" is a String: if success is false, check message to see why upload failed.
• Value for key "warnings" is a List<String>, if size is not zero there may be issues with file uploads.
• Value for key "errors" is a List<String>, if "success" is true then this will be empty.

The data param passed to upload is a Map<String, Object> containing your results data. Here is a complete example showing how to populate data with your build and test results and then complete upload to Tesults with a call to Results.upload(data):

// Required imports:
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import com.tesults.tesults.*;  // Tesults Java API

// A list to hold your test cases.
List<Map<String,Object>> testCases = new ArrayList<Map<String, Object>>();

// Each test case is a Map<String,Object>. We use generic types rather than
// concrete helper classes so that if and when the Tesults services adds more fields
// you do not have to update the library.

// You would usually add test cases in a loop taking the results from the data objects
// in your build/test scripts. At a minimum you must add a name and result:
Map<String, Object> testCase1 = new HashMap<String, Object>();
testCase1.put("name", "Test 1");
testCase1.put("desc", "Test 1 description");
testCase1.put("suite", "Suite A");
testCase1.put("result", "pass"); // result value must be pass, fail or unknown

testCases.add(testCase1);

Map<String, Object> testCase2 = new HashMap<String, Object>();
testCase2.put("name", "Test 2");
testCase2.put("desc", "Test 2 description");
testCase2.put("suite", "Suite B");
testCase2.put("result", "pass");

// (Optional) Add start and end time for test:
// In this example, start is offset to 60 seconds earlier
// but it should be set to current time when the test starts
testCase2.put("start", java.lang.System.currentTimeMillis() - 60000);
testCase2.put("end", java.lang.System.currentTimeMillis());

// (Optional) For a paramaterized test case:
Map<String, String> params = new HashMap<String, String>();
params.put("param1", "value1");
params.put("param2", "value2");
testCase2.put("params", params);

// (Optional) Custom fields start with an underscore:
testCase2.put("_CustomField", "Custom field value");

testCases.add(testCase2);

Map<String, Object> testCase3 = new HashMap<String, Object>();
testCase3.put("name", "Test 3");
testCase3.put("desc", "Test 3 description");
testCase3.put("suite", "Suite A");
testCase3.put("result", "fail");
testCase3.put("reason", "Assert fail in line 203 of example.java.");

// (Optional) For uploading files:
List<String> files = new ArrayList<String>();
files.add("/Path/to/file/log.txt");
files.add("/Path/to/file/screencapture.png");
files.add("/Path/to/file/metrics.xls");
testCase3.put("files", files);

// (Optional) For providing test steps for a test case:
List<Map<String,Object>> steps = new ArrayList<Map<String, Object>>();
Map<String, Object> step1 = new HashMap<String, Object>();
step1.put("name", "Step 1");
step1.put("desc", "Step 1 description");
step1.put("result", "pass"); // can be pass, fail or unknown
step1.put("reason", "Failure reason if result is a fail");
steps.add(step1);

Map<String, Object> step2 = new HashMap<String, Object>();
step2.put("name", "Step 2");
step2.put("desc", "Step 2 description");
step2.put("result", "pass"); // pass, fail or unknown
step2.put("reason", "Failure reason if result is a fail");
steps.add(step2);

testCase3.put("steps", steps);

testCases.add(testCase3);

// Map<String, Object> to hold your test results data.
Map<String, Object> data = new HashMap<String, Object>();
data.put("target", "token");

Map<String, Object> results = new HashMap<String, Object>();
results.put("cases", testCases);
data.put("results", results);

// Upload
Map<String, Object> response = Results.upload(data);
System.out.println("success: " + response.get("success"));
System.out.println("message: " + response.get("message"));
System.out.println("warnings: " + ((List<String>) response.get("warnings")).size());
System.out.println("errors: " + ((List<String>) response.get("errors")).size());

The target value, 'token' above should be replaced with your Tesults target token. If you have lost your token you can regenerate one from the config menu.