eu.stratosphere.sopremo.testing

Class SopremoTestPlan

java.lang.Object

eu.stratosphere.sopremo.testing.SopremoTestPlan

public class SopremoTestPlan
extends Object

The primary resource to test one or more implemented Operators. It is created in a unit test and performs the following operations.

• Adds SopremoTestPlan.MockupSources and SopremoTestPlan.MockupSinks if not explicitly specified,
• locally runs the Operators,
• checks the results against the expectations specified in getExpectedOutput(int), and
• provides comfortable access to the results with getActualOutput(int).
  To investigate the execution of the Operators the execution steps can be traced. The typical usage is inside a unit test and might look like one of the following examples.
  Test complete plan
  

   Source source = new Source(...);
   
   Identity projection = new Identity();
   projection.setInputs(source);
   
   Sink sink = new Sink(...);
   sink.setInputs(projection);
   
   SopremoTestPlan testPlan = new SopremoTestPlan(sink);
   testPlan.run();
   

  SopremoTestPlan with MockupSource and MockupSink
  

   Identity identity = new Identity();
   SopremoTestPlan testPlan = new SopremoTestPlan(identity);
   testPlan.getInput(0).
          addValue(value1).
          addValue(value2);
   testPlan.getExpectedOutput(0).
          addValue(value1).
          addValue(value2);
   testPlan.run();
   

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SopremoTestPlan.ActualOutput Represents the actual output of a SopremoTestPlan.
static class	SopremoTestPlan.ExpectedOutput Represents the expected output of a GenericTestPlan.
static class	SopremoTestPlan.Input Represents the input of a SopremoTestPlan.
static class	SopremoTestPlan.MockupSink Creates a mocked Sink.
static class	SopremoTestPlan.MockupSource Creates a mocked Source.
class	SopremoTestPlan.SopremoRecordTestPlan

Constructor Summary

Constructors

Constructor and Description
SopremoTestPlan(int numInputs, int numOutputs) Initializes a SopremoTestPlan with the given number of in/outputs.
SopremoTestPlan(List<Operator<?>> sinks) Initializes a SopremoTestPlan with the given Operators.
SopremoTestPlan(Operator<?>... sinks) Initializes a SopremoTestPlan with the given Operators.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
SopremoTestPlan.ActualOutput	getActualOutput(int index) Returns the output of the operator that is associated with the given index.
SopremoTestPlan.ActualOutput	getActualOutputForStream(JsonStream stream) Returns the output of the operator that is associated with the given JsonStream.
EvaluationContext	getCompilationContext() Returns the EvaluationContext of this plan.
SopremoTestPlan.ExpectedOutput	getExpectedOutput(int index) Returns the expected output of the operator that is associated with the given index.
SopremoTestPlan.ExpectedOutput	getExpectedOutputForStream(JsonStream stream) Returns the expected output of the operator that is associated with the given JsonStream.
SopremoTestPlan.Input	getInput(int index) Returns the input for the given index.
SopremoTestPlan.Input	getInputForStream(JsonStream stream) Returns the input that is associated with the given stream.
Source	getInputOperator(int index) Returns the input operator for the given index.
Source[]	getInputOperators(int from, int to) Returns all input operators for the given range of indices.
Sink	getOutputOperator(int index) Returns the output operator for the given index.
Sink[]	getOutputOperators(int from, int to) Returns alls output operators for the given range of indices.
int	hashCode()
protected void	initInputsAndOutputs(int numInputs, int numOutputs) Initializes the given number of in-/outputs.
void	run() Executes all operators.
void	setDegreeOfParallelism(int dop) Returns the degree of parallelism of the test plan.
void	setInputOperator(int index, Source operator) Sets the input operator of the specified index.
void	setOutputOperator(int index, Sink operator) Sets the output operator of the specified index.
String	toString()
void	trace() If called, the execution of the Operators will be traced by SopremoUtil.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SopremoTestPlan

public SopremoTestPlan(int numInputs,
               int numOutputs)

Initializes a SopremoTestPlan with the given number of in/outputs. All inputs are initialized with SopremoTestPlan.Inputs and all expected/actual outputs are initialized with SopremoTestPlan.ExpectedOutputs/SopremoTestPlan.ActualOutputs.

