nl.nn.adapterframework.testtool

Class TestTool

java.lang.Object

nl.nn.adapterframework.testtool.TestTool

public class TestTool
extends Object

Author:

Jaco de Groot

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TestTool.BetweenKeysAction
static interface	TestTool.SingleKeyAction

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	DEFAULT_TIMEOUT
static int	ERROR_NO_SCENARIO_DIRECTORIES_FOUND
protected static int	globalTimeout
static String	LOG_LEVEL_ORDER
static int	RESULT_AUTOSAVED
static int	RESULT_ERROR
static int	RESULT_OK
protected static String	TESTTOOL_BIFNAME
protected static String	TESTTOOL_CLEAN_UP_REPLY
protected static String	TESTTOOL_CORRELATIONID
static Message	TESTTOOL_DUMMY_MESSAGE

Constructor Summary

Constructors

Constructor and Description
TestTool()

Method Summary

Modifier and Type	Method and Description
static void	addAbsolutePathProperties(String propertiesDirectory, Properties properties)
static String	canonicaliseFilePathContentBetweenKeys(String string, String key1, String key2, Map<String,Object> writers)
static boolean	closeQueues(Map<String,Queue> queues, Properties properties, Map<String,Object> writers, String correlationId)
static int	compareResult(String step, String stepDisplayName, String fileName, String expectedResult, String actualResult, Properties properties, Map<String,Object> writers, String queueName)
static Map<String,Object>	createParametersMapFromParamProperties(Properties properties, String property, Map<String,Object> writers, boolean createParameterObjects, PipeLineSession session) Create a Map for a specific property based on other properties that are the same except for a .param1.name, .param1.value or .param1.valuefile suffix.
static void	debugMessage(String message, Map<String,Object> writers)
static void	debugPipelineMessage(String stepDisplayName, String message, String pipelineMessage, Map<String,Object> writers)
static void	debugPipelineMessagePreparedForDiff(String stepDisplayName, String message, String pipelineMessage, Map<String,Object> writers)
static String	decodeUnzipContentBetweenKeys(String string, String key1, String key2, boolean replaceNewlines, Map<String,Object> writers)
static String	doActionBetweenKeys(String key, String value, Properties properties, HashMap<String,HashMap<String,HashMap<String,String>>> ignoreMap, Map<String,Object> writers, TestTool.BetweenKeysAction action)
static String	doActionWithSingleKey(String keyName, String value, Properties properties, HashMap<String,HashMap<String,HashMap<String,String>>> ignoreMap, Map<String,Object> writers, TestTool.SingleKeyAction action)
static void	errorMessage(String message, Exception exception, Map<String,Object> writers)
static void	errorMessage(String message, Map<String,Object> writers)
static int	executeStep(String step, Properties properties, String stepDisplayName, Map<String,Queue> queues, Map<String,Object> writers, int parameterTimeout, String correlationId)
static ArrayList<String>	findAttributesForIgnore(String propertyName) This method is used to de-couple the need of providing a set of attributes when calling mapPropertiesByIdentifier().
static String	formatDecimalContentBetweenKeys(String string, String key1, String key2, Map writers)
static String	formatString(String string, Map<String,Object> writers)
static String	getAbsolutePath(String parent, String child)
static String	getAbsolutePath(String parent, String child, boolean addFileSeparator) Returns the absolute pathname for the child pathname.
static List<String>	getSteps(Properties properties, Map<String,Object> writers)
static String	ignoreContentAfterKey(String string, String key)
static String	ignoreContentBeforeKey(String string, String key)
static String	ignoreContentBetweenKeys(String string, String key1, String key2)
static String	ignoreCurrentTimeBetweenKeys(String string, String key1, String key2, String pattern, String margin, boolean errorMessageOnRemainingString, boolean isControlString, Map<String,Object> writers)
static String	ignoreKey(String string, String key)
static String	ignoreKeysAndContentBetweenKeys(String string, String key1, String key2)
static String	ignoreRegularExpression(String string, String regex)
static String	initScenariosRootDirectories(String realPath, String paramScenariosRootDirectory, List<String> scenariosRootDirectories, List<String> scenariosRootDescriptions, Map<String,Object> writers)
static boolean	jmsCleanUp(String queueName, PullingJmsListener pullingJmsListener, Map<String,Object> writers)
static HashMap<String,HashMap<String,HashMap<String,String>>>	mapPropertiesToIgnores(Properties properties) This method is used to provide a way to implement ignores based on an identifier.
static String	prepareResultForCompare(String input, Properties properties, HashMap<String,HashMap<String,HashMap<String,String>>> ignoreMap, Map<String,Object> writers)
static void	printHtmlForm(List<String> scenariosRootDirectories, List<String> scenariosRootDescriptions, String scenariosRootDirectory, AppConstants appConstants, List<File> scenarioFiles, int waitBeforeCleanUp, int timeout, String paramExecute, String autoScroll, Map<String,Object> writers)
static String	readFile(String fileName, Map<String,Object> writers)
static Properties	readProperties(AppConstants appConstants, File propertiesFile, boolean root, Map<String,Object> writers)
static Properties	readProperties(AppConstants appConstants, File propertiesFile, Map<String,Object> writers)
static List<File>	readScenarioFiles(AppConstants appConstants, String scenariosDirectory, Map<String,Object> writers)
static String	removeKey(String string, String key)
static String	removeKeysAndContentBetweenKeys(String string, String key1, String key2)
static String	removeRegularExpression(String string, String regex)
static String	replaceKey(String string, String from, String to)
static String	replaceRegularExpression(String string, String from, String to)
static int	runScenarios(IbisContext ibisContext, String paramLogLevel, String paramAutoScroll, String paramExecute, String paramWaitBeforeCleanUp, int timeout, String realPath, String paramScenariosRootDirectory, Writer out, boolean silent)
static void	runScenarios(javax.servlet.ServletContext application, javax.servlet.http.HttpServletRequest request, Writer out, String realPath)
static void	scenarioAutosavedMessage(String message, Map<String,Object> writers)
static void	scenarioFailedMessage(String message, Map<String,Object> writers)
static void	scenarioPassedMessage(String message, Map<String,Object> writers)
static void	scenariosAutosavedTotalMessage(String message, Map<String,Object> writers, Writer out, boolean silent)
static void	scenariosFailedTotalMessage(String message, Map<String,Object> writers, Writer out, boolean silent)
static void	scenariosPassedTotalMessage(String message, Map<String,Object> writers, Writer out, boolean silent)
static void	scenariosTotalMessage(String message, Map<String,Object> writers, Writer out, boolean silent)
static void	setTimeout(int newTimeout)
static void	stepAutosavedMessage(String message, Map<String,Object> writers)
static void	stepFailedMessage(String message, Map<String,Object> writers)
static void	stepPassedMessage(String message, Map<String,Object> writers)
static void	windiff(javax.servlet.ServletContext application, javax.servlet.http.HttpServletRequest request, String expectedFileName, String result, String expected)
static void	write(String html, String type, String method, Map<String,Object> writers, boolean scroll)
static void	writeFile(String fileName, String content)
static void	writeHtml(String html, Map<String,Object> writers, boolean scroll)
static void	writeLog(String html, String method, Map<String,Object> writers, boolean scroll)
static void	wrongPipelineMessage(String message, String pipelineMessage, Map<String,Object> writers)
static void	wrongPipelineMessage(String stepDisplayName, String message, String pipelineMessage, String pipelineMessageExpected, Map<String,Object> writers)
static void	wrongPipelineMessagePreparedForDiff(String stepDisplayName, String pipelineMessagePreparedForDiff, String pipelineMessageExpectedPreparedForDiff, Map<String,Object> writers)

