Package net.officefloor.frame.test

Class ConstructTestSupport

java.lang.Object

net.officefloor.frame.test.ConstructTestSupport

All Implemented Interfaces:

EscalationHandler, MonitorClock, TestSupport, org.junit.jupiter.api.extension.AfterEachCallback, org.junit.jupiter.api.extension.BeforeEachCallback, org.junit.jupiter.api.extension.Extension

public class ConstructTestSupport
extends Object
implements TestSupport, org.junit.jupiter.api.extension.BeforeEachCallback, org.junit.jupiter.api.extension.AfterEachCallback, EscalationHandler, MonitorClock

Construction testing of an Office TestSupport.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor	Description
ConstructTestSupport()	Default constructor for TestSupport.
ConstructTestSupport(ThreadedTestSupport threadedTestSupport, LogTestSupport logTestSupport)	Instantiate with required dependencies.

Method Summary

Modifier and Type	Method	Description
void	addOfficeFloorEnhancer(Consumer<OfficeFloorBuilder> enhancer)	Adds an OfficeFloor enhancer.
void	adjustCurrentTimeMillis(long timeInMilliseconds)	Move current time forward the input number of milliseconds.
void	afterEach()	Undertakes the afterEach functionality.
void	afterEach(org.junit.jupiter.api.extension.ExtensionContext context)
void	assertThreadUsed(Thread thread)	Ensures the Thread is used.
void	beforeEach()	Undertakes the beforeEach functionality.
void	beforeEach(org.junit.jupiter.api.extension.ExtensionContext context)
DependencyMappingBuilder	bindManagedObject(String bindName, ManagedObjectScope managedObjectScope, ManagedFunctionBuilder<?,?> managedFunctionBuilder)	Builds the ManagedObject for use at the desired ManagedObjectScope.
ReflectiveFunctionBuilder	constructFunction(Object object, String methodName)	Constructs the ReflectiveFunctionBuilder.
<O extends Enum<O>, F extends Enum<F>> ManagedFunctionBuilder<O,F>	constructFunction(String functionName, ManagedFunction<O,F> function)	Facade method to register a ManagedFunction.
<O extends Enum<O>, F extends Enum<F>> ManagedFunctionBuilder<O,F>	constructFunction(String functionName, ManagedFunctionFactory<O,F> functionFactory)	Facade method to register a ManagedFunction.
ReflectiveGovernanceBuilder	constructGovernance(Object object, String governanceName)	Constructs the Governance.
ManagedObjectBuilder<?>	constructManagedObject(Object object, String managedObjectName, String managingOffice)	Facade method to register a ManagedObject.
<D extends Enum<D>, F extends Enum<F>, MS extends ManagedObjectSource<D, F>> ManagedObjectBuilder<F>	constructManagedObject(String managedObjectName, Class<MS> managedObjectSourceClass, String managingOffice)	Facade method to register a ManagedObject.
<D extends Enum<D>, F extends Enum<F>, MS extends ManagedObjectSource<D, F>> ManagedObjectBuilder<F>	constructManagedObject(String managedObjectName, MS managedObjectSource, String managingOffice)	Facade method to register a ManagedObject.
OfficeFloor	constructOfficeFloor()	Facade method to create the OfficeFloor.
ReflectiveFunctionBuilder	constructStaticFunction(Class<?> clazz, String methodName)	Constructs the ReflectiveFunctionBuilder for a static Method.
<TS extends TeamSource> TeamBuilder<?>	constructTeam(String teamName, Class<TS> teamSourceClass)	Facade method to create a Team.
TeamBuilder<?>	constructTeam(String teamName, Team team)	Facade method to create a Team.
long	currentTimeMillis()	Obtains the approximate current time.
OfficeBuilder	getOfficeBuilder()	Obtains the OfficeBuilder.
OfficeFloorBuilder	getOfficeFloorBuilder()	Obtains the OfficeFloorBuilder.
String	getOfficeFloorName()	Obtains the name of the OfficeFloor currently being constructed.
String	getOfficeName()	Obtains the name of the Office currently being constructed.
void	handleEscalation(Throwable escalation)	Handles an Escalation from an Office.
void	init(org.junit.jupiter.api.extension.ExtensionContext context)	Intialise.
OfficeFloor	invokeFunction(String functionName, Object parameter)	Facade method to invoke ManagedFunction of an Office.
OfficeFloor	invokeFunction(String functionName, Object parameter, int secondsToRun)	Facade method to invoke ManagedFunction of an Office.
void	invokeFunctionAndValidate(String functionName, Object parameter, String... expectedFunctions)	Facade method to invoke the ManagedFunction of an Office and validate the ManagedFunction instances invoked.
void	recordReflectiveFunctionMethodInvoked(String methodName)	Invoked by the ReflectiveFunctionBuilder when it executes the method.
void	setRecordReflectiveFunctionMethodsInvoked(boolean isRecord)	Specifies whether to record the invocations of the ReflectiveFunctionBuilder instances.
Office	triggerFunction(String functionName, Object parameter, FlowCallback callback)	Triggers the ManagedFunction but does not wait for its completion.
void	validateNoTopLevelEscalation()	Validates that no top level escalation occurred.
void	validateReflectiveMethodOrder(String... methodNames)	Validates the order the ReflectiveFunctionBuilder invoked the methods.

