org.dynamide.restreplay

Class RestReplay

java.lang.Object

org.dynamide.restreplay.ConfigFile

org.dynamide.restreplay.RestReplay

public class RestReplay
extends ConfigFile

This class is used to replay a request to the Services layer, by sending the XML or JSON payload in an appropriate Multipart request. This class is a runtime representation of a control file, which starts with the XML element <restReplay>. See example usage in the calling class Main, and the calling maven surefire classes RestReplayTest and RestReplaySelfTest.

Author:

Laramie Crocker

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	RestReplay.ImportFilter This class handles an import element in the control file, for example: <import ID="myImportedTokenTest" control="_self_test/self-test.xml" testGroup="login" test="token" />
static class	RestReplay.Loop script-facing class known in context as "loop" so that the values for key, value and index may be retrieved with loop.key, loop.value, and loop.index, for each iteration of the test.
protected static class	RestReplay.OneTest

Field Summary

Fields

Modifier and Type	Field and Description
List<EvalResult>	evalReport
static Kit	KIT
Map<String,Object>	masterVars
static String	REL_PATH_TO_DB
static Tools	TOOLS

Fields inherited from class org.dynamide.restreplay.ConfigFile

reportsDir

Constructor Summary

Constructors

Constructor and Description
RestReplay(String testdir, String reportsDir, ResourceManager manager, RunOptions parentRunOptions)

Method Summary

Modifier and Type	Method and Description
List<ServiceResult>	autoDelete(Map<String,ServiceResult> theServiceResultsMap, String logName) Use this method to clean up resources created on the server that returned CSIDs, if you have specified autoDeletePOSTS==false, which means you are managing the cleanup yourself.
List<ServiceResult>	autoDelete(String logName)
String	calculateElipses(String relpath)
static Map<String,ServiceResult>	createResultsMap()
String	dumpMasterNamespace()
String	getControlFileName()
String	getMasterEnvsFileLocation()
String	getMasterFilename()
Map<String,ServiceResult>	getMasterNamespace()
Map<String,Object>	getMasterVars()
String	getMasterVarsFileLocation()
String	getRelToMaster()
String	getRelToMasterURL()
Map<String,ServiceResult>	getServiceResultsMap()
List<ServiceResult>	runRestReplayFile(String testdir, String controlFileName, String testGroupID, String oneTestID, Map<String,Object> masterVarsOverride, boolean param_autoDeletePOSTS, String protoHostPortParam, AuthsMap authsFromMaster, List<String> reportsList, String reportsDir, String relativePathFromReportsDir, String masterFilenameInfo, String runID, Integer runHashCount, List<RestReplayReport.Header> testGroups)
List<ServiceResult>	runTests(String testGroupID, String testID, String runID, Integer runHashCount, List<RestReplayReport.Header> testGroups) Use this if you wish to run named tests within a testGroup.
protected EvalResult	runValidatorScript(ServiceResult serviceResult, org.dynamide.restreplay.RestReplay.PartsStruct expectedResponseParts, Eval evalStruct)
protected void	runValidatorScriptSinglePayload(ServiceResult serviceResult, org.dynamide.restreplay.RestReplay.PartsStruct expectedResponseParts, Eval evalStruct)
File	saveServiceResultToJSON(ServiceResult serviceResult)
void	setControlFileName(String controlFileName)
void	setMasterEnvsFileLocation(String masterEnvsFileLocation)
void	setMasterFilename(String val)
void	setMasterNamespace(Map<String,ServiceResult> namespace)
void	setMasterVars(Map<String,Object> masterVars)
void	setMasterVarsFileLocation(String masterVarsFileLocation)
void	setRelToMaster(String val)
static String	testToString(org.dom4j.Node testNode)
String	toString()
protected String	validateResponse(ServiceResult serviceResult, org.dynamide.restreplay.RestReplay.PartsStruct expectedResponseParts, Eval evalStruct)
protected String	validateResponseSinglePayload(ServiceResult serviceResult, org.dynamide.restreplay.RestReplay.PartsStruct expectedResponseParts, Eval evalStruct)

Methods inherited from class org.dynamide.restreplay.ConfigFile

addHeader, getCurrentTestIDLabel, getDefaultAuthsMap, getDump, getEnvID, getProtoHostPort, getRelativePathFromReportsDir, getReportsDir, getReportsList, getResourceManager, getRunOptions, getTestDir, isAutoDeletePOSTS, readAuths, readDefaultRunOptions, readDumpOptions, readHeaders, readVars, setAutoDeletePOSTS, setCurrentTestIDLabel, setDefaultAuthsMap, setDump, setEnvID, setProtoHostPort, setReportsList, setResourceManager, setRunOptions, setTestDir

