ScalaMeta Metals 项目对 TestNG 测试框架支持的探索与实践

在 Java 生态系统中，TestNG 是一个广泛使用的测试框架，它提供了比 JUnit 更丰富的功能集。然而，当开发者尝试在 ScalaMeta Metals 项目中使用 TestNG 时，遇到了测试无法运行的问题。本文将深入探讨这一问题的根源以及解决方案。

问题背景

Metals 是 Scala 语言的 Language Server 实现，它为多种编辑器提供了丰富的功能支持，包括代码导航、自动补全以及测试运行等。在 Metals 1.3.5 版本中，用户发现无法通过编辑器运行 TestNG 测试，具体表现为：

1. 测试方法上没有显示代码透镜（Code Lenses）
2. 无法执行文件中的所有测试

技术分析

经过深入调查，发现问题根源在于 Metals 底层依赖的 Bloop 构建工具对 TestNG 框架的支持不完善。Bloop 需要通过特定的测试框架接口来识别和运行测试，而 TestNG 的适配器没有被正确配置。

解决方案探索

最初尝试使用 sbt-testng 适配器，但遇到了"Old frameworks are not supported"的错误提示。这表明 sbt-testng 的实现可能已经过时，不再兼容当前的 Bloop 版本。

最终解决方案是采用 mill-contrib-testng 作为替代方案。具体步骤如下：

1. 在项目依赖中添加 mill-contrib-testng 库
2. 手动修改 Bloop 配置文件，添加 TestNG 框架声明

具体实现

要使 TestNG 测试在 Metals 中正常工作，需要进行以下配置：

1. 在构建配置中添加 mill-contrib-testng 依赖，推荐版本为 1.0.0-RC2
2. 在项目的 .bloop 配置文件中添加框架声明

{
    "names": [
        "mill.testng.TestNGFramework"
    ]
}

效果验证

完成上述配置后，Metals 能够正确识别 TestNG 测试方法，并显示相应的代码透镜。用户可以通过点击这些透镜来运行单个测试，也可以通过命令运行文件中的所有测试。

技术启示

这一问题的解决过程展示了构建工具生态系统的复杂性。当遇到测试框架支持问题时，开发者可以：

1. 检查构建工具是否提供了对应的适配器接口
2. 尝试不同来源的适配器实现
3. 必要时手动修改构建配置

对于 Scala 和 Java 混合项目，特别是使用非标准测试框架的情况，这种调试思路具有普遍参考价值。

未来展望

随着 Metals 和 Bloop 的持续发展，期待未来能够提供更完善的 TestNG 原生支持，减少手动配置的需要。同时，这也提醒我们，在项目中使用非主流测试框架时，需要考虑工具链支持的完整性。