Jest test reporting

Using the Jest test framework? Follow the instructions below to report results. If you are not using Jest please see the Node.js docs for integrating with a lower-level library.

Installation

npm install jest-tesults-reporter --save

Configuration

Add this snippet to your Jest configuration in package.json or your jest.config.js or through the --config <path/to/js|json> option (See https://jestjs.io/docs/en/configuration for details about Jest configuration):

"jest": {
  "reporters":
  ["default", ["jest-tesults-reporter", {"tesults-target": "token"}]]
}

The tesults-target is an argument passed through to the jest-tesults-reporter. Multiple args can be passed to the jest-tesults-reporter and are outlined in detail below.

You can now run Jest as usual with the npm test command, or npm script-name if you named the script something other than test in the package.json.

The 'token' above should be replaced with your Tesults target token, which you received when creating a project or target, and can be regenerated from the configuration menu.

The reporter treats the describe as a test suite and each test (or it) as a test case.

describe('SuiteA', () => {
  test("Test1", () => {
     expect(sum(1, 2)).toBe(3);
  });

  test("Test2", () => {
     expect(sum(2, 2)).toBe(4);
  });
});

describe('SuiteB', () => {
  test("Test3", () => {
     expect(sum(3, 3)).toBe(6);
  });
});

We recommend using 'describe' so that test cases can be appropriately grouped by test suite on Tesults.

tesults-targetRequired

Required to upload to Tesults, if this arg is not provided the reporter does not attempt upload, effectively disabling it. Get your target token from the configuration menu in the Tesults web interface.

{ "tesults-target": "eyJ0eXAiOiJ..." }

If you see this warning message from Jest you can safely ignore it.

Jest did not exit one second after the test run has completed. This usually means that there are asynchronous operations that weren't stopped in your tests. Consider running Jest with `--detectOpenHandles` to troubleshoot this issue.

Sending results data to Tesults can longer than one second, especially if there are files.

Basic configuration complete

At this point the jest-tesults-reporter will push results to Tesults when you run your tests. The tesults-target arg must be supplied to indicate which target to use. See above for complete details.

Files

During a test run, save test generated files such as logs and screenshots to a local temporary directory. At the end of the test run all files will automatically be saved to Tesults as long as you save files in the directory structure below.
  • expanded temporary
    • expanded Test suite name
      • expanded Test case name
        • file 1
        • file 2

For example:

  • expanded temporary
    • expanded Test Suite A
      • expanded Test 1
        • test.log
        • screenshot.png
      • expanded Test 2
        • test.log
        • screenshot.png
    • expanded Test Suite B
      • expanded Test 3
        • metrics.csv
        • error.log
      • expanded Test 4
        • test.log

If not using test suites then omit the suite directories:

  • expanded temporary
    • expanded Test 1
      • test.log
      • screenshot.png
    • expanded Test 2
      • test.log
      • screenshot.png
tesults-filesOptional

Provide the top-level directory where files generated during testing are saved for the running test run. Files, including logs, screen captures and other artifacts will be automatically uploaded.

{ "tesults-target": "eyJ0eXAiOiJ...", "tesults-files":"/Users/admin/Desktop/temporary" }

This is one area where the jest-tesults-reporter is opinionated and requires that files generated during a test run be saved locally temporarily within a specific directory structure.

Store all files in a temporary directory as your tests run. After Tesults upload is complete, delete the temporary directory or just have it overwritten on the next test run.

Within this temporary directory create subdirectories matching the test suite (describe) and test case (test/it) name.

Be aware that if providing build files, the build suite is always set to [build] and files are expected to be located in temporary/[build]/buildname

Caution: If uploading files the time taken to upload is entirely dependent on your network speed. Typical office upload speeds of 100 - 1000 Mbps should allow upload of even hundreds of files quite quickly, just a few seconds, but if you have slower access it may take hours. We recommend uploading a reasonable number of files for each test case. The upload method blocks while uploading test results and files. When starting out test without files first to ensure everything is setup correctly.

Build

tesults-build-nameOptional

Use this to report a build version or name for reporting purposes.

{ "tesults-build-name": "1.0.0" }

tesults-build-resultOptional

Use this to report the build result, must be one of [pass, fail, unknown].

{ "tesults-build-result": "pass" }

tesults-build-descriptionOptional

Use this to report a build description for reporting purposes.

{ "tesults-build-description": "added new feature" }

tesults-build-reasonOptional

Use this to report a build failure reason.

{ "tesults-build-reason": "build error line 201 somefile.js" }

Consolidating multiple test results submissions into one test run

If you execute multiple test runs in parallel or serially for the same build or release and results are submitted to Tesults within each run, separately, you will find that multiple test runs are generated on Tesults. This is because the default behavior on Tesults is to treat each results submission as a separate test run. This behavior can be changed from the configuration menu. Click 'Results Consolidation By Build' from the Configure Project menu to enable and disable consolidation by target. Enabling consolidation will mean that multiple test runs submitted with the same build name will be consolidated into a single test run.

Dynamically created test cases should have static names

If you dynamically create test cases, such as test cases with variable values, we recommend that the test suite and test case names themselves be static. Provide the variable data information in the test case description or other custom fields but try to keep the test suite and test name static. This way you will you benefit from a range of features Tesults has to offer including test case failure assignment and historical results analysis. You need not make your tests any less dynamic, variable values can still be reported within test case details.

Proxy servers

Does your corporate/office network run behind a proxy server? Contact us and we will supply you with a custom API Library for this case. Without this results will fail to upload to Tesults.

Have questions or need help? Contact us