Methods inherited from class java.lang.Object

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

Constructor Details

ConstructTestSupport

public ConstructTestSupport(ThreadedTestSupport threadedTestSupport,
 LogTestSupport logTestSupport)

Instantiate with required dependencies.

Parameters:

threadedTestSupport - ThreadedTestSupport.

logTestSupport - LogTestSupport.

ConstructTestSupport

public ConstructTestSupport()

Default constructor for TestSupport.

Method Details

addOfficeFloorEnhancer

public void addOfficeFloorEnhancer(Consumer<OfficeFloorBuilder> enhancer)

Adds an OfficeFloor enhancer.

Parameters:

enhancer - OfficeFloor enhancer.

init

public void init(org.junit.jupiter.api.extension.ExtensionContext context)
          throws Exception

Description copied from interface: TestSupport

Intialise.

Specified by:

init in interface TestSupport

Parameters:

context - ExtensionContext.

Throws:

Exception - If fails to init.

beforeEach

public void beforeEach(org.junit.jupiter.api.extension.ExtensionContext context)
                throws Exception

Specified by:

beforeEach in interface org.junit.jupiter.api.extension.BeforeEachCallback

Throws:

Exception

beforeEach

public void beforeEach()
                throws Exception

Undertakes the beforeEach functionality.

Throws:

Exception - If fails.

afterEach

public void afterEach(org.junit.jupiter.api.extension.ExtensionContext context)
               throws Exception

Specified by:

afterEach in interface org.junit.jupiter.api.extension.AfterEachCallback

Throws:

Exception

afterEach

public void afterEach()
               throws Exception

Undertakes the afterEach functionality.

Throws:

Exception - If fails.

currentTimeMillis

public long currentTimeMillis()

Description copied from interface: MonitorClock

Obtains the approximate current time.

This is more efficient means to obtain System.currentTimeMillis() as complete millisecond accuracy is not required.

Specified by:

currentTimeMillis in interface MonitorClock

Returns:

Approximate System.currentTimeMillis().

adjustCurrentTimeMillis

public void adjustCurrentTimeMillis(long timeInMilliseconds)

Move current time forward the input number of milliseconds.

Parameters:

timeInMilliseconds - Milliseconds to move current time forward.

handleEscalation

public void handleEscalation(Throwable escalation)
                      throws Throwable

Description copied from interface: EscalationHandler

Handles an Escalation from an Office.

Specified by:

handleEscalation in interface EscalationHandler

Parameters:

escalation - Escalation.

Throws:

Throwable - Should failure in handling Escalation.

validateNoTopLevelEscalation

public void validateNoTopLevelEscalation()
                                  throws Throwable

Validates that no top level escalation occurred.

This method will clear the escalation on exit.

Throws:

Throwable - If top level Escalation.

getOfficeFloorBuilder

public OfficeFloorBuilder getOfficeFloorBuilder()

Obtains the OfficeFloorBuilder.

Returns:

OfficeFloorBuilder.

getOfficeBuilder

public OfficeBuilder getOfficeBuilder()

Obtains the OfficeBuilder.

