您可以在 GUI 或命令行界面中配置报告设置(使用 localsettings)。除了生成本地报告,您还可以将报告发送到 Parasoft DTP 或 Parasoft 项目中心(传统)。向 DTP 发送报告使您能够应用复杂的分析来更好地理解与被测试的应用程序以及您的总体开发和测试流程相关的风险。向项目中心发送报告可以实现集中的任务管理。    

本章包含:

在 GUI 中

您可以使用 GUI 控件为所有测试指定报告设置(无论它们是从命令行界面还是 GUI 运行的)。配置报表设置之前,应该检查以下首选项页面上的设置,以确保正确计算了任务作者、将结果发送到适当的系统、使用了正确的电子邮件主机,等等:

用户界面中指定的设置可以被通过 localsettings 指定的设置完全或部分覆盖。

若要从 GUI 中指定报告设置,请完成以下内容:

  1. 选择 Parasoft> Preferences。将打开一个首选项对话框。
  2. 选择  Parasoft> Reports
  3. 指定合适的设置。可用的设置如下 Report Configuration Settings 所述。
  4. 如果还没有在 GUI 或命令行中配置电子邮件设置(发送者地址、主机名等),那么现在就 Parasoft> E-mail 中配置。
  5. 选择  Parasoft> Reports> E-mail Notifications
  6. 指定合适的电子邮件通知设置。可用设置包括:
    • Send reports by e-mail:指定是否通过电子邮件发送报告。
    • E-mail subject:指定包含报告的电子邮件的主题。指定发送邮件的主题行。默认主题行为 "[Product Name] Report."例如,如果想要将主题行更改为 "Functional Testing Report for Project A",那么可以输入 Functional Report for Project A
    • Send manager reports to指定发送管理器报告的位置。您可以输入单个地址或分号分隔的列表。
    • Send reports without tasks定在报告零任务时是否发送报告。您可以输入单个地址或分号分隔的列表。
    • Send developer reports to指定发送开发人员报告的位置。您可以输入单个地址或分号分隔的列表。
    • Send ’Unknown’ developer reports to指定将分配给“未知”的任务(无法追溯到特定开发人员的任务)的开发人员报告发送到何处。这些报告只能发送到一个用户/地址。用分号分隔的地址列表无效。

报告配置设置

报告内容

设置说明
Detailed report for developers确定是否为每个团队成员生成定制的详细报告(除了为管理人员生成摘要报告之外)。这些报告只包含分配给特定团队成员的任务。
Overview of tasks by authors确定报告是否包含分配给每个开发人员的任务数量及类型的概述。
Overview of checked files and executed tests

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

对于静态分析,这将生成一个已检查的所有文件的列表。对于每个文件,它列出违反规则的数量和被禁止违反的数量。如果文件有违规行为,它还列出了违规的行号、规则名和规则 ID。

对于测试执行,这将产生一个所有已执行测试用例及其结果(通过或失败)的列表。对于每个测试套件,它列出了测试用例的总数和通过测试用例的数量。如果为测试用例报告了一个任务,就会显示额外的细节(堆栈跟踪、结果等)。

对于代码评审,这将导致一个包含 author - reviewer - monitor 之间消息的所有未决问题的列表(默认情况下由会话标记过滤)。

Task details确定报告是否包含所有报告任务的详细信息。
Test case details确定报告是否包含所有执行的测试用例的详细信息。
Suppression details指定报告是否列出被抑制的消息。
Requirement/defect details

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

要使此设置生效,必须禁用 Only top-level test suites(下面的)。

Only top-level test suites确认测试套件汇总报告部分是只列出 .tst 文件(需要启用该选项),还是显示每个 .tst 文件中的树状视图(需要禁用该选项)。
Active static analysis rules确定报告是否列出为测试启用的静态分析规则。
Only tests that failed指定报告是否只列出失败的测试。
Generate formatted reports in command-line mode确定是否为在命令行模式下运行的测试生成格式化报告。
Cutoff date for graphs指定跟踪一段时间内不同任务类别的趋势图的开始日期。 

HTML 报告需求/缺陷详情的超链接

如果您正在为工件指定一个 URL(例如,作为一个 SOAtest 测试属性),该 URL 将在 HTML 报告中作为一个超链接可用。 

如果希望创建超链接,并且仅使用 指示代码和测试相关性中指定的工件 ID 指定工件关联,那么您可以使用本地属性指定 ID 如何映射到 URL。

