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.
// 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"Add MockWS as test dependency in the build.sbt.
| play-mock-ws version | Play versions | Scala versions |
|---|---|---|
| 3.0.x | 2.8, 2.9, 3.0 | 2.12, 2.13, 3.3 |
| 2.9.x | 2.9 | 2.13, 3.3 |
| 2.8.x | 2.8 | 2.12, 2.13 |
| 2.7.1 | 2.7 | 2.11, 2.12, 2.13 |
| 2.7.0 | 2.7 | 2.11, 2.12 |
| 2.6.x | 2.6 | 2.11, 2.12 |
| 2.5.x | 2.5 | 2.11 |
| 2.4.x | 2.4 | 2.10, 2.11 |
| 2.3.x | 2.3 | 2.10, 2.11 |
// Play 3.0.x
libraryDependencies += "de.leanovate.play-mockws" %% "play-mockws-3-0" % "3.0.1" % Test
// Play 2.9.x
libraryDependencies += "de.leanovate.play-mockws" %% "play-mockws-2-9" % "3.0.1" % Test
// Play 2.8.x
libraryDependencies += "de.leanovate.play-mockws" %% "play-mockws-2-8" % "3.0.1" % TestNote that before the version 3.x, play-mockws was following a different naming and versioning scheme:
// Play 2.9.x
libraryDependencies += "de.leanovate.play-mockws" %% "play-mockws" % "2.9.0" % Test
// Play 2.8.x
libraryDependencies += "de.leanovate.play-mockws" %% "play-mockws" % "2.8.0" % Test
// Play 2.7.x
libraryDependencies += "de.leanovate.play-mockws" %% "play-mockws" % "2.7.1" % Test
// Play 2.6.x
libraryDependencies += "de.leanovate.play-mockws" %% "play-mockws" % "2.6.6" % Test
// Play 2.5.x
libraryDependencies += "de.leanovate.play-mockws" %% "play-mockws" % "2.5.2" % Test
// Play 2.4.x
libraryDependencies += "de.leanovate.play-mockws" %% "play-mockws" % "2.4.2" % Test
// Play 2.3.x
libraryDependencies += "de.leanovate.play-mockws" %% "play-mockws" % "2.3.2" % TestFrom the 2.6 version, it is recommended that your tests either extend trait MockWSHelpers or import MockWSHelpers. MockWSHelpers provides an implicit Materializer you need when working with Play's Actions.
class MySpec extends FreeSpec with Matchers with MockWSHelpers with BeforeAndAfterAll {
...
override def afterAll(): Unit = {
shutdownHelpers()
}
}or
import mockws.MockWSHelpers._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.
If you want more control on 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 == 0An example how to structure an implementation to test it with MockWS can be found here.
Other examples can be found in the tests.
See RELEASE-NOTES.md or GitHub releases.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent