Package emissary.test.core.junit5

Class ExtractionTest

java.lang.Object

emissary.test.core.junit5.UnitTest

emissary.test.core.junit5.ExtractionTest

Direct Known Subclasses:

HtmlEscapePlaceTest, RegressionTest, TestingResourcesTest

public abstract class ExtractionTest
extends UnitTest

Nested Class Summary

Nested classes/interfaces inherited from class emissary.test.core.junit5.UnitTest

UnitTest.DumpFailuresWatcher

Field Summary

Fields

Modifier and Type	Field	Description
protected List<LogbackTester.SimplifiedLogEvent>	actualSimplifiedLogEvents	The list of actual logEvents generated by executing the place.
protected emissary.kff.KffDataObjectHandler	kff
protected static org.slf4j.Logger	logger
protected emissary.place.IServiceProviderPlace	place

Fields inherited from class emissary.test.core.junit5.UnitTest

answerFileClassRef, origConfigPkg, temporaryDirectory, thisPackage, TMPDIR

Constructor Summary

Constructors

Constructor	Description
ExtractionTest()

Method Summary

Modifier and Type	Method	Description
protected void	checkAnswers(org.jdom2.Document answers, emissary.core.IBaseDataObject payload, List<emissary.core.IBaseDataObject> attachments, String tname)
protected void	checkAnswers(org.jdom2.Element el, emissary.core.IBaseDataObject payload, List<emissary.core.IBaseDataObject> attachments, String tname)
protected void	checkAnswersPostHook(org.jdom2.Document answers, emissary.core.IBaseDataObject payload, List<emissary.core.IBaseDataObject> attachments, String tname)
protected void	checkAnswersPostHook(org.jdom2.Element answers, emissary.core.IBaseDataObject payload, emissary.core.IBaseDataObject attachment, String tname)
protected void	checkAnswersPreHook(org.jdom2.Document answers, emissary.core.IBaseDataObject payload, List<emissary.core.IBaseDataObject> attachments, String tname)
protected void	checkAnswersPreHook(org.jdom2.Element answers, emissary.core.IBaseDataObject payload, emissary.core.IBaseDataObject attachment, String tname)
protected void	checkAnswersPreHookLogEvents(List<LogbackTester.SimplifiedLogEvent> simplifiedLogEvents)	This method allows log events to be modified prior to checkAnswers being called.
protected void	checkStringValue(org.jdom2.Element meta, String data, String tname)
abstract emissary.place.IServiceProviderPlace	createPlace()	Derived classes must implement this
static Stream<? extends org.junit.jupiter.params.provider.Arguments>	data()
protected String	getInitialForm(String resource)	Allow overriding the initial form in extensions to this test.
protected String	getLogbackLoggerName()	This method returns the logger name to capture log events from or null if log events are not to be checked.
protected List<emissary.core.IBaseDataObject>	processHeavyDutyHook(emissary.place.IServiceProviderPlace place, emissary.core.IBaseDataObject payload)
protected void	processPostHook(emissary.core.IBaseDataObject payload, List<emissary.core.IBaseDataObject> attachments)
protected void	processPreHook(emissary.core.IBaseDataObject payload, org.jdom2.Document controlDoc)
protected void	setupPayload(emissary.core.IBaseDataObject payload, org.jdom2.Document doc)
void	setUpPlace()
void	tearDownPlace()
void	testExtractionPlace(String resource)
protected boolean	verifyOs(org.jdom2.Element element)

Methods inherited from class emissary.test.core.junit5.UnitTest

assertMaxNonSystemThreadCount, configure, getAnswerDocumentFor, getMyTestParameterFiles, getMyTestResources, getMyXmlResources, pause, restoreConfig, setConfig, setUp, setupSystemProperties, setupTmpDirJunit5, tearDown, useAlternateAnswerFileSource

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.slf4j.Logger logger

actualSimplifiedLogEvents

protected List<LogbackTester.SimplifiedLogEvent> actualSimplifiedLogEvents

