Package io.openems.edge.common.test

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

java.lang.Object

io.openems.edge.common.test.AbstractComponentTest<SELF,SUT>

Direct Known Subclasses:

ComponentTest, ControllerTest, ManagedSymmetricEssTest

public abstract class AbstractComponentTest<SELF extends AbstractComponentTest<SELF,SUT>,SUT extends OpenemsComponent>
extends Object

Provides a test framework for OpenEMS Components.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	AbstractComponentTest.ChannelValue
static class	AbstractComponentTest.TestCase	Defines a Test-Case consisting of given inputs and expected outputs.

Constructor Summary

Constructors

Constructor	Description
AbstractComponentTest(SUT sut)	Constructs the Component-Test and validates the implemented Channel-IDs.

Method Summary

Modifier and Type	Method	Description
SELF	activate(AbstractComponentConfig config)	Calls the 'activate()' method of the 'system-under-test'.
SELF	addComponent(OpenemsComponent component)	Adds an available OpenemsComponent.
SELF	addReference(String memberName, Object object)	Adds a OSGi Declarative Services @Reference via java reflection.
SUT	getSut()	Gets the 'system-under-test', i.e.
protected void	handleEvent(String topic)	If the 'system-under-test' is a EventHandler call the EventHandler.handleEvent(Event) method.
SELF	next(AbstractComponentTest.TestCase testCase)	Runs a Test-Case.
SELF	next(AbstractComponentTest.TestCase testCase, int executeCount)	Run a Test-Case multiple times.
protected void	onAfterControllers()	This method is executed before the EdgeEventConstants.TOPIC_CYCLE_AFTER_CONTROLLERS event.
protected void	onAfterProcessImage()	This method is executed before the EdgeEventConstants.TOPIC_CYCLE_AFTER_PROCESS_IMAGE event.
protected void	onAfterWrite()	This method is executed before EdgeEventConstants.TOPIC_CYCLE_AFTER_WRITE.
protected void	onBeforeControllers()	This method is executed before the EdgeEventConstants.TOPIC_CYCLE_BEFORE_CONTROLLERS event.
protected void	onBeforeProcessImage()	This method is executed before the EdgeEventConstants.TOPIC_CYCLE_BEFORE_PROCESS_IMAGE event.
protected void	onBeforeWrite()	This method is executed before the EdgeEventConstants.TOPIC_CYCLE_BEFORE_WRITE event.
protected void	onExecuteControllers()	This method is executed after EdgeEventConstants.TOPIC_CYCLE_BEFORE_CONTROLLERS and before EdgeEventConstants.TOPIC_CYCLE_AFTER_CONTROLLERS.
protected void	onExecuteWrite()	This method is executed before the EdgeEventConstants.TOPIC_CYCLE_EXECUTE_WRITE event.
protected abstract SELF	self()	Gets an instance of the correct subclass of myself.

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractComponentTest

public AbstractComponentTest(SUT sut)
                      throws OpenemsException

Constructs the Component-Test and validates the implemented Channel-IDs.

Parameters:

sut - the 'system-under-test'

Throws:

OpenemsException - on error

Method Details

getSut

public SUT getSut()

Gets the 'system-under-test', i.e. the tested OpenemsComponent.

Returns:

the tested Component

self

protected abstract SELF self()

Gets an instance of the correct subclass of myself.

Returns:

myself

addReference

public SELF addReference(String memberName,
 Object object)
                  throws Exception

Adds a OSGi Declarative Services @Reference via java reflection.

Can also be used to set any other private field via reflection.

Parameters:

memberName - the name of the field or method

object - the reference object

Returns:

itself, to use as a builder

Throws:

Exception - on error

addComponent

public SELF addComponent(OpenemsComponent component)

Adds an available OpenemsComponent.

If the provided Component is a DummyComponentManager.

Parameters:

component - the OpenemsComponents

Returns:

itself, to use as a builder

activate

public SELF activate(AbstractComponentConfig config)
              throws Exception

Calls the 'activate()' method of the 'system-under-test'.

If 'activate()' changes the configuration, the OSGi behavior is simulated by calling 'deactivate()' and then again 'activate()'

Parameters:

config - the configuration

Returns:

itself, to use as a builder

Throws:

Exception - on error

next

public SELF next(AbstractComponentTest.TestCase testCase)
          throws Exception

Runs a Test-Case.

Parameters:

testCase - The TestCase

Returns:

itself, to use as a builder

Throws:

Exception - on error

next

public SELF next(AbstractComponentTest.TestCase testCase,
 int executeCount)
          throws Exception

Run a Test-Case multiple times.

Parameters:

testCase - The TestCase

executeCount - The execution amount of the test case

Returns:

itself, to use as a builder

Throws:

Exception - on error

handleEvent

protected void handleEvent(String topic)
                    throws Exception

If the 'system-under-test' is a EventHandler call the EventHandler.handleEvent(Event) method.

Parameters:

topic - the Event topic

Throws:

Exception - on error

onBeforeProcessImage

protected void onBeforeProcessImage()
                             throws OpenemsError.OpenemsNamedException

This method is executed before the EdgeEventConstants.TOPIC_CYCLE_BEFORE_PROCESS_IMAGE event.

Throws:

OpenemsError.OpenemsNamedException - on error

onAfterProcessImage

protected void onAfterProcessImage()
                            throws OpenemsError.OpenemsNamedException

This method is executed before the EdgeEventConstants.TOPIC_CYCLE_AFTER_PROCESS_IMAGE event.

Throws:

OpenemsError.OpenemsNamedException - on error

onBeforeControllers

protected void onBeforeControllers()
                            throws OpenemsError.OpenemsNamedException

This method is executed before the EdgeEventConstants.TOPIC_CYCLE_BEFORE_CONTROLLERS event.

Throws:

OpenemsError.OpenemsNamedException - on error

onExecuteControllers

protected void onExecuteControllers()
                             throws OpenemsError.OpenemsNamedException

This method is executed after EdgeEventConstants.TOPIC_CYCLE_BEFORE_CONTROLLERS and before EdgeEventConstants.TOPIC_CYCLE_AFTER_CONTROLLERS.

Throws:

OpenemsError.OpenemsNamedException - on error

onAfterControllers

protected void onAfterControllers()
                           throws OpenemsError.OpenemsNamedException

This method is executed before the EdgeEventConstants.TOPIC_CYCLE_AFTER_CONTROLLERS event.

Throws:

OpenemsError.OpenemsNamedException - on error

onBeforeWrite

protected void onBeforeWrite()
                      throws OpenemsError.OpenemsNamedException

This method is executed before the EdgeEventConstants.TOPIC_CYCLE_BEFORE_WRITE event.

Throws:

OpenemsError.OpenemsNamedException - on error

onExecuteWrite

protected void onExecuteWrite()
                       throws OpenemsError.OpenemsNamedException

This method is executed before the EdgeEventConstants.TOPIC_CYCLE_EXECUTE_WRITE event.

Throws:

OpenemsError.OpenemsNamedException - on error

onAfterWrite

protected void onAfterWrite()
                     throws OpenemsError.OpenemsNamedException

This method is executed before EdgeEventConstants.TOPIC_CYCLE_AFTER_WRITE.

Throws:

OpenemsError.OpenemsNamedException - on error