seSuiteBase Class Reference

Script engine base class for suites. More...

Inheritance diagram for seSuiteBase:

[legend]Collaboration diagram for seSuiteBase:

[legend]List of all members.

Public Member Functions
def	__init__
	seSuiteBase constructor
def	getRunSequence
	Return the order of transitions for this type of application.
def	doAbort
	Request stop of execution.
def	doPause
	Request pause of execution.
def	doResume
	Request resume of execution.
def	error
	This method is called when an undefined transition is requested.
def	seSetup
	SETUP transition method.
def	seRun
	RUN transition method.
def	sePause
	PAUSE transition method.
def	seResume
	RESUME transition method.
def	seStopRun
	STOP_RUN transition method.
def	seAbort
	ABORT transition method.
def	__updateGUI
	Update the state of the run on the GUI.
def	setup
	Transition method to be overridden by the suite.
def	stopRun
	Transition method to be overridden by the suite.
def	pause
	Transition method to be overridden by the suite.
def	resume
	Transition method to be overridden by the suite.
def	abort
	Transition method to be overridden by the suite.
def	scriptLoad
	Load and instantiate an seAppBase or seSuiteBase based script.
def	scriptRun
	Start the run of the specified script.
def	getName
	Retrieve the class name of the script.
def	getScript
	Retrieve the script object.
def	getType
	Return the type of test based on this class.
def	isStopRequested
	Is stop requested?
def	setStopRequested
	Set the stop requested flag.
def	isPauseRequested
	Is pause requested?
def	isPaused
	Retrieve the paused status of the script.
def	setPaused
	Mark the script and its parent suites as paused or unpaused.
def	setParentSuite
	Set the parent suite instance.
def	getParentSuite
	Retrieve the parent suite instance.
def	getParentSuiteName
	Retrieve the parent suite name.
def	isRunFromSuite
	Check if the script is being run from a suite.
def	getScriptSequence
	Retrieve the sequence number for the running suite script.
def	getSuiteID
	Retrieve the suite identifier.
def	setSuiteID
	Set the suite identifier.
def	setSessionVar
	Set a session variable.
def	getSessionVar
	Retrieve the values of the session variable indicated by key.
Static Private Attributes
list	__suiteStack = []

---

Detailed Description

Script engine base class for suites.

Definition at line 28 of file seSuiteBase.py.

---

Member Function Documentation

def __init__ (    self,   common )

seSuiteBase constructor Parameters: common  ScriptEngineCommon instance Reimplemented in testSuite, testSuite2, and testSuiteLoop. Definition at line 34 of file seSuiteBase.py.

def __updateGUI (    self  )

Update the state of the run on the GUI. Definition at line 203 of file seSuiteBase.py.

def abort (    self  )

Transition method to be overridden by the suite. Reimplemented in testSuite, testSuite2, and testSuiteLoop. Definition at line 234 of file seSuiteBase.py.

def doAbort (    self  )

Request stop of execution. Returns: Result of the transition Definition at line 70 of file seSuiteBase.py.

def doPause (    self  )

Request pause of execution. Returns: Result of the transition Definition at line 81 of file seSuiteBase.py.

def doResume (    self  )

Request resume of execution. Returns: Result of the transition Definition at line 89 of file seSuiteBase.py.

def error (    self  )

This method is called when an undefined transition is requested. Definition at line 97 of file seSuiteBase.py.

def getName (    self  )

Retrieve the class name of the script. Returns: Name of the script class Definition at line 280 of file seSuiteBase.py.

def getParentSuite (    self  )

Retrieve the parent suite instance. Returns: Suite instance Definition at line 346 of file seSuiteBase.py.

def getParentSuiteName (    self  )

Retrieve the parent suite name. Returns: Parent suite name. Definition at line 353 of file seSuiteBase.py.

def getRunSequence (    self  )

Return the order of transitions for this type of application. Returns: A list of transitions Definition at line 63 of file seSuiteBase.py.

def getScript (    self  )

Retrieve the script object. Returns: Script object instance. Definition at line 287 of file seSuiteBase.py.

def getScriptSequence (    self  )

Retrieve the sequence number for the running suite script. The script sequence is incremented for each scriptRun called in the suite. This method is provided so that the suite author and the script engine can keep track of which script is the first script being run (which will have a script sequence of 1). Returns: Suite script sequence Definition at line 369 of file seSuiteBase.py.

def getSessionVar (    self,   key )

Retrieve the values of the session variable indicated by key. Returns: Session variable value Definition at line 412 of file seSuiteBase.py.

