本主题说明了如何配置报告设置。可以在 GUI 或命令行界面(使用 localsettings )中配置报告设置。
各节内容包括:
从 GUI
可用的 GUI 控件可用于为所有测试指定报告设置,无论它们是从命令行界面还是用户界面运行。
在配置报告设置之前,您应该查看以下首选项页上的设置,以确保正确计算任务作者身份,将结果发送到已配置的 DTP 服务器(或 Team Server),使用了正确的电子邮件主机,等等。
- 电子邮件
- DTP
- 许可
- 范围和作者
- 源代码控制
- 团队服务器
用户界面中指定的设置可以全部或部分地重写通过 localsettings 指定的设置。
要从 GUI 指定报告设置:
- 选择 Parasoft>首选项。首选项对话框将打开。
- 选择Parasoft> 报告。
- 指定适当的设置。可用的设置在下面的报告配置设置中进行了描述。
- 如果您尚未在 GUI 或命令行中配置电子邮件设置(发件人地址,主机名等),请立即在 Parasoft> 电子邮件中进行配置。
- 选择 Parasoft>报告>电子邮件通知。
- 指定适当的电子邮件通知设置。可用的设置包括:
- 通过电子邮件发送报告:指定是否通过电子邮件发送报告。
- 电子邮件主题:指定包含报告的电子邮件的主题。指定发送的电子邮件的主题行。默认主题行是“[产品名称]报告”。例如,如果要将主题行更改为“项目 A 的功能测试报告”,则应输入
项目 A 的功能报告
。 - 将管理器报告发送至:指定将管理器报告发送到的位置。您可以输入一个地址或以分号分隔的列表。
- 发送没有任务的报告:指定在报告零个任务时是否发送报告。您可以输入一个地址或以分号分隔的列表。
- 将开发人员报告发送至:指定在何处发送开发人员报告。 您可以输入一个地址或以分号分隔的列表。
- 将“未知”开发人员报告发送给:指定将分配给“未知”的任务(无法追溯到特定开发人员的任务)的开发人员报告发送到何处。这些报告只能发送给一个用户/地址。以分号分隔的地址列表无效。
报告配置设置
报告内容
设置 | 说明 |
---|---|
开发人员详细报告 | 确定是否为每个团队成员生成定制的详细报告(除了针对经理的摘要报告)。这些报告仅包含分配给该特定团队成员的任务。 |
作者的任务概述 | 确定报告是否包括分配给每个开发人员的任务数量和类型的概述。 |
检查文件和已执行测试的概述 | 指定报告是否提供有关所有已检查文件和已执行测试的详细信息。 对于静态分析,这将生成所有已检查文件的列表。对于每个文件,它列出了规则违规的数量和抑制的违规的数量。如果文件有违规,它还会列出该违规的行号,规则名称和规则 ID。 对于测试执行,这会生成所有已执行测试用例及其结果(通过或失败)的列表。对于每个测试套件,它列出了测试用例的总数和通过的测试用例的数量。如果报告了测试用例的任务,则会显示其他详细信息(堆栈跟踪,结果等)。 |
任务详情 | 确定报告是否包括有关所有报告任务的详细信息。 |
测试用例详细信息 | 确定报告是否包含有关所有已执行测试用例的详细信息。 |
抑制详细信息 | 指定报告是否列出被抑制的报文。 |
需求/缺陷详细信息 | 指定报告是否显示与测试关联的需求、缺陷、任务和功能请求。 |
主动静态分析规则 | 确定报告是否列出为测试启用的静态分析规则。 |
只有失败的测试 | 指定报告是否仅列出失败的测试。 |
在命令行模式下生成格式化的报告 | 确定是否为在命令行模式下运行的测试生成格式化的报告。 |
图形的截止日期 | 指定在一段时间内跟踪不同类别任务的趋势图的开始日期。 |
报告格式
设置 | 说明 |
---|---|
格式 | 指定所需的报告格式:
|
XSL 文件 | 如果您选择定制 XSL 作为报告格式,请指定用于定义定制格式的 XSL 文件的路径。 |
报告文件扩展名 | 如果要使用默认的 .html 扩展名以外的文件扩展名,请在此处指定该扩展名。 |
生成包含整个报告内容的其他存档 | 启用此选项可在指定的报告位置生成其他压缩的存档(.zip)文件。ZIP 文件包含为生成报告而生成的所有文件。 此选项可以为任何报告格式(例如 HTML、CSV、PDF 等)生成存档。 通过生成存档,您还可以执行报表的自定义转换,因为所有元素都生成到指定的目标文件夹。 |
高级设置
设置 | 说明 |
---|---|
将绝对文件路径添加到 XML 数据 | 指定是否将绝对文件路径添加到 XML 数据。如果要在导入到桌面安装时重新定位任务,则需要在服务器安装上启用此功能(如在导入期间重新定位任务中所述:Configuring Task Reporting Preferences#Relocating_1要求和限制)。 |
将度量指标详细信息添加到 XML 数据: | 指定是否将类型级别和方法级别的度量详细信息添加到 XML 报告(除了项目和包/命名空间级别的详细信息,默认情况下包括)。度量指标详细信息将显示在 HTML 和 PDF 报告中。 |
会话标签 | 指定此报告的标签。此值用于将摘要结果上传到 DTP。每个团队的常规测试结果均应具有唯一标记。 可以按照使用首选项设置进行命令行执行中的说明使用变量。例如,如果您的团队运行静态分析和单元测试,则可以使用会话标签静态 或执行 。或者您可以使用诸如 session.tag=${config_name} 或session.tag=${analysis_type} 变量 |
构建 ID | 指定用于标记结果的构建标识符。对于每个构建,它可能是唯一的,但也可能标记在指定构建过程中执行的多个测试会话。 默认是 |
来自本地设置
可以在本地设置中指定报告选项(例如,通过 DTP 共享整个团队范围的设置或在命令行中指定选项)。有关详细信息,请参见配置本地设置 。
支持自定义报告格式
您可以通过构建一个自定义 XSL 转换器来自定义本地生成并通过电子邮件发送的报告,该转换器指定如何格式化结果。例如,您可以使用自定义转换器将数据映射为证明符合内部安全策略所需的格式。
要指定自定义报告格式,您需要:
- 创建一个 XSL 文件,该文件指定您要如何转换 XML 数据。
- 在【偏好设置】面板的【报告】页面中,指定此 XSL 文件的位置以及应分配给结果文件的扩展名。
或者,您可以通过设置
(results.)report.custom.extension 和 (results.)report.custom.xsl.file.
在 localsettings 文件中指定此信息。
可用参数
可以在自定义 XSL 文件中使用以下参数:
参数 | 注意 |
---|---|
report_type=disk_report|email_report | 确定生成的报告是通过电子邮件发送还是保存在本地磁盘驱动器上。 |
test_params | 用于启动生成此报告的产品的命令行。 示例: cpptestcli: -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 | 为生成此报告而执行的测试配置的名称。 |
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 | Localsettings 密钥 report.mail.attachments 的值。有关详细信息,请参见配置本地设置 。 |
test_suites_only=true|false | Localsettings 密钥 report.test_suites_only 的值。有关详细信息,请参见配置本地设置 。 |
test_cases_details=true|false | “测试用例详细信息”选项的值。有关详细信息,请参见报告配置设置 。 |
failed_tests_only=true|false | Localsettings 密钥 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