Package net.officefloor.polyglot.test

Class AbstractPolyglotProcedureTest

java.lang.Object

junit.framework.Assert

junit.framework.TestCase

net.officefloor.frame.test.OfficeFrameTestCase

net.officefloor.polyglot.test.AbstractPolyglotProcedureTest

All Implemented Interfaces:

junit.framework.Test

public abstract class AbstractPolyglotProcedureTest
extends OfficeFrameTestCase

Abstract tests for a polyglot Procedure via a SectionSource.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractPolyglotProcedureTest.CollectionReturn	Handles the return of collection types.
static class	AbstractPolyglotProcedureTest.FlowHandlers	Handles various flow outputs from the procedure.
static class	AbstractPolyglotProcedureTest.ObjectReturn	Handles the return of object types.
static class	AbstractPolyglotProcedureTest.ParameterPass	Passes a parameter to the procedure.
static class	AbstractPolyglotProcedureTest.ParameterReturn	Returns parameter types from the procedure.
static class	AbstractPolyglotProcedureTest.PrimitiveReturn	Handles the return of primitive types.
protected static interface	AbstractPolyglotProcedureTest.ProcedureBuilder	Builds the Procedure.
static class	AbstractPolyglotProcedureTest.VariablePass	Passes variables through to the procedure.
static class	AbstractPolyglotProcedureTest.VariableReturn	Returns variable types from the procedure.

Nested classes/interfaces inherited from class net.officefloor.frame.test.OfficeFrameTestCase

OfficeFrameTestCase.FailOperation, OfficeFrameTestCase.GuiTest, OfficeFrameTestCase.MultithreadedTestLogic<T extends Throwable>, OfficeFrameTestCase.StressTest, OfficeFrameTestCase.TestCapture<T extends Throwable>, OfficeFrameTestCase.TestLogic<R,T extends Throwable>, OfficeFrameTestCase.UsesDockerTest, OfficeFrameTestCase.UsesGCloudTest, OfficeFrameTestCase.WaitForTruePredicate<T extends Throwable>

Field Summary

Fields

Modifier and Type	Field	Description
protected static final com.fasterxml.jackson.databind.ObjectMapper	mapper	ObjectMapper.
protected OfficeFloor	officeFloor	OfficeFloor.

Fields inherited from class net.officefloor.frame.test.OfficeFrameTestCase

CLASS_LOADER_EXTRA_CLASS_NAME, CLASS_LOADER_EXTRA_PACKAGE_NAME, classLoaderTestSupport, END_OF_LINE, fileTestSupport, logTestSupport, mockTestSupport, threadedTestSupport

Constructor Summary

Constructors

Constructor	Description
AbstractPolyglotProcedureTest()

Method Summary

