play.test

Class Helpers

java.lang.Object

play.test.Helpers

All Implemented Interfaces:

Http.HeaderNames, Http.Status

public class Helpers
extends java.lang.Object
implements Http.Status, Http.HeaderNames

Helper functions to run tests.

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_TIMEOUT Default Timeout (milliseconds) for fake requests issued by these Helpers.
static java.lang.String	DELETE
static java.lang.Class<? extends org.openqa.selenium.WebDriver>	FIREFOX
static java.lang.String	GET
static java.lang.String	HEAD
static java.lang.Class<? extends org.openqa.selenium.WebDriver>	HTMLUNIT
static java.lang.String	POST
static java.lang.String	PUT

Fields inherited from interface play.mvc.Http.Status

ACCEPTED, BAD_GATEWAY, BAD_REQUEST, CONFLICT, CONTINUE, CREATED, EXPECTATION_FAILED, FAILED_DEPENDENCY, FORBIDDEN, FOUND, GATEWAY_TIMEOUT, GONE, HTTP_VERSION_NOT_SUPPORTED, INSUFFICIENT_STORAGE, INTERNAL_SERVER_ERROR, LENGTH_REQUIRED, LOCKED, METHOD_NOT_ALLOWED, MOVED_PERMANENTLY, MULTI_STATUS, MULTIPLE_CHOICES, NO_CONTENT, NON_AUTHORITATIVE_INFORMATION, NOT_ACCEPTABLE, NOT_FOUND, NOT_IMPLEMENTED, NOT_MODIFIED, OK, PARTIAL_CONTENT, PAYMENT_REQUIRED, PERMANENT_REDIRECT, PRECONDITION_FAILED, PROXY_AUTHENTICATION_REQUIRED, REQUEST_ENTITY_TOO_LARGE, REQUEST_TIMEOUT, REQUEST_URI_TOO_LONG, REQUESTED_RANGE_NOT_SATISFIABLE, RESET_CONTENT, SEE_OTHER, SERVICE_UNAVAILABLE, SWITCHING_PROTOCOLS, TEMPORARY_REDIRECT, TOO_MANY_REQUESTS, UNAUTHORIZED, UNPROCESSABLE_ENTITY, UNSUPPORTED_MEDIA_TYPE, UPGRADE_REQUIRED, USE_PROXY

Fields inherited from interface play.mvc.Http.HeaderNames

ACCEPT, ACCEPT_CHARSET, ACCEPT_ENCODING, ACCEPT_LANGUAGE, ACCEPT_RANGES, ACCESS_CONTROL_ALLOW_CREDENTIALS, ACCESS_CONTROL_ALLOW_HEADERS, ACCESS_CONTROL_ALLOW_METHODS, ACCESS_CONTROL_ALLOW_ORIGIN, ACCESS_CONTROL_EXPOSE_HEADERS, ACCESS_CONTROL_MAX_AGE, ACCESS_CONTROL_REQUEST_HEADERS, ACCESS_CONTROL_REQUEST_METHOD, AGE, ALLOW, AUTHORIZATION, CACHE_CONTROL, CONNECTION, CONTENT_DISPOSITION, CONTENT_ENCODING, CONTENT_LANGUAGE, CONTENT_LENGTH, CONTENT_LOCATION, CONTENT_MD5, CONTENT_RANGE, CONTENT_TRANSFER_ENCODING, CONTENT_TYPE, COOKIE, DATE, ETAG, EXPECT, EXPIRES, FORWARDED, FROM, HOST, IF_MATCH, IF_MODIFIED_SINCE, IF_NONE_MATCH, IF_RANGE, IF_UNMODIFIED_SINCE, LAST_MODIFIED, LOCATION, MAX_FORWARDS, ORIGIN, PRAGMA, PROXY_AUTHENTICATE, PROXY_AUTHORIZATION, RANGE, REFERER, RETRY_AFTER, SERVER, SET_COOKIE, SET_COOKIE2, TE, TRAILER, TRANSFER_ENCODING, UPGRADE, USER_AGENT, VARY, VIA, WARNING, WWW_AUTHENTICATE, X_FORWARDED_FOR, X_FORWARDED_HOST, X_FORWARDED_PORT, X_FORWARDED_PROTO, X_REQUESTED_WITH

Constructor Summary

Constructors

Constructor and Description
Helpers()

Method Summary

