One of the nicest things about CFWheels 2.x is the tighter integration with command-line tools such as Commandbox. We can take advantage of the new testing suite JSON return type and the new CFWheels CLI in Commandbox 2.x to easily build a Travis CI test. It’s perhaps easiest to just show the .travis.yml file – this goes in the root of your gitHub plugin repository, and once you’ve turned on testing under Travis.org, will run your test suite on every commit.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| language: java | |
| sudo: required | |
| jdk: | |
| - oraclejdk8 | |
| before_install: | |
| # Get Commandbox | |
| - sudo apt-key adv --keyserver keys.gnupg.net --recv 6DA70622 | |
| - sudo echo "deb http://downloads.ortussolutions.com/debs/noarch /" | sudo tee -a /etc/apt/sources.list.d/commandbox.list | |
| install: | |
| # Install Commandbox | |
| - sudo apt-get update && sudo apt-get --assume-yes install commandbox | |
| # Check it's working | |
| - box version | |
| # Install CLI: needed to repackage the plugin to a zip on install | |
| - box install cfwheels-cli | |
| # Install Master Branch; nb, installed into folder of the git repo name, i.e neokoenig/cfwheels-ical4j | |
| - box install cfwheels/cfwheels | |
| # Install the Plugin: use gitHub path to get the absolute latest rather than the forgebox version | |
| - box install neokoenig/cfwheels-ical4j | |
| before_script: | |
| # Master branch has a bunch of server.jsons we can use: lucee4 | lucee5 | cf10 | cf11 | cf2016 | |
| - box server start lucee5 | |
| # Type should be the name of the plugin | servername should reflect the server we've just started | |
| script: > | |
| testResults="$(box wheels test type=ical4j servername=lucee5)"; | |
| echo "$testResults"; | |
| if ! grep -i "\Tests Complete: All Good!" <<< $testResults; then exit 1; fi | |
| notifications: | |
| email: true |
by In sum, this:
- Installs Commandbox
- Installs the CFWheels CLI
- Installs the master branch of the CFWheels repository
- Installs your plugin from your repository (rather than the forgebox version which will be the version behind)
- Starts the local server
- Runs the test suite, pointing only at your plugin’s unit tests
Naturally, you could do more complex things with this, such as multiple CF Engines, and maybe even multiple CFWheels versions, but for a quick setup it’s a good starting point!