ServiceTest

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 ran standalone without persistence, pubsub or cluster features enabled. Cassandra is also disabled by default. If your service require either of these features you can enable them in the Setup.

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.

Source: ServiceTest.scala

Linear Supertypes

AnyRef, Any

Type Members

sealed trait Setup extends AnyRef
class TestServer extends AnyRef

When the server is started you can get the service client and other Guice bindings here.

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
final def asInstanceOf[T0]: T0

Definition Classes
Any
def bind[T](clazz: Class[T]): BindingKey[T]

Create a binding that can be used with the GuiceApplicationBuilder in the Setup, e.g.
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.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val defaultSetup: Setup

The default Setup configuration, which has persistence enabled.
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def eventually(max: FiniteDuration, interval: FiniteDuration, block: Effect): Unit

Retry the give block (lambda) until it does not throw an exception or the timeout expires, whichever comes first.
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.
def eventually(max: FiniteDuration, block: Effect): Unit

Retry the give block (lambda) until it does not throw an exception or the timeout expires, whichever comes first.
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.
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def startServer(setup: Setup): TestServer

Start the test server with the given 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.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
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( ... )
def withServer(setup: Setup, block: Procedure[TestServer]): Unit

Start the test server with the given setup and run the block (lambda).
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.
You can get the service client from the TestServer that is passed as parameter to the block.

Related Doc: package testkit

object ServiceTest

Type Members

sealed trait Setup extends AnyRef

class TestServer extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def bind[T](clazz: Class[T]): BindingKey[T]

def clone(): AnyRef

val defaultSetup: Setup

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def eventually(max: FiniteDuration, interval: FiniteDuration, block: Effect): Unit

def eventually(max: FiniteDuration, block: Effect): Unit

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def startServer(setup: Setup): TestServer

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def withServer(setup: Setup, block: Procedure[TestServer]): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped