Skip to main content

reporting.yml

The reporting.yml file defines the reports and dashboards to output data to during the test run.

failure_screenshots​

nodejs
2021.1.0
ruby
2021.1.0
failure_screenshots: true

Enable the collection of a screenshot on the failure of a test. The screenshot will be saved as a png to the results folder for the test run and embedded in compatible reports. The screenshot will also be uploaded to Halo if enabled is set to true in the dashboard section.

resize_for_screenshots​

ruby
2021.1.0
resize_for_screenshots: false

Enable resizing of a browser to collect a screenshot of the whole page, not just the visible viewport. This option only applies for desktop browsers under certain circumstances.

local​

nodejs
2021.1.0
ruby
2021.1.0

The local section configures reports that will be generated locally in the test run subfolder of the results directory or the remote_test_results folder in the root of the project.

html_report​

nodejs
2021.1.0
ruby
2021.1.0
html_report: true

Enables generation of a html report. This will be saved to the test run subfolder of the results directory. If failure_screenshots is enabled, failure screenshots will be embedded against the failing scenario.

realtime_failure​

nodejs
2021.1.0
ruby
2021.1.0
realtime_failure: true

Enables generation of the realtime failure report. This will be saved to the failures subfolder of the remote_test_results directory and will update during the test run. If failure_screenshots is enabled, failure screenshots will be embedded against the failing scenario.

junit​

nodejs
2021.1.0
ruby
2021.1.0
junit: true

Outputs the test run results to a junit xml file in the remote_test_results folder.

json​

nodejs
2021.1.0
ruby
2021.1.0
json: true

Outputs the test run results to a json file in the remote_test_results folder.

rerun​

nodejs
2021.1.0
ruby
2021.1.0
rerun: true

Creates a file with a list of failing tests in the remote_test_results folder. This can be used to execute only the test scenarios that failed in the test run.

dashboard​

nodejs
2021.1.0
ruby
2021.1.0

The dashboard section configures the output to the Test Evolve cloud reporting.

enabled​

nodejs
2021.1.0
ruby
2021.1.0
enabled: true

When set to true, data from the test run will be sent to Test Evolve Halo after each scenario or after a time specified in 'scheduled_interval' if 'scheduled_updates' is enabled.

dashboard_url​

deprecated

Please remove this option from your configuration file.

project_id​

nodejs
2022.2.0
ruby
2022.2.0
project_id: 1

The project id in Halo to push data to. This ID can be found on the Project selection screen in Halo or the navigation bar in the project itself.

label​

nodejs
2021.1.0
ruby
2021.1.0
label: example-label

The label to be associated with your test run in Halo. More information on managing labels is available here.

auth_token​

nodejs
2021.1.0
ruby
2021.1.0
auth_token: api-key

Specify an api key that is saved in the admin section of the Test Evolve cloud reporting for your organisation.

This value can be overridden with the TE_HALO_AUTH_TOKEN environment variable.

scheduled_updates​

nodejs
2021.1.0
ruby
2021.1.0
scheduled_updates: true

Enable to output data to the Test Evolve cloud reporting after a scheduled interval rather than after every scenario. The interval at which to send data is specified in scheduled_interval.

scheduled_interval​

nodejs
2021.1.0
ruby
2021.1.0
scheduled_interval: 10

Specify the number of seconds for the interval between posting data to the Test Evolve cloud reporting. If scheduled_updates is enabled this value will be used instead of posting data after every scenario.

testrail​

nodejs
2023.0.1
ruby
2023.0.0

The testrail section configures the output to Test Rail.

enabled​

nodejs
2023.0.1
ruby
2023.0.0
enabled: true

When set to true, results of testrail tagged scenarios in the test run will be sent to Test Rail.

domain​

nodejs
2023.0.1
ruby
2023.0.0
domain: example-domain

The domain for your Test Rail account. For example if your Test Rail url is example-domain.testrail.io then the domain configuration should be example-domain.

project_id​

nodejs
2023.0.1
ruby
2023.0.0
project_id: 1

The id of the project in Test Rail that results will be output to.

test_run_id​

nodejs
2023.0.1
ruby
2023.0.0
test_run_id: 1

The id of the test run in Test Rail that results will be output to.

If the test_run_id is set to 0, a new Test Rail test run will be created in the specified project.

Example reporting.yml​

default_config/reporting.yml
&defaults_reporting

failure_screenshots: true
resize_for_screenshots: false

local:
  html_report: true
  realtime_failure: false
  junit: true
  json: true
  rerun: true

dashboard:
  enabled: false
  project_id: 1
  label: example-label
  auth_token: api-key
  scheduled_updates: false
  scheduled_interval: 10

testrail:
  enabled: false
  domain: example-domain
  project_id: 1
  test_run_id: 0