What's New With 6.0.0
September 27, 2024
Last updated
Was this helpful?
September 27, 2024
Last updated
Was this helpful?
TestBox 6.x series is a major bump in our library. Here are the major areas of improvement and the full release notes.
BoxLang is the newest JVM language that can support running not only BoxLang language files but CFML files with our bx-compat-cfml
module. In TestBox 6 we now not only support and certify that it runs in CFML compatibility mode, but you can now create all your tests, specs and harnesses in BoxLang. You can find the base test harness for BoxLang here: https://github.com/Ortus-Solutions/TestBox/tree/development/bx/tests
Here is a sample Spec written in BoxLang
We have also updated the testbox-cli
to now support BoxLang native generation. It will detect if you are in a BoxLang server or if you have the new language
entry in your box.json
Also all generation commands have a new boxlang
argument, which is a boolean argument you can use to explicitly generate Boxlang code.
The CLI will detect if it's a BoxLang project if:
If there is a CommandBox BoxLang server detected in the root of the project
If the runner
defined in your box.json
is called boxlang
If the language=boxlang
in your box.json
is detected
We have also created a new runner for BoxLang exclusively. This runner allows you to run your specs, and bundles from the CLI with no web server required. You can find the entire docs for the runner in our BoxLang CLI Runner page. The runner must be run from the root of your BoxLang project:
Remember that BoxLang not only allows you to build web server applications, but also CLI applications, serverless (AWS Lambdas, Azure Functions), Android and more.
We have also created a new module called bx-web-support
which will allow you to do headless web server testing right from the CLI.
This will add web support to the CLI (BIFS, components, etc.) and a mock HTTP server so you can do full life-cycle testing from the CLI like if running your app in a web server. This runner does not require a web server to function, thus if you are building a web app, you will need this module if you still want to continue to execute your tests in the CLI Runtime.
If you are building exclusively a web application, we suggest you use the CommandBox runner which will call your runner via HTTP from the CLI. You can also just use the Web Runner.
Adobe 2018 has been dropped and BoxLang is now fully supported and certified with special features JUST for BoxLang.
All the test bundles will now inherit several new methods to assist in environment and OS detection:
isAdobe()
Are you running the test in an Adobe CFML Engine
isLucee()
Are you running the test in a Lucee CFML Engine
isBoxLang()
Are you running the test in a BoxLang Engine
isWindows()
Are you in a windows OS
isLinux()
Are you in a Linux OS
isMac()
Are you in a Mac OS
We have added a new method for your BDD tests called test()
so you can create even further human-readable tests apart from it(), then()
If you are building your tests in xUnit mode, then you are getting more features especially for your reports. Instead of just seeing the name of the function, you can now annotate it with a displayName
annotation and give it a human readable title.
If you are writing your specs in BoxLang you will start to get further advantages than in CFML. Here is the first one, dynamic assertion methods. Before, in order to use the assertions library you had to use the $assert
variable and call the assertion methods on it:
Now, you can use our dynamic delegator and just simply your assertions:
All these dynamic methods will proxy to the assertions library.
TESTBOX-391 MockBox converted to script
TESTBOX-392 BoxLang classes support
TESTBOX-393 New environment helpers to do skip detections or anything you see fit: isAdobe, isLucee, isBoxLang, isWindows, isMac, isLinux
TESTBOX-394 new `test(), xtest(), ftest()` alias for more natuarl testing
TESTBOX-397 debug() get's two new arguments: label and showUDFs
TESTBOX-398 DisplayName on a bundle now shows up in the reports
TESTBOX-399 xUnit new annotation for @DisplayName so it can show instead of the function name
TESTBOX-401 BoxLang CLI mode and Runner
TESTBOX-402 New matcher: toHaveKeyWithCase()
TESTBOX-403 Assertions: key() and notKey() now have a CaseSensitive boolean argument
TESTBOX-289 showUDFs = false option with debug()
TESTBOX-331 TextReporter doesn't correctly support testBundles URL param
TESTBOX-395 adding missing focused argument to spec methods
TESTBOX-396 Generating a repeatable id for specs to track them better in future UIs
TESTBOX-123 If test spec descriptor contains a comma, it can not be drilled down to run that one spec directly
TESTBOX-338 describe handler in non-called test classes being executed
TESTBOX-400 Drop Adobe 2018 support