If you are reading this from within the plugin as the README.pdf, and any of this fails for you, please see http://farcry.jira.com/wiki/display/FCPLUG/testMXUnit for the latest information about testMXUnit.
Prerequisite
Farcry unit tests uses http://mxunit.org/ with a wrapper that adds in Farcry hooks and webskin compatibility. You can get the latest copy of the plugin by checking out the code from the following SVN repository URL:
...
You are ready to write and run tests.
Running Tests
To run unit tests, log into the webtop and choose the Admin tab. From the pull down select Testing. This will display two menu options Run Tests and Configure Tests.
Configure Tests
You select which tests you would like to run on the Configure Tests screen. After you have ticked the boxes next to the CFCs you'd like to run (and click Save Configuration), you can then proceed to Run Tests.
Run Tests
Run Tests Does what it says on the tin - it runs the tests selected from the Configure Tests screen.
Writing Tests
Create a directory named tests in the root level of your plugin or project. In other words, the directory should be at the same level as packages, tags, webskin, etc. Within the test directory you will create CFCs that hold all your tests. By creating your test CFCs in this directory, they will automatically be selectable in the Configure Tests screen described above.
Simple tests
The Test CFCs must extend mxunit.framework.TestCase. There is a file called ExampleTest.cfc in the testMXUnit plugin that you can use as a template. The contents of that file at the time of this writing are the following:
...
For documentation and tutorials on MXUnit see http://mxunit.org/doc/index.cfm
FarCry tests
Some tests require integration to a higher degree with the FarCry framework. For example, creating a bunch of ContentTypes and then rolling those back when the test is done. For tests that require this kind of integration, have your test CFCs extend farcry.plugins.testmxunit.tests.FarcryTestCase. This component provides functionality for creating and destroying test data. These tests work the same way as basic tests, but the following functions are available.
Temporary data
These functions create data in the database. The FarcryTestCase automatically removes this data once the test is complete. Generally these are used in setUp and tearDown. super.setUp() must be called at the start of the overriding setUp function, and super.tearDown() must be called at the end of the overriding tearDown function.
Function | Description |
|---|---|
createTemporaryObject | Creates a temporary object in the database. One argument for each property. Include a categories to attach categories in refCategories. Object is automatically removed at the end of the test. |
createTemporaryCategory | Requires alias, parentid, categoryid, and categoryLabel. Category (and references) is automatically removed at the end of the test. |
pinCategories | Takes a list category and remembers them. At the end of each test all changes to these categories (and the object references) are reverted. |
pinObjects | Takes typename, and optionally timeframe (seconds) which restricts match to objects created recently. Objects are reverted, re-added, or deleted as necessary to restore the snapshot. |
pinScope | Takes variable defining a valid isdefined argument. If the variable exists it is duplicated and reset at the end of the test. If it does not, structdelete is used to remove the final part. e.g. request.a.b => structdelete("request.a","b"). Only useful for basic variable structures. |
Assertions
These functions are FarCry specific assertions.
...
| Section | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|