org.dynamide.restreplay

Class Master

java.lang.Object

org.dynamide.restreplay.ConfigFile

org.dynamide.restreplay.Master

public class Master
extends ConfigFile

This class represents the master-control file, which simply sets up an environment, and calls multiple control files.

Author:

Laramie Crocker

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Master.Event
class	Master.ScriptEventResult

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_MASTER_CONTROL
long	endTime
String	masterEnvsFileLocation
String	masterVarsFileLocation
long	startTime
Map<String,Object>	vars

Fields inherited from class org.dynamide.restreplay.ConfigFile

reportsDir

Constructor Summary

Constructors

Constructor and Description
Master(String testdir, String reportsDir, ResourceManager manager)

Method Summary

Modifier and Type	Method and Description
Master.ScriptEventResult	fireEvent(String eventID)
Map<String,ServiceResult>	getMasterNamespace()
Map<String,Object>	getVars()
boolean	masterConfigFileExists(String masterFilename) Optional information method: call this method after instantiating this class using the constructor RestReplay(String), which sets the testdir.
org.dom4j.Document	openMasterConfigFile(String reason, String masterFilename)
org.dom4j.Document	readOptionsFromMasterConfigFile(String masterFilename) specify the master config file, relative to getTestDir(), but ignore any tests or testGroups in the master.
List<List<ServiceResult>>	runMaster(String masterFilename)
List<List<ServiceResult>>	runMaster(String masterFilename, boolean readOptionsFromMaster) Creates new instances of RestReplay, one for each controlFile specified in the master, and setting defaults from this instance, but not sharing ServiceResult objects or maps.
List<List<ServiceResult>>	runMaster(String masterFilename, boolean readOptionsFromMaster, String controlFile, String testGroup, String test)
void	setVars(Map<String,Object> masterVars)

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, toString, wait, wait, wait

Field Detail

DEFAULT_MASTER_CONTROL

public static final String DEFAULT_MASTER_CONTROL

See Also:

Constant Field Values

startTime

public long startTime

endTime

public long endTime

masterEnvsFileLocation

public String masterEnvsFileLocation

masterVarsFileLocation

public String masterVarsFileLocation

vars

public Map<String,Object> vars

Constructor Detail

Master

public Master(String testdir,
              String reportsDir,
              ResourceManager manager)

Method Detail

getMasterNamespace

public Map<String,ServiceResult> getMasterNamespace()

getVars

public Map<String,Object> getVars()

setVars

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

masterConfigFileExists

public boolean masterConfigFileExists(String masterFilename)

Optional information method: call this method after instantiating this class using the constructor RestReplay(String), which sets the testdir. Then you pass in your relative masterFilename to that testdir to this method, which will return true if the file is readable, valid xml, etc. Do this in preference to just seeing if File.exists(), because there are rules to finding the file relative to the maven test dir, yada, yada. This method makes it easy to have a development test file that you don't check in, so that dev tests can be missing gracefully, etc.

openMasterConfigFile

public org.dom4j.Document openMasterConfigFile(String reason,
                                               String masterFilename)
                                        throws FileNotFoundException

Throws:

FileNotFoundException

readOptionsFromMasterConfigFile

public org.dom4j.Document readOptionsFromMasterConfigFile(String masterFilename)
                                                   throws FileNotFoundException

specify the master config file, relative to getTestDir(), but ignore any tests or testGroups in the master. Depends on this.getEnvID() being set before this method is called, otherwise uses default envID found in master.

Returns:

a Document object, which you don't need to use: all options will be stored in this RestReplay instance.

Throws:

FileNotFoundException

fireEvent

public Master.ScriptEventResult fireEvent(String eventID)

runMaster

public List<List<ServiceResult>> runMaster(String masterFilename)
                                    throws Exception

Throws:

Exception

runMaster

public List<List<ServiceResult>> runMaster(String masterFilename,
                                           boolean readOptionsFromMaster)
                                    throws Exception

Creates new instances of RestReplay, one for each controlFile specified in the master, and setting defaults from this instance, but not sharing ServiceResult objects or maps.

Throws:

Exception

runMaster

public List<List<ServiceResult>> runMaster(String masterFilename,
                                           boolean readOptionsFromMaster,
                                           String controlFile,
                                           String testGroup,
                                           String test)
                                    throws Exception

Throws:

Exception