org.apache.flink.test.util

Class TestEnvironment

java.lang.Object

org.apache.flink.api.java.ExecutionEnvironment

org.apache.flink.test.util.TestEnvironment

public class TestEnvironment
extends ExecutionEnvironment

A ExecutionEnvironment implementation which executes its jobs on a MiniCluster.

Field Summary

Fields inherited from class org.apache.flink.api.java.ExecutionEnvironment

lastJobExecutionResult, LOG

Constructor Summary

Constructors

Constructor and Description
TestEnvironment(JobExecutor executor, int parallelism, boolean isObjectReuseEnabled)
TestEnvironment(JobExecutor jobExecutor, int parallelism, boolean isObjectReuseEnabled, Collection<Path> jarFiles, Collection<URL> classPaths)

Method Summary

Modifier and Type	Method and Description
JobExecutionResult	execute(String jobName) Triggers the program execution.
JobExecutionResult	getLastJobExecutionResult() Returns the JobExecutionResult of the last executed job.
void	setAsContext()
static void	setAsContext(JobExecutor jobExecutor, int parallelism) Sets the current ExecutionEnvironment to be a TestEnvironment.
static void	setAsContext(JobExecutor jobExecutor, int parallelism, Collection<Path> jarFiles, Collection<URL> classPaths) Sets the current ExecutionEnvironment to be a TestEnvironment.
static void	unsetAsContext()

Methods inherited from class org.apache.flink.api.java.ExecutionEnvironment

addDefaultKryoSerializer, addDefaultKryoSerializer, areExplicitEnvironmentsAllowed, clearJobListeners, configure, createCollectionsEnvironment, createInput, createInput, createLocalEnvironment, createLocalEnvironment, createLocalEnvironment, createLocalEnvironmentWithWebUI, createProgramPlan, createProgramPlan, createProgramPlan, createRemoteEnvironment, createRemoteEnvironment, createRemoteEnvironment, execute, executeAsync, executeAsync, fromCollection, fromCollection, fromCollection, fromCollection, fromElements, fromElements, fromParallelCollection, fromParallelCollection, generateSequence, getConfig, getConfiguration, getDefaultLocalParallelism, getExecutionEnvironment, getExecutionPlan, getExecutorServiceLoader, getJobListeners, getNumberOfExecutionRetries, getParallelism, getRestartStrategy, getUserCodeClassLoader, initializeContextEnvironment, readCsvFile, readFile, readFileOfPrimitives, readFileOfPrimitives, readTextFile, readTextFile, readTextFileWithValue, readTextFileWithValue, registerCachedFile, registerCachedFile, registerJobListener, registerType, registerTypeWithKryoSerializer, registerTypeWithKryoSerializer, resetContextEnvironment, setDefaultLocalParallelism, setNumberOfExecutionRetries, setParallelism, setRestartStrategy

Methods inherited from class java.lang.Object

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

Constructor Detail

TestEnvironment

public TestEnvironment(JobExecutor jobExecutor,
                       int parallelism,
                       boolean isObjectReuseEnabled,
                       Collection<Path> jarFiles,
                       Collection<URL> classPaths)

TestEnvironment

public TestEnvironment(JobExecutor executor,
                       int parallelism,
                       boolean isObjectReuseEnabled)

Method Detail

getLastJobExecutionResult

public JobExecutionResult getLastJobExecutionResult()

Description copied from class: ExecutionEnvironment

Returns the JobExecutionResult of the last executed job.

Overrides:

getLastJobExecutionResult in class ExecutionEnvironment

Returns:

The execution result from the latest job execution.

execute

public JobExecutionResult execute(String jobName)
                           throws Exception

Description copied from class: ExecutionEnvironment

Triggers the program execution. The environment will execute all parts of the program that have resulted in a "sink" operation. Sink operations are for example printing results (DataSet.print(), writing results (e.g. DataSet.writeAsText(String), DataSet.write(org.apache.flink.api.common.io.FileOutputFormat, String), or other generic data sinks created with DataSet.output(org.apache.flink.api.common.io.OutputFormat).

The program execution will be logged and displayed with the given job name.

Overrides:

execute in class ExecutionEnvironment

Returns:

The result of the job execution, containing elapsed time and accumulators.

Throws:

Exception - Thrown, if the program executions fails.

setAsContext

public void setAsContext()

setAsContext

public static void setAsContext(JobExecutor jobExecutor,
                                int parallelism,
                                Collection<Path> jarFiles,
                                Collection<URL> classPaths)

Sets the current ExecutionEnvironment to be a TestEnvironment. The test environment executes the given jobs on a Flink mini cluster with the given default parallelism and the additional jar files and class paths.

Parameters:

jobExecutor - The executor to run the jobs on

parallelism - The default parallelism

jarFiles - Additional jar files to execute the job with

classPaths - Additional class paths to execute the job with

setAsContext

public static void setAsContext(JobExecutor jobExecutor,
                                int parallelism)

Sets the current ExecutionEnvironment to be a TestEnvironment. The test environment executes the given jobs on a Flink mini cluster with the given default parallelism and the additional jar files and class paths.

Parameters:

jobExecutor - The executor to run the jobs on

parallelism - The default parallelism

unsetAsContext

public static void unsetAsContext()