Methods inherited from class java.lang.Object

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

Field Detail

LOG_LEVEL_ORDER

public static final String LOG_LEVEL_ORDER

See Also:

Constant Field Values

TESTTOOL_CORRELATIONID

protected static final String TESTTOOL_CORRELATIONID

See Also:

Constant Field Values

DEFAULT_TIMEOUT

protected static final int DEFAULT_TIMEOUT

TESTTOOL_BIFNAME

protected static final String TESTTOOL_BIFNAME

See Also:

Constant Field Values

TESTTOOL_DUMMY_MESSAGE

public static final Message TESTTOOL_DUMMY_MESSAGE

TESTTOOL_CLEAN_UP_REPLY

protected static final String TESTTOOL_CLEAN_UP_REPLY

See Also:

Constant Field Values

RESULT_ERROR

public static final int RESULT_ERROR

See Also:

Constant Field Values

RESULT_OK

public static final int RESULT_OK

See Also:

Constant Field Values

RESULT_AUTOSAVED

public static final int RESULT_AUTOSAVED

See Also:

Constant Field Values

globalTimeout

protected static int globalTimeout

ERROR_NO_SCENARIO_DIRECTORIES_FOUND

public static final int ERROR_NO_SCENARIO_DIRECTORIES_FOUND

See Also:

