章节目录：

build.id

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

构建 ID 的最大长度为 128 个字符。

可接受的值

[id]用于标记结果的 id。默认为 ${dtp_project}-${time:yyyy-MM-dd}。

用法示例

默认构建 ID 包括 DTP 中的项目名称和构建日期。例如，对于 ATM 项目，报告中包含的构建 ID 可能类似如下：ATM-2017-07-07。 

以下配置指定了自定义构建 ID，该 ID 由项目名称和通过环境变量 BUILD 传递的构建编号组成：

build.id=${dtp_project}-${env_var:BUILD}

例如 ABC 项目和 CI 服务器上的构建编号 114 可以解析为 ABC-114。

dupcode.sorting.mode

此设置指定代码重复任务中元素的排序方式。 

可接受的值

oldest先显示最早的结果。
newests先显示最新的结果。
paths默认。按完整路径名的字母升序（A 到 Z）对结果排序。

exec.env

此设置指定一个字符串，描述运行的执行环境。您可以通过服务 API 标记整个测试会话，以及单个测试套件、测试或测试用例。默认情况下，标签由操作系统名称（例如，Windows、Linux）及其架构（例如，x86、x86_64）组合。

可接受的值

[标签]指定执行环境详细信息的字符串。默认为 ${os}${arch}。

用法示例

以下配置指定在使用 GCC 5.4 编译器的 64 位 Linux 机器上执行运行：

exec.env=linux_x86_64_gcc5.4

goal{n}.name

此设置指定目标的名称——满足指定条件的任务的子集（请参阅 goal.severities、goal.projects、goal.max.to.recommend、goal.rules、goal.deadline）。任务在 HTML 报告的“目标”部分列出，作为向每个开发人员提供的建议。

您可以通过在“目标”前缀中添加数字来配置多个目标。

可接受的值

[goal name]目标的名称。

用法示例

以下配置将启用两个目标：“Priorities1”和“Priorities2”。

goal1.name=Priorities1

goal2.name=Priorities2

goal{n}.severities

此设置指定要为目标报告的任务的严重级别。此设置需要配置 goal.name。

您可以指定多个严重级别。

可接受的值

[严重级别]严重级别（1-5）或以逗号分隔的严重级别列表。

用法示例

以下配置启用了“Priorities1”目标，该目标是严重级别为 1 或 2 的任务的子集。

goal1.name=Priorities1

goal1.severities=1.2

goal{n}.max.to.recommend

此设置指定在 HTML 报告的“目标”部分为每个开发人员报告的最大任务数。此设置需要配置 goal.name。

可接受的值

[数字]针对每个开发人员报告的任务的最大数量。

用法示例

以下配置将“Priorities1”目标的报告限制为 20。

goal1.name=Priorities1

goal1.severities=1.2

goal1.max.to.recommend=20

goal{n}.projects

此设置指定您希望目标仅包括特定项目的任务。此设置需要配置 goal.name。

可接受的值

[项目名称]报告任务的项目的名称。

用法示例

以下配置指定“Priorities1”目标将仅包括为“examples”项目报告的严重度为 1 和 2 的任务。

goal1.name=Priorities1

goal1.severities=1.2

goal1.projects=examples

goal{n}.rules

此设置指定要为目标报告的特定规则的任务。此设置需要配置 goal.name。

可接受的值

[规则 ID]规则 ID 或逗号分隔的规则 ID 列表。

用法示例

以下配置指定“Priorities1”目标将仅包括针对 BD_SECURITY_VPPD 和 BD_PB_VALRANGE 规则报告的任务。

goal1.name=Priorities1

goal.rules=BD_SECURITY_VPPD,BD_PB_VALRANGE

goal{n}.deadline

此设置指定修复任务的截止日期。为目标报告的任务数量取决于距离截止日期剩余的时间：任务总数除以剩余天数。此设置需要配置 goal.name。

可接受的值

[年-月-日]截止日期。

用法示例

以下配置指定 BD_SECURITY_VPPD 和 BD_PB_VALRANGE 规则报告的所有任务应在 2019 年 5 月 10 日之前修复。

goal1.name=Priorities1

goal.rules=BD_SECURITY_VPPD,BD_PB_VALRANGE

goal1.deadline=2019-05-10

goal.ref.report.file

