com.lightbend.lagom.javadsl.testkit

Class ServiceTest

Object

com.lightbend.lagom.javadsl.testkit.ServiceTest

public class ServiceTest
extends Object

Support for writing functional tests for one service. The service is running in a server and in the test you can interact with it using its service client, i.e. calls to the service API.

Dependencies to other services must be replaced by stub or mock implementations by overriding the bindings of the GuiceApplicationBuilder in the Setup.

The server is by default running with persistence, pubsub and cluster features enabled. Cassandra is also started before the test server is started. If your service does not use these features you can disable them in the Setup, which will reduce the startup time.

There are two different styles that can be used. It is most convenient to use withServer, since it automatically starts and stops the server before and after the given lambda. When your test have several test methods, and especially when using persistence, it is faster to only start the server once in a static method annotated with @BeforeClass and stop it in a method annotated with @AfterClass.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServiceTest.Setup
static class	ServiceTest.Setup$
static class	ServiceTest.TestServer When the server is started you can get the service client and other Guice bindings here.

Constructor Summary

Constructors

Constructor and Description
ServiceTest()

Method Summary

Modifier and Type	Method and Description
static <T> play.api.inject.BindingKey<T>	bind(Class<T> clazz) Create a binding that can be used with the GuiceApplicationBuilder in the Setup, e.g.
static ServiceTest.Setup	defaultSetup() The default Setup configuration, which has persistence enabled.
static void	eventually(scala.concurrent.duration.FiniteDuration max, akka.japi.function.Effect block) Retry the give block (lambda) until it does not throw an exception or the timeout expires, whichever comes first.
static void	eventually(scala.concurrent.duration.FiniteDuration max, scala.concurrent.duration.FiniteDuration interval, akka.japi.function.Effect block) Retry the give block (lambda) until it does not throw an exception or the timeout expires, whichever comes first.
static ServiceTest.TestServer	startServer(ServiceTest.Setup setup) Start the test server with the given setup.
static void	withServer(ServiceTest.Setup setup, akka.japi.function.Procedure<ServiceTest.TestServer> block) Start the test server with the given setup and run the block (lambda).

Methods inherited from class Object

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

Constructor Detail

ServiceTest

public ServiceTest()

Method Detail

defaultSetup

public static ServiceTest.Setup defaultSetup()

The default Setup configuration, which has persistence enabled.

withServer

public static void withServer(ServiceTest.Setup setup,
                              akka.japi.function.Procedure<ServiceTest.TestServer> block)

Start the test server with the given setup and run the block (lambda). When the block returns or throws the test server will automatically be stopped.

This method should be used when the server can be started and stopped for each test method. When your test have several test methods, and especially when using persistence, it is faster to only start the server once with startServer(com.lightbend.lagom.javadsl.testkit.ServiceTest.Setup).

You can get the service client from the TestServer that is passed as parameter to the block.

startServer

public static ServiceTest.TestServer startServer(ServiceTest.Setup setup)

Start the test server with the given setup. You must stop the server with the stop method of the returned TestServer when the test is finished.

When your test have several test methods, and especially when using persistence, it is faster to only start the server once in a static method annotated with @BeforeClass and stop it in a method annotated with @AfterClass. Otherwise withServer is more convenient.

You can get the service client from the returned TestServer.

eventually

public static void eventually(scala.concurrent.duration.FiniteDuration max,
                              akka.japi.function.Effect block)

Retry the give block (lambda) until it does not throw an exception or the timeout expires, whichever comes first. If the timeout expires the last exception is thrown. The block is retried with 100 milliseconds interval.

eventually

public static void eventually(scala.concurrent.duration.FiniteDuration max,
                              scala.concurrent.duration.FiniteDuration interval,
                              akka.japi.function.Effect block)

Retry the give block (lambda) until it does not throw an exception or the timeout expires, whichever comes first. If the timeout expires the last exception is thrown. The block is retried with the given interval.

bind

public static <T> play.api.inject.BindingKey<T> bind(Class<T> clazz)

Create a binding that can be used with the GuiceApplicationBuilder in the Setup, e.g. to override bindings to stub out dependencies to other services.