Modifier and Type	Method and Description
static akka.util.ByteString	contentAsBytes(play.twirl.api.Content content) Extracts the content as bytes.
static akka.util.ByteString	contentAsBytes(Result result) Extracts the content as a ByteString.
static akka.util.ByteString	contentAsBytes(Result result, akka.stream.Materializer mat) Extracts the content as a ByteString.
static akka.util.ByteString	contentAsBytes(Result result, akka.stream.Materializer mat, long timeout) Extracts the content as a ByteString.
static java.lang.String	contentAsString(play.twirl.api.Content content) Extracts the content as a String.
static java.lang.String	contentAsString(Result result) Extracts the content as a String.
static java.lang.String	contentAsString(Result result, akka.stream.Materializer mat) Extracts the content as a String.
static java.lang.String	contentAsString(Result result, akka.stream.Materializer mat, long timeout) Extracts the content as a String.
static Application	fakeApplication() Build a new fake application.
static Application	fakeApplication(GlobalSettings global) Deprecated. Use dependency injection (since 2.5.0)
static Application	fakeApplication(java.util.Map<java.lang.String,? extends java.lang.Object> additionalConfiguration) Build a new fake application.
static Application	fakeApplication(java.util.Map<java.lang.String,? extends java.lang.Object> additionalConfiguration, GlobalSettings global) Deprecated. Use the version without GlobalSettings (since 2.5.0)
static GlobalSettings	fakeGlobal() Deprecated. Use dependency injection (since 2.5.0)
static Http.RequestBuilder	fakeRequest() Build a new GET / fake request.
static Http.RequestBuilder	fakeRequest(Call call) Build a new fake request corresponding to a given route call
static Http.RequestBuilder	fakeRequest(java.lang.String method, java.lang.String uri) Build a new fake request.
static java.util.Map<java.lang.String,java.lang.String>	inMemoryDatabase() Constructs a in-memory (h2) database configuration to add to a fake application.
static java.util.Map<java.lang.String,java.lang.String>	inMemoryDatabase(java.lang.String name) Constructs a in-memory (h2) database configuration to add to a fake application.
static java.util.Map<java.lang.String,java.lang.String>	inMemoryDatabase(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> options) Constructs a in-memory (h2) database configuration to add to a fake application.
static <V> V	invokeWithContext(Http.RequestBuilder requestBuilder, java.util.concurrent.Callable<V> callable) Calls a Callable which invokes a Controller or some other method with a Context
static Result	route(Application app, Call call)
static Result	route(Application app, Call call, long timeout)
static Result	route(Application app, Http.RequestBuilder requestBuilder)
static Result	route(Application app, Http.RequestBuilder requestBuilder, long timeout)
static Result	route(Call call)
static Result	route(Call call, long timeout)
static Result	route(Http.RequestBuilder requestBuilder)
static Result	route(Http.RequestBuilder requestBuilder, long timeout)
static Result	routeAndCall(java.lang.Class<? extends Router> router, Http.RequestBuilder requestBuilder, long timeout)
static Result	routeAndCall(Http.RequestBuilder requestBuilder, long timeout)
static Result	routeAndCall(Router router, Http.RequestBuilder requestBuilder)
static Result	routeAndCall(Router router, Http.RequestBuilder requestBuilder, long timeout)
static void	running(Application application, java.lang.Runnable block) Executes a block of code in a running application.
static void	running(TestServer server, java.lang.Class<? extends org.openqa.selenium.WebDriver> webDriver, java.util.function.Consumer<TestBrowser> block) Executes a block of code in a running server, with a test browser.
static void	running(TestServer server, java.lang.Runnable block) Executes a block of code in a running server.
static void	running(TestServer server, org.openqa.selenium.WebDriver webDriver, java.util.function.Consumer<TestBrowser> block) Executes a block of code in a running server, with a test browser.
static void	start(Application application) Starts a new application.
static void	start(TestServer server) Starts a Test server.
static void	stop(Application application) Stops an application.
static void	stop(TestServer server) Stops a Test server.
static TestBrowser	testBrowser() Creates a Test Browser.
static TestBrowser	testBrowser(java.lang.Class<? extends org.openqa.selenium.WebDriver> webDriver) Creates a Test Browser.
static TestBrowser	testBrowser(java.lang.Class<? extends org.openqa.selenium.WebDriver> webDriver, int port) Creates a Test Browser.
static TestBrowser	testBrowser(int port) Creates a Test Browser.
static TestBrowser	testBrowser(org.openqa.selenium.WebDriver of) Creates a Test Browser.
static TestBrowser	testBrowser(org.openqa.selenium.WebDriver of, int port) Creates a Test Browser.
static TestServer	testServer() Creates a new Test server listening on port defined by configuration setting "testserver.port" (defaults to 19001).
static TestServer	testServer(Application app) Creates a new Test server listening on port defined by configuration setting "testserver.port" (defaults to 19001) and using the given Application.
static TestServer	testServer(int port) Creates a new Test server.
static TestServer	testServer(int port, Application app) Creates a new Test server.

