Test Runner

CommandBox : CLI, Package Manager, REPL & More
Search…
Test Runner
Run unit test suite from the command line
There is a testbox run command available that will run your unit or integration tests from the command line. All you need is to have your server running (it doesn't have to be a CommandBox server).
Run your test suite like so (modify the runner URL to match your site).
1
testbox run "http://localhost:8080/tests/runner.cfm"
Copied!
This will hit your runner URL and output a CLI-formatted report of your test results. If your test suite failed, the command will also return a failing status code when being run from your native shell. This makes integrations with CI tools like Jenkins or Travis-CI very easy since a failing test will fail your build automatically.
Default runner URL
You can also set up the default runner URL in your box.json and it will be used for you. Setting the URL is a one-time operation.
1
package set testbox.runner="http://localhost:8080/tests/runner.cfm"
2
testbox run
Copied!
You can also use a relative path and CommandBox will look up the host and port from your server settings.  
1
package set testbox.runner="/tests/runner.cfm"
2
testbox run
Copied!
The default runner URL of the testbox run command is  /tests/runner.cfm so there's actually no need to even configure it if you're using the default convention location for your runner.
Multiple Output Formats
You can run your tests and post-produce many reporting results, great for CI purposes
1
testbox run outputformats=json,antjunit,simple
2
testbox run outputformats=json,antjunit,simple outputFile=myresults
Copied!
Arbitrary URL options
You can set arbitrary URL options in our box.json like so
1
package set testbox.options.opt1=value1
2
package set testbox.options.opt2=value2
Copied!
You can set arbitrary URL options when you run the command like so
1
testbox run options:opt1=value1 options:opt2=value2
Copied!
Both of those examples will include ?opt1=value1&opt2=value2 on the runner URL. 
Additional Settings
There are a number of settings you can provide to the testbox run command to control exactly what tests run and how much output is included. Each of these can also be set in your box.json. Run this for more information.
1
testbox run help
Copied!
Example Output
Here is an example of the non-verbose output.
1
testbox run --noVerbose
2
​
3
Executing tests via http://127.0.0.1:55197/tests/runner.cfm?&recurse=true&reporter=json, please wait...
4
TestBox v2.5.0+107
5
---------------------------------------------------------------------------------
6
| Passed  | Failed  | Errored | Skipped | Time    | Bundles | Suites  | Specs   |
7
---------------------------------------------------------------------------------
8
| 8       | 0       | 0       | 0       | 112 ms  | 1       | 3       | 8       |
9
---------------------------------------------------------------------------------
Copied!
Code Coverage
If you run tests on a server with FusionReactor installed and you are using TestBox 2.9 or greater, you will have code coverage reported in the CLI output as a percentage as well as the LOC (lines of code) that were tracked. 
TestBox Integration
Test Watcher
Last modified 3mo ago
Copy link
Contents
Run unit test suite from the command line
Default runner URL
Multiple Output Formats
Arbitrary URL options
Additional Settings
Example Output
Code Coverage