Skip to content
On this page

ReportPortal History

ReportPortal is an open-source tool that allows testers and key project stakeholders to manage and view all of their testing results and reports in one place.

In ReportPortal, the historical trend of executions represents your history view for the list of test items. This feature can help you to find the most unstable test cases in your suites/ launches/ builds..

This extension will help you to display the results of the last n runs.

DEFAULTS
  • hook: end
  • condition: fail

Syntax

json
{
  "name": "report-portal-history",
  "inputs": {
    "url": "<report-portal-base-url>",
    "api_key": "<api-key>",
    "project": "<project-id>",
    "launch_id": "<launch-id>"
  }
}
  • url (string) - base url of report portal (https://your-domain.reportportal.com).
  • api_key (string) - project api key.
  • project (string) - project id.
  • launch_id? (string) - launch id will be generated dynamically during the test execution. To use it in the config file, we need to use the environment variables. One way is to save it in the .env file for this tool to read.
  • launch_name? (string) - if fetching launch id is difficult, we can just use the launch name. This tool will fetch the latest launch id based on the given launch name.

    NOTE

    If launch_name is mentioned, make sure there are no other new runs triggered on the same launch name before the reporting is finished.

  • history_depth? (number) - no. of last run results to display. Defaults to 5.
  • link_history_via? (string) - link history link via uuid or launchId. Defaults to uuid.

Reports

Teams

teams-link

Slack

slack-link

Examples

Using launch_id

json
{
  "targets": [
    {
      "name": "teams",
      "inputs": {
        "url": "<teams-incoming-webhook-url>"
      },
      "extensions": [
        {
          "name": "report-portal-history",
          "inputs": {
            "url": "<report-portal-base-url>",
            "api_key": "<api-key>",
            "project": "<project-id>",
            "launch_id": "<launch-id>"
          }   
        }
      ]
    }
  ],
  "results": [
    {
      "type": "testng",
      "files": ["path/to/testng-results.xml"]
    }
  ]
}

Using launch_name and history_depth to fetch last 10 runs

json
{
  "targets": [
    {
      "name": "teams",
      "inputs": {
        "url": "<teams-incoming-webhook-url>"
      },
      "extensions": [
        {
          "name": "report-portal-history",
          "inputs": {
            "url": "<report-portal-base-url>",
            "api_key": "<api-key>",
            "project": "<project-id>",
            "launch_name": "<launch-name>",
            "history_depth": 10
          }   
        }
      ]
    }
  ],
  "results": [
    {
      "type": "testng",
      "files": ["path/to/testng-results.xml"]
    }
  ]
}

Released under the MIT License.