本主题说明如何配置报告设置。可以在 GUI 中或从命令行界面（使用设置）配置报告设置。

章节目录：

通过 GUI 配置

GUI 中的控件可用于指定所有测试的报告设置——无论通过命令行界面还是 UI 运行。 

在配置报告设置之前，应该检查以下首选项页面上的设置，以确保正确推算任务作者，将结果发送到配置的 DTP 服务器，使用正确的电子邮件主机等：

  • E-mail
  • DTP
  • 许可证
  • 范围和作者
  • 源码控制

UI 中指定的设置可被通过设置文件指定的设置完全或部分覆盖。

通过 GUI 指定报告设置的步骤：

  1. 选择 Parasoft> 首选项。将打开一个首选项对话框。
  2. 选择 Parasoft> 报告。
  3. 指定合适的设置。下面的报告配置设置对可用设置进行了说明。
  4. 如果还没有在 GUI 或命令行中配置电子邮件设置（发送者地址、主机名等），应在 Parasoft> E-mail 中进行配置。
  5. 选择 Parasoft> 报告> E-mail 通知。
  6. 指定相应的电子邮件通知设置。可配置的设置包括：
    • 通过电子邮件发送报告：指定是否通过电子邮件发送报告。
    • 电子邮件主题：指定包含报告的电子邮件的主题。指定发送邮件的主题行。默认主题行为 "[Product Name] Report."例如，如果想要将主题行更改为“Functional Testing Report for Project A”，则输入 Functional Report for Project A
    • 发送管理者的报告至：指定发送管理者报告的邮箱地址。您可以输入单个地址或以分号分隔的列表。
    • 发送没有任务的报告：指定在报告的任务数量为零时是否发送报告。您可以输入单个地址或以分号分隔的列表。
    • 发送开发者的报告至：指定发送开发人员报告的位置。您可以输入单个地址或以分号分隔的列表。
    • 发送 '未知' 开发者的报告至：指定将分配给“未知开发人员”的任务（无法追溯到特定开发人员的任务）的开发人员报告发送到哪里。这些报告只能发送到一个用户/地址。不能使用以分号分隔的地址列表。

报告配置设置

报告内容

设置说明
为开发者提供详细报告指定是否为每个团队成员生成自定义的详细报告（除了为管理者生成概要报告之外）。这些报告只包含分配给特定团队成员的任务。
按作者分配的任务概述指定报告是否包含分配给每个开发人员的任务数量及类型的概述。
已检查文件和执行测试的概述

指定报告是否提供有关所有已检查文件和已执行测试的详细信息。 

针对静态分析，将生成一个已检查的所有文件的列表。针对每个文件，将列出违规的数量和被抑制的违规的数量。如果文件出现违规，还将列出相应违规的行号、规则名和规则 ID。

针对测试执行，这将产生一个所有已执行测试用例及其结果（通过或失败）的列表。针对每个测试套件，将列出测试用例的总数和通过的测试用例的数量。如果针对某个测试用例报告了一个任务，则会显示额外的详细信息（堆栈跟踪、结果等）。

任务细节指定报告是否包含所有报告任务的详细信息。
测试用例细节指定报告是否包含所有执行的测试用例的详细信息。
抑制细节指定报告是否列出被抑制的消息。
需求/缺陷细节

指定报告是否显示与测试相关联的需求、缺陷、任务和特征请求。

启用的静态分析规则指定报告是否列出为测试启用的静态分析规则。

需求/缺陷细节的 HTML 报告超链接

如果为工件（例如，作为 C/C++test 测试属性）指定一个 URL，该 URL 将作为 HTML 报告中的超链接提供。 

如果想要创建超链接并仅使用将测试与开发工件相关联中指定的工件 ID 指定工件关联性，那么您可以使用本地属性指定 ID 如何映射到 URL。

例如：

报告格式

设置说明
格式

指定所需报告格式：

  • HTML - 包括 XML 源数据文件
  • HTML (C/C++test 的单元测试详情)
  • PDF
  • SARIF (静态分析结果交换格式)
  • SARIF for Azure DevOps
  • SAST for GitLab
  • SAST v14 for GitLab
  • XML SATE (静态分析工具说明) - NIST SAMATE SATE 专用格式
  • XSL 自定义
  • cppUnit - CppUnit 单元测试框架使用的格式
  • xUnit - 类似于 JUnit 的格式，添加了嵌套测试套件。Jenkins、Hudson、Eclipse JUnit 视图等都支持这种格式。仅适用于已启用已检查文件和执行测试的概述的情况。

如需选择多个格式来为单次运行生成多个报告，可配置 .properties 文件中的 report.format 设置。

XSL file如果选择自定义 XSL 作为报告格式，请指定定义您的自定义格式的 XSL 文件的路径。 
报告文件扩展名如果您想为自定义报告使用默认的 .html 扩展名以外的文件扩展名，则可以在此处指定。
生成包括整个报告内容的附加压缩包

启用此选项可在指定的报告位置生成附加压缩包（.zip）文件。该 ZIP 文件包含生成的用于构建报告的所有文件。 

