Kotlin test reporting

For Kotlin use the Tesults Java API. The Tesults Java API Library is available from the JCenter and Maven Central repositories or as a JAR you can download from here.

Gradle

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

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

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

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.1</version>
</dependency>

JAR

Alternatively a JAR is available for download directly here: tesults.jar (compatible with Java 7+)

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.Results;

Upload results using the upload method in the Results class:

// Results upload - the single point of contact between your code and Tesults
val response = Results.upload(data)

// Response output:
println("success: " + response["success"])
println("message: " + response["message"])
println("warnings: " + (response["warnings"] as List<String>).size);
println("errors: " + (response["errors"] as List<String>).size);

The upload method returns a response 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 Hashmap<String, Any> 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 com.tesults.tesults.Results  // Tesults Java API available as library for using Results class

fun main(args: Array<String>) {
  // In main function as an example only, ordinarily this code would be
  // located wherever your results data is available.

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

  // Each test case is of HashMap<String,Any> type. 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.
  val testCase1 = HashMap<String, Any>()
  testCase1["name"] = "Test 1"
  testCase1["desc"] = "Test 1 description"
  testCase1["suite"] = "Suite A"
  testCase1["result"] = "pass"

  testCases.add(testCase1)

  val testCase2 = HashMap<String, Any>()
  testCase2["name"] = "Test 2"
  testCase2["desc"] = "Test 2 description"
  testCase2["suite"] = "Suite B"
  testCase2["result"] = "pass"

  // (Optional) For a paramaterized test case:
  val params = HashMap<String, String>();
  params["param1"] = "value1"
  params["param2"] = "value2"
  testCase2["params"] = params

  // (Optional) Custom fields start with an underscore:
  testCase2["_CustomField"] = "Custom field value"

  testCases.add(testCase2)

  val testCase3 = HashMap<String, Any>();
  testCase3["name"] = "Test 3"
  testCase3["desc"] = "Test 3 description"
  testCase3["suite"] = "Suite A"
  testCase3["result"] = "fail"
  testCase3["reason"] = "Assert fail in line 203 of example.java."

  // (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
  testCase3["start"] = System.currentTimeMillis() - 60000;
  testCase3["end"] = System.currentTimeMillis();

  // (Optional) For uploading files:
  val files = ArrayList<String>()
  files.add("/Path/to/file/log.txt")
  files.add("/Path/to/file/screencapture.png")
  files.add("/Path/to/file/metrics.xls")
  testCase3["files"] = files

  // (Optional) For adding test steps:
  val steps = new ArrayList<Map<String, Any>>();

  val step1 = HashMap<String, Any>();
  step1["name"] = "Step 1"
  step1["desc"] = "Step 1 description"
  step1["result"] = "pass"
  steps.add(step1)

  val step2 = HashMap<String, Any>();
  step2["name"] = "Step 2"
  step2["desc"] = "Step 2 description"
  step2["result"] = "fail"
  step2["reason"] = "Assert fail in line 203 of example.java."
  steps.add(step2)

  testCase3["steps"] = steps

  testCases.add(testCase3)

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

  val results = HashMap<String, Any>()
  results["cases"] = testCases
  data["results"] = results

  // Upload
  val response = Results.upload(data)
  println("success: " + response["success"])
  println("message: " + response["message"])
  println("warnings: " + (response["warnings"] as List<String>).size)
  println("errors: " + (response["errors"] as List<String>).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.

Each test case added to cases must have a name and a result. The result value must be one of 'pass', 'fail' or 'unknown'. All other fields are optional: desc, suite, files, params, steps, reason and custom fields (prefixed with underscore).