ratpack.groovy.test.embed

Interface GroovyEmbeddedApp

All Superinterfaces:

ApplicationUnderTest, AutoCloseable, CloseableApplicationUnderTest, EmbeddedApp

public interface GroovyEmbeddedApp
extends EmbeddedApp

A highly configurable EmbeddedApp implementation that allows the application to be defined in code at runtime.

This implementation is usually sufficient for testing Ratpack modules or extensions.

 import ratpack.test.embed.BaseDirBuilder
 import ratpack.groovy.test.embed.GroovyEmbeddedApp

 def baseDir = BaseDirBuilder.tmpDir().build {
   it.file "public/foo.txt", "bar"
 }

 GroovyEmbeddedApp.of(baseDir) {
   // Use the GroovyChain DSL for defining the application handlers
   handlers {
     get {
       render "root"
     }
     files { dir "public" }
   }
 } test {
   assert getText() == "root"
   assert getText("foo.txt") == "bar"
 }
 

See Also:

BaseDirBuilder, EmbeddedApp

Method Summary

Modifier and Type	Method and Description
static GroovyEmbeddedApp	from(EmbeddedApp embeddedApp)
static GroovyEmbeddedApp	fromHandler(Closure<?> handler)
static GroovyEmbeddedApp	fromHandler(Path baseDir, Closure<?> handler)
static GroovyEmbeddedApp	fromHandlers(Closure<?> handlers)
static GroovyEmbeddedApp	fromHandlers(Path baseDir, Closure<?> handlers)
static GroovyEmbeddedApp	fromServer(ServerConfig.Builder serverConfig, Closure<?> definition)
static GroovyEmbeddedApp	fromServer(ServerConfig serverConfig, Closure<?> definition)
static GroovyEmbeddedApp	of(Closure<?> definition)
static GroovyEmbeddedApp	of(Path baseDir, Closure<?> definition)
default void	test(Closure<?> test)

Methods inherited from interface ratpack.test.embed.EmbeddedApp

close, fromHandler, fromHandler, fromHandlerFactory, fromHandlerFactory, fromHandlers, fromHandlers, fromServer, fromServer, fromServer, fromServer, getAddress, getServer, of, of

Methods inherited from interface ratpack.test.CloseableApplicationUnderTest

test

Methods inherited from interface ratpack.test.ApplicationUnderTest

getHttpClient, of, of, of, of

Method Detail

from

static GroovyEmbeddedApp from(EmbeddedApp embeddedApp)

of

static GroovyEmbeddedApp of(@DelegatesTo(value=GroovyRatpackServerSpec.class,strategy=1)
                            Closure<?> definition)
                     throws Exception

Throws:

Exception

of

static GroovyEmbeddedApp of(Path baseDir,
                            @DelegatesTo(value=GroovyRatpackServerSpec.class,strategy=1)
                            Closure<?> definition)
                     throws Exception

Throws:

Exception

fromServer

static GroovyEmbeddedApp fromServer(ServerConfig.Builder serverConfig,
                                    @DelegatesTo(value=GroovyRatpackServerSpec.class,strategy=1)
                                    Closure<?> definition)

fromServer

static GroovyEmbeddedApp fromServer(ServerConfig serverConfig,
                                    @DelegatesTo(value=GroovyRatpackServerSpec.class,strategy=1)
                                    Closure<?> definition)

fromHandler

static GroovyEmbeddedApp fromHandler(@DelegatesTo(value=GroovyContext.class,strategy=1)
                                     Closure<?> handler)

fromHandler

static GroovyEmbeddedApp fromHandler(Path baseDir,
                                     @DelegatesTo(value=GroovyContext.class,strategy=1)
                                     Closure<?> handler)

fromHandlers

static GroovyEmbeddedApp fromHandlers(@DelegatesTo(value=GroovyChain.class,strategy=1)
                                      Closure<?> handlers)

fromHandlers

static GroovyEmbeddedApp fromHandlers(Path baseDir,
                                      @DelegatesTo(value=GroovyChain.class,strategy=1)
                                      Closure<?> handlers)

test

default void test(@DelegatesTo(value=TestHttpClient.class,strategy=1)
                  Closure<?> test)
           throws Exception

Throws:

Exception