此选项可以为任何报告格式生成一个压缩包（例如，HTML、PDF、SARIF 等）。 

通过生成压缩包，还可以执行报告的自定义转换，因为所有元素都会生成到指定目标文件夹。

高级设置

设置说明
添加度量指标细节到 XML 数据中：指定是否将类型级和方法级指标详细信息添加到 XML 报告中（除了默认包含的项目和包/命名空间级详细信息外）。HTML 和 PDF 报告中将显示指标详细信息。
会话标签指定报告的标签。该值用于将概要结果上传到 DTP。团队每次常规测试运行产生的结果都应该有一个唯一的标签。可以按照为命令行执行使用首选项设置中的说明来使用变量。例如，如果您的团队运行静态分析和单元测试，则可以使用 Static 或 Execution 会话标签。或者，您可以使用类似 session.tag=${config_name} 或 session.tag=${analysis_type} 的变量
构建 ID

指定用于标记结果的构建标识符。可以针对每个构建唯一标记，也可以标记在指定的构建期间执行的多个测试会话。

默认为 ${dtp_project}-${time}。

通过设置配置

报告选项可以在设置中指定（例如，通过 DTP 共享团队范围的设置或在命令行中指定选项）。详细信息请参阅配置设置。 

支持自定义报告格式

通过构建一个指定了如何进行结果格式化的自定义 XSL 转换器，可以自定义本地生成和通过电子邮件发送的报告。例如，您可以使用自定义转换器将数据映射到所需的格式，以体现对内部安全策略的遵循。

指定自定义报告格式的步骤：

  1. 创建一个 XSL 文件，指定要如何转换 XML 数据。
  2. 在首选项面板的报告页面中，指定这个 XSL 文件的位置，以及报告文件应该使用的扩展名。

    • 或者，也可以在设置文件中指定以上信息：
      (results.)report.custom.extension 和 (results.)report.custom.xsl.file。

可用参数

自定义 XSL 文件可以使用以下参数：

参数注意
report_type=disk_report|email_report指定生成的报告是通过电子邮件发送还是保存在本地磁盘驱动器上。 
test_params

用于启动生成此报告的产品的命令行。

示例：cpptestcli: -config "builtin://Recommended Rules" -settings /home/nightly/settings.properties -publish -report /home/nightly/reports/report.html -resource myproject -dtp.autoconfig [email protected]:8443

test_config_name

为生成此报告而执行的测试配置的名称。
例如：Parasoft 推荐的规则

output_dir=[dir]

创建报告的目录。可用于生成开发人员报告。

示例：<xsl:value-of select="concat($output_dir,$dev_reports_prefix,$authid,'.csv')"/> 

rules_dir_path=[path]

保存规则文档的目录。可用于生成规则弹出信息/链接。

示例：<xsl:value-of select="concat('javascript:openWin(',$qt,$rules_dir_path,$id,'.html',$qt,')')"/> 

suppr_msgs=true|false“抑制细节”选项的值。详细信息请参阅报告配置设置。
dev_errors=true|false“任务细节”选项的值。详细信息请参阅报告配置设置。
dev_reports=true|false“为开发者提供详细报告”选项的值。详细信息请参阅报告配置设置。
show_active_rules=true|false“启用的静态分析规则”选项的值。详细信息请参阅报告配置设置。
associations=true|false“需求/缺陷细节”选项的值。详细信息请参阅报告配置设置。
dev_reports_prefix=[prefix]

用于命名开发人员报告的前缀。

示例：<xsl:value-of select="concat($output_dir,$dev_reports_prefix,$authid,'.csv')"/>

exec_cvg_details=true|false

“详细报告关于”选项的值。详细信息请参阅报告配置设置。

attachments=true|false设置键 report.mail.attachments 的值。详细信息请参阅配置设置。
test_cases_details=true|false“测试用例细节”选项的值。详细信息请参阅报告配置设置。
failed_tests_only=true|false设置键 report.failed_tests_only 的值。详细信息请参阅配置设置。
authors_details=true|false“按作者分配的任务概述”选项的值。详细信息请参阅报告配置设置。
contexts_details=true|false“已检查文件和执行测试的概述”选项的值。详细信息请参阅报告配置设置。

示例

有关进一步的指导信息，请参阅以下文件：

本地报告

  • XML Schema：reports.xsd
  • 包含多种结果的 XML 示例：rep_example.xml
    • 注意，以下所有转换均使用该报告
  • 转换为纯文本 CSV 文件的示例
    • XSL 文件：csv.xsl
    • 结果：csv.txt
  • 转换为包含违规列表的 HTML 表格的示例
    • XSL 文件：html_table.xsl
    • 结果：html_table.html
  • 转换为包含作者/违规统计信息的 HTML 表格的示例
    • XSL 文件：stats_table.xsl
    • 结果：stats_table.html
  • 开发人员报告转换为 CSV 文件的示例
    • XSL 文件：csv_dev.xsl
    • 结果：csv_dev.csv
  • 开发人员报告转换为 HTML 文件的示例
    • XSL 文件：html_dev.xsl
    • 结果：html_dev.html


  • No labels

Need assistance? Visit our support page