JUnit Interface 技术文档

1. 安装指南

依赖添加

要在 sbt 项目中使用 JUnit Interface，首先需要在 build.sbt 文件中添加以下依赖：

libraryDependencies += "com.github.sbt" % "junit-interface" % "0.13.2" % Test

注意：从版本 0.12 开始，组织名称已更改为 "com.github.sbt"。

JUnit 本身会作为传递依赖自动引入。

版本对应关系

junit-interface 版本	JUnit 版本
0.13.2	4.13.2
0.13.1	4.13.1
0.13	4.13
0.12	4.12

sbt 已经内置了对 junit-interface 的支持，因此只需添加依赖即可，无需将其添加到测试框架列表中。

2. 项目的使用说明

运行测试

在 sbt shell 中，可以通过以下命令运行 JUnit 测试：

> test

增量测试

要增量运行测试，并且只运行上次运行失败的测试，可以使用 testQuick 命令：

> testQuick

运行特定测试套件

要运行特定的测试套件，可以使用 testOnly 命令，并指定类名或使用通配符：

> testOnly example.HelloTest

或者使用通配符：

> testOnly *.HelloTest

运行特定测试方法

要运行特定测试方法，可以在 testOnly 命令后添加 -- 并指定测试方法名：

> testOnly -- example.HelloTest.testSuccess1

也可以使用通配符：

> testOnly -- *.HelloTest.testI*

详细输出

要获取详细的测试输出，可以使用 -v 选项：

> testOnly -- -v

3. 项目API使用文档

支持的选项

以下是 JUnit 测试支持的选项及其描述：

选项	描述
-v	等同于 --verbosity=2
-q	抑制成功测试的标准输出，标准错误输出正常打印。
-n	即使 sbt 支持 ANSI 颜色，也不使用 ANSI 颜色。
-s	尝试解码堆栈跟踪和测试名称中的 Scala 名称。
-a	显示 AssertionErrors 的堆栈跟踪和异常类名。
-c	不打印异常类名前缀，仅显示 getMessage() 的结果和堆栈跟踪。
+v	等同于 --verbosity=0
+q	关闭 -q，优先于 -q。
+n	关闭 -n，优先于 -n。
+s	关闭 -s，优先于 -s。
+a	关闭 -a，优先于 -a。
+c	关闭 -c，优先于 -c。
--ignore-runners=<COMMA-SEPARATED-STRINGS>	忽略带有 @RunWith 注解的测试，如果 Runner 类名在此列表中。
--tests=<REGEXPS>	仅运行名称匹配指定正则表达式的测试。
-Dkey=value	临时设置系统属性，测试结束后恢复原值。
--run-listener=<CLASS_NAME>	用户定义的类，扩展 org.junit.runner.notification.RunListener。
--include-categories=<CLASSES>	包含的类别类名列表，仅运行这些类别的测试。
--exclude-categories=<CLASSES>	排除的类别类名列表，不运行这些类别的测试。
--verbosity=<INT>	设置详细级别，0 为默认，1 为 "Test run finished"，2 为更多信息。
--summary=<INT>	设置测试任务执行的摘要类型，0 为默认，1 为单行，2 为包含失败测试列表。

设置默认选项

可以在 build.sbt 文件中设置默认选项：

testOptions += Tests.Argument(TestFrameworks.JUnit, "-q", "-v")

4. 项目安装方式

通过 sbt 安装

1. 在 build.sbt 文件中添加依赖：

   libraryDependencies += "com.github.sbt" % "junit-interface" % "0.13.2" % Test
   

2. 在 sbt shell 中运行 reload 命令以加载新的依赖。

3. 使用 test 或 testOnly 命令运行 JUnit 测试。

通过插件安装（可选）

如果需要更高级的功能，可以考虑使用 sbt-jupiter-interface 插件来支持 JUnit 5。

通过以上步骤，您可以顺利地在 sbt 项目中使用 JUnit Interface 进行测试。