Constant Field Values

Constructor Detail

TestTool

public TestTool()

Method Detail

setTimeout

public static void setTimeout(int newTimeout)

runScenarios

public static void runScenarios(javax.servlet.ServletContext application,
                                javax.servlet.http.HttpServletRequest request,
                                Writer out,
                                String realPath)

runScenarios

public static int runScenarios(IbisContext ibisContext,
                               String paramLogLevel,
                               String paramAutoScroll,
                               String paramExecute,
                               String paramWaitBeforeCleanUp,
                               int timeout,
                               String realPath,
                               String paramScenariosRootDirectory,
                               Writer out,
                               boolean silent)

Returns:

negative: error condition 0: all scenarios passed positive: number of scenarios that failed

printHtmlForm

public static void printHtmlForm(List<String> scenariosRootDirectories,
                                 List<String> scenariosRootDescriptions,
                                 String scenariosRootDirectory,
                                 AppConstants appConstants,
                                 List<File> scenarioFiles,
                                 int waitBeforeCleanUp,
                                 int timeout,
                                 String paramExecute,
                                 String autoScroll,
                                 Map<String,Object> writers)

write

public static void write(String html,
                         String type,
                         String method,
                         Map<String,Object> writers,
                         boolean scroll)

writeHtml

public static void writeHtml(String html,
                             Map<String,Object> writers,
                             boolean scroll)

writeLog

public static void writeLog(String html,
                            String method,
                            Map<String,Object> writers,
                            boolean scroll)

debugMessage

public static void debugMessage(String message,
                                Map<String,Object> writers)

debugPipelineMessage

public static void debugPipelineMessage(String stepDisplayName,
                                        String message,
                                        String pipelineMessage,
                                        Map<String,Object> writers)

debugPipelineMessagePreparedForDiff

public static void debugPipelineMessagePreparedForDiff(String stepDisplayName,
                                                       String message,
                                                       String pipelineMessage,
                                                       Map<String,Object> writers)

wrongPipelineMessage

public static void wrongPipelineMessage(String message,
                                        String pipelineMessage,
                                        Map<String,Object> writers)

wrongPipelineMessage

public static void wrongPipelineMessage(String stepDisplayName,
                                        String message,
                                        String pipelineMessage,
                                        String pipelineMessageExpected,
                                        Map<String,Object> writers)

wrongPipelineMessagePreparedForDiff

public static void wrongPipelineMessagePreparedForDiff(String stepDisplayName,
                                                       String pipelineMessagePreparedForDiff,
                                                       String pipelineMessageExpectedPreparedForDiff,
                                                       Map<String,Object> writers)

stepPassedMessage

public static void stepPassedMessage(String message,
                                     Map<String,Object> writers)

stepAutosavedMessage

public static void stepAutosavedMessage(String message,
                                        Map<String,Object> writers)

stepFailedMessage

public static void stepFailedMessage(String message,
                                     Map<String,Object> writers)

scenarioPassedMessage

public static void scenarioPassedMessage(String message,
                                         Map<String,Object> writers)

scenarioAutosavedMessage

public static void scenarioAutosavedMessage(String message,
                                            Map<String,Object> writers)