此设置指定 report.xml 参考文件的路径，该文件将作为基准用于在当前分析中识别新的任务。如果当前分析运行中检测到的任务在此设置指定的参考文件中不存在，则会标记为‘new’。

可接受的值

[路径或 URL]report.xml 参考文件的路径或 URL。

用法示例

以下配置指定当前分析中检测到的任务将与‘baseline’目录中的 report.xml 文件进行比较：

goal.ref.report.file=C:/parasoft/baseline/report.xml

goal.ref.report.findings.exclude

此设置启用或禁用从报告中排除现有任务。通过将当前分析运行中检测到的任务与使用 goal.ref.report.file 配置的 report.xml 参考文件进行比较来识别已有的任务。如果启用，同时存在于参考文件中的当前任务将从报告中排除。

可接受的值

true报告中只包括新的任务。
false默认。报告中包括新的任务和已有的任务。

用法示例

以下配置将已有的任务从报告中排除：

goal.ref.report.file=http://mycompany.com/sa/baseline/report.xml

goal.ref.report.findings.exclude=true

issue.tracking.tags

此设置指定问题跟踪标签列表。要求启用 report.associations 选项。

可接受的值

[标签]

逗号分隔的标签列表。默认支持以下标签：asset、fr、pr、req、task、test

用法示例

以下配置禁用 asset 默认标签并启用 high 自定义标签：

report.associations=true

issue.tracking.tags=fr,pr,req,task,high,test

相关内容

project.module

此设置指定项目模块的自定义名称。该设置可用于描述唯一运行。如果未指定，则会根据分析的代码自动检测被测模块。

可接受的值

[名称]

项目模块的名称。

用法示例

以下配置指定 XTests 自定义模块名称：

project.module=xTests


report.active_rules

此设置指定是否在报告中包含分析期间启用的规则列表。 

可接受的值

true默认。报告中包括启用的规则列表。
false报告中不包括启用的规则列表。

用法示例

以下配置将禁用在报告中显示分析期间启用的规则：

report.active_rules=false

report.archive

此设置启用或禁用将报告归档到 ZIP 文件中。

可接受的值

true报告归档到 ZIP 文件中。
false报告不会归档到 ZIP 文件中。

report.associations

此设置启用或禁用在报告中显示与测试关联的需求、缺陷、任务和特性请求。

可接受的值

true默认。报告中包括需求、任务和特性请求。
false报告中不包括需求、任务和特性请求。

用法示例

以下配置禁用在报告中显示需求、任务和特性请求：

report.associations=false

相关内容

关联测试与开发工件

report.assoc.url.[tag]

此设置生成指向 HTML 报告内关联的链接。此 URL 是一个查询字符串，包含 PropertyAttribute 值的 [%ID%] 占位符。关联的标签必须使用 issue.tracking.tags 选项配置。

可接受的值

[URL]

指向将包含在 HTML 报告中的关联的链接。

用法示例

以下配置启用 high 自定义标签并在 HTML 报告中生成链接。

report.associations=true

issue.tracking.tags=high

report.assoc.url.high=http://bugzilla.company.com/workitem?id=[%ID%]

相关内容

关联测试与开发工件

report.authors_details

此设置指定报告是否包括对分配给每个开发人员的任务数量及类型的概述。

可接受的值

true默认。报告中包括分配给每个开发人员的任务类型和数量。
false报告中不包括分配给每个开发人员的任务类型和数量。

用法示例

以下配置不会包括每个开发人员的任务数量和类型的详细信息：

report.authors_details=false


report.contexts_details

此设置指定报告是否包括对测试期间检查或执行文件的概述。

可接受的值

true默认。报告中包括已检查文件的列表。
false报告中不包括已检查文件的列表。

用法示例

以下配置不会包括已检查文件的列表。

report.contexts_details=false

report.coverage.images

此设置指定了一组标签，用于在 DTP 中创建覆盖率图像。针对每份报告，DTP 最多支持 3 张覆盖率图像。 

可接受的值

[标签]

在 DTP 中创建覆盖率图像时将使用的以分号分隔的标签列表。

report.coverage.limit

此设置指定覆盖率下限阈值。低于指定值的覆盖率结果会在报告中突出显示。

可接受的值

[值]

表示覆盖率下限的值。默认值为 40。

用法示例

以下配置将覆盖率下限值设置为 50：

report.coverage.limit=50

report.coverage.line.hashes

此设置指定 XML 覆盖率报告中是否包括行哈希。

可接受的值

true默认。覆盖率报告中包括行哈希。
false覆盖率报告中不包括行哈希。


report.custom.extension

此设置指定自定义格式的 XSL 文件的报告文件扩展名。需要将 report.format 选项设置为 custom，并配置 report.custom.xsl.file。

可接受的值

[扩展名]XSL 文件的自定义扩展名。

report.custom.xsl.file

此设置指定自定义格式的 XSL 文件的位置。

可接受的值

[路径]XSL 文件的路径。

(info) 在 Windows 中指定文件路径时使用双反斜线。

report.developer_errors

此设置指定管理者报告是否包括有关开发人员错误的详细信息。 

可接受的值

true报告中包括有关开发人员错误的详细信息。
false默认。报告中不包括有关开发人员错误的详细信息。

用法示例

以下配置会在报告中包括有关开发人员错误的详细信息：

report.developer_errors=true


report.developer_reports

此设置指定系统是否为所有开发人员生成详细报告（除了为管理者生成概要报告之外）。

可接受的值

true启用为开发人员生成详细报告。
false默认。禁用为开发人员生成详细报告。

用法示例

以下配置启用为开发人员生成详细报告：

report.developer_reports=true


report.dtp.publish

此设置指定产品的当前安装实例是否向 DTP 服务器报告本地分析结果。

可接受的值

true

结果会发布到 DTP。

false默认。结果不会发布到 DTP。

用法示例

以下配置会将本地分析结果发送到 DTP。

report.dtp.publish=true

相关内容

report.dtp.publish.src

此设置指定是否将被测源代码发送到 DTP 服务器。  

可接受的值

off不向 DTP 发布源代码。
min发送最少的一部分源代码（在大多数情况下，发送没有引用源码控制的源代码，例如自动生成的代码）。
full

指定范围内的所有源代码都将发送到 DTP。这是启用 report.dtp.publish 选项时的默认值。

用法示例

以下配置会将部分源代码发送到 DTP。

report.dtp.publish.src=min

相关内容

report.file.name

此设置指定报告文件的自定义名称。

需注意，此设置不指定文件扩展名。您可以使用 report.format 设置报告格式。

  • “report”这个名称十分受限，因此不应使用。
  • 如果指定了此设置并且选择了扩展名相同的多种格式，报告将被覆盖。

可接受的值

[file_name] 

报告文件的名称。有关默认的名称，请参阅报告文件名。

用法示例

配置以下设置后，结果将保存在 report-cwe.pdf 文件中。

report.file.name=report-cwe

report.format=pdf

report.format

此设置指定报告格式。使用逗号分隔的格式列表，可发布多种格式的报告。

可接受的值

xml默认。生成 XML 格式的报告。
html默认。生成 HTML 格式的报告。
pdf生成 PDF 格式的报告。
csv生成 CSV 格式的报告。
sarif生成 SARIF 格式的报告。
sarif-azure生成 Azure DevOps 专用的 SARIF 格式报告。
sate生成 SATE 格式的报告（详细信息，请参阅 https://samate.nist.gov/SATE4.html）
sast-gitlab生成 GitLab 专用的 SAST 格式报告。
xunit生成 xUnit 格式的报告。
custom生成自定义格式的报告；请参阅 report.custom.extension 和 report.custom.xsl.file。

用法示例

以下配置指定 PDF 报告格式：

report.format=pdf

report.graph.start_date

此设置指定跟踪静态分析任务、测试执行和覆盖率的趋势图的起始日期。需要配置 report.graph.period 选择。

可接受的值

[月/日/年]

月-日-年格式的日期。

report.graph.period

此设置指定从跟踪静态分析任务、测试执行和覆盖率的趋势图的起始日期起算的持续时间。需要配置 report.graph.start_date 选项。

可接受的值

[?d|?m|?y] 

以日-月-年格式指定持续时间。

report.location

此设置指定报告创建目录。

可接受的值

[路径]报告创建目录的路径。

用法示例

以下配置指定 new_reports 目录的路径：

report.location=C:\\Users\\user1\\new_reports


report.mail.enabled

此设置启用或禁用向使用 report.mail.cc 设置指定的开发人员和其他收件人发送报告邮件。 

可接受的值

true向开发人员和其他收件人自动发送一份报告，其中包括与其工作相关的错误/结果。 
false默认。  不向开发人员和其他收件人发送报告。

