A B C D E F G H I J L M P R S T U

A

ApplicationUnderTest - Interface in ratpack.test

Provides the address of the running application.

B

BaseDirBuilder - Interface in ratpack.test.embed

body(byte[], String) - Method in interface ratpack.test.handling.RequestFixture

Sets the request body to be the given bytes, and adds a Content-Type request header of the given value.

body(String, String) - Method in interface ratpack.test.handling.RequestFixture

Sets the request body to be the given string in utf8 bytes, and adds a Content-Type request header of the given value.

body(byte[], String) - Method in class ratpack.test.handling.RequestFixtureAction

Sets the request body to be the given bytes, and adds a Content-Type request header of the given value.

body(String, String) - Method in class ratpack.test.handling.RequestFixtureAction

Sets the request body to be the given string in utf8 bytes, and adds a Content-Type request header of the given value.

build() - Method in interface ratpack.test.embed.BaseDirBuilder

Build the baseDir.

build() - Method in class ratpack.test.embed.PathBaseDirBuilder

Build the baseDir.

C

close() - Method in class ratpack.test.embed.EmbeddedApplicationSupport

Stops the server returned by EmbeddedApplicationSupport.getServer().

close() - Method in class ratpack.test.embed.PathBaseDirBuilder

If the path backing this build is not from the default file system, its file system will be closed.

close() - Method in interface ratpack.test.exec.ExecHarness

Shuts down the thread pool backing this harness.

close() - Method in class ratpack.test.ServerBackedApplicationUnderTest

create() - Method in class ratpack.test.RatpackMainServerFactory

createLaunchConfig() - Method in class ratpack.test.embed.LaunchConfigEmbeddedApplication

Creates a launch config that defines the application.

createServer() - Method in class ratpack.test.embed.EmbeddedApplicationSupport

Subclass implementation hook for creating the server implementation.

createServer() - Method in class ratpack.test.embed.LaunchConfigEmbeddedApplication

Creates a server using RatpackServerBuilder.build(LaunchConfig), using the launch config returned by LaunchConfigEmbeddedApplication.createLaunchConfig().

D

dir(String) - Method in interface ratpack.test.embed.BaseDirBuilder

Creates a directory at the given path within the base dir.

dir(String) - Method in class ratpack.test.embed.PathBaseDirBuilder

Creates a directory at the given path within the base dir.

E

EmbeddedApplication - Interface in ratpack.test.embed

An application created and used at runtime, useful for functionally testing subsets of functionality.

EmbeddedApplicationSupport - Class in ratpack.test.embed

A support implementation that handles the file system and ApplicationUnderTest requirements.

EmbeddedApplicationSupport() - Constructor for class ratpack.test.embed.EmbeddedApplicationSupport

ExecHarness - Interface in ratpack.test.exec

A utility for testing asynchronous support/service code.

execHarness() - Static method in class ratpack.test.UnitTest

Creates a new execution harness, for unit testing code that produces a promise.

execute(Function<Execution, Promise<T>>) - Method in interface ratpack.test.exec.ExecHarness

Synchronously returns a promised value.

execute(RequestFixture) - Method in class ratpack.test.handling.RequestFixtureAction

Delegates to RequestFixtureAction.execute(), using the given requestFixture for delegation.

execute() - Method in class ratpack.test.handling.RequestFixtureAction

Implementations can naturally use the RequestFixture DSL for the duration of this method.

F

file(String) - Method in interface ratpack.test.embed.BaseDirBuilder

Returns a path for the given path within the base dir.

file(String, String) - Method in interface ratpack.test.embed.BaseDirBuilder

Creates a file with the given string content at the given path within the base dir.

file(String) - Method in class ratpack.test.embed.PathBaseDirBuilder

Returns a path for the given path within the base dir.

file(String, String) - Method in class ratpack.test.embed.PathBaseDirBuilder

Creates a file with the given string content at the given path within the base dir.

G

getAddress() - Method in interface ratpack.test.ApplicationUnderTest

The address of the application under test, which is guaranteed to be accepting requests.

getAddress() - Method in class ratpack.test.embed.EmbeddedApplicationSupport

The address of the application under test, which is guaranteed to be accepting requests.

getAddress() - Method in class ratpack.test.ServerBackedApplicationUnderTest

getBodyBytes() - Method in interface ratpack.test.handling.HandlingResult

The response body, as bytes.