scenarioFailedMessage

public static void scenarioFailedMessage(String message,
                                         Map<String,Object> writers)

scenariosTotalMessage

public static void scenariosTotalMessage(String message,
                                         Map<String,Object> writers,
                                         Writer out,
                                         boolean silent)

scenariosPassedTotalMessage

public static void scenariosPassedTotalMessage(String message,
                                               Map<String,Object> writers,
                                               Writer out,
                                               boolean silent)

scenariosAutosavedTotalMessage

public static void scenariosAutosavedTotalMessage(String message,
                                                  Map<String,Object> writers,
                                                  Writer out,
                                                  boolean silent)

scenariosFailedTotalMessage

public static void scenariosFailedTotalMessage(String message,
                                               Map<String,Object> writers,
                                               Writer out,
                                               boolean silent)

errorMessage

public static void errorMessage(String message,
                                Map<String,Object> writers)

errorMessage

public static void errorMessage(String message,
                                Exception exception,
                                Map<String,Object> writers)

initScenariosRootDirectories

public static String initScenariosRootDirectories(String realPath,
                                                  String paramScenariosRootDirectory,
                                                  List<String> scenariosRootDirectories,
                                                  List<String> scenariosRootDescriptions,
                                                  Map<String,Object> writers)

readScenarioFiles

public static List<File> readScenarioFiles(AppConstants appConstants,
                                           String scenariosDirectory,
                                           Map<String,Object> writers)

readProperties

public static Properties readProperties(AppConstants appConstants,
                                        File propertiesFile,
                                        Map<String,Object> writers)

readProperties

public static Properties readProperties(AppConstants appConstants,
                                        File propertiesFile,
                                        boolean root,
                                        Map<String,Object> writers)

getAbsolutePath

public static String getAbsolutePath(String parent,
                                     String child)

getAbsolutePath

public static String getAbsolutePath(String parent,
                                     String child,
                                     boolean addFileSeparator)

Returns the absolute pathname for the child pathname. The parent pathname is used as a prefix when the child pathname is an not absolute.

Parameters:

parent - the parent pathname to use

child - the child pathname to convert to a absolute pathname

addAbsolutePathProperties

public static void addAbsolutePathProperties(String propertiesDirectory,
                                             Properties properties)

getSteps

public static List<String> getSteps(Properties properties,
                                    Map<String,Object> writers)

closeQueues

public static boolean closeQueues(Map<String,Queue> queues,
                                  Properties properties,
                                  Map<String,Object> writers,
                                  String correlationId)

jmsCleanUp

public static boolean jmsCleanUp(String queueName,
                                 PullingJmsListener pullingJmsListener,
                                 Map<String,Object> writers)

executeStep

public static int executeStep(String step,
                              Properties properties,
                              String stepDisplayName,
                              Map<String,Queue> queues,
                              Map<String,Object> writers,
                              int parameterTimeout,
                              String correlationId)

readFile

public static String readFile(String fileName,
                              Map<String,Object> writers)

windiff

public static void windiff(javax.servlet.ServletContext application,
                           javax.servlet.http.HttpServletRequest request,
                           String expectedFileName,
                           String result,
                           String expected)
                    throws IOException,
                           SenderException

Throws:

IOException

SenderException

writeFile

public static void writeFile(String fileName,
                             String content)
                      throws IOException

Throws:

IOException

compareResult

public static int compareResult(String step,
                                String stepDisplayName,
                                String fileName,
                                String expectedResult,
                                String actualResult,
                                Properties properties,
                                Map<String,Object> writers,
                                String queueName)

prepareResultForCompare

public static String prepareResultForCompare(String input,
                                             Properties properties,
                                             HashMap<String,HashMap<String,HashMap<String,String>>> ignoreMap,
                                             Map<String,Object> writers)

doActionBetweenKeys

public static String doActionBetweenKeys(String key,
                                         String value,
                                         Properties properties,
                                         HashMap<String,HashMap<String,HashMap<String,String>>> ignoreMap,
                                         Map<String,Object> writers,
                                         TestTool.BetweenKeysAction action)

