ratpack.groovy.test.handling

Interface GroovyRequestFixture

All Superinterfaces:

ratpack.test.handling.RequestFixture

public interface GroovyRequestFixture
extends ratpack.test.handling.RequestFixture

A more Groovy friendly version of RequestFixture.

Method Summary

Modifier and Type	Method and Description
GroovyRequestFixture	body(byte[] bytes, java.lang.String contentType)
GroovyRequestFixture	body(java.lang.String text, java.lang.String contentType)
static ratpack.test.handling.HandlingResult	handle(ratpack.func.Action<? super ratpack.handling.Chain> handlers, groovy.lang.Closure<?> closure) Unit test a chain of handlers.
static ratpack.test.handling.HandlingResult	handle(ratpack.handling.Handler handler, groovy.lang.Closure<?> closure) Unit test a Handler.
GroovyRequestFixture	header(java.lang.CharSequence name, java.lang.String value)
GroovyRequestFixture	localAddress(com.google.common.net.HostAndPort local)
GroovyRequestFixture	method(java.lang.String method)
GroovyRequestFixture	pathBinding(java.util.Map<java.lang.String,java.lang.String> pathTokens)
GroovyRequestFixture	pathBinding(java.lang.String boundTo, java.lang.String pastBinding, java.util.Map<java.lang.String,java.lang.String> pathTokens)
GroovyRequestFixture	registry(ratpack.func.Action<? super ratpack.registry.RegistrySpec> action)
GroovyRequestFixture	registry(groovy.lang.Closure<?> closure) A closure friendly overload of registry(Action).
GroovyRequestFixture	remoteAddress(com.google.common.net.HostAndPort remote)
static GroovyRequestFixture	requestFixture() Create a Groovy request fixture, for unit testing a Handler.
static GroovyRequestFixture	requestFixture(ratpack.test.handling.RequestFixture requestFixture) Create a Groovy request fixture, for unit testing a Handler, by wrapping the given RequestFixture.
GroovyRequestFixture	responseHeader(java.lang.CharSequence name, java.lang.String value)
GroovyRequestFixture	serverConfig(ratpack.func.Action<? super ratpack.server.ServerConfigBuilder> action)
GroovyRequestFixture	timeout(int timeoutSeconds)
GroovyRequestFixture	uri(java.lang.String uri)

Methods inherited from interface ratpack.test.handling.RequestFixture

getRegistry, handle, handle, handle, handleChain, protocol

Method Detail

handle

static ratpack.test.handling.HandlingResult handle(ratpack.handling.Handler handler,
                                                   @DelegatesTo(value=GroovyRequestFixture.class)
                                                   groovy.lang.Closure<?> closure)
                                            throws java.lang.Exception

Unit test a Handler.

Example:

 import ratpack.groovy.handling.GroovyHandler
 import ratpack.groovy.handling.GroovyContext
 import ratpack.groovy.test.handling.GroovyRequestFixture

 class MyHandler extends GroovyHandler {
   void handle(GroovyContext context) {
     context.with {
       def outputHeaderValue = request.headers.get("input-value") + ":bar"
       response.headers.set("output-value", outputHeaderValue)
       render "received: " + request.path
     }
   }
 }

 def result = GroovyRequestFixture.handle(new MyHandler()) {
   header "input-value", "foo"
   uri "some/path"
 }

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

Parameters:

handler - the handler to test

closure - the configuration of the request fixture

Returns:

The result of the invocation

Throws:

ratpack.test.handling.HandlerTimeoutException - if the handler takes more than RequestFixture.timeout(int) seconds to send a response or call next() on the context

java.lang.Exception - any thrown by closure

handle

static ratpack.test.handling.HandlingResult handle(ratpack.func.Action<? super ratpack.handling.Chain> handlers,
                                                   @DelegatesTo(value=GroovyRequestFixture.class)
                                                   groovy.lang.Closure<?> closure)
                                            throws java.lang.Exception

Unit test a chain of handlers.

Example:

