org.gridgain.grid.test.junit4
Class GridJunit4Suite

java.lang.Object
  org.junit.runner.Runner
      org.gridgain.grid.test.junit4.GridJunit4Suite

All Implemented Interfaces:

Serializable

public class GridJunit4Suite
extends org.junit.runner.Runner

Test suite runner for distributing JUnit4 tests. Simply add tests to this suite runner just like you would for regular JUnit4 suites, and these tests will be executed in parallel on the grid. Note that if there are no other grid nodes, this suite runner will still ensure parallel test execution within single VM.

Below is an example of distributed JUnit4 test suite:

 @RunWith(GridJunit4Suite.class)
 @SuiteClasses({
     TestA.class, // TestA will run in parallel on the grid.
     TestB.class, // TestB will run in parallel on the grid.
     TestC.class, // TestC will run in parallel on the grid.
     TestD.class // TestD will run in parallel on the grid.
 })
 public class GridJunit4ExampleSuite {
     // No-op.
 } 
 

If you have four tests A, B, C, and D, and if you need to run A and B sequentially, then you should create a nested test suite with test A and B as follows:

 @RunWith(GridJunit4Suite.class)
 @SuiteClasses({
     GridJunit4ExampleNestedSuite.class, // Nested suite that will execute tests A and B added to it sequentially.
     TestC.class, // TestC will run in parallel on the grid.
     TestD.class // TestD will run in parallel on the grid.
 })
 public class GridJunit4ExampleSuite {
     // No-op.
 } 
 

 @RunWith(Suite.class)
 @SuiteClasses({
     TestA.class,
     TestB.class
 })
 public class GridJunit4ExampleNestedSuite {
     // No-op.
 } 
 

Note that you can also grid-enable existing JUnit4 tests using @GridifyTest annotation which you can attach to the same class you attach RunWith annotation to. Refer to @GridifyTest documentation for more information.

Also note that some tests can only be executed locally mostly due to some environment issues. However they still can benefit from parallel execution with other tests. GridGain supports it via GridJunit4LocalSuite suites that can be added as nested suites to GridJunit4Suite. Refer to GridJunit4LocalSuite documentation for more information.

Logging

When running distributed JUnit, all the logging that is done to System.out or System.err is preserved. GridGain will accumulate all logging that is done on remote nodes, send them back to originating node and associate all log statements with their corresponding tests. This way, for example, if you are running tests from IDEA or Eclipse (or any other IDE) you would still see the logs as if it was a local run. However, since remote nodes keep all log statements done within a single individual test case in memory, you must make sure that enough memory is allocated on every node and that individual test cases do not spit out gigabytes of log statements. Also note, that logs will be sent back to originating node upon completion of every test, so don't be alarmed if you don't see any log statements for a while and then all of them appear at once.

GridGain achieves such log transparency via reassigning System.out or System.err to internal PrintStream implementation. However, when using Log4J within your tests you must make sure that it is configured with ConsoleAppender and that ConsoleAppender.setFollow(boolean) attribute is set to true. Logging to files is not supported yet and is planned for next point release.

Test Suite Nesting

GridJunit4TestSuite instances can be nested within each other as deep as needed. However all nested distributed test suites will be treated just like regular JUnit test suites. This approach becomes convenient when you have several distributed test suites that you would like to be able to execute separately in distributed fashion, but at the same time you would like to be able to execute them as a part of larger distributed suites.

Configuration

To run distributed JUnit tests you need to start other instances of GridGain. You can do so by running GRIDGAIN_HOME/bin/gridgain-junit.{sh|bat} script, which will start default configuration. If configuration other than default is required, then use regular GRIDGAIN_HOME/bin/gridgain.{sh|bat} script and pass your own Spring XML configuration file as a parameter to the script.

You can use the following configuration parameters to configure distributed test suite locally. These parameters are set via GridifyTest annotation. Note that GridGain will check these parameters even if AOP is not enabled. Also note that many parameters can be overridden by setting corresponding VM parameters defined in GridTestVmParameters at VM startup.

GridConfiguration Method	Default Value	Description
GridifyTest.disabled()	false	If true then GridGain will be turned off and suite will run locally. This value can be overridden by setting GridTestVmParameters.GRID_DISABLED VM parameter to true. This parameter comes handy when you would like to turn off GridGain without changing the actual code.
GridifyTest.configPath()	DFLT_JUNIT_CONFIG	Optional path to GridGain Spring XML configuration file for running JUnit tests. This property can be overridden by setting GridTestVmParameters.GRID_CONFIG VM parameter. Note that the value can be either absolute value or relative to [GRIDGAIN_HOME] installation folder.
GridifyTest.routerClass()	GridTestRouterAdapter	Optional test router class that implements GridTestRouter interface. If not provided, then tests will be routed in round-robin fashion using default GridTestRouterAdapter. The value of this parameter can be overridden by setting GridTestVmParameters.GRID_TEST_ROUTER VM parameter to the name of your own customer router class.
GridifyTest.timeout()	0 which means that tests will never timeout.	Maximum timeout value in milliseconds after which test suite will return without waiting for the remaining tests to complete. This value can be overridden by setting GridTestVmParameters.GRID_TEST_TIMEOUT VM parameter to the timeout value for the tests.

See Also:

Documentation
Email Support
Online Forums
Issue Tracking

