root
API
Generated with
root/play.api/play.api.test/WsTestClient

WsTestClient

play.api.test.WsTestClient$
See theWsTestClient companion trait
object WsTestClient extends WsTestClient

Attributes

Companion
trait
Graph
Supertypes
trait WsTestClient
class Object
trait Matchable
class Any
Self type

Members list

Type members

Classlikes

class InternalWSClient(scheme: String, port: Port) extends WSClient

Creates a standalone WSClient, using its own ActorSystem and Netty thread pool.

Creates a standalone WSClient, using its own ActorSystem and Netty thread pool.

This client has no dependencies at all on the underlying system, but is wasteful of resources.

Value parameters

port

the port to connect to the server on.

scheme

the scheme to connect on ("http" or "https")

Attributes

Supertypes
trait WSClient
trait Closeable
trait AutoCloseable
class Object
trait Matchable
class Any
Show all

Inherited types

type Port = Int

Attributes

Inherited from:
WsTestClient

Value members

Inherited methods

def withClient[T](block: WSClient => T)(implicit port: Port, scheme: String): T

Run the given block of code with a client.

Run the given block of code with a client.

The client passed to the block of code supports absolute path relative URLs passed to the url method. If an absolute path relative URL is used, the protocol is assumed to be http, the host localhost, and the port is the implicit port parameter passed to this method. This is designed to work smoothly with the Server.with* methods, for example:

Server.withRouter() {
 case GET(p"/hello/$who") => Action(Ok("Hello " + who))
} { implicit port =>
 withClient { ws =>
   await(ws.url("/hello/world").get()).body must_== "Hello world"
 }
}

Value parameters

block

The block of code to run

port

The port

Attributes

Returns

The result of the block of code

Inherited from:
WsTestClient
def wsCall(call: Call)(implicit port: Port, client: (Port, String) => WSClient, scheme: String): WSRequest

Constructs a WS request for the given reverse route. Optionally takes a WSClient producing function. Note that the WS client used by default requires a running Play application (use WithApplication for tests).

Constructs a WS request for the given reverse route. Optionally takes a WSClient producing function. Note that the WS client used by default requires a running Play application (use WithApplication for tests).

For example:

"work" in new WithApplication() { implicit app =>
 wsCall(controllers.routes.Application.index()).get()
}

Attributes

Inherited from:
WsTestClient
def wsUrl(url: String)(implicit port: Port, client: (Port, String) => WSClient, scheme: String): WSRequest

Constructs a WS request holder for the given relative URL. Optionally takes a scheme, a port, or a client producing function. Note that the WS client used by default requires a running Play application (use WithApplication for tests).

Constructs a WS request holder for the given relative URL. Optionally takes a scheme, a port, or a client producing function. Note that the WS client used by default requires a running Play application (use WithApplication for tests).

Attributes

Inherited from:
WsTestClient
Generated with