org.spincast.testing.core

Class SpincastTestBase

java.lang.Object

org.spincast.testing.core.SpincastTestBase

All Implemented Interfaces:

BeforeAfterClassMethodsProvider, RepeatedClassAfterMethodProvider, TestFailureListener

Direct Known Subclasses:

IntegrationTestBase, UnitTestBase

public abstract class SpincastTestBase
extends Object
implements BeforeAfterClassMethodsProvider, TestFailureListener, RepeatedClassAfterMethodProvider

Base class for Spincast test classes.

Uses a custom Junit runner, SpincastJUnitRunner.

This runner create a single instance of the test class for all of its tests, instead of a new instance for each test. It also calls a beforeClass() method before the tests are run and an afterClass() method after they are run.

A class extending this will be part of a Guice context (created using the createInjector method) and the required dependencies will be injected into it.

The NAME_ASCENDING option is used to sort the tests. This means you can force the order in which tests are run by prefixeing them with something like : "t01_firstTest", "t02_secondTest", etc.

A GuiceTweaker instance is used to be able to tweak a Guice context automagaically. This for example allows you to start your actual application, using its main() method, but still be able to mock some components for testing purposes. Note that the Guice tweaker only works when the Guice context is created using the standard Spincast bootstrapper.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
SpincastTestBase()

Method Summary

Modifier and Type	Method and Description
protected void	addExtraSystemProperties() Adds System properties as they are provided by the getExtraSystemProperties() method.
void	afterClass() Called after the tests of the class are ran.
void	afterClassLoops() Called after all the loops of the class as specified by the @repeat annotation.
void	afterTest()
void	beforeClass() Called before the tests of the class are ran.
void	beforeClassException(Throwable ex) This method will be called if an exception occures during the BeforeAfterClassMethodsProvider.beforeClass() execution.
void	beforeTest()
protected GuiceTweaker	createGuiceTweaker()
protected abstract com.google.inject.Injector	createInjector() The test class must implement this method to create the Guice injector.
protected String	createTestingFilePath() Create a temporary test file.
protected String	createTestingFilePath(String relativePath) Create a temporary test file, using the given relative path.
protected void	deleteTempDir()
protected Map<String,String>	getExtraSystemProperties() Extra System properties to set before the tests are run.
protected Class<? extends SpincastConfig>	getGuiceTweakerConfigImplementationClass() The implementation to use for the SpincastConfig binding when isGuiceTweakerAutoTestingConfigBindings() is enabled.
protected GuiceTweaker	getGuiceTweakerFromThreadLocal()
protected com.google.inject.Module	getGuiceTweakerOverridingModule() If an overriding Module is to be added using the Guice tweaker.
protected List<SpincastPlugin>	getGuiceTweakerPlugins() Extra plugins to be added by the Guice Tweaker.
protected com.google.inject.Injector	getInjector()
protected SpincastConfig	getSpincastConfig()
protected File	getTestingWritableDir()
protected boolean	isGuiceTweakerAutoTestingConfigBindings() Should the SpincastConfig bindings be automatically configured? If true (the default), any bindings for components in the hierarchy of SpincastConfig will be removed and new bindings will be added using the testing implementation returned by getGuiceTweakerConfigImplementationClass().
protected void	resetSystemProperties() Resets System properties.
protected void	setSpincastConfig(SpincastConfig spincastConfig)
void	testFailure(org.junit.runner.notification.Failure failure) You can override this method to be informed when a test fails.
protected void	validateCreatedInjector(com.google.inject.Injector guice) Validates the created Injector, before the dependencies are injected in the test class.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.slf4j.Logger logger

Constructor Detail

SpincastTestBase

public SpincastTestBase()

Method Detail

beforeClass

public void beforeClass()

Description copied from interface: BeforeAfterClassMethodsProvider

Called before the tests of the class are ran.

Specified by:

beforeClass in interface BeforeAfterClassMethodsProvider

addExtraSystemProperties

protected void addExtraSystemProperties()

Adds System properties as they are provided by the getExtraSystemProperties() method.

getExtraSystemProperties

protected Map<String,String> getExtraSystemProperties()

