You can generate reports in various formats. In this section:
Generating Reports from the GUI
After the test has completed, click the Generate Report button in the Test Progress panel’s toolbar.
Complete the Report & Publish dialog that opens. You can configure the following options:
Preferences: Opens the Reports preference page that allows you to configure report options; see Configuring Report Settings.
Option file: Specifies the path to a .properties file that contains your custom report settings; see Configuring Settings. Settings configured in the .properties file override the options specified in the GUI.
To generate multiple reports in different formats for a single run, configure the report.format setting in the .properties file.
Report location: Specifies the path to the folder where you want save the report file. By default, reports are created in the
<USER_HOME_DIR>\Local Settings\Temp\parasoft\xtest
directory.Open in browser: If enabled, the report will automatically open in the browser .
Delete on exit: If enabled, the report will be deleted when you exit C/C++test.
Generate Reports: Enables or disables generating a report. This option must be enable to proceed. You can publish reports to DTP; see Uploading Reports to DTP.
Click OK. The report will then open. For details on the format and contents, see Understanding Reports.
Alternatively, you can generate the report using the options at the bottom of the Report & Publish section of the Test Progress view:
- Click Proceed to immediately generate the report using the existing report options.
- Click Configure to open the Report & Publish dialog to review or configure the options before generating the report.
Generating the Test Execution Details Report
You can generate an additional Test Execution Details report linked to your regular report (see Understanding Reports for details). To generate this report, configure the following settings in the test configuration before executing it:
- Choose Parasoft> Test Configurations... and select a test configuration.
- Open the Execution> Runtime tab and enable the following options:
- Report unit test execution details
- Include tasks details
- Include passed assertion details
- Generate detailed test execution report
- (Optional) Enable the Generate detailed coverage report for option and choose a coverage metric.
- Apply changes and close the test configuration.
- Choose Parasoft> Preferences... > Reports.
- In the Report Format section, choose HTML (C/C++test’s Unit Testing details) from the drop-down menu.
Click Generate Report after the test completes (see Generating the Report). The link to the Test Execution Details report will be available in the Test Execution Details column included in the Additional Reports section at the bottom of main report (see Understanding Reports).
You can also generate the Test Execution Details report in XML format. This enables you to apply additional post-processing workflows to the test execution results. The XML file is available in the same location as the original Test Execution Details HTML file, for example:
<REPORT_DIR>/<EXECUTION_DIR>/report_TestSuiteFoo_cpp.xml
<REPORT_DIR>/<EXECUTION_DIR>/report_TestSuiteFoo_cpp.html
In addition, XML Schema for Test Execution Details XML file is available:
<CPPTEST_INSTALL_DIR>/manuals/examples/ut_details_report_schema.xsd
Uploading Reports to DTP
Uploading reports to DTP allows you to review results on DTP, where they are aggregated, analyzed, and prioritized to help you optimize your testing efforts. See the DTP User Guide for details.
To upload the report to DTP:
Ensure that C/C++test is connected to a DTP server (See Connecting to DTP).
Go to Parasoft> Preferences... > DTP and enable the Enable reporting results to DTP option.
The results will be automatically uploaded to DTP when you perform testing in the GUI.
Publishing reports to DTP requires the "DTP Publish" or "Automaton" license feature to be enabled.
Generating Reports from the Command Line
- Use the
-report %REPORT_FILE%
command line option to generate a report for command line execution. - Use the the
-publish
option to upload the report to DTP.
See Testing from the Command Line Interface for details about executing tests from the command line interface and configuring email notifications.
Uploading Source Code to DTP
Uploading source code to DTP allows you to review the source code associated with findings. See the DTP User Guide for details.
To upload the source code to DTP:
- Ensure that C/C++test is connected to a source control repository (see Connecting to Source Control).
Ensure that C/C++test is connected to a DTP server (see Connecting to DTP).
- From the GUI:
- Go to Parasoft> Preferences... > DTP and enable the Enable reporting results to DTP option.
(Optional) Click Edit and define the advanced report settings:
report.dtp.publish.src
andreport.scontrol
.
Tested sources will be automatically uploaded to DTP when you perform testing in the GUI.
From the command line:
- Define the setting
report.dtp.publish=true
. Seereport.dtp.publish.
(Optional) Define the report settings:
report.dtp.publish.src
andreport.scontrol
.Example:
report.dtp.publish=true dtp.additional.settings=report.scontrol\=min\nreport.dtp.publish.src\=min
- Define the setting
Report File Names
The following table lists the names of the generated report files in each format:
Report Format | Report File Name |
---|---|
HTML | report.html |
HTML (C/C++test's Unit Testing details) | report_ut_details.html |
report.pdf | |
SARIF (Static Analysis Results Interchange Format) | report.sarif |
SARIF for Azure DevOps | report_azure.sarif |
SAST for GitLab | report.sast |
SAST v14 for GitLab | report_v14.sast |
XML SATE (Static Analysis Tool Exposition) | report_sate.xml |
XSL Custom | report_custom.xml |
cppUnit | report_cppunit.xml |
xUnit | report_xunit.xml |