org.jukito

Class JukitoModule

java.lang.Object

com.google.inject.AbstractModule

org.jukito.TestModule

org.jukito.JukitoModule

All Implemented Interfaces:

Module

public abstract class JukitoModule
extends TestModule

A guice Module with a bit of syntactic sugar to bind within typical test scopes. Depends on mockito. This module automatically mocks any interface or abstract class dependency for which a binding is not explicitly provided. Any concrete class for which a binding is not explicitly provided is bound as a TestScope.SINGLETON.

Depends on Mockito.

Author:

Philippe Beaudoin

Field Summary

Fields

Modifier and Type	Field and Description
protected List<BindingsCollector.BindingInfo>	bindingsObserved

Fields inherited from class org.jukito.TestModule

testClass

Constructor Summary

Constructors

Constructor and Description
JukitoModule()

Method Summary

Methods

Modifier and Type	Method and Description
void	configure()
protected void	forceMock(Class<?> klass) By default, only abstract classes, interfaces and classes annotated with TestMockSingleton are automatically mocked.
Writer	getReportWriter() Override and return the Writer you want to use to report the tree of test objects,and whether they were mocked, spied, automatically instantiated, or explicitly bound.
void	printReport(List<BindingsCollector.BindingInfo> allBindings) Outputs the report, see #setReportWriter(Writer).
void	setBindingsObserved(List<BindingsCollector.BindingInfo> bindingsObserved) Attach this JukitoModule to a list of the bindings that were observed by a preliminary run of BindingsCollector.

Methods inherited from class org.jukito.TestModule

bindMany, bindMany, bindManyInstances, bindManyInstances, bindMock, bindMock, bindNamed, bindNamed, bindNamedMock, bindNamedMock, bindNamedSpy, bindNamedSpy, bindScopes, bindSpy, bindSpy, configureTest, setTestClass

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

bindingsObserved

protected List<BindingsCollector.BindingInfo> bindingsObserved

Constructor Detail

JukitoModule

public JukitoModule()

Method Detail

setBindingsObserved

public void setBindingsObserved(List<BindingsCollector.BindingInfo> bindingsObserved)

Attach this JukitoModule to a list of the bindings that were observed by a preliminary run of BindingsCollector.

Parameters:

bindingsObserved - The observed bindings.

forceMock

protected void forceMock(Class<?> klass)

By default, only abstract classes, interfaces and classes annotated with TestMockSingleton are automatically mocked. Use forceMock to indicate that all concrete classes derived from the a specific type will be mocked in TestMockSingleton scope.

Parameters:

klass - The Class or interface for which all subclasses will be mocked.

configure

public final void configure()

Overrides:

configure in class TestModule

getReportWriter

public Writer getReportWriter()

Override and return the Writer you want to use to report the tree of test objects,and whether they were mocked, spied, automatically instantiated, or explicitly bound. Mostly useful for debugging.

Returns:

The Writer, if null no report will be output.

printReport

public void printReport(List<BindingsCollector.BindingInfo> allBindings)

Outputs the report, see #setReportWriter(Writer). Will not output anything if the reportWriter is null. Do not call directly, it will be called by JukitoRunner. To obtain a report, override getReportWriter().