report.mail.server

此设置指定用于发送报告的邮箱服务器。

可接受的值

[主机名] 

将向其发送报告的服务器的主机名。

report.mail.port

此设置指定 SMTP 服务器的端口。

可接受的值

[端口号] 

端口号。默认为 25。

report.mail.security

此设置指定 SMTP 服务器连接安全性。 

可接受的值

STARTTLS默认。使用 STARTTLS 连接安全。
SSL使用 SSL 连接安全。


report.mail.subject

指定发送邮件的主题行。

可接受的值

[subject] 

电子邮件的主题。

用法示例

report.mail.subject=ABC Project Results

report.mail.username

report.mail.password

report.mail.realm

这些设置指定 SMTP 服务器身份验证所需的信息。只有使用 SASL 领域进行身份验证的服务器才需要指定 realm 值。

用法示例

report.mail.username=user1
report.mail.password=Psm#3P!

report.mail.domain

此设置指定用于发送报告的邮件域名。

可接受的值

[域名] 

发送报告的目标域名。

report.mail.time_delay

指定发送电子邮件报告的时间延迟（避免批量电子邮件限制）。

可接受的值

[时间] 

根据指定的时间延迟发送电子邮件报告。

report.mail.from

此设置指定电子邮件“发件人”栏的内容。

可接受的值

[email]“发件人”栏将包括电子邮件地址
[用户]“发件人”栏将包括此用户名。

report.mail.attachments

此设置启用或禁用将报告作为附件发送。所有组件都作为附件被包含在内；必须将所有附件都保存到磁盘才能查看带有图像的报告。

可接受的值

true发送电子邮件时包含附件。
false发送电子邮件时不包含附件。

report.mail.compact

此设置指定电子邮件中报告信息的呈现方式。默认不配置该设置。

可接受的值

trends电子邮件包含趋势图、摘要表和其他精简数据；不包括详细数据
links电子邮件仅包括 DTP 服务器上的报告链接。

report.mail.format

此设置指定电子邮件的内容类型。 

可接受的值

html电子邮件内容采用 HTML 格式。
ascii电子邮件内容采用 ASCII 格式。

report.mail.cc

此设置指定用于发送管理者综合报告的电子邮件地址。多个地址必须使用分号分隔。此设置通常用于向管理者、架构师以及特定开发人员发送报告。

可接受的值

[电子邮件地址] 

分号分隔的电子邮件地址列表。

用法示例

[email protected];[email protected]

report.mail.include

此设置指定希望接收开发人员报告的开发人员电子邮件地址。多个地址必须使用分号分隔。如果没有自动发送此类报告（例如，团队未使用支持的源码控制系统），则通常使用此设置将开发人员报告发送给开发人员。 

该设置将覆盖‘exclude’列表中指定的地址。

可接受的值

[电子邮件地址] 

分号分隔的电子邮件地址列表。

report.mail.exclude

此设置指定应从自动接收报告的电子邮件地址中排除的地址。

可接受的值

[电子邮件地址] 

分号分隔的电子邮件地址列表。

report.mail.exclude.developers

此设置启用或禁用向未在 report.mail.cc 设置中明确列出的开发人员发送报告邮件。此设置用于防止将报告发送给特定的团队成员。

可接受的值

true电子邮件不会发送给未明确指定的开发人员。
false默认。不会从邮件列表中排除开发人员。

report.mail.unknown

此设置指定将分配给“未知人员”的错误报告发送给谁。

可接受的值

[email]分配给“未知人员”的报告将发送到指定的电子邮件地址。
[用户]分配给“未知人员”的报告将发送给指定的用户。

report.mail.on.error.only

此设置启用或禁用在发现错误或发生致命异常时向管理者发送电子邮件报告。开发人员邮件不受此设置影响；开发人员邮件只发送给负责相关错误的开发人员。

可接受的值

true向管理者发送包含有关错误和致命异常具体信息的电子邮件。
false默认。不向管理者发送包含有关错误和致命异常具体信息的电子邮件。

report.metadata

此设置指定是否应从 DTP 下载任务相关的额外元数据。只有 DTP 上已经存在的任务才会受到影响。此外，DTP 服务器还必须支持元数据服务，此设置才能生效。

可接受的值

true默认。从 DTP 下载任务相关的元数据。
false不从 DTP 下载任务相关的元数据。

用法示例

