README.md

codeceptjs-rphelper

Streamline your CodeceptJS test results with seamless integration into ReportPortal.

codeceptjs-rphelper is a CodeceptJS helper designed to publish test results on ReportPortal effortlessly after execution.

Installation

npm i codeceptjs-rphelper --save

Configuration

To utilize this plugin, add the following configuration to your codecept.conf.(js|ts) file:

{
  ...
   plugins: {
    reportportal: {
      require: 'codeceptjs-rphelper',
      token: 'YOUR_TOKEN',
      endpoint: 'http://localhost:8080/api/v1',
      launchName: 'This is awesome',
      launchDescription: 'This is a description of your launch',
      launchAttributes: [{ key: 'yourKey', value: 'yourValue' }],
      projectName: 'YOUR_PROJECT',
      rerun: false,
      debug: false,
      enabled: true
    }
  ...
}

Specify the following information:

• token: Found on the user profile page, use it for authentication instead of a password.
• endpoint: Your ReportPortal host + /api/v1, e.g., http://localhost:8080/api/v1.
• launchName: The desired launch name (default is the suite title).
• launchDescription: Description of your launch (default is empty).
• launchAttributes: Attributes for your launch (default is empty).
• projectName: The project created in the ReportPortal UI.
• debug: Enable debug mode for ReportPortal.
• rerun: Enable rerun.
• rerunOf: UUID of the launch to rerun. If not specified, the latest launch with the same name will be updated.
• issue: Test item issue object. Visit client-javascript for more info.

For additional logs, set debug: true in the configuration.

Video

Screen.Recording.2024-01-19.at.11.11.06.mov