Author: 2005-2008 Copyright © GridGain Systems. All Rights Reserved. ver. 2.0.3

	Nikita Ivanov, GridGain Systems nivanov@gridgain.com
	Dmitriy Setrakyan, GridGain Systems dsetrakyan@gridgain.com
	Alexander Magdenko, GridGain Systems amagdenko@gridgain.com
	Boris Suchodoev, GridGain Systems bsuchodoev@gridgain.com
	Denis Kharlamov, GridGain Systems dkharlamov@gridgain.com
	close

See Also:

Serialized Form

Field Summary

static String	DFLT_JUNIT_CONFIG Default GridGain configuration file for JUnits (value is config/junit/junit-spring.xml).
static String	DFLT_JUNIT_ROUTER Default JUnit test router (value is GridTestRouterAdapter.class.getName()).

Constructor Summary

GridJunit4Suite(Class<?> cls)
Creates distributed suite runner for given class.

Method Summary

protected List<org.gridgain.grid.test.junit4.GridJunit4Runner>	createChildren()
protected org.junit.runner.Description	createDescription()
String	getConfigurationPath() Gets path to GridGain configuration file.
org.junit.runner.Description	getDescription()
Class<? extends GridTestRouter>	getRouterClass() Gets router class used for test routing.
String	getRouterClassName() Gets JUnit test router class name.
protected org.gridgain.grid.test.junit4.GridJunit4Runner	getRunner(Class<?> testCls)
boolean	isDisabled() Gets flag indicating whether GridGain should be enabled or not.
protected boolean	isLocal(org.gridgain.grid.test.junit4.GridJunit4Runner runner)
void	run(org.junit.runner.notification.RunNotifier notifier)
void	setConfigurationPath(String cfgPath) Sets path to GridGain configuration file.
void	setDisabled(boolean disabled) Disables GridGain.
void	setRouterClass(Class<? extends GridTestRouter> routerCls) Sets router class.
void	setRouterClassName(String routerClsName) Sets name of class for routing JUnit tests.

Methods inherited from class org.junit.runner.Runner

testCount

Methods inherited from class java.lang.Object

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

Field Detail

DFLT_JUNIT_CONFIG

public static final String DFLT_JUNIT_CONFIG

Default GridGain configuration file for JUnits (value is config/junit/junit-spring.xml).

See Also:

Constant Field Values

DFLT_JUNIT_ROUTER

public static final String DFLT_JUNIT_ROUTER

Default JUnit test router (value is GridTestRouterAdapter.class.getName()).

Constructor Detail

GridJunit4Suite

public GridJunit4Suite(Class<?> cls)

Creates distributed suite runner for given class.

Parameters:

cls - Class to create suite runner for.

Method Detail

setConfigurationPath

public void setConfigurationPath(String cfgPath)

Sets path to GridGain configuration file. By default {GRIDGAIN_HOME}/config/junit/junit-spring.xml is used.

Parameters:

cfgPath - Path to GridGain configuration file.

getConfigurationPath

public String getConfigurationPath()

Gets path to GridGain configuration file. By default {GRIDGAIN_HOME}/config/junit/junit-spring.xml is used.

Returns:

Path to GridGain configuration file.

setDisabled

public void setDisabled(boolean disabled)

Disables GridGain. If set to true then this suite will execute locally as if GridGain was not in a picture at all.

Parameters:

disabled - If set to true then this suite will execute locally as if GridGain was not in a picture at all.

isDisabled

public boolean isDisabled()

Gets flag indicating whether GridGain should be enabled or not. If set to true then this suite will execute locally as if GridGain was not in a picture at all.

Returns:

Flag indicating whether GridGain should be enabled or not. If set to true then this suite will execute locally as if GridGain was not in a picture at all.

setRouterClassName

public void setRouterClassName(String routerClsName)

Sets name of class for routing JUnit tests. By default GridJunit4Suite.DFLT_JUNIT_ROUTER class name is used.

Parameters:

routerClsName - Junit test router class name.

getRouterClassName

public String getRouterClassName()

Gets JUnit test router class name.

Returns:

JUnit test router class name.

setRouterClass

public void setRouterClass(Class<? extends GridTestRouter> routerCls)

Sets router class. By default GridTestRouterAdapter is used.

Parameters:

routerCls - Router class to use for test routing.

getRouterClass

public Class<? extends GridTestRouter> getRouterClass()

Gets router class used for test routing.

Returns:

Router class used for test routing.

run

public void run(org.junit.runner.notification.RunNotifier notifier)

getDescription

public final org.junit.runner.Description getDescription()

Specified by:

getDescription in class org.junit.runner.Runner

createDescription

protected org.junit.runner.Description createDescription()

Returns:

Description for test class.

createChildren

protected List<org.gridgain.grid.test.junit4.GridJunit4Runner> createChildren()

Returns:

Child runners.

isLocal

protected boolean isLocal(org.gridgain.grid.test.junit4.GridJunit4Runner runner)

Parameters:

runner - FIXDOC

Returns:

True if runner is local.

getRunner

protected org.gridgain.grid.test.junit4.GridJunit4Runner getRunner(Class<?> testCls)
                                                            throws org.junit.internal.runners.InitializationError

Throws:

org.junit.internal.runners.InitializationError - FIXDOC

Parameters:

testCls - FIXDOC

Returns:

Runner for the class.