@reportportal/agent-js-vitest v5.1.1

@reportportal/agent-js-vitest

Agent to integrate Vitest with ReportPortal.

• More about Vitest
• More about ReportPortal

Installation

Install the agent in your project:

npm install --save-dev @reportportal/agent-js-vitest

Configuration

1. Create vitest.config.ts file with ReportPortal configuration:

  import { defineConfig } from 'vitest/config';
  import RPReporter from '@reportportal/agent-js-vitest'; // or import { RPReporter } from '@reportportal/agent-js-vitest';

  const rpConfig = {
    apiKey: '<API_KEY>',
    endpoint: 'https://your.reportportal.server/api/v1',
    project: 'Your ReportPortal project name',
    launch: 'Your launch name',
    attributes: [
      {
        key: 'key',
        value: 'value',
      },
      {
        value: 'value',
      },
    ],
    description: 'Your launch description',
  };

  export default defineConfig({
    test: {
      // add setup file to be able to use ReportingApi via `this.ReportingApi` in your tests
      setupFiles: ["@reportportal/agent-js-vitest/setup"],
      reporters: ['default', new RPReporter(rpConfig)],
    },
  });

The full list of available options presented below.

The following options can be overridden using ENVIRONMENT variables:

2. Add script to package.json file:

{
  "scripts": {
    "test": "vitest run"
  }
}

Asynchronous API

The client supports an asynchronous reporting (via the ReportPortal asynchronous API). If you want the client to report through the asynchronous API, change v1 to v2 in the endpoint address.

Reporting

When organizing tests, specify titles for describe blocks, as this is necessary to build the correct structure of reports.

Logging

You can use the following console native methods to report logs to the tests:

console.log();
console.info();
console.debug();
console.warn();
console.error();

console's log, info,dubug reports as info log.

console's error, warn reports as error log if message contains error mention, otherwise as warn log.

Reporting API

This reporter provides Reporting API to use it directly in tests to send some additional data to the report.

To start using the ReportingApi in tests, you can:

• Add setup file in vitest.config.ts

    import { defineConfig } from 'vitest/config';
  
    export default defineConfig({
      test: {
        ...
        setupFiles: ["@reportportal/agent-js-vitest/setup"],
      },
    });

  ReportingApi will be available in global variables and supports receiving Vitest task from the setup file.

      test('should contain logs with attachments',() => {
        ...
        ReportingApi.attachment({ name, type, content }, 'Description');
        ...
      });

• Import ReportingApi directly from '@reportportal/agent-js-vitest':

  import { ReportingApi } from '@reportportal/agent-js-vitest';

  In this case you are required to pass Vitest task as the first argument to the ReportingApi methods.

      test('should contain logs with attachments',({ task }) => {
        ...
        ReportingApi.attachment(task, { name, type, content }, 'Description');
        ...
      });

Reporting API methods

The API provides methods for attaching data.

attachment

Send file to ReportPortal for the current test. Should be called inside of corresponding test. ReportingApi.attachment(task: vitest.Task, data: Attachment, description?: string); required: task, data optional: description where Attachment type is {name: string; type: string; content: string | Buffer;} Example:

test('should contain logs with attachments',({ task }) => {
  const fileName = 'test.jpg';
  const fileContent = fs.readFileSync(path.resolve(__dirname, './attachments', fileName));

  ReportingApi.attachment(task, {
    name: fileName,
    type: 'image/png',
    content: fileContent.toString('base64'),
  }, 'Description');

  expect(true).toBe(true);
});

testCaseId

Add testCaseId to ReportPortal for the current test. Should be called inside of corresponding test. ReportingApi.testCaseId(task: vitest.Task, data: string); required: task, data Example:

test('should contain testCaseId',({ task }) => {
  ReportingApi.testCaseId(task, 'C123456');

  expect(true).toBe(true);
});

description

Add description to ReportPortal for the current test. In case the user call the method more than one time, the existing description will be extended. Should be called inside of corresponding test. ReportingApi.description(task: vitest.Task, data: string); required: task, data Example:

test('should contain description',({ task }) => {
  ReportingApi.description(task, 'Test Description');

  expect(true).toBe(true);
});

attributes

Send file to ReportPortal for the current test. Should be called inside of corresponding test. ReportingApi.attributes(task: vitest.Task, data: Attribute[]); required: task, data where Attribute type is { value: string; key?: string; system?: boolean; } Example:

test('should contain attributes',({ task }) => {
  ReportingApi.attributes(task,
    [
      { key: 'attrKey1', value: 'attrValue1'},
      { value: 'attrValue2'}
    ]);

  expect(true).toBe(true);
});