Modifier and Type	Method	Description
protected OfficeSection	addProcedure(String resourceName, Class<? extends ProcedureSourceServiceFactory> serviceFactory, String procedureName, boolean isNext, PropertyList properties, CompileOfficeContext context)	Convenience method to add a Procedure.
protected String	asynchronousFlow(CompileOfficeContext context)	Invokes asynchronous flow via the procedure.
protected abstract void	asynchronousFlow(AsynchronousFlow flowOne, AsynchronousFlow flowTwo)	Invokes asynchronous flow directly.
protected abstract void	asynchronousFlow(AbstractPolyglotProcedureTest.ProcedureBuilder builder)	Builds the asynchronous flow procedure.
protected abstract CollectionTypes	collections(List<Integer> list, Set<Character> set, Map<String,JavaObject> map)	Invokes collection types directly.
protected String	collections(CompileOfficeContext context, OfficeSectionInput handleResult)	Invokes collections via the procedure.
protected abstract void	collections(AbstractPolyglotProcedureTest.ProcedureBuilder builder)	Builds the collections procedure.
protected String	flow(CompileOfficeContext context, OfficeSectionInput next, OfficeSectionInput flow, OfficeSectionInput flowWithCallback, OfficeSectionInput flowWithParameterAndCallback, OfficeSectionInput flowWithParameter, OfficeSectionInput exception)	Invokes flow via the procedure.
protected abstract void	flow(AbstractPolyglotProcedureTest.ProcedureBuilder builder)	Builds the flow procedure.
protected abstract Class<? extends ProcedureSourceServiceFactory>	getProcedureSourceServiceFactoryClass()	Obtains the ProcedureSourceServiceFactory Class.
protected String	getSourceName(Class<? extends ProcedureSourceServiceFactory> serviceFactory)	Obtains the source name for the ProcedureSourceServiceFactory.
protected abstract void	httpException()	Invokes http exception directly.
protected void	httpException(OfficeFlowSourceNode pass, CompileWebContext context)	Invokes http exception via the procedure.
protected abstract void	httpException(AbstractPolyglotProcedureTest.ProcedureBuilder builder)	Builds the http exception procedure.
protected boolean	isSupportExceptions()	Some languages do not provide exceptions.
protected abstract ObjectTypes	objects(String string, JavaObject object, int[] primitiveArray, JavaObject[] objectArray)	Invokes object types directly.
protected String	objects(CompileOfficeContext context, OfficeSectionInput handleResult)	Invokes objects via the procedure.
protected abstract void	objects(AbstractPolyglotProcedureTest.ProcedureBuilder builder)	Builds the objects procedure.
protected abstract ParameterTypes	parameter(String parameter)	Invokes parameter types directly.
protected void	parameter(OfficeSectionOutput pass, CompileOfficeContext context, OfficeSectionInput handleResult)	Invokes parameter via the procedure.
protected abstract void	parameter(AbstractPolyglotProcedureTest.ProcedureBuilder builder)	Builds the parameter procedure.
protected abstract PrimitiveTypes	primitives(boolean _boolean, byte _byte, short _short, char _char, int _int, long _long, float _float, double _double)	Invokes primitive types directly.
protected String	primitives(CompileOfficeContext context, OfficeSectionInput handleResult)	Invokes primitives via the procedure.
protected abstract void	primitives(AbstractPolyglotProcedureTest.ProcedureBuilder builder)	Builds the primitives procedure.
protected void	tearDown()
void	testAsynchronousFlowType()	Ensure correct ProcedureType.
void	testCollectionsType()	Ensure correct ProcedureType.
void	testDirectAsynchronousFlow()	Validate direct AsynchronousFlow.
void	testDirectCollections()	Ensure can pass collections.
void	testDirectHttpException()	Ensure can run direct for HttpException.
void	testDirectMultiThreaded()	Ensure safe to run directly multi-threaded.
void	testDirectObject()	Ensure can pass in a Java object.
void	testDirectParameter()	Ensure can provide Parameter.
void	testDirectPrimitives()	Ensure can use primitive types.
void	testDirectVariables()	Ensure can handle variables.
void	testDirectWeb()	Ensure can run direct for web.
void	testFlow()	Ensure can invoke flow.
void	testFlowType()	Ensure correct ProcedureType.
void	testHttpExceptionType()	Ensure correct ProcedureType.
void	testInvokeAsynchronousFlow()	Ensure can invoke AsynchronousFlow.
void	testInvokeCollections()	Ensure can invoke collections.
void	testInvokeHttpException()	Ensure can invoke to handle HttpException.
void	testInvokeMultiThreaded()	Ensure safe to run invoked multi-threaded.
void	testInvokeObject()	Ensure can invoke object types.
void	testInvokeParameter()	Ensure can use parameter.
void	testInvokePrimitives()	Ensure can invoke primitive types.
void	testInvokeVariables()	Ensure can using variables.
void	testInvokeWeb()	Ensure can invoke for web.
void	testObjectType()	Ensure correct ProcedureType.
void	testParameterType()	Ensure correct ProcedureType.
void	testPrimitivesType()	Ensure correct ProcedureType.
void	testVariablesType()	Ensure correct ProcedureType.
protected abstract VariableTypes	variables(char val, In<String> in, Out<JavaObject> out, Var<Integer> var)	Invokes variable types directly.
protected void	variables(OfficeSectionOutput pass, CompileOfficeContext context, OfficeSectionInput handleResult)	Invokes variables via the procedure.
protected abstract void	variables(AbstractPolyglotProcedureTest.ProcedureBuilder builder)	Builds the variables procedure.
protected abstract void	web(String pathParameter, String queryParameter, String headerParameter, String cookieParameter, MockHttpParameters httpParameters, MockHttpObject httpObject, ObjectResponse<WebTypes> response)	Invokes web types directly.
protected void	web(OfficeFlowSourceNode pass, CompileWebContext context)	Invokes web via the procedure.
protected abstract void	web(AbstractPolyglotProcedureTest.ProcedureBuilder builder)	Builds the web procedure.

