ratpack.groovy.test

Class GroovyUnitTest

java.lang.Object

ratpack.groovy.test.GroovyUnitTest

public abstract class GroovyUnitTest
extends Object

Constructor Summary

Constructors

Constructor and Description
GroovyUnitTest()

Method Summary

Methods

Modifier and Type	Method and Description
static GroovyInvocationBuilder	invocationBuilder() Create a Groovy invocation builder, for unit testing a Handler.
static GroovyInvocationBuilder	invocationBuilder(InvocationBuilder invocationBuilder) Create a Groovy invocation builder, for unit testing a Handler, by wrapping the given InvocationBuilder.
static Invocation	invoke(Handler handler, Closure<?> closure) Unit test a Handler.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GroovyUnitTest

public GroovyUnitTest()

Method Detail

invoke

public static Invocation invoke(Handler handler,
                @DelegatesTo(value=GroovyInvocationBuilder.class)
                Closure<?> closure)
                         throws InvocationTimeoutException

Unit test a Handler.

Example:

 import ratpack.handling.*
 import static ratpack.groovy.test.GroovyUnitTest.invoke

 class MyHandler implements Handler {
   void handle(Context context) {
     context.with {
       def outputHeaderValue = request.headers.get("input-value") + ":bar"

       response.headers.set("output-value", outputHeaderValue)
       render "received: " + request.path
     }
   }
 }

 // The following code unit tests MyHandler, typically it would be written inside a test framework.

 def invocation = invoke(new MyHandler()) {
   header "input-value", "foo"
   uri "some/path"
 }

 assert invocation.rendered(String) == "received: some/path"
 assert invocation.headers.get("output-value") == "foo:bar"
 

Parameters:

handler - The handler to unit test

closure - The closure that configures the invocation builder

Returns:

The result of the invocation

Throws:

InvocationTimeoutException - if the handler takes more than InvocationBuilder.timeout(int) seconds to send a response or call next() on the context

invocationBuilder

public static GroovyInvocationBuilder invocationBuilder()

Create a Groovy invocation builder, for unit testing a Handler.

Returns:

An invocation builder.

invocationBuilder

public static GroovyInvocationBuilder invocationBuilder(InvocationBuilder invocationBuilder)

Create a Groovy invocation builder, for unit testing a Handler, by wrapping the given InvocationBuilder.

Returns:

An invocation builder.