Helpers

Type Members

case class NegativeTimeout(t: Timeout) extends Product with Serializable

How long we should wait for something that we expect *not* to happen, e.g.
How long we should wait for something that we expect *not* to happen, e.g. waiting to make sure that a channel is *not* closed by some concurrent process.
NegativeTimeout is a separate type to a normal Timeout because we'll want to set it to a lower value. This is because in normal usage we'll need to wait for the full length of time to show that nothing has happened in that time. If the value is too high then we'll spend a lot of time waiting during normal usage. If it is too low, however, we may miss events that occur after the timeout has finished. This is a necessary tradeoff.
Where possible, tests should avoid using a NegativeTimeout. Tests will often know exactly when an event should occur. In this case they can perform a check for the event immediately rather than using using NegativeTimeout.

Definition Classes
DefaultAwaitTimeout

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val ACCEPT: String

Definition Classes
HeaderNames
val ACCEPTED: Int

Definition Classes
Status
val ACCEPT_CHARSET: String

Definition Classes
HeaderNames
val ACCEPT_ENCODING: String

Definition Classes
HeaderNames
val ACCEPT_LANGUAGE: String

Definition Classes
HeaderNames
val ACCEPT_RANGES: String

Definition Classes
HeaderNames
val ACCESS_CONTROL_ALLOW_CREDENTIALS: String

Definition Classes
HeaderNames
val ACCESS_CONTROL_ALLOW_HEADERS: String

Definition Classes
HeaderNames
val ACCESS_CONTROL_ALLOW_METHODS: String

Definition Classes
HeaderNames
val ACCESS_CONTROL_ALLOW_ORIGIN: String

Definition Classes
HeaderNames
val ACCESS_CONTROL_EXPOSE_HEADERS: String

Definition Classes
HeaderNames
val ACCESS_CONTROL_MAX_AGE: String

Definition Classes
HeaderNames
val ACCESS_CONTROL_REQUEST_HEADERS: String

Definition Classes
HeaderNames
val ACCESS_CONTROL_REQUEST_METHOD: String

Definition Classes
HeaderNames
val AGE: String

Definition Classes
HeaderNames
val ALLOW: String

Definition Classes
HeaderNames
val AUTHORIZATION: String

Definition Classes
HeaderNames
val BAD_GATEWAY: Int

Definition Classes
Status
val BAD_REQUEST: Int

Definition Classes
Status
val CACHE_CONTROL: String

Definition Classes
HeaderNames
val CHUNKED: String

Definition Classes
HttpProtocol
val CONFLICT: Int

Definition Classes
Status
val CONNECTION: String

Definition Classes
HeaderNames
val CONTENT_DISPOSITION: String

Definition Classes
HeaderNames
val CONTENT_ENCODING: String

Definition Classes
HeaderNames
val CONTENT_LANGUAGE: String

Definition Classes
HeaderNames
val CONTENT_LENGTH: String

Definition Classes
HeaderNames
val CONTENT_LOCATION: String

Definition Classes
HeaderNames
val CONTENT_MD5: String

Definition Classes
HeaderNames
val CONTENT_RANGE: String

Definition Classes
HeaderNames
val CONTENT_TRANSFER_ENCODING: String

Definition Classes
HeaderNames
val CONTENT_TYPE: String

Definition Classes
HeaderNames
val CONTINUE: Int

Definition Classes
Status
val COOKIE: String

Definition Classes
HeaderNames
val CREATED: Int

Definition Classes
Status
val DATE: String

Definition Classes
HeaderNames
val DELETE: String

Definition Classes
HttpVerbs
val ETAG: String

Definition Classes
HeaderNames
val EXPECT: String

Definition Classes
HeaderNames
val EXPECTATION_FAILED: Int

Definition Classes
Status
val EXPIRES: String

Definition Classes
HeaderNames
val FAILED_DEPENDENCY: Int

Definition Classes
Status
val FIREFOX: Class[FirefoxDriver]

Definition Classes
PlayRunners
val FORBIDDEN: Int

Definition Classes
Status
val FORWARDED: String

Definition Classes
HeaderNames
val FOUND: Int

Definition Classes
Status
val FROM: String

Definition Classes
HeaderNames
val GATEWAY_TIMEOUT: Int

Definition Classes
Status
val GET: String

Definition Classes
HttpVerbs
val GONE: Int

Definition Classes
Status
val HEAD: String

Definition Classes
HttpVerbs
val HOST: String

Definition Classes
HeaderNames
val HTMLUNIT: Class[HtmlUnitDriver]

Definition Classes
PlayRunners
val HTTP_1_0: String

Definition Classes
HttpProtocol
val HTTP_1_1: String

Definition Classes
HttpProtocol
val HTTP_VERSION_NOT_SUPPORTED: Int

Definition Classes
Status
val IF_MATCH: String

Definition Classes
HeaderNames
val IF_MODIFIED_SINCE: String

Definition Classes
HeaderNames
val IF_NONE_MATCH: String

Definition Classes
HeaderNames
val IF_RANGE: String

Definition Classes
HeaderNames
val IF_UNMODIFIED_SINCE: String

Definition Classes
HeaderNames
val INSUFFICIENT_STORAGE: Int

Definition Classes
Status
val INTERNAL_SERVER_ERROR: Int

Definition Classes
Status
val LAST_MODIFIED: String

Definition Classes
HeaderNames
val LENGTH_REQUIRED: Int

Definition Classes
Status
val LOCATION: String

Definition Classes
HeaderNames
val LOCKED: Int

Definition Classes
Status
val MAX_FORWARDS: String

Definition Classes
HeaderNames
val METHOD_NOT_ALLOWED: Int

Definition Classes
Status
val MOVED_PERMANENTLY: Int

Definition Classes
Status
val MULTIPLE_CHOICES: Int

Definition Classes
Status
val MULTI_STATUS: Int

Definition Classes
Status
val NON_AUTHORITATIVE_INFORMATION: Int

Definition Classes
Status
val NOT_ACCEPTABLE: Int

Definition Classes
Status
val NOT_FOUND: Int

Definition Classes
Status
val NOT_IMPLEMENTED: Int

Definition Classes
Status
val NOT_MODIFIED: Int

Definition Classes
Status
val NO_CONTENT: Int

Definition Classes
Status
val OK: Int

Definition Classes
Status
val OPTIONS: String

Definition Classes
HttpVerbs
val ORIGIN: String

Definition Classes
HeaderNames
val PARTIAL_CONTENT: Int

Definition Classes
Status
val PATCH: String

Definition Classes
HttpVerbs
val PAYMENT_REQUIRED: Int

Definition Classes
Status
val POST: String

Definition Classes
HttpVerbs
val PRAGMA: String

Definition Classes
HeaderNames
val PRECONDITION_FAILED: Int

Definition Classes
Status
val PROXY_AUTHENTICATE: String

Definition Classes
HeaderNames
val PROXY_AUTHENTICATION_REQUIRED: Int

Definition Classes
Status
val PROXY_AUTHORIZATION: String

Definition Classes
HeaderNames
val PUT: String

Definition Classes
HttpVerbs
val RANGE: String

Definition Classes
HeaderNames
val REFERER: String

Definition Classes
HeaderNames
val REQUESTED_RANGE_NOT_SATISFIABLE: Int

Definition Classes
Status
val REQUEST_ENTITY_TOO_LARGE: Int

Definition Classes
Status
val REQUEST_TIMEOUT: Int

Definition Classes
Status
val REQUEST_URI_TOO_LONG: Int

Definition Classes
Status
val RESET_CONTENT: Int

Definition Classes
Status
val RETRY_AFTER: String

Definition Classes
HeaderNames
val SEE_OTHER: Int

Definition Classes
Status
val SERVER: String

Definition Classes
HeaderNames
val SERVICE_UNAVAILABLE: Int

Definition Classes
Status
val SET_COOKIE: String

Definition Classes
HeaderNames
val SET_COOKIE2: String

Definition Classes
HeaderNames
val SWITCHING_PROTOCOLS: Int

Definition Classes
Status
val TE: String