Methods inherited from class net.officefloor.frame.test.OfficeFrameTestCase

assertContents, assertContents, assertFail, assertFail, assertFail, assertGraph, assertList, assertList, assertList, assertList, assertList, assertProperties, assertTextEquals, assertXmlEquals, captureLoggerOutput, clearDirectory, copyDirectory, createFile, createMock, createNewClassLoader, createPlatformIndependentText, createSynchronizedMock, deleteDirectory, displayGraph, displayGraph, doMultiThreadedTest, doMultiThreadedTest, doTest, fail, findFile, findFile, findInputStream, getDisplayRunTime, getDisplayRunTime, getFileContents, getFileLocation, getItem, getPackageRelativePath, getProperty, isGuiAvailable, isPrintMessages, isSkipStressTests, isSkipTestsUsingDocker, isSkipTestsUsingGCloud, param, paramType, printHeapMemoryDiagnostics, printMessage, printMessage, printMessage, recordReturn, recordReturn, recordThrows, recordVoid, removeXmlWhiteSpacing, replayMockObjects, runBare, setDebugVerbose, setLogGC, setName, setVerbose, sleep, throwException, timeout, timeout, verifyMockObjects, waitForTrue, waitForTrue

Methods inherited from class junit.framework.TestCase

assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertFalse, assertFalse, assertNotNull, assertNotNull, assertNotSame, assertNotSame, assertNull, assertNull, assertSame, assertSame, assertTrue, assertTrue, countTestCases, createResult, fail, fail, failNotEquals, failNotSame, failSame, format, getName, run, run, runTest, setUp, toString

Methods inherited from class java.lang.Object

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

Field Details

mapper

protected static final com.fasterxml.jackson.databind.ObjectMapper mapper

ObjectMapper.

officeFloor

protected OfficeFloor officeFloor

OfficeFloor.

Constructor Details

AbstractPolyglotProcedureTest

public AbstractPolyglotProcedureTest()

Method Details

tearDown

protected void tearDown()
                 throws Exception

Overrides:

tearDown in class junit.framework.TestCase

Throws:

Exception

addProcedure

protected OfficeSection addProcedure(String resourceName,
 Class<? extends ProcedureSourceServiceFactory> serviceFactory,
 String procedureName,
 boolean isNext,
 PropertyList properties,
 CompileOfficeContext context)

Convenience method to add a Procedure.

Parameters:

resourceName - Name of resource.

serviceFactory - ProcedureSourceServiceFactory.

procedureName - Name of Procedure.

isNext - Indicates if next Flow.

properties - PropertyList.

context - CompileOfficeContext.

Returns:

OfficeSection for the Procedure.

getProcedureSourceServiceFactoryClass

protected abstract Class<? extends ProcedureSourceServiceFactory> getProcedureSourceServiceFactoryClass()

Obtains the ProcedureSourceServiceFactory Class.

Returns:

ProcedureSourceServiceFactory Class.

getSourceName

