Swift test reporting

Add the tesults-swift package as a dependency to your project. Search for tesults-swift in Xcode to find the package.

Ensure you install version 1.0.9 or higher. You can verify the version you have installed by checking package dependencies.

If you receive a build error about missing dependencies for tests, ensure the Tesults library is added to the Link Binary With Libaries section of Build Phases for the target:

Make use of the package using an import statement in any file you need it:

import tesults

Upload results using the results function of the Tesults struct. This is the single point of contact between your code and Tesults.

Tesults().results(data: data)

The results function is async so use await. The results function returns a ResultsResponse struct with four properties indicating success or failure:

print("Tesults results upload...")
let resultsResponse = await Tesults().results(data: data)
print("Success: \(resultsResponse.success)")
print("Message: \(resultsResponse.message)")
print("Warnings: \(resultsResponse.warnings.count)")
print("Errors: \(resultsResponse.errors.count)")

The results function returns a ResultsResponse type that you can use to check whether the upload was a success.

• Value for key "success" is a Bool: 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 [String], if count is not zero there may be issues with file uploads.
• Value for key "errors" is a [String], if "success" is true then this will be empty.

The data param passed to resultss is a Dictionary<String, Any?> containing your results data. Here is a complete example showing how to populate data with your build and test results and then upload it:

// Required imports:
import tesults

// Other imports:
import XCTest
@testable import app_under_test

// Dictionary to hold test cases data.
var cases : [Dictionary<String, Any>] = []

// Each test case is a Dictionary<String, Any> too. 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:
var testCase1 = Dictionary<String, Any>()
testCase1["name"] = "Test Case 1"
testCase1["result"] = "pass" // result value must be pass, fail or unknown

testCase1["suite"] = "Suite A" // Suite is usually the class name
testCase1["desc"] = "Test Case 1 description"
cases.append(testCase1);

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

// (Optional) Add start and end time for test (in milliseconds since epoch):
// In this example, end is set to 100 seconds later
testCase2["start"] =  Date().timeIntervalSince1970*1000
testCase2["end"] = (Date().timeIntervalSince1970 + 100) * 1000

// An optional duration can also be set if a start or end time is unavailable
testCase2["duration"] = 100 * 1000

// (Optional) For a paramaterized test case:
testCase2["params"] = ["Param 1" : "Param 1 Value", "Param 2" : "Param 2 Value"]

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

cases.append(testCase2);

var testCase3 = Dictionary<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.swift." // Test failure reason

// (Optional) For uploading files:
testCase3["files"] = ["/full/path/to/file/log.txt", "/full/path/to/file/screenshot.png"]

// (Optional) For providing test steps for a test case:
testCase3["steps"] = [
  [
    "name":"Step 1",
    "desc":"Step 1 description",
    "result":"pass"
  ],
  [
    "name":"Step 2",
    "desc":"Step 2 description",
    "result":"fail",
    "reason":"Failure reason if result is a fail"
  ]
]

cases.append(testCase3);

// Prepare data for upload
var data = Dictionary<String, Any>()
data["target"] = "token" // The token for the target you wish to upload to
data["results"] = ["cases" : cases] // Test case data

// Upload
print("Tesults results upload...")
let resultsResponse = await Tesults().results(data: data)
print("Success: \(resultsResponse.success)")
print("Message: \(resultsResponse.message)")
print("Warnings: \(resultsResponse.warnings.count)")
print("Errors: \(resultsResponse.errors.count)")

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.