Methods inherited from class java.lang.Object

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

Field Detail

GET

public static java.lang.String GET

POST

public static java.lang.String POST

PUT

public static java.lang.String PUT

DELETE

public static java.lang.String DELETE

HEAD

public static java.lang.String HEAD

HTMLUNIT

public static java.lang.Class<? extends org.openqa.selenium.WebDriver> HTMLUNIT

FIREFOX

public static java.lang.Class<? extends org.openqa.selenium.WebDriver> FIREFOX

DEFAULT_TIMEOUT

public static final long DEFAULT_TIMEOUT

Default Timeout (milliseconds) for fake requests issued by these Helpers. This value is determined from System property test.timeout. The default value is 30000 (30 seconds).

Constructor Detail

Helpers

public Helpers()

Method Detail

invokeWithContext

public static <V> V invokeWithContext(Http.RequestBuilder requestBuilder,
                                      java.util.concurrent.Callable<V> callable)

Calls a Callable which invokes a Controller or some other method with a Context

fakeRequest

public static Http.RequestBuilder fakeRequest()

Build a new GET / fake request.

fakeRequest

public static Http.RequestBuilder fakeRequest(java.lang.String method,
                                              java.lang.String uri)

Build a new fake request.

fakeRequest

public static Http.RequestBuilder fakeRequest(Call call)

Build a new fake request corresponding to a given route call

fakeApplication

public static Application fakeApplication()

Build a new fake application.

fakeApplication

@Deprecated
public static Application fakeApplication(GlobalSettings global)

Deprecated. Use dependency injection (since 2.5.0)

Build a new fake application.

fakeGlobal

@Deprecated
public static GlobalSettings fakeGlobal()

Deprecated. Use dependency injection (since 2.5.0)

A fake Global.

inMemoryDatabase

public static java.util.Map<java.lang.String,java.lang.String> inMemoryDatabase()

Constructs a in-memory (h2) database configuration to add to a fake application.

inMemoryDatabase

public static java.util.Map<java.lang.String,java.lang.String> inMemoryDatabase(java.lang.String name)

Constructs a in-memory (h2) database configuration to add to a fake application.

inMemoryDatabase

public static java.util.Map<java.lang.String,java.lang.String> inMemoryDatabase(java.lang.String name,
                                                                                java.util.Map<java.lang.String,java.lang.String> options)

Constructs a in-memory (h2) database configuration to add to a fake application.

fakeApplication

public static Application fakeApplication(java.util.Map<java.lang.String,? extends java.lang.Object> additionalConfiguration)

Build a new fake application.

fakeApplication

@Deprecated
public static Application fakeApplication(java.util.Map<java.lang.String,? extends java.lang.Object> additionalConfiguration,
                                                      GlobalSettings global)

Deprecated. Use the version without GlobalSettings (since 2.5.0)

Build a new fake application.

contentAsBytes

public static akka.util.ByteString contentAsBytes(Result result)

Extracts the content as a ByteString. This method is only capable of extracting the content of results with strict entities. To extract the content of results with streamed entities, use contentAsBytes(Result, Materializer).

Parameters:

result - The result to extract the content from.

Returns:

The content of the result as a ByteString.

Throws:

java.lang.UnsupportedOperationException - if the result does not have a strict entity.

contentAsBytes

public static akka.util.ByteString contentAsBytes(Result result,
                                                  akka.stream.Materializer mat)

Extracts the content as a ByteString.

Parameters:

result - The result to extract the content from.

mat - The materializer to use to extract the body from the result stream.

Returns:

The content of the result as a ByteString.

contentAsBytes

public static akka.util.ByteString contentAsBytes(Result result,
                                                  akka.stream.Materializer mat,
                                                  long timeout)

Extracts the content as a ByteString.

Parameters:

result - The result to extract the content from.

mat - The materializer to use to extract the body from the result stream.

timeout - The amount of time, in milliseconds, to wait for the body to be produced.

