com.asakusafw.testdriver.core

Class VerifyEngine

java.lang.Object

com.asakusafw.testdriver.core.VerifyEngine

public class VerifyEngine
extends Object

Verifies model objects using VerifyRule and expected data set.

Since:

0.2.0

Constructor Summary

Constructors

Constructor and Description
VerifyEngine(VerifyRule rule) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
VerifyEngine	addExpected(DataModelSource expected) Appends the expected data model objects.
List<Difference>	inspectInput(DataModelSource input) Verifies the input sequence and returns diagnostics.
List<Difference>	inspectRest() Verifies the rest of expected data objects.

Methods inherited from class java.lang.Object

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

Constructor Detail

VerifyEngine

public VerifyEngine(VerifyRule rule)

Creates a new instance.

Parameters:

rule - the verification strategy

Throws:

IllegalArgumentException - if some parameters were null

Method Detail

addExpected

public VerifyEngine addExpected(DataModelSource expected)
                         throws IOException

Appends the expected data model objects.

If this already saw data model objects with same key in the expected input, the old one will be replaced with in input. Note that the expected input will be closed.

Parameters:

expected - the expected input

Returns:

this object (for method chain)

Throws:

IOException - if failed to obtain model objects from the input, or the input key is already registered

IllegalArgumentException - if some parameters were null

inspectInput

public List<Difference> inspectInput(DataModelSource input)
                              throws IOException

Verifies the input sequence and returns diagnostics.

First, this engine search an expected model object corresponded to each input object using their keys. If there are the such pairs, then this engine invokes VerifyRule.verifyModel(eachExpected, eachInput) for each pair, and then removes the expected data. Otherwise, this engine invokes VerifyRule.verifyModel(null, eachInput). for each input without corresponding expected object.

If there are any differences between expected objects and input objects, the resulting list includes them.

Parameters:

input - the input to verify

Returns:

differences between the input and the expected, or an empty list if successfully verified

Throws:

IOException - if failed to obtain model objects from the input, or the input key is already presented

IllegalArgumentException - if some parameters were null

See Also:

inspectRest()

inspectRest

public List<Difference> inspectRest()

Verifies the rest of expected data objects.

This engine invokes VerifyRule.verifyModel(eachExpected, null) for each expected data objects, and clears them from this engine.

Note that the rest of expected data mean "expected but appeared in input." You should invoke inspectInput(DataModelSource) for each input before invoke this method.

Returns:

diagnostics for expected but not appeared in input objects

See Also:

inspectInput(DataModelSource)