com.asakusafw.testdriver

Class OperatorTestEnvironment

java.lang.Object

com.asakusafw.testdriver.DriverElementBase

com.asakusafw.testdriver.OperatorTestEnvironment

All Implemented Interfaces:

org.junit.rules.TestRule

public class OperatorTestEnvironment
extends DriverElementBase
implements org.junit.rules.TestRule

An Operator DSL test helper which enables framework APIs. Application developers can use this class like as following:

@Rule
public OperatorTestEnvironment env = new OperatorTestEnvironment();

The above activates a configuration file asakusa-resources.xml on the current class-path, and enables framework APIs (e.g. Report API) using the configuration. Clients can also use alternative configuration files by specifying their paths:

@Rule
public OperatorTestEnvironment env = new OperatorTestEnvironment("com/example/testing.xml");

Additionally, clients can also put batch arguments or extra configuration items:

@Rule
public OperatorTestEnvironment env = new OperatorTestEnvironment(...);

@Test
public void sometest() {
    env.configure("key", "value");
    env.setBatchArg("date", "2011/03/31");
    ...
    env.reload();

    TheOperatorClass op = env.newInstance(TheOperatorClass.class);
    <... test code>
}

Since:

0.1.0

Version:

0.10.3

Constructor Summary

Constructors

Constructor and Description
OperatorTestEnvironment() Creates a new instance with the default configuration file.
OperatorTestEnvironment(String configurationPath) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
protected void	after() Invoked after ran test case.
org.junit.runners.model.Statement	apply(org.junit.runners.model.Statement base, org.junit.runner.Description description)
protected void	before() Invoked before running test case.
void	configure(String key, String value) Adds a configuration item.
protected org.apache.hadoop.conf.Configuration	createConfig() Returns a new configuration object for RuntimeResourceManager.
<T> void	dump(Class<T> dataType, Iterable<? extends T> objects, Class<? extends DataFormat<? super T>> formatClass, File outputPath) Stores objects into the given sink.
<T> void	dump(Class<T> dataType, Iterable<? extends T> objects, DataModelSinkFactory factory) Stores objects into the given sink.
protected Class<?>	getCallerClass() Returns the caller class.
org.apache.hadoop.conf.Configuration	getConfiguration() Returns the Configuration object for the current environment.
TestContext	getTestContext() Returns the TestContext for the current environment.
protected TestDataToolProvider	getTestTools() Returns the test tools.
<T> DataLoader<T>	loader(Class<T> dataType, Class<? extends DataFormat<? super T>> formatClass, File file) Returns a new data loader.
<T> DataLoader<T>	loader(Class<T> dataType, Class<? extends DataFormat<? super T>> formatClass, String sourcePath) Returns a new data loader.
<T> DataLoader<T>	loader(Class<T> dataType, DataModelSourceFactory factory) Returns a new data loader.
<T> DataLoader<T>	loader(Class<T> dataType, Iterable<? extends T> objects) Returns a new data loader.
<T> DataLoader<T>	loader(Class<T> dataType, Provider<? extends Source<? extends T>> provider) Returns a new data loader.
<T> DataLoader<T>	loader(Class<T> dataType, String sourcePath) Returns a new data loader.
<T> T	newInstance(Class<T> operatorClass) Returns an implementation of the given operator class.
<T extends DataModel<T>> MockResult<T>	newResult(Class<T> dataType) Returns a new MockResult.
void	reload() Reloads the configuration file and activates changes.
void	setBatchArg(String key, String value) Adds a batch argument.

Methods inherited from class com.asakusafw.testdriver.DriverElementBase

toDataModelSinkFactory, toDataModelSourceFactory, toDataModelSourceFactory, toDataModelSourceFactory, toDataModelSourceFactory, toDataModelSourceFactory, toDataModelSourceFilter, toOutputUri, toUri, toVerifierFactory

Methods inherited from class java.lang.Object

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

Constructor Detail

OperatorTestEnvironment

public OperatorTestEnvironment()

Creates a new instance with the default configuration file.

OperatorTestEnvironment

public OperatorTestEnvironment(String configurationPath)

Creates a new instance.

Parameters:

configurationPath - the configuration file location (relative from the class-path)

Throws:

IllegalArgumentException - if the parameter is null

Method Detail

apply

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

Specified by:

apply in interface org.junit.rules.TestRule

getCallerClass

protected Class<?> getCallerClass()

Description copied from class: DriverElementBase

Returns the caller class.

Specified by:

getCallerClass in class DriverElementBase

Returns:

the caller class

getTestTools

protected TestDataToolProvider getTestTools()

Description copied from class: DriverElementBase

