org.easetech.easytest.runner

Class DataDrivenTestRunner

java.lang.Object

org.junit.runner.Runner

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

org.junit.runners.BlockJUnit4ClassRunner

org.easetech.easytest.runner.DataDrivenTestRunner

All Implemented Interfaces:

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

public class DataDrivenTestRunner
extends org.junit.runners.BlockJUnit4ClassRunner

Construct a new DataDrivenTestRunner. This runner is an extension of BlockJUnit4ClassRunner. The algorithm of constructing and making the runner ready for execution is as follows:

• Set the Scheduling Strategy. The SchedulerStrategy can be PARALLEL or SERIAL and is decided based on Parallel annotation
• Load the Test Bean Configurations that are defined at the class level using the TestConfigProvider annotation.
  (For details on how he test bean is loaded look at TestConfigUtil.loadTestBeanConfig(Class)) method.
• Next, load the input test data, if any, at the class level. We mention if any because the input test data can be loaded per method as well instead of loading it at the class level.
  (For details on how the input test data is loaded, look at DataLoaderUtil.loadData(java.lang.Class<?>, org.junit.runners.model.FrameworkMethod, org.junit.runners.model.TestClass, java.util.Map<java.lang.String, java.util.List<java.util.Map<java.lang.String, java.lang.Object>>>)) method.
• Next, we registers the converters, if any, declared at the class level using Converters annotation
• We then move to inject the fields in the test class marked with Provided or Inject annotation with the test beans that were loaded in step 1 above.
• Next, we try to resolve any test properties that are specified on the test class using the TestProperties annotation.
  Note that TestProperties annotation requires a filed of type Properties be defined at the class level. Look at TestConfigUtil.loadResourceProperties(Class, Object) method for details.
• We finally create a proxy for the class under test, if it is marked with Intercept annotation. This helps in intercepting the method calls to the class under test and perform any initialization/destruction logic before/after the method execution.

Author:

Anuj Kumar

Constructor Summary

Constructors

Constructor and Description
DataDrivenTestRunner(Class<?> klass) Look at DataDrivenTestRunner for details.

Method Summary

Methods

Modifier and Type	Method and Description
protected List<org.junit.runners.model.FrameworkMethod>	computeMethodsForTest() Overridden the compute test method to make it save the method list as class instance, so that the method does not run multiple times.
protected List<org.junit.runners.model.FrameworkMethod>	computeTestMethods() Compute any test methods
protected Object	createTest() Returns a new fixture for running a test.
void	filter(org.junit.runner.manipulation.Filter filter) Override the filter method from ParentRunner so that individual tests can be run using EasyTest
protected Object	getTestInstance() Get the instance of the class under test
protected void	instrumentClass(Class<?> testClass, Object testInstance) Instrument the class's field that are marked with Intercept annotation
protected void	loadResourceProperties(Object testInstance)
protected void	loadTestConfigurations(Object testInstance)
protected org.junit.runners.model.Statement	methodBlock(org.junit.runners.model.FrameworkMethod method)
protected org.junit.runners.model.Statement	methodInvoker(org.junit.runners.model.FrameworkMethod method, Object testInstance) Returns a Statement that invokes method on test
void	registerConverter(Converters converter) Method responsible for registering the converters with the EasyTest framework
protected void	setSchedulingStrategy() Set whether the tests should be run in parallel or serial.
protected String	testName(org.junit.runners.model.FrameworkMethod method) Override the name of the test.
protected void	validateConstructor(List<Throwable> errors) Validate that there could ever be only one constructor.
protected void	validateInstanceMethods(List<Throwable> errors) Deprecated. unused API, will go away in future version
protected void	validateTestMethods(List<Throwable> errors) Validate the test methods.
protected org.junit.runners.model.Statement	withAfterClasses(org.junit.runners.model.Statement statement) Returns a Statement: run all non-overridden @AfterClass methods on this class and superclasses before executing statement; all AfterClass methods are always executed: exceptions thrown by previous steps are combined, if necessary, with exceptions from AfterClass methods into a MultipleFailureException .
protected org.junit.runners.model.Statement	withTestResult(EasyFrameworkMethod method, org.junit.runners.model.Statement statement)

Methods inherited from class org.junit.runners.BlockJUnit4ClassRunner

collectInitializationErrors, describeChild, getChildren, getTestRules, possiblyExpectingExceptions, rules, runChild, validateNoNonStaticInnerClass, validateOnlyOneConstructor, validateZeroArgConstructor, withAfters, withBefores, withPotentialTimeout

Methods inherited from class org.junit.runners.ParentRunner

childrenInvoker, classBlock, classRules, getDescription, getName, getRunnerAnnotations, getTestClass, run, runLeaf, setScheduler, sort, validatePublicVoidNoArgMethods, 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

Constructor Detail

DataDrivenTestRunner

public DataDrivenTestRunner(Class<?> klass)
                     throws org.junit.runners.model.InitializationError

Look at DataDrivenTestRunner for details.

Parameters:

klass -

Throws:

