play-mockws

Play MockWS is a mock WS client for Play Framework.

If:

you write an application in Scala with the Play Framework
the application makes HTTP calls to external web services with the WS client
you want to test your implementation

then you can use play-mockws to simulate HTTP requests to external web services in your tests.

Example

// simulation of a GET request to http://dns/url
val ws = MockWS {
  case (GET, "http://dns/url") => Action { Ok("http response") }
}

await(ws.url("http://dns/url").get()).body == "http response"

Adding play-mockws to your project

Add MockWS as test dependency in the build.sbt:

libraryDependencies += "de.leanovate.play-mockws" %% "play-mockws" % "0.13" % "test"

The last version can be found on Maven Central

And use it:

import mockws.MockWS

val ws = MockWS { ... }

Usage

General usage

A MockWS instance can be directly constructed with a partial function like this:

val ws = MockWS {
  case (GET, "/") => Action { Ok("homepage") }
  case (POST, "/users") => Action { request => Created((request.body.asJson.get \ "id").as[String]) }
  case (GET, "/users/24") => Action { NotFound("") }
}

The partial function binds 2 Strings, an HTTP method and the URL, to a Play Action.

For clarity this partial function is aliased as MockWS.Routes

When calling MockWS.url(), if the HTTP method and the URL are found, the defined play action is evaluated.

Controlling the routes

If you want to control more the routes, for example to know whether a route was called or how many times, use the Route class for this.

Routes can be defined together with the standard function orElse.

val route1 = Route {
  case (GET, "/route1") => Action { Ok("") }
}
val route2 = Route {
  case (GET, "/route2") => Action { Ok("") }
}

val ws = MockWS(route1 orElse route2)

await(ws.url("/route1").get())

route1.called == true
route2.called == false

route1.timeCalled == 1
route2.timeCalled == 0

An example how to structure an implementation to test it with MockWS can be found here.

Other examples can be found in the tests.

Compatibility Matrix

MockWS is actually only compatible with Play 2.3.x., with Scala 2.10 or 2.11.

Releasee Notes

0.13: handle URL query parameters
0.12: remove dependency to specs2 - retain only mockito
0.11: add Route

Developer info

Travis:

jdanbrown / play-mockws