# Data Format Reference Currents can accept results from arbitrary testing frameworks. This document provides detailed instructions for creating test results data that is compatible with Currents. * To upload the results, use the [currents-upload](https://docs.currents.dev/resources/reporters/currents-cmd/currents-upload "mention") command. * Refer to [currents-convert](https://docs.currents.dev/resources/reporters/currents-cmd/currents-convert "mention") to see how we convert results from various popular testing frameworks to "Currents Format" that conforms to the specification presented below. ## Results Directory To upload the results to Currents, create a "Results Directory" with all the necessary files. The directory will be used as the `--output-dir` parameter for the [currents-upload](https://docs.currents.dev/resources/reporters/currents-cmd/currents-upload "mention") command, for example: `npx currents convert --output-dir path-to-results-directory` Within the Results Directory, the following structure of files and directories is expected. ``` results-dir/ ├── instances/ │ ├── .json │ ├── .json │ └── .json │── config.json └── fullTestSuite.json ``` The output consists of three main components: * `fullTestSuite.json` is the [#full-test-suite](#full-test-suite "mention") JSON document that contains the tests expected to be reported. It does not contain test results. * `config.json` is a [#configuration-file](#configuration-file "mention") that contains metadata such as test framework name, version, and more. * `instances` folder contains [#instance-files](#instance-files "mention") - JSON documents that represent a spec file or logical collection and the associated test results. ## Full Test Suite The Full Test Suite is a JSON-formatted file that contains a list of all tests expected to be reported to the Currents platform for the current build/run. Each element in the `fullTestSuite.json` file array represents a group of tests, organized by the `name` property which defines the group name.

Note that the property "name" is showed as the "group name" in the dashboard.

