> For the complete documentation index, see [llms.txt](https://coldbox.ortusbooks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://coldbox.ortusbooks.com/the-basics/testing-quick-start/common-methods.md).

# Testing Methods

Common TestBox methods available in ColdBox tests — assertions, expectations, life-cycle, and spec grouping methods.

## BaseSpec

It is important to get familiar with TestBox before adventuring into ColdBox testing. Therefore, we suggest you reference the TestBox Docs (<https://testbox.ortusbooks.com/primers/testbox-bdd-primer>) or the TestBox API Docs (<http://apidocs.ortussolutions.com/testbox/current>). Below you can see a few of the common methods available to you.

{% hint style="info" %}
We highly encourage you to use expectations instead of assertions in order to use more human and fluent syntax: <https://testbox.ortusbooks.com/in-depth/expectations>
{% endhint %}

```cfscript
// quick assertion methods
assert( expression, [message] )
expect( actual ).toBe( value )
fail(message)

// Life Cycle Methods
beforeEach( body )
afterEach( body )
aroundEach( body, spec )

// Spec Grouping Methods
describe( title, body, labels, asyncAll, skip )
feature( title, body, labels, asyncAll, skip )
story( title, body, labels, asyncAll, skip )
scenario( title, body, labels, asyncAll, skip )
given( title, body, labels, asyncAll, skip )
when( title, body, labels, asyncAll, skip )

// Spec or Tests
it( title, body, labels, skip )
then( title, body, labels, skip )

// utility methods
console( var, top )
debug( var, deepCopy, label, top )
clearDebugBuffer()
getDebugBuffer()
print( message )
printLn( message )

// mocking methods
makePublic( target, method, newName )
querySim( queryData )
getmockBox( generationPath )
createEmptyMock( className, object, callLogging )
createMock( className, object, clearMethods, callLogging )
prepareMock( object, callLogging )
createStub( callLogging, extends, implements )
getProperty( target, name, scope, defaultValue )
```

## BaseTestCase

As we have seen that our `BaseTestCase` inherits from the `BaseSpec` you get all the goodness of TestBox. However, the `BaseTestCase` also has a wealth of methods to assist in your testing adventures:

<https://apidocs.ortussolutions.com/coldbox/current/?coldbox/system/testing/BaseTestCase.html>

{% embed url="<https://apidocs.ortussolutions.com/coldbox/current/?coldbox/system/testing/BaseTestCase.html>" %}

Here are some useful methods:

```javascript
announce(any state, [struct data='[runtime expression]'], [boolean async='false'], [boolean asyncAll='false'], [boolean asyncAllJoin='true'], [any asyncPriority='NORMAL'], [numeric asyncJoinTimeout='0'])

// Getters
getCache(any cacheName='default')
getCacheBox() 
getController() 
getFlashScope() 
getHandlerResults() 
getInstance([any name], [struct initArguments='[runtime expression]'], [any dsl]) 
getInterceptor(any interceptorName) 
getLogBox() 
getRenderData() 
getRenderedContent() 
getRequestContext() 
getStatusCode()
getUtil()
getWireBox()

// Get Mocking Objects
getMockController() 
getMockModel(any name, [boolean clearMethods='false'])
getMockRequestContext([boolean clearMethods='false'], [any decorator])


//Reset the persistence of the unit test coldbox app, basically removes the controller from application scope. 
reset([boolean clearMethods='false'], [any decorator]) 

// Prepare a ColdBox request
setup()
```

### ColdBox TestBox Matchers

ColdBox also automatically adds several [custom matchers](https://testbox.ortusbooks.com/digging-deeper/expectations/custom-matchers) to TestBox, so it can help you get nice expectations:

#### toHaveStatus()

Checks if the ColdBox response object has a matched status code.

```cfscript
expect( event.getResponse() ).toHaveStatus( statusCode )
```

#### toHaveInvalidData()

Expectation for testing against `cbValidation` invalid data fields returned in a Restful response by looking into the response object.

```cfscript
expect( event.getResponse() ).toHaveInvalidData( "username", "is required" )
expect( event.getResponse() ).toHaveInvalidData( "role", "is required" )
expect( event.getResponse() ).toHaveInvalidData( "permission", "is not unique" )
expect( event.getResponse() ).toHaveInvalidData( "status", "does not match" )
```

#### toRedirectTo()

The expectation for testing if an event returns a relocation.

```cfscript
expect( event ).toRedirectTo( "Main.index" )
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://coldbox.ortusbooks.com/the-basics/testing-quick-start/common-methods.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.