Parameters:

numInputs - the number of inputs that should be initialized

numOutputs - the number of outputs that should be initialized

SopremoTestPlan

public SopremoTestPlan(List<Operator<?>> sinks)

Initializes a SopremoTestPlan with the given Operators. For each Operator that has no source or no sink, SopremoTestPlan.MockupSources and SopremoTestPlan.MockupSinks are automatically set.

Parameters:

sinks - the Operators that should be executed

SopremoTestPlan

public SopremoTestPlan(Operator<?>... sinks)

Initializes a SopremoTestPlan with the given Operators. For each Operator that has no source or no sink, SopremoTestPlan.MockupSources and SopremoTestPlan.MockupSinks are automatically set.

Parameters:

sinks - the Operators that should be executed

Method Detail

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getActualOutput

public SopremoTestPlan.ActualOutput getActualOutput(int index)

Returns the output of the operator that is associated with the given index. The return value is only meaningful after a run().

Parameters:

index - the index of the operator

Returns:

the output of the execution of the specified operator

getActualOutputForStream

public SopremoTestPlan.ActualOutput getActualOutputForStream(JsonStream stream)

Returns the output of the operator that is associated with the given JsonStream. The return value is only meaningful after a run(). Should no operator have an association with the given stream: null will be returned.

Parameters:

stream - the stream

Returns:

the output of the execution of the specified operator

getCompilationContext

public EvaluationContext getCompilationContext()

Returns the EvaluationContext of this plan.

Returns:

the context

getExpectedOutput

public SopremoTestPlan.ExpectedOutput getExpectedOutput(int index)

Returns the expected output of the operator that is associated with the given index.

Parameters:

index - the index of the operator

Returns:

the expected output

getExpectedOutputForStream

public SopremoTestPlan.ExpectedOutput getExpectedOutputForStream(JsonStream stream)

Returns the expected output of the operator that is associated with the given JsonStream.

Parameters:

stream - the stream

Returns:

the expected output

getInput

public SopremoTestPlan.Input getInput(int index)

Returns the input for the given index.

Parameters:

index - the index

Returns:

the input at the specified index

getInputForStream

public SopremoTestPlan.Input getInputForStream(JsonStream stream)

Returns the input that is associated with the given stream.

Parameters:

stream - the stream

Returns:

the input

getInputOperator

public Source getInputOperator(int index)

Returns the input operator for the given index.

Parameters:

index - the index

Returns:

the input operator

getInputOperators

public Source[] getInputOperators(int from,
                         int to)

Returns all input operators for the given range of indices.

Parameters:

from - the start index (inclusive)

to - the end index (exclusive)

Returns:

array of the input operators

getOutputOperator

public Sink getOutputOperator(int index)

Returns the output operator for the given index.

Parameters:

index - the index

Returns:

the output operator

getOutputOperators

public Sink[] getOutputOperators(int from,
                        int to)

Returns alls output operators for the given range of indices.

Parameters:

from - the start index (inclusive)

to - the end index (exclusive)

Returns:

array of the output operators

hashCode

public int hashCode()

Overrides:

hashCode in class Object

run

public void run()

Executes all operators. If expected values have been specified, the actual outputs values are compared to the expected values.

setDegreeOfParallelism

public void setDegreeOfParallelism(int dop)

Returns the degree of parallelism of the test plan.

setInputOperator

public void setInputOperator(int index,
                    Source operator)

Sets the input operator of the specified index. The operator that is saved at the specified index will be overwritten.

Parameters:

index - the index where the operator should be saved

operator - the new operator

setOutputOperator

public void setOutputOperator(int index,
                     Sink operator)

Sets the output operator of the specified index. The operator that is saved at the specified index will be overwritten.

Parameters:

index - the index where the operator should be saved

operator - the new operator

toString

public String toString()

Overrides:

toString in class Object

trace

public void trace()

If called, the execution of the Operators will be traced by SopremoUtil.

initInputsAndOutputs

protected void initInputsAndOutputs(int numInputs,
                        int numOutputs)

Initializes the given number of in-/outputs.

Parameters:

numInputs - the number of inputs

numOutputs - the number of outputs