Executor file

This page describes a data format used by Allure and its adapters for test frameworks. Understanding this format is not necessary for using Allure in your project. For a more high-level description of the process of building a report, see How it works.

The executor.json file in the test results directory, if present, should contain information about the CI build that produced the test report. It is automatically generated by various CI integration plugins.

Example:

JSON
{
  "reportName": "Build #1234",
  "buildOrder": 1234,
  "reportUrl": "http://example.org/build#1234/AllureReport",
  "name": "Jenkins",
  "type": "jenkins",
  "buildName": "allure-report_deploy#1234",
  "buildUrl": "http://example.org/build#1234"
}

Report properties

• reportName (string) — the name to be shown on top of the Overview tab. When not set, it defaults to “Allure Report”.

History-related properties

These fields will be copied into the report's history files so that future reports can link back to the current one.

• buildOrder (integer) — the identifier for this build's columns on future trend graphs.
• reportUrl (string) — the URL at which this test report will be located.

Build properties

These fields affect the “Executor” block in the test report. The purpose of the block is to show what CI build produced the current report, with an optional link to that CI build.

• name (string) — the name of the CI server or plugin.
• type (string) — the type of the CI tool. This affects the icon next to the name. Allowed values are: “jenkins”, “bamboo”, “teamcity”, “gitlab”, “github”, “circleci”, “bitbucket”.
• buildName (string) — the name of the CI build that produced the current report. Normally, a CI integration plugin includes a unique build identifier into this name.
• buildUrl (string) — the URL of the CI build.