以下配置不会从 DTP 下载额外的元数据：

report.metadata=false


report.metrics.attributes

此设置指定指标结果的额外属性列表。

以下属性始终处于启用状态，不需要使用此设置进行配置：module、namespace、type、method。

可接受的值

[属性]

逗号分隔的属性列表。


report.rules

此设置指定静态分析规则 HTML 文件的存储目录。 

可接受的值

[URL]

HTML 静态分析规则文件的存储位置。

用法示例

示例 1：

report.rules=file:///C:/parasoft/gendoc/

示例 2：

report.rules=../gendoc/


report.scontrol

此设置指定报告中是否包含来自源码控制的其他信息以及包含多少信息。

可接受的值

off默认。报告中不会包括源码控制中的信息。
min报告中包括有关资源库、文件路径以及修订的信息。
full报告中包括有关资源库、文件路径、修订以及任务修订和评论的信息。

用法示例

以下配置会在报告中包括有关存储库、文件路径和修订的信息：

report.scontrol=min


report.suppressed_msgs

此设置指定报告是否包括抑制的消息。

可接受的值

true报告中包括抑制的消息。
false默认。报告中不包括抑制的消息。

用法示例

以下配置会包括抑制的消息：

report.suppressed_msgs=true


report.setup.problems

此设置指定设置问题部分在报告中的位置。

top设置问题部分位于报告的顶部。
bottom默认。设置问题部分位于报告的底部。
hidden设置问题部分不在报告中显示。

report.setup.problems.category_limit

此设置指定在一个设置问题分类中报告的消息数限制。

可接受的值

[数字] 

一个设置问题分类中报告的最大消息数。默认值为 10。

report.setup.problems.display_limit

此设置指定在 HTML 报告的设置问题部分中显示的消息总数限制。

可接受的值

[数字] 

设置问题部分中报告的消息总数的最大数量。默认值为 100。

report.setup.problems.console

此设置指定是否在控制台中打印设置问题。

可接受的值

true默认。在控制台中打印设置问题。
false不在控制台中打印设置问题。

report.separate_vm.xmx

此设置指定生成报告应使用多少内存。 

可接受的值

[内存大小] 

为报告生成分配的最大内存量。默认为 120M。

report.separate_vm

此设置启用或禁用将报告作为单独的虚拟机生成。

可接受的值

true将报告作为单独的虚拟机生成。
false默认。禁用将报告作为单独的虚拟机生成。

report.separate_vm.launch.file

此设置指定在生成报告期间应使用的启动文件的路径。

可接受的值

[路径] 

启动文件的路径。

(info) 在 Windows 中指定文件路径时使用双反斜线。

report.test_params

此设置指定报告是否包括测试参数详细信息。 

可接受的值

true默认。报告中包括参数详细信息。
false报告中不包括参数详细信息。


report.xml.param{n}.key

此设置指定一个添加到 xml 报告根元素中的自定义参数 Id。必须为要添加的自定义参数指定 report.xml.param{n}.key 和 report.xml.param{n}.value。

可接受的值

[id]自定义参数的唯一 id。

用法示例

以下配置指定一个具有给定键和值的属性将被添加到 xml 报告的根元素中。

report.xml.param1.key=customId

report.xml.param1.value=12345

report.xml.param{n}.value

此设置指定一个添加到 xml 报告根元素中的自定义参数值。必须为要添加的自定义参数指定 report.xml.param{n}.key 和 report.xml.param{n}.value。

可接受的值

[值]自定义参数的值。

用法示例

以下配置指定一个具有给定键和值的属性将被添加到 xml 报告的根元素中。

report.xml.param1.key=customId

report.xml.param1.value=12345

session.tag

此设置指定用于对测试会话的结果进行签名的标签。此标签是对指定模块执行的特定分析过程的唯一标识符。不同测试会话的报告应使用不同的标签进行标记。

可以使用字符串和变量（请参阅使用变量）创建标签。

可接受的值

[标签名称]用于标识不同会话结果的唯一标签。默认为 ${scontrol_branch}-${exec_env}。

用法示例

默认会话标签包括指定了源码控制分支名称和执行环境的变量。例如，如果未配置源码控制集成，并且测试会话在 64 位 Windows 上执行，报告将会包含一个会话标签，可能类似于：${scontrol_branch}-win32_x86_64。

以下配置指定了非默认的标签：

session.tag=ut_win