ABLUnit Test Runner

The ABLUnit Test Runner VSCode extension integrates ABLUnit tests into the VSCode test explorer.

This is my first VSCode extension, and my first TypeScript project. I'm sure there are many ways to improve the code, and I welcome any feedback. I'm also open to collaboration for anyone who might wish to contribute.

Quality code, and thus unit testing, is my passion I hope this extension helps others to embrace TDD and improve their code.

OpenEdge Versions Note

This project was developed using the Progress OpenEdge Developers Kit: Classroom Edition. That means it's only been tested against version 12.2 at the moment. Feel free to report any bugs you may run into with other versions.

Extension

Features

Run ABLUnit Tests
See test results in VSCode Test Explorer
View code coverage highlighting in the editor

Code Coverage Example Screenshot

code coverage example screenshot

Configuration

The configuration is broken into two sections.

The first section shows configuration options that users are most likely to change.
Additional configuration options available that are not likely to be change by most users.

Configuration - Sample Config

This config searches the test/ directory for test files, named *Test.cls or *Test.p. It also passes a database connection to _progres via the -pf parameter.

.vscode/settings.json:

{
  "ablunit.files.include": [
    "test/**/*Test.{cls,p}"
  ],
  "ablunit.params": "-pf path/to/dbconnections.pf"
}

Configuration - Most Commonly Changed

Setting	Default	Description
`ablunit.params`		Additional options/parameters passed to `_progres`. This is most useful for providing database connections. Example: `-pf path/to/dbconnections.pf`
`ablunit.files.include`	`[ "*/.{cls,p}" ]`	Glob pattern array to include test files
`ablunit.files.exclude`	`[ "/.builder/" ]`	Glob pattern array to exclude test files
`ablunit.findAllFilesAtStartup`	`true`	Search all workspace files for test cases. It may be beneficial to disable this for large workspaces, in which case the extension will find tests as files are accessed.
`ablunit.notificationsEnabled`	`true`	Enable/disable notifications
`ablunit.tempDir`	Extension storage area	Any files generated when running ABLUnit will be stored here. It is also used for the `-T` startup parameter

Configuration - Additional Options

Setting	Default	Description
`ablunit.display.classLabel`	`classname`	`[ "classname" \\| "filename" ]`
`ablunit.importOpenedgeProjectJson`	`true`	Import settings from `openedge-project.json`
`ablunit.progressIniPath`		Path to a `progress.ini` file. Exclusive to Windows.
`ablunit.tests.command`	`_progres -b -p ABLUnitCore.p <...>`	This setting can be used to run tests with any existing shell command your tests are configured to run with. Example: `ant test`
`ablunit.tests.task`		Use this task to run tests via VSCode
`ablunit.configJson.configPath`	`ablunit.json`
`ablunit.configJson.outputLocation`	`results.xml`	Output location for the xml generated by ABLUnit. Typically used with `ablunit.tests.command`
`ablunit.configJson.outputWriteJson`	`false`	Output `results.json` version of `results.xml` after analysis
`ablunit.configJson.quitOnEnd`	`true`	Quit the session when the test run is complete
`ablunit.configJson.writeLog`	`true`	If `writeLog` is true then a log file, `ablunit.log` is created in the current working directory and writes error messages to that log file
`ablunit.configJson.showErrorMessage`	`true`	If `showErrorMessage` is set to true then the error messages is displayed in a new window
`ablunit.configJson.throwError`	`true`	If ABLUnit is used as a library inside another program, set `throwError` to true, the framework displays the errors occurred
`ablunit.profilerOptions.optionsPath`	`profile.options`	See the `-profile` startup parameter
`ablunit.profilerOptions.enabled`	`true`	Enable the profiler See the `PROFILER:ENABLED` attribute
`ablunit.profilerOptions.description`	`Unit Tests Run via ABLUnit Test Runner (VSCode)`	Description assigned to the profiler output See the `PROFILER:DESCRIPTION` attribute
`ablunit.profilerOptions.filename`	`prof.out`	Location of the profiler results (`-outfile <outfile>`) See the `PROFILER:FILE-NAME` attribute
`ablunit.profilerOptions.listings`		Flag to output debug listings (`-listings`) When unset (default value) no listings will be output. When set to `"true"` listings will be output to the `${config:ablunit.tempDir}/listings` directory. See the `PROFILER:LISTINGS` attribute See the `PROFILER:DIRECTORY` attribute
`ablunit.profilerOptions.directory`		The directory to which the listings files are written (`-directory <dirname>`) When set to blank or not set the `${config:ablunit.tempDir}/listings` diretory will be used.
`ablunit.profilerOptions.statistics`	`false`	Flag to output statistics (`-statistics`) See the `PROFILER:STATISTICS` attribute
`ablunit.profilerOptions.traceFilter`		Comma-separated string that uses wildcard matching for any procedure or class you want trace (`-trace-filter <string>`) See the `PROFILER:TRACE-FILTER` attribute
`ablunit.profilerOptions.tracing`		Comma-separated string of procedure and line number pairs. A pipe (`\\|`) separates the procedure name and line number (`-tracing <string>`) Example: `test1\\|32,test2\\|17` See the `PROFILER:TRACING` attribute
`ablunit.profilerOptions.writeJson`	`false`	Output a json formatted version of the profiler output. Filepath is the same as `abluint.profilerOptions.filename` with `json` extension.

Contributing

See CONTRIBUTING.md

ABLUnit Test Runner

Ken Herring

ABLUnit Test Runner

OpenEdge Versions Note

Extension

Features

Code Coverage Example Screenshot

Configuration

Configuration - Sample Config

Configuration - Most Commonly Changed

Configuration - Additional Options

Contributing

Links