Collect report

Overview of the Collect report job step, which allows easier collection of the reports.

The Collect report job step makes it easier to collect reports. You can customize information about the job step, including:

• A custom step name can be defined; otherwise, the default step name will be used
• Target: Enter a relative path inside of a agent's working directory where the file is located.
• Report type: Allure, HTML, PDF or Custom. Depending on the report type different additional information needs to be entered.
• Tags: enables user to choose one or more Tags and to tag the Report.
• Every step has Advanced options through which steps can be managed. When execution of the step fails, execution of the job continues. If option Abort job on step fail is marked, Job execution will stop once this step fails and further steps will not be executed. When it comes to skip condition, it allows skipping the current step if the condition is met.
  Expression of the condition can include:

  • a basic scenario, such as entering True/False directly or using an expression like 1 == 1.
  • variable/value exist check - if the user adds $parameter_name to the if clause, the Job will be executed as long as the parameter name is defined.
    • variable can be referenced by using any of the following formats: ${parameter_name}, %parameter_name%, {{parameter_name}}, and $parameter_name.
  • variable equal(==)/not equal(!=) to a certain value - if the user adds $parameter_name == some_value to the if clause and the values match, the Job will be executed.
  • variable containing(~~)/not containing(!~) a certain value - if the user adds $parameter_name ~~ some_value and the value or parameter_name contains some_value, the Job will be executed.
  • Within the execute if condition user can use environment variable AGENT_OS if needed, and create a condition based on the Agent's operating system.

Additional information for report collection depending on the report type

If the report is Allure, report collection method needs to be chosen, from the following options:

• Collect Allure results
• Collect directory with multiple Allure results
• Collect previously generated Allure report

When the report type is Allure, the target field should be set to the directory that contains the allure-results. If the report collection method is set to multiple Allure reports, then the target field should be set to the directory containing multiple allure-results directories.

Note: In case that the chosen collection method is either "Collect Allure results" or "Collect directory with multiple Allure results", collected allure-results are preserved by the Hub for 30 days from the moment they were collected, while the generated Allure report is preserved according to retention policy.

If the report is HTML, PDF or a Custom one, user needs to provide following data:

• Summary path file: Specifying a path to JSON file with the report summary
• Test results file path: Specifying a path to JSON file with the test results.

If the report type is HTML, the target field value should be set to the directory containing the HTML file. When the report type is PDF, the target should be set as the path to the PDF file. The same applies if the report type is Custom; in that case, the target field value should be the path to the custom file, regardless of the file extension.