Methods inherited from class java.lang.Object

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

Field Detail

REL_PATH_TO_DB

public static final String REL_PATH_TO_DB

See Also:

Constant Field Values

masterVars

public Map<String,Object> masterVars

evalReport

public List<EvalResult> evalReport

TOOLS

public static Tools TOOLS

KIT

public static Kit KIT

Constructor Detail

RestReplay

public RestReplay(String testdir,
                  String reportsDir,
                  ResourceManager manager,
                  RunOptions parentRunOptions)

Method Detail

getControlFileName

public String getControlFileName()

setControlFileName

public void setControlFileName(String controlFileName)

getMasterFilename

public String getMasterFilename()

setMasterFilename

public void setMasterFilename(String val)

getMasterEnvsFileLocation

public String getMasterEnvsFileLocation()

setMasterEnvsFileLocation

public void setMasterEnvsFileLocation(String masterEnvsFileLocation)

getMasterVarsFileLocation

public String getMasterVarsFileLocation()

setMasterVarsFileLocation

public void setMasterVarsFileLocation(String masterVarsFileLocation)

getRelToMaster

public String getRelToMaster()

getRelToMasterURL

public String getRelToMasterURL()

setRelToMaster

public void setRelToMaster(String val)

getMasterVars

public Map<String,Object> getMasterVars()

setMasterVars

public void setMasterVars(Map<String,Object> masterVars)

getServiceResultsMap

public Map<String,ServiceResult> getServiceResultsMap()

createResultsMap

public static Map<String,ServiceResult> createResultsMap()

setMasterNamespace

public void setMasterNamespace(Map<String,ServiceResult> namespace)

getMasterNamespace

public Map<String,ServiceResult> getMasterNamespace()

toString

public String toString()

Overrides:

toString in class Object

testToString

public static String testToString(org.dom4j.Node testNode)

runTests

public List<ServiceResult> runTests(String testGroupID,
                                    String testID,
                                    String runID,
                                    Integer runHashCount,
                                    List<RestReplayReport.Header> testGroups)
                             throws Exception

Use this if you wish to run named tests within a testGroup.

Throws:

Exception

autoDelete

public List<ServiceResult> autoDelete(String logName)

autoDelete

public List<ServiceResult> autoDelete(Map<String,ServiceResult> theServiceResultsMap,
                                      String logName)

Use this method to clean up resources created on the server that returned CSIDs, if you have specified autoDeletePOSTS==false, which means you are managing the cleanup yourself. POST and PUT requests automatically should be able to be autodeleted, they will cause an error if they don't have a deleteURL. GET requests will not cause an error if they don't have a deleteURL.

Parameters:

theServiceResultsMap - a Map of ServiceResult objects, which will contain ServiceResult.deleteURL.

Returns:

a List including error result for which URLs could not be deleted.

runValidatorScriptSinglePayload

protected void runValidatorScriptSinglePayload(ServiceResult serviceResult,
                                               org.dynamide.restreplay.RestReplay.PartsStruct expectedResponseParts,
                                               Eval evalStruct)
                                        throws Exception

Throws:

Exception

validateResponse

protected String validateResponse(ServiceResult serviceResult,
                                  org.dynamide.restreplay.RestReplay.PartsStruct expectedResponseParts,
                                  Eval evalStruct)

validateResponseSinglePayload

protected String validateResponseSinglePayload(ServiceResult serviceResult,
                                               org.dynamide.restreplay.RestReplay.PartsStruct expectedResponseParts,
                                               Eval evalStruct)
                                        throws Exception

Throws:

Exception

runValidatorScript

protected EvalResult runValidatorScript(ServiceResult serviceResult,
                                        org.dynamide.restreplay.RestReplay.PartsStruct expectedResponseParts,
                                        Eval evalStruct)
                                 throws IOException

Throws:

IOException

dumpMasterNamespace

public String dumpMasterNamespace()

runRestReplayFile

public List<ServiceResult> runRestReplayFile(String testdir,
                                             String controlFileName,
                                             String testGroupID,
                                             String oneTestID,
                                             Map<String,Object> masterVarsOverride,
                                             boolean param_autoDeletePOSTS,
                                             String protoHostPortParam,
                                             AuthsMap authsFromMaster,
                                             List<String> reportsList,
                                             String reportsDir,
                                             String relativePathFromReportsDir,
                                             String masterFilenameInfo,
                                             String runID,
                                             Integer runHashCount,
                                             List<RestReplayReport.Header> testGroups)
                                      throws Exception

Throws:

Exception

calculateElipses

public String calculateElipses(String relpath)

saveServiceResultToJSON

public File saveServiceResultToJSON(ServiceResult serviceResult)
                             throws IOException

Throws:

IOException