本文档的内容是由机器翻译的。请通过反馈微件提交您的反馈。
 

JaCoCo

最后修改日期： 2025年 3月 21日

TeamCity 支持 JaCoCo ，这是一种 Java 代码覆盖工具，让您可以衡量一组广泛的覆盖指标和代码复杂性。

JaCoCo 可用于以下构建运行程序： Ant、 IntelliJ IDEA Project、 Gradle 和 Maven。

tip

为了确保正确收集覆盖率数据，请确保您的测试在一个或多个单独的 JVM 中运行。

启用 JaCoco 覆盖率

TeamCity 支持 Java 代理覆盖模式，让您可以在不修改构建脚本或二进制文件的情况下收集覆盖率。 无需额外的构建步骤 — 只需在运行测试的构建步骤中选择 JaCoCo 覆盖率：

  1. 在 Code Coverage（代码覆盖率） 部分中，在 选择覆盖率运行程序 下拉菜单中选择 JaCoCo 作为覆盖工具。

  2. 设置覆盖率选项 — 请参考下述的可用选项描述。

note

请注意，此运行程序当前不支持为 Android 项目配置的自动 JaCoCo 覆盖。
要在 Android 项目中提供 JaCoCo 覆盖，构建脚本应生成 .exec 文件，并按照在 此节中描述的方式导入它们。

选项

描述

示例

类文件目录或jar包

以 +|-:[路径] 的形式，相对于 检出目录 的路径模式的换行符分隔的集合，用于扫描需要分析的类文件。 除非需要它们的覆盖率，否则不必列出库和测试类文件。

tip

这里， pipe符号 | 表示 或 命令，如正则表达式中：使用 + 包含，使用 或- 排除。

+:target/main/java/**

需要进行插桩的类

以 +|-:[路径] 形式的类名模式的换行符分隔的集合。 允许筛选出列在 "类文件目录或jar包 " 字段中的不需要的类。 在测试类编译的情况下非常有用。

+:com.package.core.*

-:com.package.*Test*

tip

在默认情况下，TeamCity 中的 jacoco.sources 属性被设置为 . ，这意味着 TeamCity 将扫描包含所有子目录在内的整个检出目录以获取您的源代码。
请检查您的类文件是否已经以包含源文件信息的调试信息编译，以便在报告中查看带有高亮显示的源代码。

代码覆盖率结果可以在 概述 选项卡的 构建结果 页面上查看；详细报告显示在专用的 Code Coverage（代码覆盖率） 选项卡上。

将 JaCoCo 覆盖率数据导入到 TeamCity

TeamCity 可以解析 JaCoCo 覆盖数据，并使用以下格式的 服务消息 生成报告：

##teamcity[jacocoReport dataPath='<path to jacoco.exec file>']

TeamCity 将使用默认的 JaCoCo 版本来解析导入的数据。 请注意，如果导入的覆盖率由不同的次版本（X.X.X 中的第二个数字）生成，TeamCity 将无法处理其类文件并收集覆盖率。 为防止这种情况，请确保在 管理 | 工具 | JaCoCo 覆盖率 中选择的默认版本与您要导入的覆盖率的工具版本相对应。
或者，您可以直接在服务消息正文中指定所需的工具版本： ##teamcity[jacocoReport dataPath='coverage_data/jacoco.exec' includes='*' classpath='+:build/classes/java/main/**' toolVersion='X.X.X']。 确保指定的版本已在 TeamCity 服务器上安装。

特性

描述

默认值

示例

dataPath

相对于检出目录的空格分隔的路径集，用于读取 jacoco 数据文件

jacocoResults/jacoco.exec jacocoResults/anotherJacocoRun.exec

包含

以空格分隔的类名包含模式集

*

com.package.core.* com.package.api.*

排除

由空格分隔的类名排除模式集合

com.package.test.* .*Test

源

相对于检出目录的，由空格分隔的路径集，用于读取来源。 默认无需列出。

.

src

classpath

空格分隔的路径模式集，以 +|-:[路径] 的形式扫描要分析的类文件。 除非需要获取其覆盖率，否则不需要列出库和测试类文件。

+:**/*

+:target/main/java/**

reportDir

存储临时文件的目录路径。 报告将在此目录下以覆盖率 .zip 的形式生成。 请检查是否有与此同名的现有目录。

Agent 的临时目录下的一个随机目录

jacocoReport

tip

使用 \ （反斜杠）来转义路径中的空格字符。

一个完整服务消息的示例：

##teamcity[jacocoReport dataPath='jacoco.exec' includes='com.package.core.*' classpath='classes/lib/some.jar' reportDir='temp/jacocoReport']