Java Test Runner

Run and debug Java test cases in Visual Studio Code

Overview

A lightweight extension to run and debug Java test cases in Visual Studio Code. The extension support following test frameworks:

• JUnit 4 (v4.8.0+)
• JUnit 5 (v5.1.0+)
• TestNG (v6.8.0+)

Note: JUnit 3 styled tests are not supported in this extension (i.e. extends junit.framework.TestCase).

The Java Test Runner works with Language Support for Java by Red Hat and Debugger for Java to provide the following features:

• Run/Debug test cases
• Customize test configurations
• View test report
• View tests in Test Explorer
• Show test logs

Requirements

• JDK (version 11 or later)
• VS Code (version 1.44.0 or later)
• Language Support for Java by Red Hat
• Debugger for Java

Quickstart

Getting Started for JUnit 5

Please refer to Getting Started from the JUnit 5's official document for getting started guide.

Note: You can use junit-platform-console-standalone.jar in projects that manually manage their dependencies similar to the plain-old JAR known from JUnit 4.

Getting Started for JUnit 4

Please refer to Download and Install from the JUnit 4's official document for the getting started guide.

Getting Started for TestNG

Please refer to TestNG Docs from the TestNG's official document for getting started guide.

Features

Run/Debug Test Cases

• The extension will generate Run Test and Debug Test shortcuts (also known as Code Lens) above the class and method definition. Simply click on them will start running or debugging the target test cases.

Note: If you cannot see the Code Lens in your editor, please refer to this issue comment as a workaround.

---

Test Explorer

• The Test Explorer is the place to show all the test cases in your project. You can also run/debug your test cases from here.
• Click the node in the Test Explorer will navigate to the location of the source code.

Note: If the Test Explorer is empty, please refer to this issue comment as a workaround.

---

Customize Test Configurations

• Sometimes you may want to customize the configuration for running the test cases. To achieve this, you can add it into your workspace settings under the section: java.test.config.

Note: More details can be found here.

---

View Test Report

• After running/debugging the test cases, the status bar will show the final results. Simply click on it to show the Test Report.
• You can also click the ✔️ or ❌ mark in Code Lens to open the Test Report.

• You can navigate to the source location of the target test case by clicking the navigate button.

Note: You can use java.test.report.showAfterExecution to configure whether to automatically show the test report after execution. By default, it will be shown when there are failed tests.

Settings

Setting Name	Description	Default Value
java.test.report.position	Specify where to show the test report. Supported values are: sideView, currentView.	sideView
java.test.report.showAfterExecution	Specify if the test report will automatically be shown after execution. Supported values are: always, onFailure, never.	onFailure
java.test.editor.enableShortcuts	Specify whether to show the Code Lenses in editor or not.	true
java.test.log.level	Specify the level of the test logs. Supported values are: error, info, verbose.	info
java.test.config	Specify the configuration for the test cases to run with. More details.	{}
java.test.defaultConfig	Specify the name of the default test configuration.	""

FAQ

If you meet any problem when using the extension, please refer to the FAQ to check if there is an answer to your problem.

Contributing and Feedback

If you are interested in providing feedback or contributing directly to the code base, please check the document Contributing to Java Test Runner, which covers the following parts:

• Questions and Feedback
• Reporting Issues
• Contributing Fixes

License

This extension is licensed under MIT License.

Telemetry

This extension collects telemetry data to help improve our products. Please read Microsoft privacy statement to learn more. If you opt out to send telemetry data to Microsoft, please set below configuration in settings.json: telemetry.enableTelemetry = false. Learn more in our FAQ.