doActionWithSingleKey

public static String doActionWithSingleKey(String keyName,
                                           String value,
                                           Properties properties,
                                           HashMap<String,HashMap<String,HashMap<String,String>>> ignoreMap,
                                           Map<String,Object> writers,
                                           TestTool.SingleKeyAction action)

ignoreContentBetweenKeys

public static String ignoreContentBetweenKeys(String string,
                                              String key1,
                                              String key2)

ignoreKeysAndContentBetweenKeys

public static String ignoreKeysAndContentBetweenKeys(String string,
                                                     String key1,
                                                     String key2)

removeKeysAndContentBetweenKeys

public static String removeKeysAndContentBetweenKeys(String string,
                                                     String key1,
                                                     String key2)

ignoreKey

public static String ignoreKey(String string,
                               String key)

removeKey

public static String removeKey(String string,
                               String key)

replaceKey

public static String replaceKey(String string,
                                String from,
                                String to)

decodeUnzipContentBetweenKeys

public static String decodeUnzipContentBetweenKeys(String string,
                                                   String key1,
                                                   String key2,
                                                   boolean replaceNewlines,
                                                   Map<String,Object> writers)

canonicaliseFilePathContentBetweenKeys

public static String canonicaliseFilePathContentBetweenKeys(String string,
                                                            String key1,
                                                            String key2,
                                                            Map<String,Object> writers)

ignoreCurrentTimeBetweenKeys

public static String ignoreCurrentTimeBetweenKeys(String string,
                                                  String key1,
                                                  String key2,
                                                  String pattern,
                                                  String margin,
                                                  boolean errorMessageOnRemainingString,
                                                  boolean isControlString,
                                                  Map<String,Object> writers)

formatDecimalContentBetweenKeys

public static String formatDecimalContentBetweenKeys(String string,
                                                     String key1,
                                                     String key2,
                                                     Map writers)

ignoreContentBeforeKey

public static String ignoreContentBeforeKey(String string,
                                            String key)

ignoreContentAfterKey

public static String ignoreContentAfterKey(String string,
                                           String key)

ignoreRegularExpression

public static String ignoreRegularExpression(String string,
                                             String regex)

removeRegularExpression

public static String removeRegularExpression(String string,
                                             String regex)

replaceRegularExpression

public static String replaceRegularExpression(String string,
                                              String from,
                                              String to)

createParametersMapFromParamProperties

public static Map<String,Object> createParametersMapFromParamProperties(Properties properties,
                                                                        String property,
                                                                        Map<String,Object> writers,
                                                                        boolean createParameterObjects,
                                                                        PipeLineSession session)

Create a Map for a specific property based on other properties that are the same except for a .param1.name, .param1.value or .param1.valuefile suffix. The property with the .name suffix specifies the key for the Map, the property with the value suffix specifies the value for the Map. A property with a the .valuefile suffix can be used as an alternative for a property with a .value suffix to specify the file to read the value for the Map from. More than one param can be specified by using param2, param3 etc.

Parameters:

properties -

property -

writers -

session - TODO

Returns:

A map with parameters

formatString

public static String formatString(String string,
                                  Map<String,Object> writers)

mapPropertiesToIgnores

public static HashMap<String,HashMap<String,HashMap<String,String>>> mapPropertiesToIgnores(Properties properties)

This method is used to provide a way to implement ignores based on an identifier. For example: ignoreContentBetweenKeys.fieldA.key1= ignoreContentBetweenKeys.fieldA.key2=

Parameters:

properties - Properties to be checked

Returns:

HashMap>> as HashMap<'ignoreContentBetweenKeys', Hashmap<'fieldA', HashMap<'key1', ''>

findAttributesForIgnore

public static ArrayList<String> findAttributesForIgnore(String propertyName)

This method is used to de-couple the need of providing a set of attributes when calling mapPropertiesByIdentifier(). Caller of mapPropertiesByIdentifier() should not necescarrily know about all attributes related to an ignore.

Parameters:

propertyName - The name of the ignore we are checking, in the example 'ignoreContentBetweenKeys'