Definition Classes
HeaderNames
val TEMPORARY_REDIRECT: Int

Definition Classes
Status
val TOO_MANY_REQUEST: Int

Definition Classes
Status
val TRAILER: String

Definition Classes
HeaderNames
val TRANSFER_ENCODING: String

Definition Classes
HeaderNames
val UNAUTHORIZED: Int

Definition Classes
Status
val UNPROCESSABLE_ENTITY: Int

Definition Classes
Status
val UNSUPPORTED_MEDIA_TYPE: Int

Definition Classes
Status
val UPGRADE: String

Definition Classes
HeaderNames
val USER_AGENT: String

Definition Classes
HeaderNames
val USE_PROXY: Int

Definition Classes
Status
val VARY: String

Definition Classes
HeaderNames
val VIA: String

Definition Classes
HeaderNames
val WARNING: String

Definition Classes
HeaderNames
val WWW_AUTHENTICATE: String

Definition Classes
HeaderNames
val X_FORWARDED_FOR: String

Definition Classes
HeaderNames
val X_FORWARDED_HOST: String

Definition Classes
HeaderNames
val X_FORWARDED_PORT: String

Definition Classes
HeaderNames
val X_FORWARDED_PROTO: String

Definition Classes
HeaderNames
val X_REQUESTED_WITH: String

Definition Classes
HeaderNames
final def asInstanceOf[T0]: T0

Definition Classes
Any
def await[T](future: Future[T], timeout: Long, unit: TimeUnit): T

Block until a Promise is redeemed with the specified timeout.
Block until a Promise is redeemed with the specified timeout.

Definition Classes
FutureAwaits
def await[T](future: Future[T])(implicit timeout: Timeout): T

Block until a Promise is redeemed.
Block until a Promise is redeemed.

Definition Classes
FutureAwaits
def call[T](action: EssentialAction, rh: RequestHeader, body: T)(implicit w: Writeable[T]): Future[Result]

Execute an play.api.mvc.EssentialAction.
Execute an play.api.mvc.EssentialAction.
The body is serialised using the implicit writable, so that the action body parser can deserialise it.

Definition Classes
EssentialActionCaller
def call[T](action: EssentialAction, req: Request[T])(implicit w: Writeable[T]): Future[Result]

Execute an play.api.mvc.EssentialAction.
Execute an play.api.mvc.EssentialAction.
The body is serialised using the implicit writable, so that the action body parser can deserialise it.

Definition Classes
EssentialActionCaller
def charset(of: Future[Result])(implicit timeout: Timeout): Option[String]

Extracts the Charset of this Result value.
Extracts the Charset of this Result value.

Definition Classes
ResultExtractors
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def contentAsBytes(of: Future[Result])(implicit timeout: Timeout): Array[Byte]

Extracts the content as bytes.
Extracts the content as bytes.

Definition Classes
ResultExtractors
def contentAsBytes(of: Content)(implicit timeout: Timeout): Array[Byte]

Extracts the content as bytes.
Extracts the content as bytes.

Definition Classes
ResultExtractors
def contentAsJson(of: Future[Result])(implicit timeout: Timeout): JsValue

Extracts the content as Json.
Extracts the content as Json.

Definition Classes
ResultExtractors
def contentAsJson(of: Content)(implicit timeout: Timeout): JsValue

Extracts the content as Json.
Extracts the content as Json.

Definition Classes
ResultExtractors
def contentAsString(of: Future[Result])(implicit timeout: Timeout): String

Extracts the content as String.
Extracts the content as String.

Definition Classes
ResultExtractors
def contentAsString(of: Content)(implicit timeout: Timeout): String

Extracts the content as String.
Extracts the content as String.

Definition Classes
ResultExtractors
def contentType(of: Future[Result])(implicit timeout: Timeout): Option[String]

Extracts the Content-Type of this Result value.
Extracts the Content-Type of this Result value.

Definition Classes
ResultExtractors
def contentType(of: Content)(implicit timeout: Timeout): String

Extracts the Content-Type of this Content value.
Extracts the Content-Type of this Content value.

Definition Classes
ResultExtractors
def cookies(of: Future[Result])(implicit timeout: Timeout): Cookies