Returns:

OfficeBuilder.

getOfficeFloorName

public String getOfficeFloorName()

Obtains the name of the OfficeFloor currently being constructed.

Returns:

Name of the OfficeFloor currently being constructed.

getOfficeName

public String getOfficeName()

Obtains the name of the Office currently being constructed.

Returns:

Name of the Office currently being constructed.

constructFunction

public ReflectiveFunctionBuilder constructFunction(Object object,
 String methodName)

Constructs the ReflectiveFunctionBuilder.

Parameters:

object - Object containing the Method.

methodName - Name of the Method.

Returns:

ReflectiveFunctionBuilder.

constructStaticFunction

public ReflectiveFunctionBuilder constructStaticFunction(Class<?> clazz,
 String methodName)

Constructs the ReflectiveFunctionBuilder for a static Method.

Parameters:

clazz - Class containing the static Method.

methodName - Name of the Method.

Returns:

ReflectiveFunctionBuilder.

setRecordReflectiveFunctionMethodsInvoked

public void setRecordReflectiveFunctionMethodsInvoked(boolean isRecord)

Specifies whether to record the invocations of the ReflectiveFunctionBuilder instances.

This is necessary as stress tests using the ReflectiveFunctionBuilder will get OutOfMemoryError issues should every ManagedFunction executed be recorded.

By default this is false to not record.

Parameters:

isRecord - true to record the ManagedFunction instances invoked.

recordReflectiveFunctionMethodInvoked

public void recordReflectiveFunctionMethodInvoked(String methodName)

Invoked by the ReflectiveFunctionBuilder when it executes the method.

Parameters:

methodName - Name of method being invoked.

validateReflectiveMethodOrder

public void validateReflectiveMethodOrder(String... methodNames)

Validates the order the ReflectiveFunctionBuilder invoked the methods.

Parameters:

methodNames - Order that the reflective methods should be invoked.

See Also:

• setRecordReflectiveFunctionMethodsInvoked(boolean)

assertThreadUsed

public void assertThreadUsed(Thread thread)

Ensures the Thread is used.

Parameters:

thread - Thread.

constructFunction

public <O extends Enum<O>,
F extends Enum<F>>
ManagedFunctionBuilder<O,F> constructFunction(String functionName,
 ManagedFunctionFactory<O,F> functionFactory)

Facade method to register a ManagedFunction.

Type Parameters:

O - Dependency key type.

F - Flow key type.

Parameters:

functionName - Name of the ManagedFunction.

functionFactory - ManagedFunctionFactory.

Returns:

ManagedFunctionBuilder for the ManagedFunction.

constructFunction

public <O extends Enum<O>,
F extends Enum<F>>
ManagedFunctionBuilder<O,F> constructFunction(String functionName,
 ManagedFunction<O,F> function)

Facade method to register a ManagedFunction.

Type Parameters:

O - Dependency key type.

F - Flow key type.

Parameters:

functionName - Name of the ManagedFunction.

function - ManagedFunction.

Returns:

ManagedFunctionBuilder for the ManagedFunction.

constructManagedObject

public <D extends Enum<D>,
F extends Enum<F>,
MS extends ManagedObjectSource<D,
F>>
ManagedObjectBuilder<F> constructManagedObject(String managedObjectName,
 Class<MS> managedObjectSourceClass,
 String managingOffice)

Facade method to register a ManagedObject.

Type Parameters:

D - Dependency key type.

F - Flow key type.

MS - ManagedObjectSource type.

Parameters:

managedObjectName - Name of the ManagedObject.

managedObjectSourceClass - ManagedObjectSource Class.

managingOffice - Name of the managing Office. May be null to manually register for ManagingOfficeBuilder.

Returns:

ManagedObjectBuilder.

constructManagedObject

public <D extends Enum<D>,
F extends Enum<F>,
MS extends ManagedObjectSource<D,
F>>
ManagedObjectBuilder<F> constructManagedObject(String managedObjectName,
 MS managedObjectSource,
 String managingOffice)

Facade method to register a ManagedObject.

Type Parameters:

D - Dependency key type.

F - Flow key type.

MS - ManagedObjectSource type.

Parameters:

managedObjectName - Name of the ManagedObject.

