现已发布!阅读关于 11 月份的新功能和修复。

使用 Visual Studio Code 进行 Java 测试

在 Visual Studio Code 中进行 Java 测试由 Java 测试运行器扩展启用。它是一个轻量级扩展,用于运行和调试 Java 测试用例。

概述

该扩展支持以下测试框架

Java 测试运行器Red Hat 的 Java™ 语言支持Java 调试器扩展一起工作,以提供以下功能

  • 运行/调试测试用例
  • 自定义测试配置
  • 查看测试报告
  • 在测试资源管理器中查看测试

要求

  • JDK(1.8 或更高版本)
  • Visual Studio Code(1.59.0 或更高版本)
  • Java 扩展包

安装 Java 扩展包

项目设置

注意:如果你的项目中已经设置了 Java 测试框架,则可以跳到功能部分。

启用测试并将测试框架 JAR 添加到你的项目

从 Java 测试运行器 0.34.0 版本开始,你可以通过在测试资源管理器中执行几个步骤,为你的非托管文件夹项目(没有任何构建工具的项目)启用测试框架

注意:目前,此功能仅支持不包含任何测试依赖项的非托管文件夹。

JUnit 4

Maven

将以下配置添加到你的 pom.xml

<dependency>
  <groupId>junit</groupId>
  <artifactId>junit</artifactId>
  <version>(YOUR_JUNIT_VERSION)</version>
  <scope>test</scope>
</dependency>

Gradle

确保在你的 build.gradle 中添加以下行

plugins {
    java
}

dependencies {
    testImplementation('junit:junit:(YOUR_JUNIT_VERSION)')
}

非托管文件夹

如果你的项目不使用任何构建工具,你可以通过测试资源管理器启用 JUnit 4,或者手动下载以下 JAR 并将它们添加到项目类路径中(通过设置 java.project.referencedLibraries,有关更多信息,请查看依赖项管理

你可以查看官方 JUnit Wiki,了解有关如何设置 JUnit 4 的更多信息。

JUnit 5

JUnit 5 团队提供了一系列带有不同构建工具的示例项目。如果你的项目使用 Maven 或 Gradle 作为你的构建工具,请查看 junit5-sample 存储库

非托管文件夹

如果你的项目不使用任何构建工具,你可以通过测试资源管理器启用 JUnit 5,或者手动在项目类路径中包含 junit-platform-console-standalone JAR(通过设置 java.project.referencedLibraries,有关更多信息,请查看依赖项管理)。

TestNG

Maven

将以下配置添加到你的 pom.xml

<dependency>
  <groupId>org.testng</groupId>
  <artifactId>testng</artifactId>
  <version>(YOUR_TESTNG_VERSION)</version>
  <scope>test</scope>
</dependency>

Gradle

确保在你的 build.gradle 中添加以下行

plugins {
    java
}

dependencies {
    testImplementation('org.testng:testng:(YOUR_TESTNG_VERSION)')
}

非托管文件夹

如果你的项目不使用任何构建工具,你可以通过测试资源管理器启用 TestNG,或者手动下载以下 JAR 并将它们添加到项目类路径中(通过设置 java.project.referencedLibraries,有关更多信息,请查看依赖项管理

功能

运行/调试测试用例

Java 测试运行器扩展将在类和方法定义的左侧生成快捷方式(绿色播放按钮)。要运行目标测试用例,请选择绿色播放按钮。你也可以右键单击它以查看更多选项。

测试资源管理器

测试资源管理器是一个树视图,用于显示你的工作区中的所有测试用例。你可以选择 Visual Studio Code 左侧活动栏上的烧杯按钮来打开它。你也可以从那里运行/调试你的测试用例并查看它们的测试结果。

自定义测试配置

有时你可能需要自定义配置以运行你的测试用例。要实现这一点,你可以将配置添加到你的工作区设置中的以下部分:java.test.config

Customize test configurations

目前支持的配置有

  • args:指定将传递给测试运行器的命令行参数。
  • classPaths:在此设置中定义的类路径将附加到已解析的类路径中。
  • env:通过键值对象指定运行测试时的额外环境变量。
  • envFile:指定包含环境变量定义的文件的绝对路径。
  • modulePaths:在此设置中定义的模块路径将附加到已解析的模块路径中。
  • name:指定配置项的名称。你可以通过设置 java.test.defaultConfig 来设置默认配置名称。
  • preLaunchTask:指定在 tasks.json(在工作区的 .vscode 文件夹中)中指定的任务的标签。该任务将在测试开始之前启动。
  • sourcePaths:指定调试测试时额外的源路径。
  • vmArgs:指定 JVM 的额外选项和系统属性。
  • workingDirectory:指定运行测试时的工作目录。
  • testKind:指定此测试配置的目标测试框架。支持的值为 junittestng
  • filters:指定测试筛选器。
    • tags:指定要包含或排除的标记。以 ! 作为前缀的标记将被排除。注意:此设置仅在 testKind 设置为 junit 时生效

更多详细信息可以在 vscode-java-test Wiki 上找到。

查看测试结果

在运行/调试测试用例后,相关测试项的状态将在编辑器装饰和测试资源管理器中更新。

您可以触发命令 测试: 查看输出 来查看结果视图。您可以选择堆栈跟踪中的链接以导航到源代码位置。

生成测试

该扩展提供了帮助您搭建测试用例的功能。您可以在编辑器上下文菜单中找到入口。选择 源操作...,然后选择 生成测试...

如果您从主源代码(测试对象)触发此源操作,系统将询问您测试类的完全限定名称以及您要测试的方法。然后,该扩展将为您生成测试代码。

如果您从测试源代码触发此源操作,系统将询问您要添加哪种类型的测试方法。包括生命周期方法和测试方法。

测试导航

该扩展提供了帮助您在测试和测试对象之间导航的功能。如果您的源代码包含在 src/main/javasrc/test/java 中,您可以在编辑器上下文菜单中找到名为 转到测试转到测试对象 的入口。

您也可以在命令面板中找到该命令(⇧⌘P (Windows, Linux Ctrl+Shift+P)),方法是搜索 Java: 转到测试

VS Code 测试命令

还有其他测试命令(例如,在当前文件中运行测试),可以通过在命令面板中搜索“Test:”找到(⇧⌘P (Windows, Linux Ctrl+Shift+P))。

Testing commands in the Command Palette

VS Code 测试设置

有一些特定于测试的 VS Code 设置,可以通过在设置编辑器中搜索“testing”找到(⌘, (Windows, Linux Ctrl+,))。

Testing settings in the Settings editor

常见问题

如果您在使用扩展时遇到任何问题,您可以查看 FAQ 和我们的 问题列表,以检查是否有针对您问题的答案。

贡献和反馈

如果您有兴趣提供反馈或直接为代码库做出贡献,请阅读 为 Java 测试运行器贡献,其中涵盖以下内容

后续步骤

继续阅读以了解

  • 调试 - 了解如何使用 VS Code 调试您的 Java 项目。
  • Java 扩展 - 了解更多有用的 VS Code Java 扩展。