Vitest test reporting

Add the reporter to your Vitest configuration in vite.config.js (or vitest.config.js). See https://vitest.dev/config/ for details about Vitest configuration:

import TesultsReporter from 'vitest-tesults-reporter'

export default defineConfig({
  test: {
    globals: true,
    reporters: [
      'default',
      new TesultsReporter({
        'tesults-target': process.env.TESULTS_TARGET || 'token',
        // Optional:
        // 'tesults-files': './tesults-files',
        // 'tesults-build-name': '1.0.0',
        // 'tesults-build-desc': 'Build description',
        // 'tesults-build-result': 'pass',
        // 'tesults-build-reason': 'Build failure reason',
      })
    ]
  }
})

You can now run Vitest as usual with the npx vitest run command (or npm test if configured in 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', () => {
  it("Test1", () => {
    expect(sum(1, 2)).toBe(3);
  });

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

describe('SuiteB', () => {
  it("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..." }

Use the Tesults reporter to report additional properties for each test case. To begin doing this, import the enhanced reporting functions in your test file:

import { description, step, custom, file } from 'vitest-tesults-reporter'

Report custom fields, test steps, descriptions and attach files to test cases using the reporter functions. Call reporter functions from within your tests (it/test block):

description

Add a description of the test case for reporting purposes.

description("some description here")

custom

Add a custom field and value to the test case for reporting purposes.

custom("Some custom field", "Some custom value")

file

Associate a file to the test case in order to upload it for reporting.

file("/absolute/path/to/file/screenshot.png")

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 at the end of a test run while uploading test results and files. When starting out test without files first to ensure everything is setup correctly.

step

Add test steps to the test case for reporting. Each step is an object with a name and result (one of [pass, fail, unknown]). You can also add the optional fields desc (description) and reason (failure reason in case of step fail).

step({
  name: "First step",
  result: "pass"
})
step({
  name: "Second step",
  desc: "Second step description",
  result: "fail"
})

This method of uploading files is no longer recommended. Utilize the file method described above to simplify uploading files from tests.

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 vitest-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 at the end of a test run while uploading test results and files. When starting out test without files first to ensure everything is setup correctly.

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

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-descOptional

Use this to report a build description for reporting purposes.

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

tesults-build-reasonOptional

Use this to report a build failure reason.

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

A complete example:

import { describe, it, expect } from 'vitest'
import { description, step, custom, file } from 'vitest-tesults-reporter'

describe('Suite A', () => {
  it('Test 1', () => {
    description("description here")

    step({name: "step 1", desc: "step 1 description", result: "pass"})
    step({name: "step 2", desc: "step 2 description", result: "pass"})

    custom("custom field 1", "custom value 1")
    custom("priority", "high")

    file("/full/path/logs/log1.txt")
    file("/full/path/screenshots/screenshot.png")

    expect(sum(1, 2)).toBe(3)
  });
});

Result interpretation is supported by Vitest. Install version 1.0.0 or newer. If you use result interpretation we recommend you add these minimum mapping values: