ABLUnit Test Runner 🏃‍♂️🏃🏃‍♀️

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

🌴 Features

Execute ABLUnit tests from the VSCode Test Explorer View
Display test results in the VSCode Test Results View
Color coded line coverage highlighting in the editor

📷 Code Coverage Screenshot

code coverage example screenshot

📝 Supported OpenEdge Versions

This project was developed using the Progress OpenEdge Developers Kit: Classroom Edition. It was primarily tested with 12.8.0, but the unit tests are run for 12.2 and 12.8.4 during the CI builds too.

⛺ Configuration

Configuration is optional. Many workspaces will work without any configuration. However, there are advanced options available via the VSCode settings and a test profile configuration file (.vscode/ablunit-test-profile.json).

📐 Settings Configuration

The settings config allows for a few global options, described in more detail below. This example shows a test file glob pattern and another with a path to a dbconnections .pf file. The ablunit.files.include setting is required for the extension to find tests.

.vscode/settings.json with include and exclude patterns:

{
  "ablunit.files.include": [
    "test/**/*Test.{cls,p}"
  ],
  "ablunit.files.exclude": [
    "src/sandbox/**"
  ]
}

.vscode/settings.json with dbconnections .pf file:

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

The following table gives a brief description of the available settings via the UI or settings.json files.

Setting	Default	Description
`ablunit.discoverAllTestsOnActivate`	`true`	Search all workspace files for tests on extension activation. It may be beneficial to disable this for large workspaces, in which case the extension will find tests as files are accessed.
`ablunit.files.include`	`[ "*/.{cls,p}" ]`	Glob pattern array matching test files.
`ablunit.files.exclude`	`[ "/.builder/", "/.pct/ ]`	Glob pattern array to exclude test files.
`ablunit.importOpenedgeProjectJson`	`true`	Import configuration settings from `openedge-project.json` when possible.
`ablunit.test.classlabel`	`classname`	The label format for test classes. Example for class with path `com/example/myClass.cls`: class-type-name example: `com.example.myClass` filename example: `myClass.cls`

🧪 Test Profile Configuration

The .vscode/ablunit-test-profile.json has additional configuration similar to launch configurations.

A default profile is created when using the ABLUnit: Configure Test Profile command and selecting ABLUnit - Run Tests. This configuration has comments describing the options available.

Note: Only the first test profile will be imported. In the future this extension will allow for multiple entries.

VSCode Configuration - Snippets

This extension includes a few snippets for test annotations and other related code you may find helpful. These can be removed from intellisense with standard VSCode functionality. See: VSCode Docs -> Snippets in Visual Studio Code -> Can I remove snippets from intellisense?

👷‍♂️ Contributing

See CONTRIBUTING.md

💻 Development

npm install
Make any changes you wish
npm test or use the Extension Test Runner

🔗 Links

VSCode Marketplace - ABLUnit Test Runner
Progress Documentation
GitHub Repo - progress/ade - OpenEdge Source Files
Docker Hub - Progress Software Corporation - progresssoftware/prgs-oedb

🤓 About Me

This is my first VSCode extension, and my first TypeScript project. I am 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 is my passion. Unit testing is an important component of ensuring code remains functional when future changes are made. I hope this extension helps others to embrace TDD and improve their code.

ABLUnit Test Runner

Ken Herring