A Test Adapter for Visual Studio Code


Keywords
test, testing, vscode, haxe, unittest, vscode-extension
License
MIT
Install
haxelib install test-adapter 1.2.10

Documentation

Haxe Test Explorer for Visual Studio Code

CI Version Installs

A test adapter for VSCode using the Test Explorer UI extension.

VSCode Test Adapter for Haxe

Features

  • Records munit, utest, buddy, hexUnit, tink_unittest and haxe.unit test results as JSON files
  • Shows latest test results in VSCode using the Test Explorer UI extension
  • Supports filtering / running individual tests directly from VSCode
  • Supports Haxe 3.4.7 and 4+ (detection of test function line numbers only works with Haxe 4)
  • Currently only works for Node.js and sys targets

Usage

A small sample project for each supported framework can be found in the samples directory.

You can run your tests using the Test Explorer: Run all tests command or by clicking the button in the "Test" tab of the activity bar. The command that it runs can be configured with this setting:

"haxeTestExplorer.testCommand": [
	"${haxe}",
	"test.hxml",
	"-lib",
	"test-adapter"
]

As you can see, by default it assumes the presence of a test.hxml that compiles and runs the tests. Additionally, the test-adapter library is injected. It adds hooks to the different testing frameworks to record the test results in a .unittest folder in your workspace.

While the test-adapter library itself ships with the extension and is set up automatically, you still need to install a dependency:

haxelib install json2object

.unittest should be added to your .gitignore. You might also want to hide it from VSCode's file explorer by adding this to your global settings:

"files.exclude": {
	"**/.unittest": true
}

Debugging

It's also possible to debug tests using a launch configuration from launch.json. Which one should be used can be configured with this setting:

"haxeTestExplorer.launchConfiguration": "Debug"

Unlike with testCommand for running tests, -lib test-adapter can't be injected automatically for debugging. Add -lib test-adapter directly to your HXML file if you want results to be recorded / filtering to work while debugging.

Detection of test positions

Note that for munit, hexUnit and tink_unittest, the test-adapter library relies on a class name filter to detect the positions of tests. This simply defaults to ~/Test/ and is checked against the names of classes and implemented interfaces anywhere in the hierarchy of a class.

You can customize the filter with -D test-adapter-filter=<filter>. Check .unittest/positions.json to see what positions were recorded.

For utest, test detection only works when utest.ITest is implemented / utest.TestCase is extended. If this is not the case, utest will print a warning.

Build from sources

cd ~/.vscode/extensions
git clone https://github.com/vshaxe/haxe-test-adapter
cd haxe-test-adapter
npm install
npx haxe build.hxml

haxelib dev test-adapter test-adapter

It's also necessary to have the Test Explorer UI extension installed (when installing Haxe Test Explorer from the markteplace, this is done automatically).

If you open the project in VSCode, the default display.hxml assumes you have all supported test frameworks installed. If you just want code completion for the sources of the extension itself, or the non-framework-specific parts of test-adapter, you can select build.hxml as your active Haxe configuration instead.