eu.stratosphere.core.testing

Class TestPlan

java.lang.Object

eu.stratosphere.core.testing.GenericTestPlan<eu.stratosphere.types.Record,TestRecords>

eu.stratosphere.core.testing.TestPlan

All Implemented Interfaces:

Closeable, AutoCloseable

public class TestPlan
extends GenericTestPlan<eu.stratosphere.types.Record,TestRecords>

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

• Adds GenericDataSources and GenericDataSinks if not explicitly specified,
• locally runs the PACT stubs,
• checks the results against the pairs as specified in getExpectedOutput(Class, Class...), and
• provides comfortable access to the results with GenericTestPlan.getActualOutput().
  

The typical usage is inside a unit test. And might look like one of the following examples.

Test complete plan

    // build plan
    GenericDataSource<Key, Value> source = ...;
    MapOperator<Key, Value, Key, Value> map = new MapOperator<Key, Value, Key, Value>(IdentityMap.class, "Map");
    map.setInput(source);    
    GenericDataSink<Key, Value> output = ...;
    output.setInput(map);
    // configure test
    TestPlan testPlan = new TestPlan(output);
    testPlan.getExpectedOutput(output).fromFile(...);
    testPlan.run();
 

Test plan with ad-hoc source and sink

    // build plan
    MapOperator<Key, Value, Key, Value> map = new MapOperator<Key, Value, Key, Value>(IdentityMap.class, "Map");
    // configure test
    TestPlan testPlan = new TestPlan(map);
    testPlan.getInput().add(pair1).add(pair2).add(pair3);
    testPlan.getExpectedOutput(output).add(pair1).add(pair2).add(pair3);
    testPlan.run();
 

Access ad-hoc source and sink of Testplan

    // build plan
    MapOperator<Key, Value, Key, Value> map = new MapOperator<Key, Value, Key, Value>(IdentityMap.class, "Map");
    // configure test
    TestPlan testPlan = new TestPlan(map);
    testPlan.getInput().add(randomInput1).add(randomInput2).add(randomInput3);
    testPlan.run();
    // custom assertions
    Assert.assertEquals(testPlan.getInput(), testPlan.getOutput());
 

Constructor Summary

Constructors

Constructor and Description
TestPlan(Collection<? extends eu.stratosphere.api.common.operators.Operator> contracts) Initializes TestPlan for the given contracts.
TestPlan(eu.stratosphere.api.common.operators.Operator... contracts) Initializes TestPlan for the given contracts.

Method Summary

Methods

Modifier and Type	Method and Description
protected TestRecords	createTestRecords(TypeConfig<eu.stratosphere.types.Record> typeConfig) Creates the concrete implementation of GenericTestRecords for this plan.
TestRecords	getActualOutput(Class<? extends eu.stratosphere.types.Value>[] schema) Returns the first actual output TestRecords with the given schema of the TestPlan.
TestRecords	getExpectedOutput(Class<? extends eu.stratosphere.types.Value> values, Class<?>... additionalFields) Returns the expected output TestRecords with the given schema of the TestPlan associated with the given sink.
TestRecords	getExpectedOutput(eu.stratosphere.api.common.operators.GenericDataSink sink, Class<? extends eu.stratosphere.types.Value>[] schema) Returns the expected output TestRecords with the given schema of the TestPlan associated with the given sink.
TestRecords	getExpectedOutput(int sink, Class<? extends eu.stratosphere.types.Value>[] schema) Returns the expected output TestRecords with the given schema of the TestPlan associated with the given sink.
Class<? extends eu.stratosphere.types.Value>[]	getSchema() Returns the schema.
void	run() Compiles the plan to an Plan and executes it.
void	setSchema(Class<? extends eu.stratosphere.types.Value>[] schema) Sets the default schema of all input and outputs.
void	setSchema(Class<? extends eu.stratosphere.types.Value> firstField, Class<?>... additionalFields) Sets the default schema of all input and outputs.
TestPlan	withSchema(Class<? extends eu.stratosphere.types.Value>[] schema) Sets the default schema of all input and outputs.
TestPlan	withSchema(Class<? extends eu.stratosphere.types.Value> firstField, Class<?>... additionalFields) Sets the default schema of all input and outputs.