def getSuiteID (    self  )

Retrieve the suite identifier. As an aid to linking runs in suites together, a LICOS activity has the concept of a suite identifier. This number is identically the runID of the first run of a suite (which is implemented in seSuiteBase.py). Returns: Suite identifier (integer string) Definition at line 381 of file seSuiteBase.py.

def getType (    self  )

Return the type of test based on this class. Used for logging purposes. Returns: Test type Definition at line 294 of file seSuiteBase.py.

def isPaused (    self  )

Retrieve the paused status of the script. Parameters: paused  Boolean indicating whether the script is paused or not Definition at line 323 of file seSuiteBase.py.

def isPauseRequested (    self  )

Is pause requested? Returns: Boolean flag indicating whether a pause was requested Definition at line 316 of file seSuiteBase.py.

def isRunFromSuite (    self  )

Check if the script is being run from a suite. Returns: True If the script is being run from a suite, False otherwise. Definition at line 361 of file seSuiteBase.py.

def isStopRequested (    self  )

Is stop requested? Returns: Boolean flag indicating whether a stop was requested Definition at line 303 of file seSuiteBase.py.

def pause (    self  )

Transition method to be overridden by the suite. Reimplemented in testSuite, testSuite2, and testSuiteLoop. Definition at line 222 of file seSuiteBase.py.

def resume (    self  )

Transition method to be overridden by the suite. Reimplemented in testSuite, testSuite2, and testSuiteLoop. Definition at line 228 of file seSuiteBase.py.

def scriptLoad (    self,   script,   args,   kwargs )

Load and instantiate an seAppBase or seSuiteBase based script. Parameters: script  Script module name or Python source path args  Positional arguments passed to the script kwargs  Keyword arguments passed to the script Returns: Instantiated script object Definition at line 240 of file seSuiteBase.py.

def scriptRun (    self,   script = None )

Start the run of the specified script. Parameters: script  Instantiated script object. If None, the last instantiated script is used. Definition at line 256 of file seSuiteBase.py.

def seAbort (    self  )

ABORT transition method. Calls self.abort() Returns: None for success or False if there is an exception or status returned by the suite. Definition at line 189 of file seSuiteBase.py.

def sePause (    self  )

PAUSE transition method. Calls self.pause() Returns: None for success or False if there is an exception or status returned by the suite. Definition at line 140 of file seSuiteBase.py.

def seResume (    self  )

RESUME transition method. Calls self.resume() Returns: None for success or False if there is an exception or status returned by the suite. Definition at line 157 of file seSuiteBase.py.

def seRun (    self  )

RUN transition method. Calls self.run() Returns: None for success or False if there is an exception or status returned by the suite. Definition at line 126 of file seSuiteBase.py.

def seSetup (    self  )

SETUP transition method. Calls self.setup() Returns: None for success or False if there is an exception or status returned by the suite. Definition at line 104 of file seSuiteBase.py.

def seStopRun (    self  )

STOP_RUN transition method. Calls self.stopRun() Returns: None for success or False if there is an exception or status returned by the suite. Definition at line 172 of file seSuiteBase.py.

def setParentSuite (    self,   suite )

Set the parent suite instance. Parameters: Suite  instance Definition at line 339 of file seSuiteBase.py.

def setPaused (    self,   paused )

Mark the script and its parent suites as paused or unpaused. Parameters: paused  Boolean indicating whether the script is paused or not Definition at line 330 of file seSuiteBase.py.

def setSessionVar (    self,   key,   value )

Set a session variable. Do not use variable names beginning with the underscore ('_') character since these are reserved for ScriptEngine Definition at line 400 of file seSuiteBase.py.

def setStopRequested (    self  )

Set the stop requested flag. Definition at line 310 of file seSuiteBase.py.

def setSuiteID (    self,   suiteID )

Set the suite identifier. Parameters: suiteID  Suite identifier (integer or numeric string) Definition at line 393 of file seSuiteBase.py.

def setup (    self  )

Transition method to be overridden by the suite. Reimplemented in testSuite, testSuite2, and testSuiteLoop. Definition at line 210 of file seSuiteBase.py.

def stopRun (    self  )

Transition method to be overridden by the suite. Reimplemented in testSuite, testSuite2, and testSuiteLoop. Definition at line 216 of file seSuiteBase.py.

---

Member Data Documentation

list __suiteStack = [] [static, private]

Definition at line 32 of file seSuiteBase.py.

---

The documentation for this class was generated from the following file:

• seSuiteBase.py

---