TestDriverBase (Asakusa Framework 0.10.4 API)

java.lang.Object
- com.asakusafw.testdriver.DriverElementBase
- - com.asakusafw.testdriver.TestDriverBase

Direct Known Subclasses:

TesterBase
```
public abstract class TestDriverBase
extends DriverElementBase
```
An abstract super class of test-driver classes.

Since:

0.2.0

Version:

0.10.0

Field Summary

Fields
Modifier and Type Field and Description

protected TestDriverContext driverContext
The internal test driver context object.

Fields
Modifier and Type	Field and Description
`protected TestDriverContext`	`driverContext` The internal test driver context object.

Constructor Summary

Constructors
Constructor and Description

TestDriverBase(Class<?> callerClass)
Creates a new instance.

Constructors
Constructor and Description
`TestDriverBase(Class<?> callerClass)` Creates a new instance.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addInputTrace(Class<?> operatorClass, String methodName, String portName)` Adds a new trace-point to the target operator input.
`void`	`addInputTrace(Class<? extends FlowDescription> flowpartClass, String portName)` Deprecated. some platform does not support tracing flow-part I/O; please use `addInputTrace(Class, String, String)` instead
`void`	`addOutputTrace(Class<?> operatorClass, String methodName, String portName)` Adds a new trace-point to the target operator output.
`void`	`addOutputTrace(Class<? extends FlowDescription> flowpartClass, String portName)` Deprecated. some platform does not support tracing flow-part I/O; please use `addOutputTrace(Class, String, String)` instead
`void`	`configure(String key, String value)` Adds a runtime configuration item.
`protected Class<?>`	`getCallerClass()` Returns the caller class.
`protected TestDataToolProvider`	`getTestTools()` Returns the test tools.
`void`	`setBatchArg(String key, String value)` Adds a batch argument.
`void`	`setCompilerWorkingDirectory(File path)` Sets the explicit compiler working directory.
`void`	`setDebug(boolean enable)` Sets whether compiler should keep debugging information or not.
`void`	`setExtraCompilerOption(String name, String value)` Sets an extra compiler option.
`void`	`setFrameworkHomePath(File frameworkHomePath)` Sets the Asakusa framework installation path (a.k.a. `$ASAKUSA_HOME`).
`void`	`setJobExecutorFactory(JobExecutorFactory factory)` Deprecated. not supported
`void`	`setLibrariesPath(File librariesPath)` Sets the search path of the external library files.
`void`	`setOptimize(int level)` Configures the compiler optimization level.
`void`	`skipCleanInput(boolean skip)` Sets whether skips truncating test input data.
`void`	`skipCleanOutput(boolean skip)` Sets whether skips truncating test output data.
`void`	`skipPrepareInput(boolean skip)` Sets whether skips preparing test input data.
`void`	`skipPrepareOutput(boolean skip)` Sets whether skips preparing test output data.
`void`	`skipRunJobflow(boolean skip)` Sets whether skips executing jobflows.
`void`	`skipValidateCondition(boolean skip)` Sets whether skips verifying test conditions.
`void`	`skipVerify(boolean skip)` Sets whether skips verifying test results.

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

- Field Detail
  - driverContext
```
protected final TestDriverContext driverContext
```
    The internal test driver context object.
- Constructor Detail
  - TestDriverBase
```
public TestDriverBase(Class<?> callerClass)
```
    Creates a new instance.
    
    Parameters:
    
    callerClass - the caller class
    
    Throws:
    
    IllegalArgumentException - if some parameters were null
- Method Detail
  - getCallerClass
```
protected final Class<?> getCallerClass()
```
    Description copied from class: DriverElementBase
    
    Returns the caller class.
    
    Specified by:
    
    getCallerClass in class DriverElementBase
    
    Returns:
    
    the caller class
  - getTestTools
```
protected final TestDataToolProvider getTestTools()
```
    Description copied from class: DriverElementBase
    
    Returns the test tools.
    
    Specified by:
    
    getTestTools in class DriverElementBase
    
    Returns:
    
    the test tools
  - configure
```
public void configure(String key,
                      String value)
```
    Adds a runtime configuration item. This may customize behavior of some framework APIs (e.g. report API).
    
    Parameters:
    
    key - the configuration key name
    
    value - the configuration value, or null to unset the target configuration
    
    Throws:
    
    IllegalArgumentException - if key is null
  - setBatchArg
```
public void setBatchArg(String key,
                        String value)
```
    Adds a batch argument.
    
    Parameters:
    
    key - the argument name
    
    value - the argument value, or null to unset the target argument
    
    Throws:
    
    IllegalArgumentException - if key is null
  - setOptimize
```
public void setOptimize(int level)
```
    Configures the compiler optimization level.
    - 0: disables all optimizations
    - 1: only enables default optimizations
    - 2~: enables aggressive optimizations
    Parameters:
    
    level - the compiler optimization level
  - setDebug
```
public void setDebug(boolean enable)
```
    Sets whether compiler should keep debugging information or not.
    
    Parameters:
    
    enable - true to keep debugging information, otherwise false
  - setExtraCompilerOption
```
public void setExtraCompilerOption(String name,
                                   String value)