Returns:

The content of the result as a ByteString.

contentAsBytes

public static akka.util.ByteString contentAsBytes(play.twirl.api.Content content)

Extracts the content as bytes.

contentAsString

public static java.lang.String contentAsString(play.twirl.api.Content content)

Extracts the content as a String.

contentAsString

public static java.lang.String contentAsString(Result result)

Extracts the content as a String. This method is only capable of extracting the content of results with strict entities. To extract the content of results with streamed entities, use contentAsString(Result, Materializer).

Parameters:

result - The result to extract the content from.

Returns:

The content of the result as a String.

Throws:

java.lang.UnsupportedOperationException - if the result does not have a strict entity.

contentAsString

public static java.lang.String contentAsString(Result result,
                                               akka.stream.Materializer mat)

Extracts the content as a String.

Parameters:

result - The result to extract the content from.

mat - The materializer to use to extract the body from the result stream.

Returns:

The content of the result as a String.

contentAsString

public static java.lang.String contentAsString(Result result,
                                               akka.stream.Materializer mat,
                                               long timeout)

Extracts the content as a String.

Parameters:

result - The result to extract the content from.

mat - The materializer to use to extract the body from the result stream.

timeout - The amount of time, in milliseconds, to wait for the body to be produced.

Returns:

The content of the result as a String.

routeAndCall

public static Result routeAndCall(Http.RequestBuilder requestBuilder,
                                  long timeout)

routeAndCall

public static Result routeAndCall(java.lang.Class<? extends Router> router,
                                  Http.RequestBuilder requestBuilder,
                                  long timeout)

routeAndCall

public static Result routeAndCall(Router router,
                                  Http.RequestBuilder requestBuilder)

routeAndCall

public static Result routeAndCall(Router router,
                                  Http.RequestBuilder requestBuilder,
                                  long timeout)

route

public static Result route(Call call)

route

public static Result route(Call call,
                           long timeout)

route

public static Result route(Application app,
                           Call call)

route

public static Result route(Application app,
                           Call call,
                           long timeout)

route

public static Result route(Http.RequestBuilder requestBuilder)

route

public static Result route(Http.RequestBuilder requestBuilder,
                           long timeout)

route

public static Result route(Application app,
                           Http.RequestBuilder requestBuilder)

route

public static Result route(Application app,
                           Http.RequestBuilder requestBuilder,
                           long timeout)

start

public static void start(Application application)

Starts a new application.

stop

public static void stop(Application application)

Stops an application.

running

public static void running(Application application,
                           java.lang.Runnable block)

Executes a block of code in a running application.

testServer

public static TestServer testServer()

Creates a new Test server listening on port defined by configuration setting "testserver.port" (defaults to 19001).

testServer

public static TestServer testServer(Application app)

Creates a new Test server listening on port defined by configuration setting "testserver.port" (defaults to 19001) and using the given Application.

testServer

public static TestServer testServer(int port)

Creates a new Test server.

testServer

public static TestServer testServer(int port,
                                    Application app)

Creates a new Test server.

start

public static void start(TestServer server)

Starts a Test server.

stop

public static void stop(TestServer server)

Stops a Test server.

running

public static void running(TestServer server,
                           java.lang.Runnable block)

Executes a block of code in a running server.

running

public static void running(TestServer server,
                           java.lang.Class<? extends org.openqa.selenium.WebDriver> webDriver,
                           java.util.function.Consumer<TestBrowser> block)

Executes a block of code in a running server, with a test browser.

running

public static void running(TestServer server,
                           org.openqa.selenium.WebDriver webDriver,
                           java.util.function.Consumer<TestBrowser> block)

Executes a block of code in a running server, with a test browser.

testBrowser

public static TestBrowser testBrowser()

Creates a Test Browser.

testBrowser

public static TestBrowser testBrowser(int port)

Creates a Test Browser.

testBrowser

public static TestBrowser testBrowser(java.lang.Class<? extends org.openqa.selenium.WebDriver> webDriver)

Creates a Test Browser.

testBrowser

public static TestBrowser testBrowser(java.lang.Class<? extends org.openqa.selenium.WebDriver> webDriver,
                                      int port)

Creates a Test Browser.

testBrowser

public static TestBrowser testBrowser(org.openqa.selenium.WebDriver of,
                                      int port)

Creates a Test Browser.

testBrowser

public static TestBrowser testBrowser(org.openqa.selenium.WebDriver of)

Creates a Test Browser.