Returns the test tools.

Specified by:

getTestTools in class DriverElementBase

Returns:

the test tools

before

protected void before()

Invoked before running test case.

newInstance

public <T> T newInstance(Class<T> operatorClass)

Returns an implementation of the given operator class.

Type Parameters:

T - the operator type

Parameters:

operatorClass - the operator class

Returns:

the created instance of the implementation

Throws:

IllegalArgumentException - if the method cannot detect its implementation, or cannot create an instance

Since:

0.10.2

configure

public void configure(String key,
                      String value)

Adds a configuration item. Please invoke reload() to active this change before executing the test target.

Parameters:

key - the configuration key name

value - the configuration value, or null to unset the target configuration

Throws:

IllegalArgumentException - if key is null

See Also:

reload()

setBatchArg

public void setBatchArg(String key,
                        String value)

Adds a batch argument. Clients can obtain batch arguments via context API. Please invoke reload() to active this change before executing the test target.

Parameters:

key - the argument name

value - the argument value, or null to unset the target argument

Throws:

IllegalArgumentException - if key is null

See Also:

reload()

reload

public void reload()

Reloads the configuration file and activates changes.

createConfig

protected org.apache.hadoop.conf.Configuration createConfig()

Returns a new configuration object for RuntimeResourceManager.

Returns:

the created configuration object

getTestContext

public TestContext getTestContext()

Returns the TestContext for the current environment.

Returns:

TestContext object

Since:

0.7.3

getConfiguration

public org.apache.hadoop.conf.Configuration getConfiguration()

Returns the Configuration object for the current environment.

Returns:

the Configuration object

Since:

0.7.3

newResult

public <T extends DataModel<T>> MockResult<T> newResult(Class<T> dataType)

Returns a new MockResult. The returned object will create copies of the incoming objects.

Type Parameters:

T - the data type

Parameters:

dataType - the data type

Returns:

the created MockResult

Since:

0.9.1

loader

public <T> DataLoader<T> loader(Class<T> dataType,
                                String sourcePath)

Returns a new data loader.

Type Parameters:

T - the data type

Parameters:

dataType - the data type

sourcePath - the path to test data set (relative from the current test case class)

Returns:

the created loader

Since:

0.9.1

loader

public <T> DataLoader<T> loader(Class<T> dataType,
                                Iterable<? extends T> objects)

Returns a new data loader.

Type Parameters:

T - the data type

Parameters:

dataType - the data type

objects - the test data objects

Returns:

the created loader

Since:

0.9.1

loader

public <T> DataLoader<T> loader(Class<T> dataType,
                                Provider<? extends Source<? extends T>> provider)

Returns a new data loader.

Type Parameters:

T - the data type

Parameters:

dataType - the data type

provider - the test data set provider

Returns:

the created loader

Since:

0.9.1

loader

public <T> DataLoader<T> loader(Class<T> dataType,
                                Class<? extends DataFormat<? super T>> formatClass,
                                String sourcePath)

Returns a new data loader. Note that, the original source path may be changed if tracking source file name. To keep the source file path information, please use loader(Class, Class, File) instead.

Type Parameters:

T - the data type

Parameters:

dataType - the data type

formatClass - the data format class

sourcePath - the input file path on the class path

Returns:

the created loader

Since:

0.9.1

loader

public <T> DataLoader<T> loader(Class<T> dataType,
                                Class<? extends DataFormat<? super T>> formatClass,
                                File file)

Returns a new data loader.

Type Parameters:

T - the data type

Parameters:

dataType - the data type

formatClass - the data format class

file - the input file path on the class path

Returns:

the created loader

Since:

0.9.1

loader

public <T> DataLoader<T> loader(Class<T> dataType,
                                DataModelSourceFactory factory)

Returns a new data loader.

Type Parameters:

T - the data type

Parameters:

dataType - the data type

factory - factory which provides test data set

Returns:

the created loader

Since:

0.9.1

dump

public <T> void dump(Class<T> dataType,
                     Iterable<? extends T> objects,
                     Class<? extends DataFormat<? super T>> formatClass,
                     File outputPath)

Stores objects into the given sink.

Type Parameters:

T - the data type

Parameters:

objects - the source data

dataType - the data type

formatClass - the data format class

outputPath - the output path

Since:

0.10.3

dump

public <T> void dump(Class<T> dataType,
                     Iterable<? extends T> objects,
                     DataModelSinkFactory factory)

Stores objects into the given sink.

Type Parameters:

T - the data type

Parameters:

objects - the source data

dataType - the data type

factory - the target sink factory

Since:

0.10.3

after

protected void after()

Invoked after ran test case.