```
    Sets an extra compiler option.
    
    Parameters:
    
    name - the option name
    
    value - the option value
    
    Since:
    
    0.7.3
  - setFrameworkHomePath
```
public void setFrameworkHomePath(File frameworkHomePath)
```
    Sets the Asakusa framework installation path (a.k.a. $ASAKUSA_HOME). If this is not set, the installation path will be computed from the environment variable.
    
    Parameters:
    
    frameworkHomePath - the framework installation path
  - setLibrariesPath
```
public void setLibrariesPath(File librariesPath)
```
    Sets the search path of the external library files. If this is not set, the search path will be TestDriverContext.EXTERNAL_LIBRARIES_PATH.
    
    Parameters:
    
    librariesPath - the search path of the external library files
    
    Since:
    
    0.5.1
  - setCompilerWorkingDirectory
```
public void setCompilerWorkingDirectory(File path)
```
    Sets the explicit compiler working directory. If this is not set, the compiler will create the working directory into the temporary area, and remove it after test was finished.
    
    Parameters:
    
    path - the explicit compiler working directory
    
    Since:
    
    0.5.2
  - skipValidateCondition
```
public void skipValidateCondition(boolean skip)
```
    Sets whether skips verifying test conditions.
    
    Parameters:
    
    skip - true if verifying test conditions, otherwise false
    
    Since:
    
    0.7.0
  - skipCleanInput
```
public void skipCleanInput(boolean skip)
```
    Sets whether skips truncating test input data.
    
    Parameters:
    
    skip - true if truncating test input data, otherwise false
  - skipCleanOutput
```
public void skipCleanOutput(boolean skip)
```
    Sets whether skips truncating test output data.
    
    Parameters:
    
    skip - true if truncating test output data, otherwise false
  - skipPrepareInput
```
public void skipPrepareInput(boolean skip)
```
    Sets whether skips preparing test input data.
    
    Parameters:
    
    skip - true if preparing test input data, otherwise false
  - skipPrepareOutput
```
public void skipPrepareOutput(boolean skip)
```
    Sets whether skips preparing test output data.
    
    Parameters:
    
    skip - true if preparing test output data, otherwise false
  - skipRunJobflow
```
public void skipRunJobflow(boolean skip)
```
    Sets whether skips executing jobflows.
    
    Parameters:
    
    skip - true if executing jobflows, otherwise false
  - skipVerify
```
public void skipVerify(boolean skip)
```
    Sets whether skips verifying test results.
    
    Parameters:
    
    skip - true if verifying test results, otherwise false
  - addInputTrace
```
public void addInputTrace(Class<?> operatorClass,
                          String methodName,
                          String portName)
```
    Adds a new trace-point to the target operator input.
    
    Parameters:
    
    operatorClass - target operator class
    
    methodName - target operator method name
    
    portName - target operator input port name
    
    Throws:
    
    IllegalArgumentException - if some parameters were null
    
    Since:
    
    0.5.1
  - addOutputTrace
```
public void addOutputTrace(Class<?> operatorClass,
                           String methodName,
                           String portName)
```
    Adds a new trace-point to the target operator output.
    
    Parameters:
    
    operatorClass - target operator class
    
    methodName - target operator method name
    
    portName - target operator input port name
    
    Throws:
    
    IllegalArgumentException - if some parameters were null
    
    Since:
    
    0.5.1
  - addInputTrace
```
@Deprecated
public void addInputTrace(Class<? extends FlowDescription> flowpartClass,
                                      String portName)
```
    Deprecated. some platform does not support tracing flow-part I/O; please use addInputTrace(Class, String, String) instead
    
    Adds a new trace-point to the target operator input.
    
    Parameters:
    
    flowpartClass - target flow-part class
    
    portName - target operator input port name
    
    Throws:
    
    IllegalArgumentException - if some parameters were null
    
    Since:
    
    0.5.1
  - addOutputTrace
```
@Deprecated
public void addOutputTrace(Class<? extends FlowDescription> flowpartClass,
                                       String portName)
```
    Deprecated. some platform does not support tracing flow-part I/O; please use addOutputTrace(Class, String, String) instead
    
    Adds a new trace-point to the target operator output.
    
    Parameters:
    
    flowpartClass - target flow-part class
    
    portName - target operator input port name
    
    Throws:
    
    IllegalArgumentException - if some parameters were null
    
    Since:
    
    0.5.1
  - setJobExecutorFactory
```
@Deprecated
public void setJobExecutorFactory(JobExecutorFactory factory)
```
    Deprecated. not supported
    
    Sets the JobExecutorFactory for executing jobs in this test.
    
    Parameters:
    
    factory - the factory, or null to use a default implementation
    
    Since:
    
    0.6.0

Class TestDriverBase

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.asakusafw.testdriver.DriverElementBase

Methods inherited from class java.lang.Object

Field Detail

driverContext

Constructor Detail

TestDriverBase

Method Detail

getCallerClass

getTestTools

configure

setBatchArg

setOptimize

setDebug

setExtraCompilerOption

setFrameworkHomePath

setLibrariesPath

setCompilerWorkingDirectory

skipValidateCondition

skipCleanInput

skipCleanOutput

skipPrepareInput

skipPrepareOutput

skipRunJobflow

skipVerify

addInputTrace

addOutputTrace

addInputTrace

addOutputTrace

setJobExecutorFactory