Results Object

The results object is the core component of a CTRF document. It contains the outcomes represented by that document, which may be one shard or partition of a logical run or merged results from multiple workers. Related documents can be correlated with a shared runId.

Properties

Name	Type	Required	Description
tool	Object	Required	Identifies the tool, framework, or system that produced the test results. See Tool Object.
summary	Object	Required	Aggregated statistics and timing data describing the test run. See Summary Object.
tests	Array	Required	The list of test cases executed during the test run. Each element follows the Test Object structure.
environment	Object	Optional	Describes the execution environment, system configuration, and build context. See Environment Object.
extra	Object	Optional	Extension point for arbitrary metadata specific to the results.

Example

"results": { 
  "tool": {
    "name": "jest",
    "version": "29.7.0"
  },
  "summary": {
    "tests": 10,
    "passed": 8,
    "failed": 1,
    "skipped": 1,
    "pending": 0,
    "other": 0,
    "start": 1706644023000,
    "stop": 1706644043000
  },
  "tests": [
    ...
  ],
  "environment": {
    "appName": "my-app",
    "buildNumber": 123
  }
}