import ratpack.groovy.test.handling.GroovyRequestFixture
 import ratpack.groovy.Groovy

 def handlers = Groovy.chain {
   all {
     def outputHeaderValue = request.headers.get("input-value") + ":bar"
     response.headers.set("output-value", outputHeaderValue)
     next()
   }
   all {
     render "received: " + request.path
   }
 }

 def result = GroovyRequestFixture.handle(handlers) {
   header "input-value", "foo"
   uri "some/path"
 }

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

Parameters:

handlers - the handlers to test

closure - the configuration of the request fixture

Returns:

The result of the invocation

Throws:

ratpack.test.handling.HandlerTimeoutException - if the handler takes more than RequestFixture.timeout(int) seconds to send a response or call next() on the context

java.lang.Exception - any thrown by closure

requestFixture

static GroovyRequestFixture requestFixture()

Create a Groovy request fixture, for unit testing a Handler.

Specified by:

requestFixture in interface ratpack.test.handling.RequestFixture

Returns:

a Groovy request fixture

requestFixture

static GroovyRequestFixture requestFixture(ratpack.test.handling.RequestFixture requestFixture)

Create a Groovy request fixture, for unit testing a Handler, by wrapping the given RequestFixture.

Parameters:

requestFixture - The request fixture to wrap

Returns:

a Groovy request fixture

registry

GroovyRequestFixture registry(@DelegatesTo(value=ratpack.registry.RegistryBuilder.class,strategy=1)
                              groovy.lang.Closure<?> closure)

A closure friendly overload of registry(Action).

Parameters:

closure - the registry configuration

Returns:

this

See Also:

registry(Action)

header

GroovyRequestFixture header(java.lang.CharSequence name,
                            java.lang.String value)

Specified by:

header in interface ratpack.test.handling.RequestFixture

body

GroovyRequestFixture body(byte[] bytes,
                          java.lang.String contentType)

Specified by:

body in interface ratpack.test.handling.RequestFixture

body

GroovyRequestFixture body(java.lang.String text,
                          java.lang.String contentType)

Specified by:

body in interface ratpack.test.handling.RequestFixture

responseHeader

GroovyRequestFixture responseHeader(java.lang.CharSequence name,
                                    java.lang.String value)

Specified by:

responseHeader in interface ratpack.test.handling.RequestFixture

method

GroovyRequestFixture method(java.lang.String method)

Specified by:

method in interface ratpack.test.handling.RequestFixture

uri

GroovyRequestFixture uri(java.lang.String uri)

Specified by:

uri in interface ratpack.test.handling.RequestFixture

timeout

GroovyRequestFixture timeout(int timeoutSeconds)

Specified by:

timeout in interface ratpack.test.handling.RequestFixture

registry

GroovyRequestFixture registry(ratpack.func.Action<? super ratpack.registry.RegistrySpec> action)
                       throws java.lang.Exception

Specified by:

registry in interface ratpack.test.handling.RequestFixture

Throws:

java.lang.Exception

pathBinding

GroovyRequestFixture pathBinding(java.util.Map<java.lang.String,java.lang.String> pathTokens)

Specified by:

pathBinding in interface ratpack.test.handling.RequestFixture

pathBinding

GroovyRequestFixture pathBinding(java.lang.String boundTo,
                                 java.lang.String pastBinding,
                                 java.util.Map<java.lang.String,java.lang.String> pathTokens)

Specified by:

pathBinding in interface ratpack.test.handling.RequestFixture

serverConfig

GroovyRequestFixture serverConfig(ratpack.func.Action<? super ratpack.server.ServerConfigBuilder> action)
                           throws java.lang.Exception

Specified by:

serverConfig in interface ratpack.test.handling.RequestFixture

Throws:

java.lang.Exception

remoteAddress

GroovyRequestFixture remoteAddress(com.google.common.net.HostAndPort remote)

Specified by:

remoteAddress in interface ratpack.test.handling.RequestFixture

localAddress

GroovyRequestFixture localAddress(com.google.common.net.HostAndPort local)

Specified by:

localAddress in interface ratpack.test.handling.RequestFixture