protected String getSourceName(Class<? extends ProcedureSourceServiceFactory> serviceFactory)

Obtains the source name for the ProcedureSourceServiceFactory.

Parameters:

serviceFactory - ProcedureSourceServiceFactory Class.

Returns:

Source name.

isSupportExceptions

protected boolean isSupportExceptions()

Some languages do not provide exceptions.

Returns:

true if support Exception.

testDirectPrimitives

public void testDirectPrimitives()
                          throws Exception

Ensure can use primitive types.

Throws:

Exception - On test failure.

primitives

protected abstract PrimitiveTypes primitives(boolean _boolean,
 byte _byte,
 short _short,
 char _char,
 int _int,
 long _long,
 float _float,
 double _double)
                                      throws Exception

Invokes primitive types directly.

Parameters:

_boolean - Boolean primitive.

_byte - Byte primitive.

_short - Short primitive.

_char - Char primitive.

_int - Int primitive.

_long - Long primitive.

_float - Float primitive.

_double - Double primitive.

Returns:

PrimitiveTypes result.

Throws:

Exception - If fails.

testPrimitivesType

public void testPrimitivesType()

Ensure correct ProcedureType.

testInvokePrimitives

public void testInvokePrimitives()
                          throws Throwable

Ensure can invoke primitive types.

Throws:

Throwable - On test failure.

primitives

protected String primitives(CompileOfficeContext context,
 OfficeSectionInput handleResult)

Invokes primitives via the procedure.

Parameters:

context - CompileOfficeContext.

handleResult - OfficeSectionInput to handle the result.

Returns:

Name of the managed function.

primitives

protected abstract void primitives(AbstractPolyglotProcedureTest.ProcedureBuilder builder)

Builds the primitives procedure.

Parameters:

builder - AbstractPolyglotProcedureTest.ProcedureBuilder.

testDirectObject

public void testDirectObject()
                      throws Exception

Ensure can pass in a Java object.

Throws:

Exception - On test failure.

objects

protected abstract ObjectTypes objects(String string,
 JavaObject object,
 int[] primitiveArray,
 JavaObject[] objectArray)
                                throws Exception

Invokes object types directly.

Parameters:

string - String value.

object - JavaObject value.

primitiveArray - Primitive array value.

objectArray - Object array value.

Returns:

ObjectTypes result.

Throws:

Exception - If fails.

testObjectType

public void testObjectType()

Ensure correct ProcedureType.

testInvokeObject

public void testInvokeObject()
                      throws Throwable

Ensure can invoke object types.

Throws:

Throwable - On test failure.

objects

protected String objects(CompileOfficeContext context,
 OfficeSectionInput handleResult)

Invokes objects via the procedure.

Parameters:

context - CompileOfficeContext.

handleResult - OfficeSectionInput to handle the result.

Returns:

Name of the managed function.

objects

protected abstract void objects(AbstractPolyglotProcedureTest.ProcedureBuilder builder)

Builds the objects procedure.

Parameters:

builder - AbstractPolyglotProcedureTest.ProcedureBuilder.

testDirectCollections

public void testDirectCollections()
                           throws Exception

Ensure can pass collections.

Throws:

Exception - On test failure.

collections

protected abstract CollectionTypes collections(List<Integer> list,
 Set<Character> set,
 Map<String,JavaObject> map)
                                        throws Exception

Invokes collection types directly.

Parameters:

list - List value.

set - Set value.

map - Map value.

Returns:

CollectionTypes result.

Throws:

Exception - If fails.

testCollectionsType

public void testCollectionsType()

Ensure correct ProcedureType.

testInvokeCollections

public void testInvokeCollections()
                           throws Throwable

Ensure can invoke collections.

Throws:

Throwable - On test failure.

collections

protected String collections(CompileOfficeContext context,
 OfficeSectionInput handleResult)

Invokes collections via the procedure.

Parameters:

context - CompileOfficeContext.

handleResult - OfficeSectionInput to handle the result.