Extracts the Cookies of this Result value.
Extracts the Cookies of this Result value.

Definition Classes
ResultExtractors
implicit def defaultAwaitTimeout: Timeout

The default await timeout.
The default await timeout. Override this to change it.

Definition Classes
DefaultAwaitTimeout
implicit val defaultNegativeTimeout: NegativeTimeout

Definition Classes
DefaultAwaitTimeout
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def flash(of: Future[Result])(implicit timeout: Timeout): Flash

Extracts the Flash values of this Result value.
Extracts the Flash values of this Result value.

Definition Classes
ResultExtractors
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def header(header: String, of: Future[Result])(implicit timeout: Timeout): Option[String]

Extracts an Header value of this Result value.
Extracts an Header value of this Result value.

Definition Classes
ResultExtractors
def headers(of: Future[Result])(implicit timeout: Timeout): Map[String, String]

Extracts all Headers of this Result value.
Extracts all Headers of this Result value.

Definition Classes
ResultExtractors
def inMemoryDatabase(name: String = "default", options: Map[String, String] = Map.empty[String, String]): Map[String, String]

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

Definition Classes
PlayRunners
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def jRoute[T](app: Application, r: RequestHeader, body: T): Option[Future[Result]]

Definition Classes
RouteInvokers
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def redirectLocation(of: Future[Result])(implicit timeout: Timeout): Option[String]

Extracts the Location header of this Result value if this Result is a Redirect.
Extracts the Location header of this Result value if this Result is a Redirect.

Definition Classes
ResultExtractors
def route[T](req: Request[T])(implicit w: Writeable[T]): Option[Future[Result]]

Use the HttpRequestHandler to determine the Action to call for this request and execute it.
Use the HttpRequestHandler to determine the Action to call for this request and execute it.
The body is serialised using the implicit writable, so that the action body parser can deserialise it.

Definition Classes
RouteInvokers
def route[T](app: Application, req: Request[T])(implicit w: Writeable[T]): Option[Future[Result]]

Use the HttpRequestHandler to determine the Action to call for this request and execute it.
Use the HttpRequestHandler to determine the Action to call for this request and execute it.
The body is serialised using the implicit writable, so that the action body parser can deserialise it.

Definition Classes
RouteInvokers
def route[T](rh: RequestHeader, body: T)(implicit w: Writeable[T]): Option[Future[Result]]

Use the HttpRequestHandler to determine the Action to call for this request and execute it.
Use the HttpRequestHandler to determine the Action to call for this request and execute it.
The body is serialised using the implicit writable, so that the action body parser can deserialise it.

Definition Classes
RouteInvokers
def route[T](app: Application, rh: RequestHeader, body: T)(implicit w: Writeable[T]): Option[Future[Result]]

Use the HttpRequestHandler to determine the Action to call for this request and execute it.
Use the HttpRequestHandler to determine the Action to call for this request and execute it.
The body is serialised using the implicit writable, so that the action body parser can deserialise it.

Definition Classes
RouteInvokers
def running[T](testServer: TestServer, webDriver: WebDriver)(block: (TestBrowser) ⇒ T): T

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

Definition Classes
PlayRunners
def running[T, WEBDRIVER <: WebDriver](testServer: TestServer, webDriver: Class[WEBDRIVER])(block: (TestBrowser) ⇒ T): T

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

Definition Classes
PlayRunners
def running[T](testServer: TestServer)(block: ⇒ T): T

Executes a block of code in a running server.
Executes a block of code in a running server.

Definition Classes
PlayRunners
def running[T](app: Application)(block: ⇒ T): T

Executes a block of code in a running application.
Executes a block of code in a running application.

Definition Classes
PlayRunners
def session(of: Future[Result])(implicit timeout: Timeout): Session

Extracts the Session of this Result value.
Extracts the Session of this Result value. Extracts the Session from this Result value.

Definition Classes
ResultExtractors
def status(of: Future[Result])(implicit timeout: Timeout): Int

Extracts the Status code of this Result value.
Extracts the Status code of this Result value.