Methods inherited from class eu.stratosphere.core.testing.GenericTestPlan

close, createDefaultSink, createDefaultSource, createPlan, getActualOutput, getActualOutput, getActualOutput, getActualOutput, getActualOutput, getActualOutput, getDefaultConfig, getDegreeOfParallelism, getExpectedOutput, getExpectedOutput, getExpectedOutput, getInput, getInput, getInput, getInput, getInput, getOutputOfOperator, getOutputsOfOperator, getSinks, getSources, setDefaultConfig, setDegreeOfParallelism

Methods inherited from class java.lang.Object

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

Constructor Detail

TestPlan

public TestPlan(Collection<? extends eu.stratosphere.api.common.operators.Operator> contracts)

Initializes TestPlan for the given contracts. Sinks and Sources are automatically added in case the contracts are not already fully connected.

TestPlan

public TestPlan(eu.stratosphere.api.common.operators.Operator... contracts)

Initializes TestPlan for the given contracts. Sinks and Sources are automatically added in case the contracts are not already fully connected.

Method Detail

getActualOutput

public TestRecords getActualOutput(Class<? extends eu.stratosphere.types.Value>[] schema)

Returns the first actual output TestRecords with the given schema of the TestPlan.

Returns:

the first actual output TestRecords of the TestPlan

getExpectedOutput

public TestRecords getExpectedOutput(Class<? extends eu.stratosphere.types.Value> values,
                            Class<?>... additionalFields)

Returns the expected output TestRecords with the given schema of the TestPlan associated with the given sink. This is the recommended method to set expected output records for more complex TestPlans.

Returns:

the expected output TestRecords of the TestPlan associated with the given sink

getExpectedOutput

public TestRecords getExpectedOutput(eu.stratosphere.api.common.operators.GenericDataSink sink,
                            Class<? extends eu.stratosphere.types.Value>[] schema)

Returns the expected output TestRecords with the given schema of the TestPlan associated with the given sink. This is the recommended method to set expected output records for more complex TestPlans.

Parameters:

sink - the sink of which the associated expected output TestRecords should be returned

Returns:

the expected output TestRecords of the TestPlan associated with the given sink

getExpectedOutput

public TestRecords getExpectedOutput(int sink,
                            Class<? extends eu.stratosphere.types.Value>[] schema)

Returns the expected output TestRecords with the given schema of the TestPlan associated with the given sink. This is the recommended method to set expected output records for more complex TestPlans.

Parameters:

sink - the sink of which the associated expected output TestRecords should be returned

Returns:

the expected output TestRecords of the TestPlan associated with the given sink

getSchema

public Class<? extends eu.stratosphere.types.Value>[] getSchema()

Returns the schema.

Returns:

the schema

run

public void run()

Description copied from class: GenericTestPlan

Compiles the plan to an Plan and executes it. If expected values have been specified, the actual outputs values are compared to the expected values.

Overrides:

run in class GenericTestPlan<eu.stratosphere.types.Record,TestRecords>

setSchema

public void setSchema(Class<? extends eu.stratosphere.types.Value> firstField,
             Class<?>... additionalFields)

Sets the default schema of all input and outputs.

setSchema

public void setSchema(Class<? extends eu.stratosphere.types.Value>[] schema)

Sets the default schema of all input and outputs.

Parameters:

schema - the schema to set

withSchema

public TestPlan withSchema(Class<? extends eu.stratosphere.types.Value> firstField,
                  Class<?>... additionalFields)

Sets the default schema of all input and outputs.

withSchema

public TestPlan withSchema(Class<? extends eu.stratosphere.types.Value>[] schema)

Sets the default schema of all input and outputs.

Parameters:

schema - the schema to set

createTestRecords

protected TestRecords createTestRecords(TypeConfig<eu.stratosphere.types.Record> typeConfig)

Description copied from class: GenericTestPlan

Creates the concrete implementation of GenericTestRecords for this plan.

Specified by:

createTestRecords in class GenericTestPlan<eu.stratosphere.types.Record,TestRecords>

Parameters:

typeConfig - the TypeConfig to use

Returns:

the test records