尝试以扩展 VS Code 中的代理模式!

在 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 扩展包

安装 Extension Pack for 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 测试命令

其他测试命令(例如,运行当前文件中的测试)可以在命令面板中找到,通过搜索“测试:”(⇧⌘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

常见问题

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

贡献和反馈

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

后续步骤

继续阅读以了解:

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