The list of actual logEvents generated by executing the place.

kff

protected emissary.kff.KffDataObjectHandler kff

place

@Nullable
protected emissary.place.IServiceProviderPlace place

Constructor Detail

ExtractionTest

public ExtractionTest()

Method Detail

setUpPlace

@BeforeEach
public void setUpPlace()
                throws Exception

Throws:

Exception

tearDownPlace

@AfterEach
public void tearDownPlace()

createPlace

public abstract emissary.place.IServiceProviderPlace createPlace()
                                                          throws IOException

Derived classes must implement this

Throws:

IOException

data

public static Stream<? extends org.junit.jupiter.params.provider.Arguments> data()

getInitialForm

@ForOverride
protected String getInitialForm(String resource)

Allow overriding the initial form in extensions to this test. By default, get the initial form from the filename in the form INITIAL_FORM@2.dat where INITIAL_FORM will be the initial form.

Parameters:

resource - to get the form from

Returns:

the initial form

getLogbackLoggerName

protected String getLogbackLoggerName()

This method returns the logger name to capture log events from or null if log events are not to be checked.

Returns:

the logger name to capture log events from or null (the default) if log events are not to be checked.

testExtractionPlace

@ParameterizedTest
@MethodSource("data")
public void testExtractionPlace(String resource)

processPreHook

protected void processPreHook(emissary.core.IBaseDataObject payload,
                              org.jdom2.Document controlDoc)

processPostHook

protected void processPostHook(emissary.core.IBaseDataObject payload,
                               List<emissary.core.IBaseDataObject> attachments)

processHeavyDutyHook

protected List<emissary.core.IBaseDataObject> processHeavyDutyHook(emissary.place.IServiceProviderPlace place,
                                                                   emissary.core.IBaseDataObject payload)
                                                            throws Exception

Throws:

Exception

checkAnswersPreHook

protected void checkAnswersPreHook(org.jdom2.Document answers,
                                   emissary.core.IBaseDataObject payload,
                                   List<emissary.core.IBaseDataObject> attachments,
                                   String tname)

checkAnswersPreHook

protected void checkAnswersPreHook(org.jdom2.Element answers,
                                   emissary.core.IBaseDataObject payload,
                                   emissary.core.IBaseDataObject attachment,
                                   String tname)

checkAnswersPreHookLogEvents

protected void checkAnswersPreHookLogEvents(List<LogbackTester.SimplifiedLogEvent> simplifiedLogEvents)

This method allows log events to be modified prior to checkAnswers being called. In the default case, do nothing.

Parameters:

simplifiedLogEvents - the log events to be tweaked.

checkAnswersPostHook

protected void checkAnswersPostHook(org.jdom2.Document answers,
                                    emissary.core.IBaseDataObject payload,
                                    List<emissary.core.IBaseDataObject> attachments,
                                    String tname)

checkAnswersPostHook

protected void checkAnswersPostHook(org.jdom2.Element answers,
                                    emissary.core.IBaseDataObject payload,
                                    emissary.core.IBaseDataObject attachment,
                                    String tname)

checkAnswers

protected void checkAnswers(org.jdom2.Document answers,
                            emissary.core.IBaseDataObject payload,
                            List<emissary.core.IBaseDataObject> attachments,
                            String tname)
                     throws org.jdom2.DataConversionException

Throws:

org.jdom2.DataConversionException

checkAnswers

protected void checkAnswers(org.jdom2.Element el,
                            emissary.core.IBaseDataObject payload,
                            @Nullable
                            List<emissary.core.IBaseDataObject> attachments,
                            String tname)
                     throws org.jdom2.DataConversionException

Throws:

org.jdom2.DataConversionException

checkStringValue

protected void checkStringValue(org.jdom2.Element meta,
                                String data,
                                String tname)

verifyOs

protected boolean verifyOs(org.jdom2.Element element)

setupPayload

protected void setupPayload(emissary.core.IBaseDataObject payload,
                            org.jdom2.Document doc)