Package io.openems.edge.common.test

Class AbstractComponentTest.TestCase

java.lang.Object

io.openems.edge.common.test.AbstractComponentTest.TestCase

Enclosing class:

AbstractComponentTest<SELF extends AbstractComponentTest<SELF,SUT>,SUT extends OpenemsComponent>

public static class AbstractComponentTest.TestCase
extends Object

Defines a Test-Case consisting of given inputs and expected outputs.

Constructor Summary

Constructors

Constructor	Description
TestCase()
TestCase(String description)	Create a TestCase with a description.

Method Summary

Modifier and Type	Method	Description
protected void	applyInputs(Map<String,OpenemsComponent> components)	Applies the values for input channels.
void	applyTimeLeap()	Applies the time leap to the clock.
AbstractComponentTest.TestCase	input(ChannelAddress address, Object value)	Adds an input value for a Channel.
AbstractComponentTest.TestCase	onAfterControllersCallbacks(ThrowingRunnable<Exception> callback)	Adds a Callback that is called on EdgeEventConstants.TOPIC_CYCLE_AFTER_CONTROLLERS event.
AbstractComponentTest.TestCase	onAfterProcessImage(ThrowingRunnable<Exception> callback)	Adds a Callback that is called on EdgeEventConstants.TOPIC_CYCLE_AFTER_PROCESS_IMAGE event.
AbstractComponentTest.TestCase	onAfterWriteCallbacks(ThrowingRunnable<Exception> callback)	Adds a Callback that is called on EdgeEventConstants.TOPIC_CYCLE_AFTER_WRITE event.
AbstractComponentTest.TestCase	onBeforeControllersCallbacks(ThrowingRunnable<Exception> callback)	Adds a Callback that is called on EdgeEventConstants.TOPIC_CYCLE_BEFORE_CONTROLLERS event.
AbstractComponentTest.TestCase	onBeforeProcessImage(ThrowingRunnable<Exception> callback)	Adds a Callback that is called on EdgeEventConstants.TOPIC_CYCLE_BEFORE_PROCESS_IMAGE event.
AbstractComponentTest.TestCase	onBeforeWriteCallbacks(ThrowingRunnable<Exception> callback)	Adds a Callback that is called on EdgeEventConstants.TOPIC_CYCLE_BEFORE_WRITE event.
AbstractComponentTest.TestCase	onExecuteControllersCallbacks(ThrowingRunnable<Exception> callback)	Adds a Callback that is called after EdgeEventConstants.TOPIC_CYCLE_BEFORE_CONTROLLERS and before EdgeEventConstants.TOPIC_CYCLE_AFTER_CONTROLLERS.
AbstractComponentTest.TestCase	onExecuteWriteCallbacks(ThrowingRunnable<Exception> callback)	Adds a Callback that is called on EdgeEventConstants.TOPIC_CYCLE_EXECUTE_WRITE event.
AbstractComponentTest.TestCase	output(ChannelAddress address, Object value)	Adds an expected output value for a Channel.
AbstractComponentTest.TestCase	timeleap(TimeLeapClock clock, long amountToAdd, TemporalUnit unit)	Adds a simulated timeleap, i.e.
protected void	validateOutputs(Map<String,OpenemsComponent> components)	Validates the output values.

Methods inherited from class java.lang.Object

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

Constructor Details

TestCase

public TestCase()

TestCase

public TestCase(String description)

Create a TestCase with a description.

Parameters:

description - the description

Method Details

input

public AbstractComponentTest.TestCase input(ChannelAddress address,
 Object value)

Adds an input value for a Channel.

Parameters:

address - the ChannelAddress

value - the value Object

Returns:

myself

output

public AbstractComponentTest.TestCase output(ChannelAddress address,
 Object value)

Adds an expected output value for a Channel.

Parameters:

address - the ChannelAddress

value - the value Object

Returns:

myself

timeleap

public AbstractComponentTest.TestCase timeleap(TimeLeapClock clock,
 long amountToAdd,
 TemporalUnit unit)

Adds a simulated timeleap, i.e. simulates that a given amount of time passed.

Parameters:

clock - the active TimeLeapClock, i.e. provided to the system-under-test by a ClockProvider like ComponentManager.

amountToAdd - the amount that should be simulated

unit - the TemporalUnit of the amount, e.g. using the ChronoUnit enum

Returns:

myself

onBeforeProcessImage

public AbstractComponentTest.TestCase onBeforeProcessImage(ThrowingRunnable<Exception> callback)

Adds a Callback that is called on EdgeEventConstants.TOPIC_CYCLE_BEFORE_PROCESS_IMAGE event.

Parameters:

callback - the callback

Returns:

myself

onAfterProcessImage

public AbstractComponentTest.TestCase onAfterProcessImage(ThrowingRunnable<Exception> callback)

Adds a Callback that is called on EdgeEventConstants.TOPIC_CYCLE_AFTER_PROCESS_IMAGE event.

Parameters:

callback - the callback

Returns:

myself

onBeforeControllersCallbacks

public AbstractComponentTest.TestCase onBeforeControllersCallbacks(ThrowingRunnable<Exception> callback)

Adds a Callback that is called on EdgeEventConstants.TOPIC_CYCLE_BEFORE_CONTROLLERS event.

Parameters:

callback - the callback

Returns:

myself

onExecuteControllersCallbacks

public AbstractComponentTest.TestCase onExecuteControllersCallbacks(ThrowingRunnable<Exception> callback)

Adds a Callback that is called after EdgeEventConstants.TOPIC_CYCLE_BEFORE_CONTROLLERS and before EdgeEventConstants.TOPIC_CYCLE_AFTER_CONTROLLERS. events.

Parameters:

callback - the callback

Returns:

myself

onAfterControllersCallbacks

public AbstractComponentTest.TestCase onAfterControllersCallbacks(ThrowingRunnable<Exception> callback)

Adds a Callback that is called on EdgeEventConstants.TOPIC_CYCLE_AFTER_CONTROLLERS event.

Parameters:

callback - the callback

Returns:

myself

onBeforeWriteCallbacks

public AbstractComponentTest.TestCase onBeforeWriteCallbacks(ThrowingRunnable<Exception> callback)

Adds a Callback that is called on EdgeEventConstants.TOPIC_CYCLE_BEFORE_WRITE event.

Parameters:

callback - the callback

Returns:

myself

onExecuteWriteCallbacks

public AbstractComponentTest.TestCase onExecuteWriteCallbacks(ThrowingRunnable<Exception> callback)

Adds a Callback that is called on EdgeEventConstants.TOPIC_CYCLE_EXECUTE_WRITE event.

Parameters:

callback - the callback

Returns:

myself

onAfterWriteCallbacks

public AbstractComponentTest.TestCase onAfterWriteCallbacks(ThrowingRunnable<Exception> callback)

Adds a Callback that is called on EdgeEventConstants.TOPIC_CYCLE_AFTER_WRITE event.

Parameters:

callback - the callback

Returns:

myself

applyTimeLeap

public void applyTimeLeap()

Applies the time leap to the clock.

applyInputs

protected void applyInputs(Map<String,OpenemsComponent> components)
                    throws IllegalArgumentException,
OpenemsError.OpenemsNamedException

Applies the values for input channels.

Parameters:

components - Referenced components

Throws:

OpenemsError.OpenemsNamedException - on error

IllegalArgumentException - on error

validateOutputs

protected void validateOutputs(Map<String,OpenemsComponent> components)
                        throws Exception

Validates the output values.

Parameters:

components - Referenced components

Throws:

Exception - on validation failure