TestCenter Reference
TestSupport.TestHelper Namespace Reference

Classes

class  CancelTestException
 
class  ExpectInfos
 
class  SetLoggingCallerStackFrame
 
class  SuppressedErrors
 
class  SuppressedWarnings
 
class  TC_ChangeSet
 
class  TestHelper
 Singleton for important helper facilities for the different tests. More...
 

Functions

def takeCurrentSpecialMessage ()
 
def emitSpecialMessage (loggingMethod, file, line, type, message, escapeHtml=True, formattedStack='')
 
def emitSpecialCommand (file, line, type, fileList, message, escapeHtml=True)
 
def UseStackFrameFromCallerForLogging (func)
 
def regexpToString (exp)
 

Variables

string gCurrentSpecialMessage = ""
 
string gSpecialMessageMarker = "<MLAB TC=1/>"
 
bool gEnablePrettyLogging = False
 
bool gLogInfoMessages = True
 
def IncreaseLoggingStackDepthDecorator = UseStackFrameFromCallerForLogging
 

Function Documentation

◆ emitSpecialCommand()

def TestSupport.TestHelper.emitSpecialCommand (   file,
  line,
  type,
  fileList,
  message,
  escapeHtml = True 
)

Definition at line 63 of file TestHelper.py.

Referenced by TestSupport.Logging.errorHTML().

◆ emitSpecialMessage()

def TestSupport.TestHelper.emitSpecialMessage (   loggingMethod,
  file,
  line,
  type,
  message,
  escapeHtml = True,
  formattedStack = '' 
)

◆ regexpToString()

◆ takeCurrentSpecialMessage()

def TestSupport.TestHelper.takeCurrentSpecialMessage ( )

Definition at line 34 of file TestHelper.py.

◆ UseStackFrameFromCallerForLogging()

def TestSupport.TestHelper.UseStackFrameFromCallerForLogging (   func)
This decorator is used to specify the stack frame that is used to detect the location while logging. 
It uses the stack frame that calls the given function. Functions with this decorator can call each other
recursively. The first stack frame of such a recursion is then used. 

Definition at line 85 of file TestHelper.py.

Variable Documentation

◆ gCurrentSpecialMessage

string TestSupport.TestHelper.gCurrentSpecialMessage = ""

Definition at line 29 of file TestHelper.py.

◆ gEnablePrettyLogging

bool TestSupport.TestHelper.gEnablePrettyLogging = False

Definition at line 31 of file TestHelper.py.

◆ gLogInfoMessages

bool TestSupport.TestHelper.gLogInfoMessages = True

Definition at line 32 of file TestHelper.py.

◆ gSpecialMessageMarker

string TestSupport.TestHelper.gSpecialMessageMarker = "<MLAB TC=1/>"

Definition at line 30 of file TestHelper.py.

◆ IncreaseLoggingStackDepthDecorator

def TestSupport.TestHelper.IncreaseLoggingStackDepthDecorator = UseStackFrameFromCallerForLogging

Definition at line 95 of file TestHelper.py.