org.junit.runners.model.InitializationError

See Also:

DataDrivenTestRunner

Method Detail

setSchedulingStrategy

protected void setSchedulingStrategy()

Set whether the tests should be run in parallel or serial.

computeMethodsForTest

protected List<org.junit.runners.model.FrameworkMethod> computeMethodsForTest()

Overridden the compute test method to make it save the method list as class instance, so that the method does not run multiple times. Also, this method now is responsible for creating multiple FrameworkMethod instances for a given method with multiple test data. So, if a given test method needs to run three times with three set of input test data, then this method will actually create three instances of FrameworkMethod. In order to allow the user to override the default name, FrameworkMethod is extended with EasyFrameworkMethod and EasyFrameworkMethod.setName(String) method introduced.

Returns:

list of FrameworkMethod

getTestInstance

protected Object getTestInstance()
                          throws InstantiationException,
                                 IllegalAccessException,
                                 IllegalArgumentException,
                                 InvocationTargetException

Get the instance of the class under test

Returns:

the instance of class under test

Throws:

InstantiationException

IllegalAccessException

IllegalArgumentException

InvocationTargetException

loadTestConfigurations

protected void loadTestConfigurations(Object testInstance)

See Also:

TestConfigUtil.loadTestConfigurations(Class, Object)

loadResourceProperties

protected void loadResourceProperties(Object testInstance)

See Also:

TestConfigUtil.loadResourceProperties(java.lang.Class<?>, java.lang.Object)

computeTestMethods

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

Compute any test methods

Overrides:

computeTestMethods in class org.junit.runners.BlockJUnit4ClassRunner

Returns:

a list of FrameworkMethods

filter

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

Override the filter method from ParentRunner so that individual tests can be run using EasyTest

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 -

Throws:

org.junit.runner.manipulation.NoTestsRemainException

instrumentClass

protected void instrumentClass(Class<?> testClass,
                   Object testInstance)
                        throws IllegalArgumentException,
                               IllegalAccessException,
                               InstantiationException

Instrument the class's field that are marked with Intercept annotation

Parameters:

testClass - the class under test

Throws:

IllegalArgumentException - if an exception occurred

IllegalAccessException - if an exception occurred

InstantiationException - if an exception occurred

registerConverter

public void registerConverter(Converters converter)

Method responsible for registering the converters with the EasyTest framework

Parameters:

converter - the annotation Converters

testName

protected String testName(org.junit.runners.model.FrameworkMethod method)

Override the name of the test. In case of EasyTest, it will be the name of the test method concatenated with the input test data that the method will run with.

Overrides:

testName in class org.junit.runners.BlockJUnit4ClassRunner

Parameters:

method - the FrameworkMethod

Returns:

an overridden test method Name

validateConstructor

protected void validateConstructor(List<Throwable> errors)

Validate that there could ever be only one constructor.

Overrides:

validateConstructor in class org.junit.runners.BlockJUnit4ClassRunner

Parameters:

errors - list of any errors while validating the Constructor

validateInstanceMethods

@Deprecated
protected void validateInstanceMethods(List<Throwable> errors)

Deprecated. unused API, will go away in future version

Adds to errors for each method annotated with @Test, @Before, or @After that is not a public, void instance method with no arguments.

Overrides:

validateInstanceMethods in class org.junit.runners.BlockJUnit4ClassRunner

validateTestMethods

protected void validateTestMethods(List<Throwable> errors)

Validate the test methods.

Overrides:

validateTestMethods in class org.junit.runners.BlockJUnit4ClassRunner

Parameters:

errors - list of any errors while validating test method

methodBlock

protected org.junit.runners.model.Statement methodBlock(org.junit.runners.model.FrameworkMethod method)

Overrides:

methodBlock in class org.junit.runners.BlockJUnit4ClassRunner

withTestResult

protected org.junit.runners.model.Statement withTestResult(EasyFrameworkMethod method,
                                               org.junit.runners.model.Statement statement)

createTest

protected Object createTest()
                     throws Exception

Returns a new fixture for running a test. Default implementation executes the test class's no-argument constructor (validation should have ensured one exists).

Overrides:

createTest in class org.junit.runners.BlockJUnit4ClassRunner

Throws:

Exception

methodInvoker

protected org.junit.runners.model.Statement methodInvoker(org.junit.runners.model.FrameworkMethod method,
                                              Object testInstance)

Returns a Statement that invokes method on test

Overrides:

methodInvoker in class org.junit.runners.BlockJUnit4ClassRunner

withAfterClasses

protected org.junit.runners.model.Statement withAfterClasses(org.junit.runners.model.Statement statement)

Returns a Statement: run all non-overridden @AfterClass methods on this class and superclasses before executing statement; all AfterClass methods are always executed: exceptions thrown by previous steps are combined, if necessary, with exceptions from AfterClass methods into a MultipleFailureException . This method is also responsible for writing the data to the output file in case the user is returning test data from the test method. This method will make sure that the data is written to the output file once after the Runner has completed and not for every instance of the test method.

Overrides:

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