Definition Classes
ResultExtractors
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
lazy val testServerPort: Int

The port to use for a test server.
The port to use for a test server. Defaults to 19001. May be configured using the system property testserver.port

Definition Classes
PlayRunners
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
implicit def writeableOf_AnyContentAsEmpty(implicit code: Codec): Writeable[AnyContentAsEmpty.type]

Definition Classes
Writeables
implicit def writeableOf_AnyContentAsFormUrlEncoded(implicit code: Codec): Writeable[AnyContentAsFormUrlEncoded]

Definition Classes
Writeables
implicit def writeableOf_AnyContentAsJson(implicit codec: Codec): Writeable[AnyContentAsJson]

Definition Classes
Writeables
implicit def writeableOf_AnyContentAsRaw: Writeable[AnyContentAsRaw]

Definition Classes
Writeables
implicit def writeableOf_AnyContentAsText(implicit code: Codec): Writeable[AnyContentAsText]

Definition Classes
Writeables
implicit def writeableOf_AnyContentAsXml(implicit codec: Codec): Writeable[AnyContentAsXml]

Definition Classes
Writeables

Related Doc: package test

object Helpers extends PlayRunners with HeaderNames with Status with HttpProtocol with DefaultAwaitTimeout with ResultExtractors with Writeables with EssentialActionCaller with RouteInvokers with FutureAwaits

Type Members

case class NegativeTimeout(t: Timeout) extends Product with Serializable

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val ACCEPT: String

val ACCEPTED: Int

val ACCEPT_CHARSET: String

val ACCEPT_ENCODING: String

val ACCEPT_LANGUAGE: String

val ACCEPT_RANGES: String

val ACCESS_CONTROL_ALLOW_CREDENTIALS: String

val ACCESS_CONTROL_ALLOW_HEADERS: String

val ACCESS_CONTROL_ALLOW_METHODS: String

val ACCESS_CONTROL_ALLOW_ORIGIN: String

val ACCESS_CONTROL_EXPOSE_HEADERS: String

val ACCESS_CONTROL_MAX_AGE: String

val ACCESS_CONTROL_REQUEST_HEADERS: String

val ACCESS_CONTROL_REQUEST_METHOD: String

val AGE: String

val ALLOW: String

val AUTHORIZATION: String

val BAD_GATEWAY: Int

val BAD_REQUEST: Int

val CACHE_CONTROL: String

val CHUNKED: String

val CONFLICT: Int

val CONNECTION: String

val CONTENT_DISPOSITION: String

val CONTENT_ENCODING: String

val CONTENT_LANGUAGE: String

val CONTENT_LENGTH: String

val CONTENT_LOCATION: String

val CONTENT_MD5: String

val CONTENT_RANGE: String

val CONTENT_TRANSFER_ENCODING: String

val CONTENT_TYPE: String

val CONTINUE: Int

val COOKIE: String

val CREATED: Int

val DATE: String

val DELETE: String

val ETAG: String

val EXPECT: String

val EXPECTATION_FAILED: Int

val EXPIRES: String

val FAILED_DEPENDENCY: Int

val FIREFOX: Class[FirefoxDriver]

val FORBIDDEN: Int

val FORWARDED: String

val FOUND: Int

val FROM: String

val GATEWAY_TIMEOUT: Int

val GET: String

val GONE: Int

val HEAD: String

val HOST: String

val HTMLUNIT: Class[HtmlUnitDriver]

val HTTP_1_0: String

val HTTP_1_1: String

val HTTP_VERSION_NOT_SUPPORTED: Int

val IF_MATCH: String

val IF_MODIFIED_SINCE: String

val IF_NONE_MATCH: String

val IF_RANGE: String

val IF_UNMODIFIED_SINCE: String

val INSUFFICIENT_STORAGE: Int

val INTERNAL_SERVER_ERROR: Int

val LAST_MODIFIED: String

val LENGTH_REQUIRED: Int

val LOCATION: String

val LOCKED: Int

val MAX_FORWARDS: String

val METHOD_NOT_ALLOWED: Int

val MOVED_PERMANENTLY: Int

val MULTIPLE_CHOICES: Int