managedObjectSource - ManagedObjectSource instance.

managingOffice - Name of the managing Office. May be null to manually register for ManagingOfficeBuilder.

Returns:

ManagedObjectBuilder.

constructManagedObject

public ManagedObjectBuilder<?> constructManagedObject(Object object,
 String managedObjectName,
 String managingOffice)

Facade method to register a ManagedObject.

Parameters:

object - Object for the ManagedObject.

managedObjectName - Name of the ManagedObject.

managingOffice - Name of the mananaging Office. May be null to manually register for ManagingOfficeBuilder.

Returns:

ManagedObjectBuilder.

bindManagedObject

public DependencyMappingBuilder bindManagedObject(String bindName,
 ManagedObjectScope managedObjectScope,
 ManagedFunctionBuilder<?,?> managedFunctionBuilder)

Builds the ManagedObject for use at the desired ManagedObjectScope.

Parameters:

bindName - Name to bind the ManagedObject under.

managedObjectScope - ManagedObjectScope for the ManagedObject.

managedFunctionBuilder - ManagedFunctionBuilder if binding to ManagedObjectScope.FUNCTION.

Returns:

DependencyMappingBuilder for the bound ManagedObject.

constructGovernance

public ReflectiveGovernanceBuilder constructGovernance(Object object,
 String governanceName)

Constructs the Governance.

Parameters:

object - Object containing the Method instances used for Governance.

governanceName - Name of the Governance.

Returns:

ReflectiveGovernanceBuilder.

constructTeam

public TeamBuilder<?> constructTeam(String teamName,
 Team team)

Facade method to create a Team.

Parameters:

teamName - Name of the Team.

team - Team.

Returns:

TeamBuilder.

constructTeam

public <TS extends TeamSource> TeamBuilder<?> constructTeam(String teamName,
 Class<TS> teamSourceClass)

Facade method to create a Team.

Type Parameters:

TS - TeamSource type.

Parameters:

teamName - Name of the Team.

teamSourceClass - TeamSource class.

Returns:

TeamBuilder.

constructOfficeFloor

public OfficeFloor constructOfficeFloor()
                                 throws Exception

Facade method to create the OfficeFloor.

Returns:

OfficeFloor.

Throws:

Exception - If fails to construct the OfficeFloor.

triggerFunction

public Office triggerFunction(String functionName,
 Object parameter,
 FlowCallback callback)
                       throws Exception

Triggers the ManagedFunction but does not wait for its completion.

Parameters:

functionName - Name of the ManagedFunction.

parameter - Parameter for the ManagedFunction.

callback - FlowCallback. May be null.

Returns:

Office containing the ManagedFunction.

Throws:

Exception - If fails to trigger the ManagedFunction.

invokeFunction

public OfficeFloor invokeFunction(String functionName,
 Object parameter)
                           throws Exception

Facade method to invoke ManagedFunction of an Office. It will create the OfficeFloor if necessary and times out after 3 seconds if invoked ManagedFunction is not complete.

Parameters:

functionName - Name of the ManagedFunction to invoke.

parameter - Parameter.

Returns:

OfficeFloor.

Throws:

Exception - If fails to construct Office or ManagedFunction invocation failure.

invokeFunctionAndValidate

public void invokeFunctionAndValidate(String functionName,
 Object parameter,
 String... expectedFunctions)
                               throws Exception

Facade method to invoke the ManagedFunction of an Office and validate the ManagedFunction instances invoked.

Parameters:

functionName - Name of the ManagedFunction to invoke.

parameter - Parameter.

expectedFunctions - Names of the expected ManagedFunction instances to be invoked in the order specified.

Throws:

Exception - If fails to construct Office or ManagedFunction invocation failure.

invokeFunction

public OfficeFloor invokeFunction(String functionName,
 Object parameter,
 int secondsToRun)
                           throws Exception

Facade method to invoke ManagedFunction of an Office. It will create the OfficeFloor if necessary.

Parameters:

functionName - Name of the ManagedFunction to invoke.

parameter - Parameter.

secondsToRun - Seconds to run.

Returns:

OfficeFloor.

Throws:

Exception - If fails to construct Office or ManagedFunction invocation failure.