Returns:

Name of the managed function.

collections

protected abstract void collections(AbstractPolyglotProcedureTest.ProcedureBuilder builder)

Builds the collections procedure.

Parameters:

builder - AbstractPolyglotProcedureTest.ProcedureBuilder.

testDirectVariables

public void testDirectVariables()
                         throws Exception

Ensure can handle variables.

Throws:

Exception - On test failure.

variables

protected abstract VariableTypes variables(char val,
 In<String> in,
 Out<JavaObject> out,
 Var<Integer> var)
                                    throws Exception

Invokes variable types directly.

Parameters:

val - Variable character value.

in - Input variable.

out - Output variable.

var - In/out variable.

Returns:

VariableTypes result.

Throws:

Exception - If fails.

testVariablesType

public void testVariablesType()

Ensure correct ProcedureType.

testInvokeVariables

public void testInvokeVariables()
                         throws Throwable

Ensure can using variables.

Throws:

Throwable - On test failure.

variables

protected void variables(OfficeSectionOutput pass,
 CompileOfficeContext context,
 OfficeSectionInput handleResult)

Invokes variables via the procedure.

Parameters:

pass - OfficeSectionOutput to pass into the procedure.

context - CompileOfficeContext.

handleResult - OfficeSectionInput to handle the result.

variables

protected abstract void variables(AbstractPolyglotProcedureTest.ProcedureBuilder builder)

Builds the variables procedure.

Parameters:

builder - AbstractPolyglotProcedureTest.ProcedureBuilder.

testDirectParameter

public void testDirectParameter()
                         throws Exception

Ensure can provide Parameter.

Throws:

Exception - On test failure.

parameter

protected abstract ParameterTypes parameter(String parameter)
                                     throws Exception

Invokes parameter types directly.

Parameters:

parameter - Parameter string value.

Returns:

ParameterTypes result.

Throws:

Exception - If fails.

testParameterType

public void testParameterType()

Ensure correct ProcedureType.

testInvokeParameter

public void testInvokeParameter()
                         throws Throwable

Ensure can use parameter.

Throws:

Throwable - On test failure.

parameter

protected void parameter(OfficeSectionOutput pass,
 CompileOfficeContext context,
 OfficeSectionInput handleResult)

Invokes parameter via the procedure.

Parameters:

pass - OfficeSectionOutput to pass into the procedure.

context - CompileOfficeContext.

handleResult - OfficeSectionInput to handle the result.

parameter

protected abstract void parameter(AbstractPolyglotProcedureTest.ProcedureBuilder builder)

Builds the parameter procedure.

Parameters:

builder - AbstractPolyglotProcedureTest.ProcedureBuilder.

testDirectMultiThreaded

public void testDirectMultiThreaded()
                             throws Exception

Ensure safe to run directly multi-threaded.

Throws:

Exception - On test failure.

testInvokeMultiThreaded

public void testInvokeMultiThreaded()
                             throws Throwable

Ensure safe to run invoked multi-threaded.

Throws:

Throwable - On test failure.

testDirectWeb

public void testDirectWeb()
                   throws Exception

Ensure can run direct for web.

Throws:

Exception - On test failure.

web

protected abstract void web(String pathParameter,
 String queryParameter,
 String headerParameter,
 String cookieParameter,
 MockHttpParameters httpParameters,
 MockHttpObject httpObject,
 ObjectResponse<WebTypes> response)
                     throws Exception

Invokes web types directly.

Parameters:

pathParameter - Path parameter value.

queryParameter - Query parameter value.

headerParameter - Header parameter value.

cookieParameter - Cookie parameter value.

httpParameters - MockHttpParameters.

httpObject - MockHttpObject.

response - ObjectResponse for the result.

Throws:

Exception - If fails.

testInvokeWeb

public void testInvokeWeb()
                   throws Throwable

Ensure can invoke for web.

Throws:

Throwable - On test failure.

web

