public interface TestRoute
run
method to run a request through the underlying route to create
a TestResponse
.
A TestRoute is created by deriving a test class from the concrete RouteTest implementation for your
testing framework (like JUnitRouteTest
for JUnit) and then using its testRoute
method to wrap
a route with testing support.
Modifier and Type | Method and Description |
---|---|
TestRouteResult |
run(HttpRequest request)
Run the request against the sealed route, meaning that exceptions and rejections will be handled by
the default exception and rejection handlers.
|
TestRouteResult |
runClientServer(HttpRequest request)
Similar to
run(org.apache.pekko.http.javadsl.model.HttpRequest) but runs the request through a full HTTP client and server stack. |
TestRouteResult |
runWithRejections(HttpRequest request)
Run the request against the "semi-sealed" route, meaning that exceptions will be handled by the
default exception handler but rejections will not be handled.
|
Route |
underlying() |
TestRouteResult run(HttpRequest request)
If you want to assert on the original rejections instead, use runWithRejections(org.apache.pekko.http.javadsl.model.HttpRequest)
.
request
- (undocumented)TestRouteResult runClientServer(HttpRequest request)
run(org.apache.pekko.http.javadsl.model.HttpRequest)
but runs the request through a full HTTP client and server stack.
Run the request against the sealed route, meaning that exceptions and rejections will be handled by the default exception and rejection handlers. The default handlers will convert exceptions and rejections into HTTP responses with corresponding status codes (like 404 when no route matches the path or 500 in cases of exceptions).
If you want to assert on the original rejections instead, use runWithRejections(org.apache.pekko.http.javadsl.model.HttpRequest)
.
request
- (undocumented)TestRouteResult runWithRejections(HttpRequest request)
TestRouteResult
allows access to the original rejection containing all the rejection details
in structured form. Use TestRouteResult.assertRejections(org.apache.pekko.http.javadsl.server.Rejection...)
to check that a route rejected a
request with expected rejections.
Otherwise, to assert on the actual error HTTP response generated by the default rejection handler,
use the run(org.apache.pekko.http.javadsl.model.HttpRequest)
method, instead.
request
- (undocumented)Route underlying()