org.atteo.moonshine.tests

Class MoonshineRule

java.lang.Object

org.atteo.moonshine.tests.MoonshineRule

All Implemented Interfaces:

org.junit.rules.TestRule

public class MoonshineRule
extends Object
implements org.junit.rules.TestRule

JUnit rule which initializes Moonshine container.

It is better for your test class to extend MoonshineTest or have it annotated with @RunWith(MoonshineRunner.class). With those solutions the test class is created using Guice injector.

Usage:

 class Test {
     @ClassRule
     public static final MoonshineRule moonshine = new MoonshineRule();
     @Rule
     public MethodRule injections = moonshine.injectMembers(this);
 }
 

Field Summary

Fields

Modifier and Type	Field and Description
static String	TEST_CONFIG

Constructor Summary

Constructors

Constructor and Description
MoonshineRule(List<MoonshineConfigurator> configurators, String... configs) Initializes Moonshine environment.
MoonshineRule(MoonshineConfigurator configurator, String... configs) Initializes Moonshine environment.
MoonshineRule(String... configs) Initializes Moonshine environment.

Method Summary

Methods

Modifier and Type	Method and Description
org.junit.runners.model.Statement	apply(org.junit.runners.model.Statement base, org.junit.runner.Description method)
com.google.inject.Injector	getGlobalInjector() Returns global Injector.
org.junit.rules.MethodRule	injectMembers(Object object) Returns the rule which injects members of given object on each test run.
void	setLoadTestConfigXml(boolean loadTestConfigXml)

Methods inherited from class java.lang.Object

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

Field Detail

TEST_CONFIG

public static final String TEST_CONFIG

See Also:

Constant Field Values

Constructor Detail

MoonshineRule

public MoonshineRule(String... configs)

Initializes Moonshine environment.

Usage:

 class Test {
     @ClassRule
     public static final MoonshineRule moonshine = new MoonshineRule();
 }
 

Parameters:

configs - resource path to the configuration files, by default "/test-config.xml"

MoonshineRule

public MoonshineRule(MoonshineConfigurator configurator,
             String... configs)

Initializes Moonshine environment.

Parameters:

configurator - configurator for Moonshine

configs - resource path to the configuration files

MoonshineRule

public MoonshineRule(List<MoonshineConfigurator> configurators,
             String... configs)

Initializes Moonshine environment.

Parameters:

configurators - list of configurators for Moonshine

configs - resource path to the configuration files

Method Detail

setLoadTestConfigXml

public void setLoadTestConfigXml(boolean loadTestConfigXml)

apply

public org.junit.runners.model.Statement apply(org.junit.runners.model.Statement base,
                                      org.junit.runner.Description method)

Specified by:

apply in interface org.junit.rules.TestRule

getGlobalInjector

public com.google.inject.Injector getGlobalInjector()

Returns global Injector.

injectMembers

public org.junit.rules.MethodRule injectMembers(Object object)

Returns the rule which injects members of given object on each test run.

Usage:

 class Test {
     @ClassRule
     public static final MoonshineRule moonshine = new MoonshineRule();
     @Rule
     public MethodRule injections = moonshine.injectMembers(this);
 }
 

Parameters:

object - object to inject members into

Returns:

the method rule to use with JUnit