{% hint style="info" %} Currents requires that all test results from the Full Test Suite be submitted before the project's specified timeout. If results are not received by the deadline, the run is marked as timed out. See [run-timeouts](https://docs.currents.dev/dashboard/runs/run-timeouts "mention"). {% endhint %} `Full Test Suite file` The root of the `fullTestSuite.json` file is a list of elements of the type `Group`. {% hint style="info" %} The `SuiteTest` objects can be part of any `Group` and may even be included in multiple `Group`s. {% endhint %}
Full Test Suite file root object: Array<Group> ```json [ { "name": "Dashboard Tests", "tags": ["e2e", "dashboard"], "tests": [ { "title": ["dashboard", "login"], "spec": "__tests__/dashboard/login.spec.tsx", "tags": ["completed"], "testId": "a50d141accce5aaa" } ... ], }, { "name": "Landing Tests", "tags": ["e2e", "landing"], "tests": [ { "title": ["landing"], "spec": "__tests__/landing/landing.spec.tsx", "tags": ["incomplete"], "testId": "7yyhd141aicke532sa" } ... ], } ... ] ```
{% hint style="info" %} Starting on version 1.6.8 of [`@currents/cmd`](https://www.npmjs.com/package/@currents/cmd) package, multiple files are allowed as input, each one representing a [`Group`](#group). See [currents-convert](https://docs.currents.dev/resources/reporters/currents-cmd/currents-convert "mention") input file flag. {% endhint %} #### Group | Property | Type | Required | Description | | -------- | -------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | name | string | Yes | Represents the group ID that will be visualized in the dashboard. All the tests will be organized by the group ID. | | tags | string\[] | Yes | Run-level tags for this run/build. See [playwright-tags](https://docs.currents.dev/guides/playwright-tags "mention") | | tests | [SuiteTest](#suitetest)\[] | Yes | List of included tests, including test title, spec file, test tags and testId. The testId of full test suite file and instance files must match. | #### `SuiteTest` | Property | Type | Required | Description | | -------- | --------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | title | string\[] | Yes | Test description plus title | | spec | string | Yes | The spec file where this test is defined | | tags | string\[] | No | A list of tags associated with the test for categorization or filtering | | testId | string | Yes | A unique identifier for the test case. It is created with a hash of the spec file property and the title. [See how to generate this property](#generating-testid) | ### Configuration File The `config.json` file contains the metadata used by Currents to properly display results in the dashboard. Example: ```json { "framework": "postman", "frameworkVersion": "1.12.12", "frameworkConfig": { "format": "junit" } } ``` | Property | Type | Required | Description | | ---------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------- | | framework | string | Yes | Name of the framework used to execute the tests. The currently accepted values are `postman`, `vitest` and `wdio` (WebDriverIO) | | frameworkVersion | string | Yes | Testing framework version used to execute the tests | | frameworkConfig | object | No | Contains information about the configuration of the framework. Currently the property format with value junit is allowed | ### Instance Files An Instance File is a JSON document that represents a spec file and its included test execution results. {% hint style="info" %} Some testing frameworks are not bound to filesystem (e.g., Postman), so an Instance File can be a logical collection of tests. {% endhint %}
Instance JSON file example ```json { "groupId": "e2e", "spec": "src/same-title.test.ts", "startTime": "2024-11-21T03:47:14.963Z", "results": { "stats": { "suites": 1, "tests": 3, "passes": 2, "pending": 0, "skipped": 1, "failures": 0, "flaky": 1, "wallClockStartedAt": "2024-11-21T03:47:14.963Z", "wallClockEndedAt": "2024-11-21T03:47:16.134Z", "wallClockDuration": 1171 }, "tests": [ { "_t": 1732160836119, "testId": "fa8675d9f8d0a03f", "title": ["Test cases with same title", "Test case example"], "state": "failed", "isFlaky": true, "expectedStatus": "passed", "timeout": 0, "location": { "column": 1, "file": "src/same-title.test.ts", "line": 1 }, "retries": 4, "attempts": [ { "_s": "failed", "attempt": 1, "startTime": "2024-11-21T03:47:16.119Z", "steps": [], "duration": 7, "status": "failed", "stdout": [], "stderr": [ "Error: \u001b[2mexpect(\u001b[22m\u001b[31mreceived\u001b[39m\u001b[2m).\u001b[22mtoBe\u001b[2m(\u001b[22m\u001b[32mexpected\u001b[39m\u001b[2m) // Object.is equality\u001b[22m\n\nExpected: \u001b[32m2\u001b[39m\nReceived: \u001b[31m0\u001b[39m\n at Object.toBe (/Users/miguelangarano/Documents/GitHub/currents-reporter/examples/src/same-title.test.ts:7:17)\n at Promise.then.completed (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/utils.js:298:28)\n at new Promise ()\n at callAsyncCircusFn (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/utils.js:231:10)\n at _callCircusTest (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/run.js:316:40)\n at processTicksAndRejections (node:internal/process/task_queues:95:5)\n at _runTest (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/run.js:252:3)\n at _runTestsForDescribeBlock (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/run.js:126:9)\n at _runTestsForDescribeBlock (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/run.js:121:9)\n at run (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/run.js:71:3)\n at runAndTransformResultsToJestFormat (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/legacy-code-todo-rewrite/jestAdapterInit.js:122:21)\n at jestAdapter (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/legacy-code-todo-rewrite/jestAdapter.js:79:19)\n at runTestInternal (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-runner/build/runTest.js:367:16)\n at runTest (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-runner/build/runTest.js:444:34)\n at Object.worker (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-runner/build/testWorker.js:106:12)" ], "errors": [ { "message": "Error: Error: \u001b[2mexpect(\u001b[22m\u001b[31mreceived\u001b[39m\u001b[2m).\u001b[22mtoBe\u001b[2m(\u001b[22m\u001b[32mexpected\u001b[39m\u001b[2m) // Object.is equality\u001b[22m\n\nExpected: \u001b[32m2\u001b[39m\nReceived: \u001b[31m0\u001b[39m\n\n 5 |\n 6 | test('Test case example', () => {\n> 7 | expect(j++).toBe(2);\n | ^\n 8 | });\n 9 |\n 10 | test.skip('Test case example', () => {\n\n at Object.toBe (/Users/miguelangarano/Documents/GitHub/currents-reporter/examples/src/same-title.test.ts:7:17)\n at Promise.then.completed (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/utils.js:298:28)\n at new Promise ()\n at callAsyncCircusFn (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/utils.js:231:10)\n at _callCircusTest (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/run.js:316:40)\n at processTicksAndRejections (node:internal/process/task_queues:95:5)\n at _runTest (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/run.js:252:3)\n at _runTestsForDescribeBlock (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/run.js:126:9)\n at _runTestsForDescribeBlock (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/run.js:121:9)\n at run (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/run.js:71:3)\n at runAndTransformResultsToJestFormat (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/legacy-code-todo-rewrite/jestAdapterInit.js:122:21)\n at jestAdapter (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/legacy-code-todo-rewrite/jestAdapter.js:79:19)\n at runTestInternal (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-runner/build/runTest.js:367:16)\n at runTest (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-runner/build/runTest.js:444:34)\n at Object.worker (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-runner/build/testWorker.js:106:12)\n at /Users/miguelangarano/Documents/GitHub/currents-reporter/packages/jest/src/reporter.ts:310:21\n at Array.map ()\n at /Users/miguelangarano/Documents/GitHub/currents-reporter/packages/jest/src/reporter.ts:306:61\n at Array.map ()\n at /Users/miguelangarano/Documents/GitHub/currents-reporter/packages/jest/src/reporter.ts:305:39\n at processTicksAndRejections (node:internal/process/task_queues:95:5)\n at async Promise.all (index 0)\n at CustomReporter.onTestFileResult (/Users/miguelangarano/Documents/GitHub/currents-reporter/packages/jest/src/reporter.ts:283:19)\n at ReporterDispatcher.onTestFileResult (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/@jest/core/build/ReporterDispatcher.js:30:9)\n at onResult (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/@jest/core/build/TestScheduler.js:154:7)", "location": { "column": 17, "file": "../..", "line": 7 } } ], "error": { "message": "Error: Error: \u001b[2mexpect(\u001b[22m\u001b[31mreceived\u001b[39m\u001b[2m).\u001b[22mtoBe\u001b[2m(\u001b[22m\u001b[32mexpected\u001b[39m\u001b[2m) // Object.is equality\u001b[22m\n\nExpected: \u001b[32m2\u001b[39m\nReceived: \u001b[31m0\u001b[39m\n\n 5 |\n 6 | test('Test case example', () => {\n> 7 | expect(j++).toBe(2);\n | ^\n 8 | });\n 9 |\n 10 | test.skip('Test case example', () => {\n\n at Object.toBe (/Users/miguelangarano/Documents/GitHub/currents-reporter/examples/src/same-title.test.ts:7:17)\n at Promise.then.completed (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/utils.js:298:28)\n at new Promise ()\n at callAsyncCircusFn (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/utils.js:231:10)\n at _callCircusTest (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/run.js:316:40)\n at processTicksAndRejections (node:internal/process/task_queues:95:5)\n at _runTest (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/run.js:252:3)\n at _runTestsForDescribeBlock (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/run.js:126:9)\n at _runTestsForDescribeBlock (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/run.js:121:9)\n at run (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/run.js:71:3)\n at runAndTransformResultsToJestFormat (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/legacy-code-todo-rewrite/jestAdapterInit.js:122:21)\n at jestAdapter (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/legacy-code-todo-rewrite/jestAdapter.js:79:19)\n at runTestInternal (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-runner/build/runTest.js:367:16)\n at runTest (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-runner/build/runTest.js:444:34)\n at Object.worker (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-runner/build/testWorker.js:106:12)\n at /Users/miguelangarano/Documents/GitHub/currents-reporter/packages/jest/src/reporter.ts:310:21\n at Array.map ()\n at /Users/miguelangarano/Documents/GitHub/currents-reporter/packages/jest/src/reporter.ts:306:61\n at Array.map ()\n at /Users/miguelangarano/Documents/GitHub/currents-reporter/packages/jest/src/reporter.ts:305:39\n at processTicksAndRejections (node:internal/process/task_queues:95:5)\n at async Promise.all (index 0)\n at CustomReporter.onTestFileResult (/Users/miguelangarano/Documents/GitHub/currents-reporter/packages/jest/src/reporter.ts:283:19)\n at ReporterDispatcher.onTestFileResult (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/@jest/core/build/ReporterDispatcher.js:30:9)\n at onResult (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/@jest/core/build/TestScheduler.js:154:7)", "location": { "column": 17, "file": "../..", "line": 7 } } }, { "_s": "passed", "attempt": 1, "startTime": "2024-11-21T03:47:16.131Z", "steps": [], "duration": 0, "status": "passed", "stdout": [], "stderr": [], "errors": [] }, { "_s": "failed", "attempt": 2, "startTime": "2024-11-21T03:47:16.132Z", "steps": [], "duration": 0, "status": "failed", "stdout": [], "stderr": [ "Error: \u001b[2mexpect(\u001b[22m\u001b[31mreceived\u001b[39m\u001b[2m).\u001b[22mtoBe\u001b[2m(\u001b[22m\u001b[32mexpected\u001b[39m\u001b[2m) // Object.is equality\u001b[22m\n\nExpected: \u001b[32m2\u001b[39m\nReceived: \u001b[31m1\u001b[39m\n at Object.toBe (/Users/miguelangarano/Documents/GitHub/currents-reporter/examples/src/same-title.test.ts:7:17)\n at Promise.then.completed (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/utils.js:298:28)\n at new Promise ()\n at callAsyncCircusFn (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/utils.js:231:10)\n at _callCircusTest (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/run.js:316:40)\n at processTicksAndRejections (node:internal/process/task_queues:95:5)\n at _runTest (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/run.js:252:3)\n at _runTestsForDescribeBlock (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/run.js:148:7)\n at _runTestsForDescribeBlock (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/run.js:121:9)\n at run (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/run.js:71:3)\n at runAndTransformResultsToJestFormat (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/legacy-code-todo-rewrite/jestAdapterInit.js:122:21)\n at jestAdapter (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/legacy-code-todo-rewrite/jestAdapter.js:79:19)\n at runTestInternal (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-runner/build/runTest.js:367:16)\n at runTest (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-runner/build/runTest.js:444:34)\n at Object.worker (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-runner/build/testWorker.js:106:12)" ], "errors": [ { "message": "Error: Error: \u001b[2mexpect(\u001b[22m\u001b[31mreceived\u001b[39m\u001b[2m).\u001b[22mtoBe\u001b[2m(\u001b[22m\u001b[32mexpected\u001b[39m\u001b[2m) // Object.is equality\u001b[22m\n\nExpected: \u001b[32m2\u001b[39m\nReceived: \u001b[31m1\u001b[39m\n\n 5 |\n 6 | test('Test case example', () => {\n> 7 | expect(j++).toBe(2);\n | ^\n 8 | });\n 9 |\n 10 | test.skip('Test case example', () => {\n\n at Object.toBe (/Users/miguelangarano/Documents/GitHub/currents-reporter/examples/src/same-title.test.ts:7:17)\n at Promise.then.completed (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/utils.js:298:28)\n at new Promise ()\n at callAsyncCircusFn (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/utils.js:231:10)\n at _callCircusTest (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/run.js:316:40)\n at processTicksAndRejections (node:internal/process/task_queues:95:5)\n at _runTest (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/run.js:252:3)\n at _runTestsForDescribeBlock (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/run.js:148:7)\n at _runTestsForDescribeBlock (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/run.js:121:9)\n at run (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/run.js:71:3)\n at runAndTransformResultsToJestFormat (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/legacy-code-todo-rewrite/jestAdapterInit.js:122:21)\n at jestAdapter (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/legacy-code-todo-rewrite/jestAdapter.js:79:19)\n at runTestInternal (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-runner/build/runTest.js:367:16)\n at runTest (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-runner/build/runTest.js:444:34)\n at Object.worker (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-runner/build/testWorker.js:106:12)\n at /Users/miguelangarano/Documents/GitHub/currents-reporter/packages/jest/src/reporter.ts:310:21\n at Array.map ()\n at /Users/miguelangarano/Documents/GitHub/currents-reporter/packages/jest/src/reporter.ts:306:61\n at Array.map ()\n at /Users/miguelangarano/Documents/GitHub/currents-reporter/packages/jest/src/reporter.ts:305:39\n at processTicksAndRejections (node:internal/process/task_queues:95:5)\n at async Promise.all (index 0)\n at CustomReporter.onTestFileResult (/Users/miguelangarano/Documents/GitHub/currents-reporter/packages/jest/src/reporter.ts:283:19)\n at ReporterDispatcher.onTestFileResult (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/@jest/core/build/ReporterDispatcher.js:30:9)\n at onResult (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/@jest/core/build/TestScheduler.js:154:7)", "location": { "column": 17, "file": "../..", "line": 7 } } ], "error": { "message": "Error: Error: \u001b[2mexpect(\u001b[22m\u001b[31mreceived\u001b[39m\u001b[2m).\u001b[22mtoBe\u001b[2m(\u001b[22m\u001b[32mexpected\u001b[39m\u001b[2m) // Object.is equality\u001b[22m\n\nExpected: \u001b[32m2\u001b[39m\nReceived: \u001b[31m1\u001b[39m\n\n 5 |\n 6 | test('Test case example', () => {\n> 7 | expect(j++).toBe(2);\n | ^\n 8 | });\n 9 |\n 10 | test.skip('Test case example', () => {\n\n at Object.toBe (/Users/miguelangarano/Documents/GitHub/currents-reporter/examples/src/same-title.test.ts:7:17)\n at Promise.then.completed (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/utils.js:298:28)\n at new Promise ()\n at callAsyncCircusFn (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/utils.js:231:10)\n at _callCircusTest (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/run.js:316:40)\n at processTicksAndRejections (node:internal/process/task_queues:95:5)\n at _runTest (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/run.js:252:3)\n at _runTestsForDescribeBlock (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/run.js:148:7)\n at _runTestsForDescribeBlock (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/run.js:121:9)\n at run (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/run.js:71:3)\n at runAndTransformResultsToJestFormat (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/legacy-code-todo-rewrite/jestAdapterInit.js:122:21)\n at jestAdapter (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-circus/build/legacy-code-todo-rewrite/jestAdapter.js:79:19)\n at runTestInternal (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-runner/build/runTest.js:367:16)\n at runTest (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-runner/build/runTest.js:444:34)\n at Object.worker (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/jest-runner/build/testWorker.js:106:12)\n at /Users/miguelangarano/Documents/GitHub/currents-reporter/packages/jest/src/reporter.ts:310:21\n at Array.map ()\n at /Users/miguelangarano/Documents/GitHub/currents-reporter/packages/jest/src/reporter.ts:306:61\n at Array.map ()\n at /Users/miguelangarano/Documents/GitHub/currents-reporter/packages/jest/src/reporter.ts:305:39\n at processTicksAndRejections (node:internal/process/task_queues:95:5)\n at async Promise.all (index 0)\n at CustomReporter.onTestFileResult (/Users/miguelangarano/Documents/GitHub/currents-reporter/packages/jest/src/reporter.ts:283:19)\n at ReporterDispatcher.onTestFileResult (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/@jest/core/build/ReporterDispatcher.js:30:9)\n at onResult (/Users/miguelangarano/Documents/GitHub/currents-reporter/node_modules/@jest/core/build/TestScheduler.js:154:7)", "location": { "column": 17, "file": "../..", "line": 7 } } }, { "_s": "passed", "attempt": 3, "startTime": "2024-11-21T03:47:16.133Z", "steps": [], "duration": 0, "status": "passed", "stdout": [], "stderr": [], "errors": [] } ] } ] } } ```
The properties that can be found in an instance file are the following: **Root Object** | Property | Type | Required | Description | | --------- | ---------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | groupId | string | Yes | Identifier for the test group. It provides a reference for what the executed tests are about | | spec | string | Yes | The name of the spec file or logical collection that contains the executed tests. The spec property must be unique across all instance files. Example: **tests**/utils.spec.ts | | startTime | string | Yes | The timestamp indicating when the execution of the spec file started in ISO 8601 format | | results | [TestResult](#testresult)\[] | Yes | Contains an array of test results | #### TestResult | Property | Type | Required | Description | | -------- | --------------------------- | -------- | ------------------------------------------------------------- | | stats | [StatsObject](#statsobject) | Yes | Summary statistics for the test run | | tests | [Test](#test)\[] | Yes | Array of objects, each representing an individual test result | #### StatsObject | Property | Type | Required | Description | | ------------------ | ------ | -------- | ------------------------------------------------------------------------------------ | | suites | number | Yes | Number of logical groupings or collections of test results | | tests | number | Yes | The total number of tests executed in the current instance | | passes | number | Yes | The number of tests that passed in the current instance | | pending | number | Yes | The number of tests that are pending execution and can be reported later | | skipped | number | Yes | The number of tests that were not executed on purpose in the current instance | | failures | number | Yes | The number of tests that failed in the current instance | | flaky | number | Yes | The number of tests marked as flaky by the testing framework in the current instance | | wallClockStartedAt | string | Yes | Time when the first test started its first attempt in ISO 8601 format | | wallClockEndedAt | string | Yes | Time when the last test finished its last attempt in ISO 8601 format | | wallClockDuration | number | Yes | Total duration of the spec file tests execution in milliseconds | #### Test Each object in the tests array represents the execution result of a test, possibly with multiple attempts. | Property | Type | Required | Description | | -------------- | ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | \_t | number | Yes | The timestamp indicating when the execution of the spec file started, in milliseconds | | testId | string | Yes | Unique identifier for the test. [See how to generate this property](#generating-testid) | | title | string\[] | Yes | Array containing the specification and title of the test. Example: \["75119228-2d2d-4e59-b426-60a002b8cdce / Get Run", "Response status code is 200"] | | state | string | Yes | Final state of the test | | isFlaky | boolean | Yes | Indicates whether the test is flaky | | expectedStatus | string | Yes | The expected status of the test | | timeout | number | Yes | Time in milliseconds that the test execution lasted without a clear state result | | location | [Location](#location) | Yes | Object containing file location details for the test | | retries | number | Yes | Number of retries attempted for the test | | attempts | [Attempt](#attempt)\[] | Yes | Array of objects representing each attempt made for the test | #### Location | Property | Type | Required | Description | | -------- | ------ | -------- | -------------------------------------------- | | column | number | Yes | Column number of the test in the source file | | file | string | Yes | The file path where the test is defined | | line | number | Yes | Line number of the test in the source file | #### Attempt Object that describes an individual attempt of a test. | Property | Type | Required | Description | | --------- | ------------------ | -------- | ---------------------------------------------------------------------------------- | | \_s | string | Yes | Intermediate test attempt status (`passed`, `failed` | | attempt | number | Yes | Index of the . Defines the order of attempt execution | | startTime | string | Yes | Timestamp when the attempt started in ISO 8601 format | | steps | [Step](#step)\[] | Yes | Array of steps executed during the attempt | | duration | number | Yes | Duration of the attempt in milliseconds | | status | string | Yes | Final test attempt status `passed`, `failed`, `timedOut`, `skipped`, `interrupted` | | stdout | string\[] | Yes | Standard output logs for the attempt | | stderr | string\[] | Yes | Standard error logs for the attempt | | errors | [Error](#error)\[] | Yes | Array of error objects encountered during the attempt | #### Step | Property | Type | Required | Description | | --------- | --------------- | -------- | ----------------------------------------------------------------------------------- | | title | string | Yes | The title or description of the step. Example: "Validate API response schema" | | category | string | No | The category of the step, indicating its classification. Example: "API Test" | | duration | number | Yes | The duration of the step in milliseconds. Example: 200 | | error | [Error](#error) | No | An optional error object describing any issue encountered during the step execution | | startTime | string | Yes | Step start date time, in ISO 8601 format | #### Error | Property | Type | Required | Description | | -------- | ------ | -------- | -------------------------------------------------------------------------------------------------------------------------------------- | | message | string | Yes | A description of the error encountered during the test attempt. Example: "expected 631 to be below 200" | | stack | string | No | The stack trace related to the error. Example: "AssertionError: expected 631 to be below 200\n at Object.eval sandbox-script.js:2:1)." | | value | string | No | The type or categorization of the error. Example: "AssertionFailure" | ### Generating testId The testId is a hash composed of the test title and the spec file name. Use this function to generate it. ```typescript export function generateTestId(testTitle: string, specFileName: string): string { const combinedString = `${testTitle}${specFileName}`; const fullHash = crypto .createHash('sha256') .update(combinedString) .digest('hex'); return fullHash.substring(0, 16); } ```