Annotations

In addition to the life-cycle methods, you can make any method a life-cycle method by giving it the desired annotation in its function definition. This is especially useful for parent classes that want to hook in to the TestBox life-cycle.
@beforeAll - Executes once before all specs for the entire test bundle CFC
@afterAll - Executes once after all specs complete in the test bundle CFC
@beforeEach - Executes before every single spec in a single describe block and receives the currently executing spec.
@afterEach - Executes after every single spec in a single describe block and receives the currently executing spec.
@aroundEach - Executes around the executing spec so you can provide code surrounding the spec.
Below are several examples using script notation.
DBTestCase.cfc (parent class)
1
component extends="coldbox.system.testing.BaseTestCase"{
2
​
3
    /**
4
     * @aroundEach
5
     */
6
    function wrapInDBTransaction( spec, suite ){
7
        transaction action="begin" {
8
            try {
9
                arguments.spec.body();
10
            } catch (any e) {
11
                rethrow;
12
            } finally {
13
                transaction action="rollback"
14
            }
15
        }
16
     }
17
}
Copied!
PostsTest.cfc
1
component extends="DBTestCase"{
2
​
3
    /**
4
     * @beforeEach
5
     */
6
    function setupColdBox() {
7
        setup();
8
    }
9
​
10
    function run() {
11
        given( "I have a two posts", function(){
12
            when( "I visit the home page", function(){
13
                then( "There should be two posts on the page", function(){
14
                    queryExecute( "INSERT INTO posts (body) VALUES ('Test Post One')" );
15
                    queryExecute( "INSERT INTO posts (body) VALUES ('Test Post Two')" );
16
​
17
                    var event = execute( event = "main.index", renderResults = true );
18
​
19
                    var content = event.getCollection().cbox_rendered_content;
20
​
21
                    expect(content).toMatch( "Test Post One" );
22
                    expect(content).toMatch( "Test Post Two" );
23
                });
24
            });
25
        });
26
    }
27
}
Copied!
This also helps parent classes enforce their setup methods are called by annotating the methods with @beforeAll. No more forgetting to call super.beforeAll()!
You can have as many annotated methods as you would like. TestBox discovers them up the inheritance chain and calls them in reverse order.

xUnit

Next - In-Depth

Suites, Tests & Specs (Oh My!)

Last modified 8mo ago

Copy link

Edit on GitHub