例如:

  • report.assoc.url.pr=https://bugzilla.parasoft.com/show_bug.cgi?id=[%ID%]
  • report.assoc.url.jira=https://jira.parasoft.com/browse/[%ID%]
  • report.assoc.url.fr=https://bugzilla.parasoft.com/show_bug.cgi?id=[%ID%]
  • report.assoc.url.task=http://dtp.parasoft.com.pl:8080/grs/jsf/planning/task/edit_task.jsf?entityId=[%ID%]

报告格式

设置说明
Format

指定所需报告格式:

  • HTML - 包括 XML 源数据文件
  • PDF
  • XML SATE - 格式特定于 NIST SAMATE 静态分析工具的说明
  • XSL 自定义
  • xUnit - 一种类似 JUnit 的格式,添加了嵌套测试套件。这种格式由 Jenkins、Hudson、Eclipse Junit 视图等支持。它只适用于启用 Overview of checked files and executed tests
    这种格式支持语言工具:dotTEST、C++test 和 Jtest。
XSL file如果选择自定义 XSL 作为报告格式,请指定定义自定义格式的 XSL 文件的路径。 
Report file extension如果想使用一个文件扩展名而不是默认的 .html 扩展名,请在这里指定该扩展名。
Generate additional archive with entire report content

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

此选项可以为任何报告格式生成一个存档(如:HTML、CSV、PDF等等)。 

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

高级设置

设置说明
Add absolute file paths to XML data指定是否将绝对文件路径添加到 XML 数据。如果希望在将任务导入到桌面安装时重新定位任务,则需要在服务器安装上启用此功能。(如 Relocating Tasks During Import:配置任务报告首选项Requirements and Limitations中所述)。 
Session tag会话标记是测试运行的唯一标识符,用于区分特定的运行和 DTP 中的类似运行。团队每次常规测试运行的结果都应该有一个唯一的标记。变量可以按照 Using Preference Settings for Command-Line Execution中所描述的那样使用来使用。例如,如果您的团队运行静态分析。单元测试和代码审查,那么您可能使用会话标记 StaticExecutionCode Review。或者,您可能使用类似 session.tag=${config_name} 或 session.tag=${analysis_type}这样的变量。

在 localsettings 中

关于更多详情,请查阅 Reporting Settings 。 

支持自定义报告格式

您可以通过构建一个定制 XSL 转换器来定制本地生成的和通过电子邮件发送的报告,该 XSL 转换器指定您希望如何格式化结果。例如,您可以使用自定义转换器将数据映射到所需的格式,以演示对内部安全策略的遵从性。

若要指定自定义报告格式,您需要这样做:

  1. 创建一个 XSL 文件,指定要如何转换 XML 数据。
  2. 在首选项面板的报告页面中,指定这个 XSL 文件的位置,以及应该分配给结果文件的扩展名。
    • 或者,您可以通过
      (results.)report.custom.extension 和 (results.)report.custom.xsl.file设置在 localsettings 文件中指定此信息。

可用参数

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

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

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

例如:

soatestcli -config team://xtest-static.properties^
 -localsettings /home/nightly/localsettings.properties^
 -publish -report /home/nightly/reports/report.html^
 -resource myproject^
 -dtp.autoconfig [email protected]:8080
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“抑制详情”选项的值。有关更多详情,请查阅 Report Configuration Settings
dev_errors=true|false“任务详情”选项的值。有关更多详情,请查阅 Report Configuration Settings 
dev_reports=true|false“适用于开发人员的详细报告”选项。有关更多详情,请查阅 Report Configuration Settings 
show_active_rules=true|false“活跃的静态分析规则”选项的值。有关更多详情,请查阅 Report Configuration Settings 
associations=true|false“需求/缺陷详情”选项的值。有关更多详情,请查阅 Report Configuration Settings 
dev_reports_prefix=[prefix]

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

例如:

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

exec_cvg_details=true|false

“Detailed report for”选项的值。有关更多详情,请查阅 Report Configuration Settings 

attachments=true|falselocalsettings 键 report.mail.attachments 的 value 值。有关更多详情,请查阅 配置 Localsettings
test_suites_only=true|false

localsettings 键 report.test_suites_only 的 value 值。有关更多详情,请查阅 配置 Localsettings 

test_cases_details=true|false“测试用例详情”选项的值。有关更多详情,请查阅 Report Configuration Settings
failed_tests_only=true|falselocalsettings 键 report.failed_tests_only 的 value 值。有关更多详情,请查阅 配置 Localsettings
authors_details=true|false“作者任务概述”选项的值。有关更多详情,请查阅 Report Configuration Settings
contexts_details=true|false“已检查文件和执行测试的概述”选项的值。有关更多详情,请查阅 Report Configuration Settings

示例

有关其他指导,请参阅以下文件:

本地报告

  • XML 模式: reports.xsd
  • 使用各种结果的示例: 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