AVA Test Adapter for Visual Studio Code

Implements an AVA Test Adapter for VSCode Test Explorer.

Getting Started

Install the extension
Restart VS Code and open the Test view
Run / Debug your tests using Test Explorer

The extension is intended to use the same AVA installation as the project. If it cannot find AVA, install it locally for the project(s).

Features

Shows a Test Explorer in the Test sidebar with all detected tests and suites and their state
Shows a failed test's log when the test is selected in the explorer
Lets you choose test suites or individual tests in the explorer that should be rerun on file change
Debug your tests easily from the Test Explorer sidebar.

Limitations

Still in early development.
Does not collect details on why a test failed, yet.
Does not display log or console output from tests, yet.
AVA does not provide the location of tests for the Test Explorer CodeLens.

In order to avoid having AVA preprocess test files frequently, it is recommended that caching be enabled in your AVA configuration.

Configuration Options

Property	Description	Default
`avaExplorer.cwd`	The working directory for AVA relative to the workspace.	The workspace folder.
`avaExplorer.configs`	Array of configurations, see Sub-Configurations.	`[{}]`
`avaExplorer.env`	Environment variables for the background worker.	`{}`
`avaExplorer.serialRuns`	If true then only one test or debug session will occur at a time.	`false`
`avaExplorer.nodePath`	The path to the Node executable to use.	Searches PATH or VSCode's installation
`avaExplorer.nodeArgv`	The arguments to the Node executable
`avaExplorer.debuggerPort`	The port for running the debug sessions	9229
`avaExplorer.debuggerSkipFiles`	An array of glob patterns for files to skip when debugging	`[]`
`avaExplorer.workerTimeout`	How long to wait for the worker process to connect in milliseconds.	10000
`avaExplorer.logpanel`	If `true` writes a diagnostic log to AVA Explorer Log	`false`
`avaExplorer.logfile`	A file to write diagnostics to	`undefined`

Sub-Configurations

Property	Description	Default
`file`	The configuration file relative to `avaExplorer.cwd`.	`ava.config.js`
`serial`	If `true` then test will be run serially.	`false`
`debuggerSkipFiles`	An array of glob patterns for files to skip when debugging	`[]`

Configuration Notes

avaExplorer.cwd should contain the projects local Node modules.
AVA will expect avaExplorer.cwd to contain the project's 'package.json'.
The config file will default to 'ava.config.js' if such a file exist in avaExplorer.cwd.
avaExplorer.configs can currently only have one configuration.
avaExplorer.env will be the base environment for tests if not overwritten in their config file.
avaExplorer.debuggerSkipFiles is prepended to the configuration specific debuggerSkipFiles.
avaExplorer.logpanel and avaExplorer.logfile are for troubleshooting the plugin.

Please be aware that AVA overrides the settings from the configuration file with those from 'package.json'. AVA also always attempts to load a configuration file, defaulting to 'ava.config.js'. The extension mimics both behaviors.

TypeScript Support

It is recommended that TS files be precompiled or the AVA configuration setup to use 'ts-node' to compile them.

See how in the AVA documentation.

You can also install 'ts-node' and set avaExplorer.nodeArgv to ["-r", "ts-node/register"]. This will register 'ts-node' with the Node interpreter before running the tests.

Support

Node Support

The extension mainly aims to support Node LTS versions 12 and above. Issues with Node 10 may be addressed, depending on the nature of the issue.

AVA Support

The extension currently tested against these AVA versions:

2.2.0
2.3.0
2.4.0

Please try these versions before reporting issue. For issues newer versions, please submit an issue to the incompatibility can be addressed in a patch.

VSCode Support

The extension is tested against the latest stable release of VSCode.

Debugging

The extension's worker process can be debugged from VSCode. First add a launch configuration like the following in your '.vscode/launch.json':

{
    [
        // your other entries
		{
			"type": "node",
			"request": "attach",
			"protocol": "inspector",
			"sourceMaps": true, // source maps are provided in the installation
			"name": "Worker", // replace with name of choice
			"stopOnEntry": true,
			"skipFiles": [],
			"showAsyncStacks": true,
			"port": 9229 // replace with port number of choice
		}
    ]
}

It is important that avaExplorer.workerTimeout is set so that you have time to begin debugging. Otherwise, the worker will be killed once the timeout has passed without a connection.

Finally, add "--inspect-brk=<port#>" to avaExplorer.nodeArgv. Changing avaExplorer.nodeArgv should cause a new worker process to be spawned. Then connect the debugger using your launch configuration.

It is recommended that you remove "--inspect-brk=<port#>" from avaExplorer.nodeArgv when finished. Otherwise, you may forget about it and be suprised when the worker does not connect.

Developers

Adam Armstrong

License

The project's code is under the ISC license, see the LICENSE file for details.

It is also included in files along side the source code.

AVA Test Explorer

James Adam Armstrong