Jenkins JaCoCo插件查看Scala代码覆盖时提示源文件读取错误求助

我之前在Scala项目里也碰到过几乎一模一样的情况，结合sbt-jacoco和Jenkins JaCoCo插件的搭配场景，给你几个实用的排查方向：

1. 先核对源代码路径的匹配度 #

Jenkins JaCoCo插件要找到具体代码行，必须让报告里记录的源文件路径和Jenkins工作区里的实际路径完全匹配。

• 先在本地运行sbt jacoco生成报告，打开target/jacoco/report/html里的任意源文件链接，看看路径格式（比如是src/main/scala/com/example/MyClass.scala这种相对路径）。
• 再登录Jenkins服务器，查看对应job工作区里的源代码实际路径，确保两者的层级完全一致。比如如果Jenkins把代码拉到了workspace/my-project/src/...，而报告里的路径是src/...，那插件就能找到；但如果Jenkins工作区里代码直接在workspace/src/...（少了项目目录层），就会触发找不到文件的错误。

2. 验证sbt-jacoco的源代码路径配置 #

sbt-jacoco默认会自动识别Scala的源代码目录，但自定义配置可能会搞乱路径记录：

• 在本地sbt控制台运行show jacocoSourceDirectories，检查输出的路径是否包含你所有的源代码目录（比如src/main/scala、src/test/scala）。
• 如果之前自定义过这个配置，别用:=直接覆盖，要用+=追加路径，比如错误写法：

  jacocoSourceDirectories := Seq(baseDirectory.value / "src" / "main" / "scala")
  

  这种会丢失默认的测试代码路径，应该改成：

  jacocoSourceDirectories += baseDirectory.value / "src" / "main" / "scala"
  

3. 检查JaCoCo版本兼容性 #

sbt-jacoco和Jenkins JaCoCo插件背后依赖的JaCoCo核心版本必须尽量匹配：

• sbt-jacoco 3.0.3对应的JaCoCo核心版本是0.8.8，而Jenkins JaCoCo Plugin 3.0.1对应的核心版本是0.8.7，版本差一点可能导致报告解析时的路径格式不兼容。
• 可以尝试把Jenkins JaCoCo插件升级到3.3.0+（对应JaCoCo 0.8.8），或者降级sbt-jacoco到2.6.0（对应JaCoCo 0.8.7），让两边的核心版本对齐。

4. 确认Jenkins工作区的源代码完整性 #

有时候Jenkins的构建步骤会意外删除源代码：

• 查看Jenkins job的工作区，确认src/main/scala等目录下的源文件都完整存在，没有被clean步骤或者自定义脚本误删。
• 如果用Pipeline，检查clean步骤是不是放在了jacoco报告生成之后，或者有没有其他步骤修改/删除了源代码目录。

5. 排查编码格式问题 #

虽然概率不高，但编码不匹配也可能导致文件读取失败：

• 确保本地和Jenkins服务器上的源代码都是UTF-8编码（Scala项目的推荐编码），在sbt里添加配置：

  scalacOptions ++= Seq("-encoding", "UTF-8")
  

• 同时在Jenkins全局配置里把默认编码设置为UTF-8。

内容的提问来源于stack exchange，提问作者Sagnik Kundu