/vscode-test-explorer

The VS Code Test Explorer extension

Primary LanguageTypeScriptMIT LicenseMIT

Test Explorer for Visual Studio Code

This extension provides an extensible user interface for running your tests in VS Code. It can be used with any testing framework if there is a corresponding Test Adapter extension.

Other extensions can get full access to the Test Adapters by acting as Test Controllers.

The Test Explorer can also be used in VS Live Share sessions by installing the Test Explorer Live Share extension.

This extension will be automatically installed when you install one of the Test Adapters, so there is usually no need to install this extension manually.

Test Adapters

Currently the following Test Adapters are available:

Javascript

C

C++

Haxe

Python

PHP

Ruby

Rust

.NET Framework

Z80 Assembler

Live Share

  • The Test Explorer Live Share extension creates Test Adapters in Live Share guests that act as proxies for the Test Adapters in the Live Share host.

If there is no Test Adapter for your favorite testing framework yet, you can easily create your own.

Test Controllers

Currently the following Test Controllers are available:

  • The Test Explorer UI (which is the main part of this extension) is itself implemented as a Test Controller
  • The Test Explorer Status Bar extension provides information about the current test suite in the Status Bar.
  • The Test Explorer Live Share extension creates Test Controllers in the Live Share host that act as proxies for the Test Explorers in the Live Share guests.

Do you have a new idea for interacting with the Test Adapters? You can easily get full access to all Test Adapters in your own extension by implementing your own controller.

Configuration

The following configuration properties are available:

Property Description
testExplorer.onStart Retire or reset all test states whenever a test run is started
testExplorer.onReload Retire or reset all test states whenever the test tree is reloaded
testExplorer.codeLens Show a CodeLens above each test or suite for running or debugging the tests
testExplorer.gutterDecoration Show the state of each test in the editor using Gutter Decorations
testExplorer.errorDecoration Show error messages from test failures as decorations in the editor
testExplorer.errorDecorationHover Provide hover messages for the error decorations in the editor
testExplorer.sort Sort the tests and suites by label or location. If this is not set (or set to null), they will be shown in the order that they were received from the adapter
testExplorer.showCollapseButton Show a button for collapsing the nodes of the test tree
testExplorer.showExpandButton Show a button for expanding the top nodes of the test tree, recursively for the given number of levels
testExplorer.showOnRun Switch to the Test Explorer view whenever a test run is started
testExplorer.addToEditorContextMenu Add menu items for running and debugging the tests in the current file to the editor context menu
testExplorer.mergeSuites Merge suites with the same label and parent
testExplorer.hideEmptyLog Hide the output channel used to show a test's log when the user clicks on a test whose log is empty

Further configuration options are provided by the Test Adapters.

Commands

The following commands are available in VS Code's command palette, use the ID to add them to your keyboard shortcuts:

ID Command
test-explorer.reload Reload tests
test-explorer.run-all Run all tests
test-explorer.run-file Run tests in current file
test-explorer.run-test-at-cursor Run the test at the current cursor position
test-explorer.rerun Repeat the last test run
test-explorer.debug-test-at-cursor Debug the test at the current cursor position
test-explorer.redebug Repeat the last test run in the debugger
test-explorer.cancel Cancel running tests