Extra System properties to set before the tests are run. Those will be automatically reset once the tests are done.

resetSystemProperties

protected void resetSystemProperties()

Resets System properties.

getGuiceTweakerFromThreadLocal

protected GuiceTweaker getGuiceTweakerFromThreadLocal()

validateCreatedInjector

protected void validateCreatedInjector(com.google.inject.Injector guice)

Validates the created Injector, before the dependencies are injected in the test class.

createGuiceTweaker

protected GuiceTweaker createGuiceTweaker()

getGuiceTweakerPlugins

protected List<SpincastPlugin> getGuiceTweakerPlugins()

Extra plugins to be added by the Guice Tweaker.

Most of the time, you want to make sure you keep the plugins already added by base classes. For example :

List<SpincastPlugin> plugins = super.getGuiceTweakerPlugins(); plugins.add(new YourPlugin()); return plugins;

getGuiceTweakerOverridingModule

protected com.google.inject.Module getGuiceTweakerOverridingModule()

If an overriding Module is to be added using the Guice tweaker.

In general, you want to keep the Module from the parent by combining/overriding it with your custom Module. For example :

return Modules.combine(super.getGuiceTweakerOverridingModule(), new SpincastGuiceModuleBase() {

isGuiceTweakerAutoTestingConfigBindings

protected boolean isGuiceTweakerAutoTestingConfigBindings()

Should the SpincastConfig bindings be automatically configured? If true (the default), any bindings for components in the hierarchy of SpincastConfig will be removed and new bindings will be added using the testing implementation returned by getGuiceTweakerConfigImplementationClass().

In a typical Spincast application, those bindings will be removed :

• SpincastConfig
• SpincastConfigDefault
• AppConfig
• AppConfigDefault

If false, it is your responsibility to make sure valid testing configurations bindings are used to create the Guuice context.

getGuiceTweakerConfigImplementationClass

protected Class<? extends SpincastConfig> getGuiceTweakerConfigImplementationClass()

The implementation to use for the SpincastConfig binding when isGuiceTweakerAutoTestingConfigBindings() is enabled.

beforeTest

public void beforeTest()

afterTest

public void afterTest()

afterClass

public void afterClass()

Description copied from interface: BeforeAfterClassMethodsProvider

Called after the tests of the class are ran.

This will only be called if the beforeClass() method completed successfully, so you can be sure that the instanciation of the class is complete here.

Specified by:

afterClass in interface BeforeAfterClassMethodsProvider

beforeClassException

public void beforeClassException(Throwable ex)

Description copied from interface: BeforeAfterClassMethodsProvider

This method will be called if an exception occures during the BeforeAfterClassMethodsProvider.beforeClass() execution. Be careful!! Here, you are pretty much certain that the instanciation of the class was not succesful, so you can't use any of its methods!

Specified by:

beforeClassException in interface BeforeAfterClassMethodsProvider

afterClassLoops

public void afterClassLoops()

Description copied from interface: RepeatedClassAfterMethodProvider

Called after all the loops of the class as specified by the @repeat annotation.

This will only be called if the beforeClass() method completed successfully, so you can be sure that the instanciation of the class is complete here.

Specified by:

afterClassLoops in interface RepeatedClassAfterMethodProvider

testFailure

public void testFailure(org.junit.runner.notification.Failure failure)

You can override this method to be informed when a test fails.

Specified by:

testFailure in interface TestFailureListener

setSpincastConfig

@Inject
protected void setSpincastConfig(SpincastConfig spincastConfig)

getSpincastConfig

protected SpincastConfig getSpincastConfig()

getInjector

protected com.google.inject.Injector getInjector()

deleteTempDir

protected void deleteTempDir()

getTestingWritableDir

protected File getTestingWritableDir()

createTestingFilePath

protected String createTestingFilePath(String relativePath)

Create a temporary test file, using the given relative path.

createTestingFilePath

protected String createTestingFilePath()

Create a temporary test file.

createInjector

protected abstract com.google.inject.Injector createInjector()

The test class must implement this method to create the Guice injector. It can be done by starting a real application (with a main(...) method) or by creating a custom Injector.