Links

Installation

TestBox can be installed easily via CommandBox CLI as a development dependency:
// latest stable version
box install testbox --saveDev
// latest bleeding edge
box install testbox@be --saveDev
Please note the --saveDev flag, which tells CommandBox that TestBox is a development dependency and not a production dependency.
DO NOT USE TESTBOX IN PRODUCTION.

TestBox CLI

TestBox comes with its own CLI for CommandBox. You can use it to generate tests, harnesses, and suites and also run executions from the CLI.
install testbox-cli
You will now have the testbox namesapce available to you, try it out
testbox help

Generating a Testing Harness

Once you install TestBox, you'll need a quick way to set up a testing harness. The generate harness command will add a new /tests folder to your application with a few example tests to get you started.
testbox generate harness
You can then run your tests by executing the testbox run command or by visiting the runner in the generated harness: http://localhost/tests/runner.cfm
testbox run

System Requirements

  • Lucee 5.x+
  • ColdFusion 2018+

What's Included

Folder
Description
system
The main system framework folder
test-browser
This is a little utility to facilitate navigating big testing suites. This helps navigate to the suites you want and execute them instead of typing all the time.
test-harness
A vanilla test runner for any application
test-runner
A simple GUI test runner
test-visualizer
A static visualizer of JSON reports. Just drop in a test-results.json and run it!
tests
Several sample tests and runners are actually used to build TestBox
Now that you are installed, please set up your favorite IDE with our tooling: