org.jukito

Class TestModule

java.lang.Object

com.google.inject.AbstractModule

org.jukito.TestModule

All Implemented Interfaces:

Module

Direct Known Subclasses:

JukitoModule

public abstract class TestModule
extends AbstractModule

A guice Module with a bit of syntactic sugar to bind within typical test scopes. Depends on mockito.

Depends on Mockito.

Author:

Philippe Beaudoin

Field Summary

Fields

Modifier and Type	Field and Description
protected Class<?>	testClass

Constructor Summary

Constructors

Constructor and Description
TestModule()

Method Summary

Methods

Modifier and Type	Method and Description
protected <T> void	bindMany(Class<T> clazz, Class<? extends T>... boundClasses) This method binds many different classes to the same interface.
protected <T,V extends T> void	bindMany(TypeLiteral<T> type, TypeLiteral<? extends T>... boundTypes) This method binds many different type litterals to the same type litteral.
protected <T,V extends T> void	bindManyInstances(Class<T> clazz, V... instances) This method binds many different instances to the same class or interface.
protected <T,V extends T> void	bindManyInstances(TypeLiteral<T> type, V... instances) This method binds many different instances to the same type literal.
protected <T> ScopedBindingBuilder	bindMock(Class<T> klass) Binds an interface to a mocked version of itself.
protected <T> ScopedBindingBuilder	bindMock(TypeLiteral<T> typeLiteral) Binds an interface annotated with a @Named to a mocked version of itself.
protected <T> LinkedBindingBuilder<T>	bindNamed(Class<T> klass, String name) Binds an interface annotated with a @Named.
protected <T> LinkedBindingBuilder<T>	bindNamed(TypeLiteral<T> typeLiteral, String name) Binds an interface annotated with a @Named.
protected <T> ScopedBindingBuilder	bindNamedMock(Class<T> klass, String name) Binds an interface annotated with a @Named to a mocked version of itself.
protected <T> ScopedBindingBuilder	bindNamedMock(TypeLiteral<T> typeLiteral, String name) Binds an interface annotated with a @Named to a mocked version of itself.
protected <T> ScopedBindingBuilder	bindNamedSpy(Class<T> klass, String name) Binds a concrete object type annotated with a @Named so that spies of instances are returned instead of instances themselves.
protected <T> ScopedBindingBuilder	bindNamedSpy(TypeLiteral<T> typeLiteral, String name) Binds a concrete object type annotated with a @Named so that spies of instances are returned instead of instances themselves.
protected void	bindScopes()
protected <T> ScopedBindingBuilder	bindSpy(Class<T> klass) Binds a concrete object type so that spies of instances are returned instead of instances themselves.
protected <T> ScopedBindingBuilder	bindSpy(TypeLiteral<T> typeLiteral) Binds a concrete object type so that spies of instances are returned instead of instances themselves.
void	configure()
protected abstract void	configureTest() Configures a test Module via the exposed methods.
void	setTestClass(Class<?> testClass) Attach the TestModule to a given test class.

Methods inherited from class com.google.inject.AbstractModule

addError, addError, addError, bind, bind, bind, bindConstant, binder, bindInterceptor, bindListener, bindScope, configure, convertToTypes, currentStage, getMembersInjector, getMembersInjector, getProvider, getProvider, install, requestInjection, requestStaticInjection, requireBinding, requireBinding

Methods inherited from class java.lang.Object

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

Field Detail

testClass

protected Class<?> testClass

Constructor Detail

TestModule

public TestModule()

Method Detail

setTestClass

public void setTestClass(Class<?> testClass)

Attach the TestModule to a given test class.

Parameters:

testClass - The test class to attach to this TestModule.

configure

public void configure()

Specified by:

configure in class AbstractModule

bindScopes

protected void bindScopes()

configureTest

protected abstract void configureTest()

Configures a test Module via the exposed methods.

bindMock

protected <T> ScopedBindingBuilder bindMock(Class<T> klass)

Binds an interface to a mocked version of itself. You will usually want to bind this in the TestSingleton scope.

Type Parameters:

T - The type of the interface to bind

Parameters:

klass - The class to bind

Returns:

A ScopedBindingBuilder.

bindMock

protected <T> ScopedBindingBuilder bindMock(TypeLiteral<T> typeLiteral)

Binds an interface annotated with a @Named to a mocked version of itself. You will usually want to bind this in the TestSingleton scope.

Type Parameters:

T - The type of the interface to bind, a parameterized type

Parameters:

typeLiteral - The TypeLiteral corresponding to the parameterized type to bind.

Returns:

A ScopedBindingBuilder.

bindSpy

protected <T> ScopedBindingBuilder bindSpy(Class<T> klass)

Binds a concrete object type so that spies of instances are returned instead of instances themselves. You will usually want to bind this in the TestSingleton scope.

Type Parameters:

T - The type of the interface to bind

Parameters:

klass - The class to bind

Returns:

A ScopedBindingBuilder.

bindSpy

protected <T> ScopedBindingBuilder bindSpy(TypeLiteral<T> typeLiteral)

Binds a concrete object type so that spies of instances are returned instead of instances themselves. You will usually want to bind this in the TestSingleton scope.

Type Parameters:

T - The type of the interface to bind, a parameterized type

Parameters:

typeLiteral - The TypeLiteral corresponding to the parameterized type to bind.

Returns:

A ScopedBindingBuilder.

bindNamedMock

protected <T> ScopedBindingBuilder bindNamedMock(Class<T> klass,
                                     String name)

Binds an interface annotated with a @Named to a mocked version of itself. You will usually want to bind this in the TestSingleton scope.

Type Parameters:

T - The type of the interface to bind

Parameters:

klass - The class to bind

name - The name used with the @Named annotation.

Returns:

A ScopedBindingBuilder.

bindNamedMock

protected <T> ScopedBindingBuilder bindNamedMock(TypeLiteral<T> typeLiteral,
                                     String name)

Binds an interface annotated with a @Named to a mocked version of itself. You will usually want to bind this in the TestSingleton scope.

Type Parameters:

T - The type of the interface to bind

Parameters:

typeLiteral - The TypeLiteral corresponding to the parameterized type to bind.

name - The name used with the @Named annotation.

Returns:

A ScopedBindingBuilder.

bindNamedSpy

protected <T> ScopedBindingBuilder bindNamedSpy(Class<T> klass,
                                    String name)

Binds a concrete object type annotated with a @Named so that spies of instances are returned instead of instances themselves. You will usually want to bind this in the TestSingleton scope.

Type Parameters:

T - The type of the interface to bind

Parameters:

klass - The class to bind

name - The name used with the @Named annotation.

Returns:

A ScopedBindingBuilder.

bindNamedSpy

protected <T> ScopedBindingBuilder bindNamedSpy(TypeLiteral<T> typeLiteral,
                                    String name)

Binds a concrete object type annotated with a @Named so that spies of instances are returned instead of instances themselves. You will usually want to bind this in the TestSingleton scope.

Type Parameters:

T - The type of the interface to bind

Parameters:

typeLiteral - The TypeLiteral corresponding to the parameterized type to bind.

name - The name used with the @Named annotation.

Returns:

A ScopedBindingBuilder.

bindManyInstances

protected <T,V extends T> void bindManyInstances(Class<T> clazz,
                                     V... instances)

This method binds many different instances to the same class or interface. Use this only if the instances are totally stateless. That is, they are immutable and have no mutable dependencies (e.g. a String or a simple POJO). For more complex classes use bindMany(java.lang.Class<T>, java.lang.Class<? extends T>...).

The specified Class will be bound to all the different instances, each binding using a different unique annotation.

This method is useful when combined with the @All annotation.

Parameters:

clazz - The Class to which the instances will be bound.

instances - All the instances to bind.

bindManyInstances

protected <T,V extends T> void bindManyInstances(TypeLiteral<T> type,
                                     V... instances)

This method binds many different instances to the same type literal. Use this only if the instances are totally stateless. That is, they are immutable and have no mutable dependencies (e.g. a String or a simple POJO). For more complex classes use bindMany(java.lang.Class<T>, java.lang.Class<? extends T>...).

The specified TypeLiteral will be bound to all the different instances, each binding using a different unique annotation.

This method is useful when combined with the @All annotation.

Parameters:

type - The TypeLiteral to which the instances will be bound.

instances - All the instances to bind.

bindMany

protected <T> void bindMany(Class<T> clazz,
                Class<? extends T>... boundClasses)

This method binds many different classes to the same interface. All the classes will be bound within the TestScope.SINGLETON scope.

This method is useful when combined with the @All annotation.

Parameters:

clazz - The Class to which the instances will be bound.

boundClasses - All the classes to bind.

bindMany

protected <T,V extends T> void bindMany(TypeLiteral<T> type,
                            TypeLiteral<? extends T>... boundTypes)

This method binds many different type litterals to the same type litteral. All the classes will be bound within the TestScope.SINGLETON scope.

This method is useful when combined with the @All annotation.

Parameters:

type - The Class to which the instances will be bound.

boundTypes - All the types to bind.

bindNamed

protected <T> LinkedBindingBuilder<T> bindNamed(Class<T> klass,
                                    String name)

Binds an interface annotated with a @Named.

Type Parameters:

T - The type of the interface to bind

Parameters:

klass - The class to bind

name - The name used with the @Named annotation.

Returns:

A ScopedBindingBuilder.

bindNamed

protected <T> LinkedBindingBuilder<T> bindNamed(TypeLiteral<T> typeLiteral,
                                    String name)

Binds an interface annotated with a @Named.

Type Parameters:

T - The type of the interface to bind

Parameters:

typeLiteral - The TypeLiteral corresponding to the parameterized type to bind.

name - The name used with the @Named annotation.

Returns:

A ScopedBindingBuilder.