getBodyText() - Method in interface ratpack.test.handling.HandlingResult

The response body, interpreted as a utf8 string.

getClientError() - Method in interface ratpack.test.handling.HandlingResult

The client error raised if any, unless a custom client error handler is in use.

getControl() - Method in interface ratpack.test.exec.ExecHarness

The execution control for the harness.

getException() - Method in interface ratpack.test.handling.HandlingResult

The exception thrown or given to Context.error(Exception), unless a custom error handler is in use.

getHeaders() - Method in interface ratpack.test.handling.HandlingResult

The final response headers.

getRegistry() - Method in interface ratpack.test.handling.HandlingResult

The final state of the context registry.

getRegistry() - Method in interface ratpack.test.handling.RequestFixture

A specification of the context registry.

getRegistry() - Method in class ratpack.test.handling.RequestFixtureAction

A specification of the context registry.

getRequestFixture() - Method in class ratpack.test.handling.RequestFixtureAction

getRequestRegistry() - Method in interface ratpack.test.handling.HandlingResult

The final state of the request registry.

getSentFile() - Method in interface ratpack.test.handling.HandlingResult

Indicates whether the result of invoking the handler was that it invoked one of the Response.sendFile(ratpack.exec.ExecControl, java.nio.file.Path) methods.

getServer() - Method in interface ratpack.test.embed.EmbeddedApplication

The server for the application.

getServer() - Method in class ratpack.test.embed.EmbeddedApplicationSupport

The server.

getStatus() - Method in interface ratpack.test.handling.HandlingResult

The response status information.

H

handle(Handler) - Method in interface ratpack.test.handling.RequestFixture

Invokes the given handler with a newly created Context based on the state of this fixture.

handle(Action<? super Chain>) - Method in interface ratpack.test.handling.RequestFixture

Similar to RequestFixture.handle(ratpack.handling.Handler), but for testing a handler chain.

handle(Handler) - Method in class ratpack.test.handling.RequestFixtureAction

Invokes the given handler with a newly created Context based on the state of this fixture.

handle(Action<? super Chain>) - Method in class ratpack.test.handling.RequestFixtureAction

Similar to RequestFixture.handle(ratpack.handling.Handler), but for testing a handler chain.

handle(Handler, Action<? super RequestFixture>) - Static method in class ratpack.test.UnitTest

Unit test a single Handler.

handle(Action<? super Chain>, Action<? super RequestFixture>) - Static method in class ratpack.test.UnitTest

Unit test a Handler chain.

HandlerTimeoutException - Exception in ratpack.test.handling

Thrown when a handler under test takes too long to produce a result.

HandlerTimeoutException(HandlingResult, int) - Constructor for exception ratpack.test.handling.HandlerTimeoutException

Constructor.

HandlingResult - Interface in ratpack.test.handling

Represents the result of testing one or more handlers.

header(String, String) - Method in interface ratpack.test.handling.RequestFixture

Set a request header value.

header(String, String) - Method in class ratpack.test.handling.RequestFixtureAction

Set a request header value.

I

isCalledNext() - Method in interface ratpack.test.handling.HandlingResult

Indicates whether the result of invoking the handler was that it delegated to a downstream handler.

isSentResponse() - Method in interface ratpack.test.handling.HandlingResult

Indicates the the handler(s) invoked one of the Response.send() methods.

J

JarFileBaseDirBuilder - Class in ratpack.test.embed

A BaseDirBuilder implementation that uses a Jar file as the base.

JarFileBaseDirBuilder(File) - Constructor for class ratpack.test.embed.JarFileBaseDirBuilder

L

launchConfig(Path, Action<? super LaunchConfigBuilder>) - Method in interface ratpack.test.handling.RequestFixture

Configures the launch config to have the given base dir and given configuration.

launchConfig(Action<? super LaunchConfigBuilder>) - Method in interface ratpack.test.handling.RequestFixture

Configures the launch config to have no base dir and given configuration.

launchConfig(Path, Action<? super LaunchConfigBuilder>) - Method in class ratpack.test.handling.RequestFixtureAction

Configures the launch config to have the given base dir and given configuration.

launchConfig(Action<? super LaunchConfigBuilder>) - Method in class ratpack.test.handling.RequestFixtureAction

Configures the launch config to have no base dir and given configuration.

LaunchConfigEmbeddedApplication - Class in ratpack.test.embed