protected void web(OfficeFlowSourceNode pass,
 CompileWebContext context)

Invokes web via the procedure.

Parameters:

pass - OfficeFlowSourceNode to pass into the procedure.

context - CompileWebContext.

web

protected abstract void web(AbstractPolyglotProcedureTest.ProcedureBuilder builder)

Builds the web procedure.

Parameters:

builder - AbstractPolyglotProcedureTest.ProcedureBuilder.

testDirectHttpException

public void testDirectHttpException()
                             throws Throwable

Ensure can run direct for HttpException.

Throws:

Throwable - On test failure.

httpException

protected abstract void httpException()
                               throws Throwable

Invokes http exception directly.

Throws:

Throwable - On test failure.

testHttpExceptionType

public void testHttpExceptionType()

Ensure correct ProcedureType.

testInvokeHttpException

public void testInvokeHttpException()
                             throws Throwable

Ensure can invoke to handle HttpException.

Throws:

Throwable - On test failure.

httpException

protected void httpException(OfficeFlowSourceNode pass,
 CompileWebContext context)

Invokes http exception via the procedure.

Parameters:

pass - OfficeFlowSourceNode to pass into the procedure.

context - CompileWebContext.

httpException

protected abstract void httpException(AbstractPolyglotProcedureTest.ProcedureBuilder builder)

Builds the http exception procedure.

Parameters:

builder - AbstractPolyglotProcedureTest.ProcedureBuilder.

testFlowType

public void testFlowType()

Ensure correct ProcedureType.

testFlow

public void testFlow()
              throws Throwable

Ensure can invoke flow.

Throws:

Throwable - On test failure.

flow

protected String flow(CompileOfficeContext context,
 OfficeSectionInput next,
 OfficeSectionInput flow,
 OfficeSectionInput flowWithCallback,
 OfficeSectionInput flowWithParameterAndCallback,
 OfficeSectionInput flowWithParameter,
 OfficeSectionInput exception)

Invokes flow via the procedure.

Parameters:

context - CompileOfficeContext.

next - OfficeSectionInput for next output.

flow - OfficeSectionInput for flow output.

flowWithCallback - OfficeSectionInput for flow with callback output.

flowWithParameterAndCallback - OfficeSectionInput for flow with parameter and callback output.

flowWithParameter - OfficeSectionInput for flow with parameter output.

exception - OfficeSectionInput for exception output.

Returns:

Name of the managed function.

flow

protected abstract void flow(AbstractPolyglotProcedureTest.ProcedureBuilder builder)

Builds the flow procedure.

Parameters:

builder - AbstractPolyglotProcedureTest.ProcedureBuilder.

testDirectAsynchronousFlow

public void testDirectAsynchronousFlow()
                                throws Throwable

Validate direct AsynchronousFlow.

Throws:

Throwable - On test failure.

asynchronousFlow

protected abstract void asynchronousFlow(AsynchronousFlow flowOne,
 AsynchronousFlow flowTwo)
                                  throws Exception

Invokes asynchronous flow directly.

Parameters:

flowOne - First AsynchronousFlow.

flowTwo - Second AsynchronousFlow.

Throws:

Exception - If fails.

testAsynchronousFlowType

public void testAsynchronousFlowType()

Ensure correct ProcedureType.

testInvokeAsynchronousFlow

public void testInvokeAsynchronousFlow()
                                throws Throwable

Ensure can invoke AsynchronousFlow.

Throws:

Throwable - On test failure.

asynchronousFlow

protected String asynchronousFlow(CompileOfficeContext context)

Invokes asynchronous flow via the procedure.

Parameters:

context - CompileOfficeContext.

Returns:

Function name.

asynchronousFlow

protected abstract void asynchronousFlow(AbstractPolyglotProcedureTest.ProcedureBuilder builder)

Builds the asynchronous flow procedure.

Parameters:

builder - AbstractPolyglotProcedureTest.ProcedureBuilder.