README.md

reportportal-agent-jest

A Jest reporter that uploads the results to a ReportPortal server.

Installation

npm install --save-dev reportportal-agent-jest

Usage

In your jest config section of package.json, add the following entry:

{
    "jest": {
        ...
        "reporters": [
            "reportportal-agent-jest",
            {
                "endpoint": "https://your.reportportal.server/api/v1",
                "project": "YourReportPortalProjectName",
                "launchname": "YourLauncherName",
                "tags": ["Ninja","MyOtherCoolTag"]
            }
        ],
        ...
    }
}

First configure your ReportPortal access token, then start Jest:

$ export RP_TOKEN=<your_secure_token>
$ jest

It's also possible to override parameters launchname and project defined in package.json by using environment variables, it's important to mention that environment variables has precedence over package.json definition.

$ export RP_LAUNCH_NAME=MY_COOL_LAUNCHER
$ export RP_PROJECT_NAME=MY_AWESOME_PROJECT

This for your convenience in case you has a continuous job that run your tests and may post the results pointing to a different Report Portal definition of project or launcher name.

Copyright Notice

Licensed under the Apache License v2.0

This code is based on the jest-junit but adapted by team members of Ontoforce for the ReportPortal upload. Ontoforce contributed this effort as Open Source to the ReportPortal project team.