A supporting implementation of EmbeddedApplication that starts a server based on a subclass provided LaunchConfig.

LaunchConfigEmbeddedApplication() - Constructor for class ratpack.test.embed.LaunchConfigEmbeddedApplication

M

method(String) - Method in interface ratpack.test.handling.RequestFixture

Set the request method (case insensitive).

method(String) - Method in class ratpack.test.handling.RequestFixtureAction

Set the request method (case insensitive).

P

PathBaseDirBuilder - Class in ratpack.test.embed

A BaseDirBuilder that is based on an initial Path.

PathBaseDirBuilder(File) - Constructor for class ratpack.test.embed.PathBaseDirBuilder

Constructor.

PathBaseDirBuilder(Path) - Constructor for class ratpack.test.embed.PathBaseDirBuilder

Constructor.

pathBinding(Map<String, String>) - Method in interface ratpack.test.handling.RequestFixture

Adds a path binding, with the given path tokens.

pathBinding(String, String, Map<String, String>) - Method in interface ratpack.test.handling.RequestFixture

Adds a path binding, with the given path tokens and parts.

pathBinding(Map<String, String>) - Method in class ratpack.test.handling.RequestFixtureAction

Adds a path binding, with the given path tokens.

pathBinding(String, String, Map<String, String>) - Method in class ratpack.test.handling.RequestFixtureAction

Adds a path binding, with the given path tokens and parts.

R

ratpack.test - package ratpack.test

ratpack.test.embed - package ratpack.test.embed

Support for creating embedded applications at test time, for testing Ratpack features and extensions.

ratpack.test.exec - package ratpack.test.exec

ratpack.test.handling - package ratpack.test.handling

RatpackMainApplicationUnderTest - Class in ratpack.test

RatpackMainApplicationUnderTest() - Constructor for class ratpack.test.RatpackMainApplicationUnderTest

RatpackMainApplicationUnderTest(Map<String, String>) - Constructor for class ratpack.test.RatpackMainApplicationUnderTest

RatpackMainApplicationUnderTest(RatpackMain, Map<String, String>) - Constructor for class ratpack.test.RatpackMainApplicationUnderTest

RatpackMainServerFactory - Class in ratpack.test

RatpackMainServerFactory() - Constructor for class ratpack.test.RatpackMainServerFactory

RatpackMainServerFactory(Map<String, String>) - Constructor for class ratpack.test.RatpackMainServerFactory

RatpackMainServerFactory(RatpackMain, Map<String, String>) - Constructor for class ratpack.test.RatpackMainServerFactory

registry(Action<? super RegistrySpec>) - Method in interface ratpack.test.handling.RequestFixture

Configures the context registry.

registry(Action<? super RegistrySpec>) - Method in class ratpack.test.handling.RequestFixtureAction

Configures the context registry.

rendered(Class<T>) - Method in interface ratpack.test.handling.HandlingResult

The object that was rendered to the response.

RequestFixture - Interface in ratpack.test.handling

A contrived request environment, suitable for unit testing Handler implementations.

requestFixture() - Static method in class ratpack.test.UnitTest

Create a request fixture, for unit testing of handlers.

RequestFixtureAction - Class in ratpack.test.handling

Convenient super class for RequestFixture configuration actions.

RequestFixtureAction() - Constructor for class ratpack.test.handling.RequestFixtureAction

responseHeader(String, String) - Method in interface ratpack.test.handling.RequestFixture

Set a response header value.

responseHeader(String, String) - Method in class ratpack.test.handling.RequestFixtureAction

Set a response header value.

S

ServerBackedApplicationUnderTest - Class in ratpack.test

ServerBackedApplicationUnderTest(Factory<RatpackServer>) - Constructor for class ratpack.test.ServerBackedApplicationUnderTest

stop() - Method in class ratpack.test.ServerBackedApplicationUnderTest

T

timeout(int) - Method in interface ratpack.test.handling.RequestFixture

Sets the maximum time to allow the handler under test to produce a result.

timeout(int) - Method in class ratpack.test.handling.RequestFixtureAction

Sets the maximum time to allow the handler under test to produce a result.

U

UnitTest - Class in ratpack.test

Static methods for the unit testing of handlers.

uri(String) - Method in interface ratpack.test.handling.RequestFixture

The URI of the request.

uri(String) - Method in class ratpack.test.handling.RequestFixtureAction

The URI of the request.

A B C D E F G H I J L M P R S T U