com.tngtech.java.junit.dataprovider

Class DataProviderRunner

java.lang.Object

org.junit.runner.Runner

org.junit.runners.ParentRunner<org.junit.runners.model.FrameworkMethod>

org.junit.runners.BlockJUnit4ClassRunner

com.tngtech.java.junit.dataprovider.DataProviderRunner

All Implemented Interfaces:

org.junit.runner.Describable, org.junit.runner.manipulation.Filterable, org.junit.runner.manipulation.Sortable

public class DataProviderRunner
extends org.junit.runners.BlockJUnit4ClassRunner

A custom runner for JUnit that allows the usage of TestNG-like dataproviders. Data providers are public, static methods that return an Object[][] (see DataProvider).

Your test method must be annotated with @UseDataProvider or @DataProvider, additionally.

Field Summary

Fields

Modifier and Type	Field and Description
protected DataConverter	dataConverter The DataConverter to be used to convert from supported return types of any dataprovider to List <Object[]> such that data can be further handled.
protected TestGenerator	testGenerator The TestGenerator to be used to generate all framework methods to be executed as test (enhanced by data providers data if desired).
protected TestValidator	testValidator The TestValidator to be used to validate all test methods to be executed as test and all dataprovider to be used to explode tests.

Constructor Summary

Constructors

Constructor and Description
DataProviderRunner(java.lang.Class<?> clazz) Creates a DataProviderRunner to run supplied clazz.

Method Summary

Modifier and Type	Method and Description
protected void	collectInitializationErrors(java.util.List<java.lang.Throwable> errors)
protected java.util.List<org.junit.runners.model.FrameworkMethod>	computeTestMethods() Generates the exploded list of methods that run tests.
void	filter(org.junit.runner.manipulation.Filter filter)
protected void	initializeHelpers() Initialize and/or override DataConverter, TestGenerator and/or TestValidator helper classes.
protected void	validateInstanceMethods(java.util.List<java.lang.Throwable> errors) Deprecated.
protected void	validateTestMethods(java.util.List<java.lang.Throwable> errors)

Methods inherited from class org.junit.runners.BlockJUnit4ClassRunner

createTest, describeChild, getChildren, getTestRules, isIgnored, methodBlock, methodInvoker, possiblyExpectingExceptions, rules, runChild, testName, validateConstructor, validateFields, validateNoNonStaticInnerClass, validateOnlyOneConstructor, validateZeroArgConstructor, withAfters, withBefores, withPotentialTimeout

Methods inherited from class org.junit.runners.ParentRunner

childrenInvoker, classBlock, classRules, createTestClass, getDescription, getName, getRunnerAnnotations, getTestClass, run, runLeaf, setScheduler, sort, validatePublicVoidNoArgMethods, withAfterClasses, withBeforeClasses

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

dataConverter

protected DataConverter dataConverter

The DataConverter to be used to convert from supported return types of any dataprovider to List <Object[]> such that data can be further handled.

testGenerator

protected TestGenerator testGenerator

The TestGenerator to be used to generate all framework methods to be executed as test (enhanced by data providers data if desired).

testValidator

protected TestValidator testValidator

The TestValidator to be used to validate all test methods to be executed as test and all dataprovider to be used to explode tests.

Constructor Detail

DataProviderRunner

public DataProviderRunner(java.lang.Class<?> clazz)
                   throws org.junit.runners.model.InitializationError

Creates a DataProviderRunner to run supplied clazz.

Parameters:

clazz - the test Class to run

Throws:

org.junit.runners.model.InitializationError - if the test Class is malformed.

Method Detail

collectInitializationErrors

protected void collectInitializationErrors(java.util.List<java.lang.Throwable> errors)

Overrides:

collectInitializationErrors in class org.junit.runners.BlockJUnit4ClassRunner

initializeHelpers

protected void initializeHelpers()

Initialize and/or override DataConverter, TestGenerator and/or TestValidator helper classes.

validateInstanceMethods

@Deprecated
protected void validateInstanceMethods(java.util.List<java.lang.Throwable> errors)

Deprecated.

Is copied from BlockJUnit4ClassRunner.validateInstanceMethods(java.util.List<java.lang.Throwable>) because computeTestMethods() must not be called if validation already found errors!

Overrides:

validateInstanceMethods in class org.junit.runners.BlockJUnit4ClassRunner

validateTestMethods

protected void validateTestMethods(java.util.List<java.lang.Throwable> errors)

Additionally validates dataproviders.

Overrides:

validateTestMethods in class org.junit.runners.BlockJUnit4ClassRunner

Parameters:

errors - that are added to this list

Throws:

java.lang.NullPointerException - if given errors is null

computeTestMethods

protected java.util.List<org.junit.runners.model.FrameworkMethod> computeTestMethods()

Generates the exploded list of methods that run tests. All methods annotated with @Test on this class and super classes that are not overridden are checked if they use a @DataProvider or not. If yes, for each row of the DataProviders result a specific, parameterized test method will be added. If not, the original test method is added.

Additionally, caches the result as computeTestMethods() is call multiple times while test execution by the JUnit framework (to validate, to filter, to execute, ...).

Overrides:

computeTestMethods in class org.junit.runners.BlockJUnit4ClassRunner

Returns:

the exploded list of test methods (never null)

filter

public void filter(org.junit.runner.manipulation.Filter filter)
            throws org.junit.runner.manipulation.NoTestsRemainException

If possible the given filter is wrapped by DataProviderFilter to enable filtering of tests using a dataprovider.

Specified by:

filter in interface org.junit.runner.manipulation.Filterable

Overrides:

filter in class org.junit.runners.ParentRunner<org.junit.runners.model.FrameworkMethod>

Parameters:

filter - the Filter to be wrapped or apply, respectively

Throws:

org.junit.runner.manipulation.NoTestsRemainException