Singleton for important helper facilities for the different tests. More...

Public Member Functions
	__new__ (self, args, *kargs)
	The new method.
	__init__ (self, args, *kargs)
	The default constructor.
	getInstance (self, args, *kargs)
	The default constructor.
	hasInstance (self)
	Check if an instance has been initialized.
	setPackageList (self, packageList)
	Set the list of available packages.
	getPackageList (self)
	Return the list of available packages.
	getGlobalContext (self)
	setTestCaseContext (self, ctx)
	Set the context of the test.
	setMacrosLogOnSuccess (self, macrosLogOnSuccess)
	getMacrosLogOnSuccess (self)
	getTestCaseContext (self)
	Get the context of the test.
	getHelperContext (self)
	getResultDirectory (self)
	setModuleName (self, moduleName)
	getModuleName (self)
	setTestCaseName (self, testCaseName)
	getTestCaseName (self)
	setTestCaseDataDirectory (self, testCaseDataPath)
	getTestCaseDataDirectory (self)
	setTestCaseResultDirectory (self, testCaseName, functionName)
	getTestCaseResultDirectory (self)
	pushChangeSet (self)
	Push a new ChangeSet to the stack.
	popChangeSet (self)
	Pop a ChangeSet from the stack and delete it.
	clearChangeSet (self)
	Clear the change set stack without restoring the field values.
	getChangeSet (self)
	Return the ChangeSet on top of the stack.
	getChangeSetStackLength (self)
	Get the length of the ChangeSet stack.
	runTestInCurrentMlabInstance (self)
	Set if tests are not run in secure mode.
	runTestInSecureMode (self)
	Set if tests are run in secure mode.
	testIsRunInSecureMode (self)
	Check if tests are run in secure mode.
	setLogHandler (self, logHandler)
	Set the current log handler.
	unsetLogHandler (self)
	Unset the current log handler.
	getLogHandler (self)
	Get the current log handler.
	pushCallerStackFrame (self, stackFrame)
	getCallerStackFrame (self)
	hasCallerStackFrame (self)
	popCallerStackFrame (self)
	addExtraTestCaseResult (self, extraTestCaseResult)
	takeExtraTestCaseResults (self)
	pushEnvironment (self)
	Pushes the current environment to the stack.
	popEnvironment (self)
	Pops an environment dictionary from the stack and makes it the current environment.

Protected Attributes
	_mChangeSet = TC_ChangeSet(ctx)

Static Protected Attributes
	_mCtx = None
	The global context.
	_mTestCaseContext = None
	The current test's context.
	_mHelperModule = None
	The context of the helper module.
	_mResultDirectory = None
	The directory used to save results.
	_mPackageList = None
	The list of packages that should be assumed to be available.
	_mTestCaseName = None
	The name of the current test case.
	_mModuleName = None
	The name of the currently tested module.
	_mTestCaseDataDirectory = None
	The path to the test case data.
	_mTestCaseResultDirectory = None
	The path to the results.
list	_mChangeSetStack = None
	A stack of ChangeSets used to revert changes to field values.
bool	_mSecureTesting = False
	Allow checking, whether tests are run in secure mode.
	_mLogHandler = None
	The log handler that can be used to handle the reports.
list	_mStackFrameStack = None
	The stack frame of the calling function that is used when logging events.
list	_mEnvironmentStack = None
	A stack of environment dictionaries used to revert changes to the environment.
list	_mExtraTestCaseResults = None
	A list of extra test case results.
bool	_mMacrosLogOnSuccess = True
	This is the default value for the 'logOnSuccess' parameter (if it is None) of the ASSERT_/EXPECT_ macros.

Detailed Description

Singleton for important helper facilities for the different tests.

Warning: Please note: This is internal stuff and should not be used in tests! The functionality is provided through the TestSupport package.

Definition at line 312 of file TestHelper.py.

Constructor & Destructor Documentation

◆ init()

TestSupport.TestHelper.TestHelper.__init__	(		self,
		*	args,
		**	kargs )

The default constructor.

Do nothing in here as construction must be done in the getInstance methode.

Definition at line 374 of file TestHelper.py.

Member Function Documentation

◆ new()

TestSupport.TestHelper.TestHelper.__new__	(		self,
		*	args,
		**	kargs )

The new method.

Definition at line 365 of file TestHelper.py.

References getInstance().

◆ addExtraTestCaseResult()

TestSupport.TestHelper.TestHelper.addExtraTestCaseResult	(		self,
			extraTestCaseResult )

Definition at line 652 of file TestHelper.py.

References _mExtraTestCaseResults.

◆ clearChangeSet()

TestSupport.TestHelper.TestHelper.clearChangeSet ( self )

Clear the change set stack without restoring the field values.

Definition at line 568 of file TestHelper.py.

References _mChangeSetStack, and popChangeSet().

◆ getCallerStackFrame()

TestSupport.TestHelper.TestHelper.getCallerStackFrame ( self )

Definition at line 642 of file TestHelper.py.

References _mStackFrameStack.

◆ getChangeSet()

TestSupport.TestHelper.TestHelper.getChangeSet ( self )

Return the ChangeSet on top of the stack.

Definition at line 578 of file TestHelper.py.

References _mChangeSetStack.

◆ getChangeSetStackLength()

TestSupport.TestHelper.TestHelper.getChangeSetStackLength ( self )

Get the length of the ChangeSet stack.

Returns: Length of the stack.

Definition at line 589 of file TestHelper.py.

References _mChangeSetStack.

◆ getGlobalContext()

TestSupport.TestHelper.TestHelper.getGlobalContext ( self )

Definition at line 445 of file TestHelper.py.

References _mCtx.

◆ getHelperContext()

TestSupport.TestHelper.TestHelper.getHelperContext ( self )

Definition at line 479 of file TestHelper.py.

References _mHelperModule.

◆ getInstance()

TestSupport.TestHelper.TestHelper.getInstance	(		self,
		*	args,
		**	kargs )

The default constructor.

Static method to have a reference to THE UNIQUE instance

Definition at line 382 of file TestHelper.py.

References __instance, __lockObj, _mChangeSetStack, _mCtx, _mEnvironmentStack, _mHelperModule, _mResultDirectory, and _mStackFrameStack.

Referenced by __new__().

◆ getLogHandler()

TestSupport.TestHelper.TestHelper.getLogHandler ( self )

Get the current log handler.

This returns None if no log handler is set!

Returns: The current log handler.

Definition at line 634 of file TestHelper.py.

References _mLogHandler.

◆ getMacrosLogOnSuccess()

TestSupport.TestHelper.TestHelper.getMacrosLogOnSuccess ( self )

Definition at line 466 of file TestHelper.py.

References _mMacrosLogOnSuccess.

◆ getModuleName()

TestSupport.TestHelper.TestHelper.getModuleName ( self )

Definition at line 497 of file TestHelper.py.

References _mModuleName.

◆ getPackageList()

TestSupport.TestHelper.TestHelper.getPackageList ( self )

Return the list of available packages.

Definition at line 439 of file TestHelper.py.

References _mPackageList.

◆ getResultDirectory()

TestSupport.TestHelper.TestHelper.getResultDirectory ( self )

Definition at line 485 of file TestHelper.py.

References _mResultDirectory.

Referenced by setTestCaseResultDirectory().

◆ getTestCaseContext()

TestSupport.TestHelper.TestHelper.getTestCaseContext ( self )

Get the context of the test.

Definition at line 473 of file TestHelper.py.

References _mTestCaseContext.

◆ getTestCaseDataDirectory()

TestSupport.TestHelper.TestHelper.getTestCaseDataDirectory ( self )

Definition at line 521 of file TestHelper.py.

References _mTestCaseDataDirectory.

◆ getTestCaseName()

TestSupport.TestHelper.TestHelper.getTestCaseName ( self )

Definition at line 509 of file TestHelper.py.

References _mTestCaseName.

◆ getTestCaseResultDirectory()

TestSupport.TestHelper.TestHelper.getTestCaseResultDirectory ( self )

Definition at line 535 of file TestHelper.py.

References _mTestCaseResultDirectory.

◆ hasCallerStackFrame()

TestSupport.TestHelper.TestHelper.hasCallerStackFrame ( self )

Definition at line 645 of file TestHelper.py.

References _mStackFrameStack.

◆ hasInstance()

TestSupport.TestHelper.TestHelper.hasInstance ( self )

Check if an instance has been initialized.

Definition at line 425 of file TestHelper.py.

References __instance.

◆ popCallerStackFrame()

TestSupport.TestHelper.TestHelper.popCallerStackFrame ( self )

Definition at line 648 of file TestHelper.py.

References _mStackFrameStack.

◆ popChangeSet()

TestSupport.TestHelper.TestHelper.popChangeSet ( self )

Pop a ChangeSet from the stack and delete it.

Deleting a ChangeSet will revert the changes.

Returns: True if deleting the ChangeSet succeeded.

Definition at line 555 of file TestHelper.py.

References _mChangeSetStack.

Referenced by clearChangeSet().

◆ popEnvironment()

TestSupport.TestHelper.TestHelper.popEnvironment ( self )

Pops an environment dictionary from the stack and makes it the current environment.

Returns: True if an environment dictionary was removed from the stack.

Definition at line 676 of file TestHelper.py.

References _mEnvironmentStack.

◆ pushCallerStackFrame()

TestSupport.TestHelper.TestHelper.pushCallerStackFrame	(		self,
			stackFrame )

Definition at line 639 of file TestHelper.py.

References _mStackFrameStack.

◆ pushChangeSet()

TestSupport.TestHelper.TestHelper.pushChangeSet ( self )

Push a new ChangeSet to the stack.

Returns: The length of the ChangeSet stack.

Definition at line 545 of file TestHelper.py.

References _mChangeSetStack, and _mTestCaseContext.

◆ pushEnvironment()

TestSupport.TestHelper.TestHelper.pushEnvironment ( self )

Pushes the current environment to the stack.

Definition at line 667 of file TestHelper.py.

References _mEnvironmentStack.

◆ runTestInCurrentMlabInstance()

TestSupport.TestHelper.TestHelper.runTestInCurrentMlabInstance ( self )

Set if tests are not run in secure mode.

Definition at line 596 of file TestHelper.py.

References _mSecureTesting.

◆ runTestInSecureMode()

TestSupport.TestHelper.TestHelper.runTestInSecureMode ( self )

Set if tests are run in secure mode.

Definition at line 603 of file TestHelper.py.

References _mSecureTesting.

◆ setLogHandler()

TestSupport.TestHelper.TestHelper.setLogHandler	(		self,
			logHandler )

Set the current log handler.

@params logHandler The current log handler.

Definition at line 618 of file TestHelper.py.

References _mLogHandler.

◆ setMacrosLogOnSuccess()

TestSupport.TestHelper.TestHelper.setMacrosLogOnSuccess	(		self,
			macrosLogOnSuccess )

Definition at line 460 of file TestHelper.py.

References _mMacrosLogOnSuccess.

◆ setModuleName()

TestSupport.TestHelper.TestHelper.setModuleName	(		self,
			moduleName )

Definition at line 491 of file TestHelper.py.

References _mModuleName.

◆ setPackageList()

TestSupport.TestHelper.TestHelper.setPackageList	(		self,
			packageList )

Set the list of available packages.

Definition at line 432 of file TestHelper.py.

References _mPackageList.

◆ setTestCaseContext()

TestSupport.TestHelper.TestHelper.setTestCaseContext	(		self,
			ctx )

Set the context of the test.

Definition at line 452 of file TestHelper.py.

References _mTestCaseContext.

◆ setTestCaseDataDirectory()

TestSupport.TestHelper.TestHelper.setTestCaseDataDirectory	(		self,
			testCaseDataPath )

Definition at line 515 of file TestHelper.py.

References _mTestCaseDataDirectory.

◆ setTestCaseName()

TestSupport.TestHelper.TestHelper.setTestCaseName	(		self,
			testCaseName )

Definition at line 503 of file TestHelper.py.

References _mTestCaseName.

◆ setTestCaseResultDirectory()

TestSupport.TestHelper.TestHelper.setTestCaseResultDirectory	(	self,
		testCaseName,
		functionName )

Definition at line 527 of file TestHelper.py.

References _mTestCaseResultDirectory, and getResultDirectory().

◆ takeExtraTestCaseResults()

TestSupport.TestHelper.TestHelper.takeExtraTestCaseResults ( self )

Definition at line 658 of file TestHelper.py.

References _mExtraTestCaseResults.

◆ testIsRunInSecureMode()

TestSupport.TestHelper.TestHelper.testIsRunInSecureMode ( self )

Check if tests are run in secure mode.

Definition at line 610 of file TestHelper.py.

References _mSecureTesting.

◆ unsetLogHandler()

TestSupport.TestHelper.TestHelper.unsetLogHandler ( self )

Unset the current log handler.

Definition at line 625 of file TestHelper.py.

References _mLogHandler.

Member Data Documentation

◆ _mChangeSet

TestSupport.TestHelper.TestHelper._mChangeSet = TC_ChangeSet(ctx)

protected

Definition at line 454 of file TestHelper.py.

◆ _mChangeSetStack

TestSupport.TestHelper.TestHelper._mChangeSetStack = None

staticprotected

A stack of ChangeSets used to revert changes to field values.

Definition at line 336 of file TestHelper.py.

Referenced by clearChangeSet(), getChangeSet(), getChangeSetStackLength(), getInstance(), popChangeSet(), and pushChangeSet().

◆ _mCtx

TestSupport.TestHelper.TestHelper._mCtx = None

staticprotected

The global context.

Definition at line 315 of file TestHelper.py.

Referenced by getGlobalContext(), and getInstance().

◆ _mEnvironmentStack

TestSupport.TestHelper.TestHelper._mEnvironmentStack = None

staticprotected

A stack of environment dictionaries used to revert changes to the environment.

Definition at line 349 of file TestHelper.py.

Referenced by getInstance(), popEnvironment(), and pushEnvironment().

◆ _mExtraTestCaseResults

list TestSupport.TestHelper.TestHelper._mExtraTestCaseResults = None

staticprotected

A list of extra test case results.

Definition at line 352 of file TestHelper.py.

Referenced by addExtraTestCaseResult(), and takeExtraTestCaseResults().

◆ _mHelperModule

TestSupport.TestHelper.TestHelper._mHelperModule = None

staticprotected

The context of the helper module.

Definition at line 319 of file TestHelper.py.

Referenced by getHelperContext(), and getInstance().

◆ _mLogHandler

TestSupport.TestHelper.TestHelper._mLogHandler = None

staticprotected

The log handler that can be used to handle the reports.

Definition at line 342 of file TestHelper.py.

Referenced by getLogHandler(), setLogHandler(), and unsetLogHandler().

◆ _mMacrosLogOnSuccess

bool TestSupport.TestHelper.TestHelper._mMacrosLogOnSuccess = True

staticprotected

This is the default value for the 'logOnSuccess' parameter (if it is None) of the ASSERT_*/EXPECT_* macros.

Definition at line 355 of file TestHelper.py.

Referenced by getMacrosLogOnSuccess(), and setMacrosLogOnSuccess().

◆ _mModuleName

TestSupport.TestHelper.TestHelper._mModuleName = None

staticprotected

The name of the currently tested module.

Definition at line 328 of file TestHelper.py.

Referenced by getModuleName(), and setModuleName().

◆ _mPackageList

TestSupport.TestHelper.TestHelper._mPackageList = None

staticprotected

The list of packages that should be assumed to be available.

Definition at line 323 of file TestHelper.py.

Referenced by getPackageList(), and setPackageList().

◆ _mResultDirectory

TestSupport.TestHelper.TestHelper._mResultDirectory = None

staticprotected

The directory used to save results.

Definition at line 321 of file TestHelper.py.

Referenced by getInstance(), and getResultDirectory().

◆ _mSecureTesting

bool TestSupport.TestHelper.TestHelper._mSecureTesting = False

staticprotected

Allow checking, whether tests are run in secure mode.

Definition at line 339 of file TestHelper.py.

Referenced by runTestInCurrentMlabInstance(), runTestInSecureMode(), and testIsRunInSecureMode().

◆ _mStackFrameStack

TestSupport.TestHelper.TestHelper._mStackFrameStack = None

staticprotected

The stack frame of the calling function that is used when logging events.

Since this can get recursive in special situations, we need to store this as a stack.

Definition at line 346 of file TestHelper.py.

Referenced by getCallerStackFrame(), getInstance(), hasCallerStackFrame(), popCallerStackFrame(), and pushCallerStackFrame().

◆ _mTestCaseContext

TestSupport.TestHelper.TestHelper._mTestCaseContext = None

staticprotected

The current test's context.

Definition at line 317 of file TestHelper.py.

Referenced by getTestCaseContext(), pushChangeSet(), and setTestCaseContext().

◆ _mTestCaseDataDirectory

TestSupport.TestHelper.TestHelper._mTestCaseDataDirectory = None

staticprotected

The path to the test case data.

Definition at line 331 of file TestHelper.py.

Referenced by getTestCaseDataDirectory(), and setTestCaseDataDirectory().

◆ _mTestCaseName

TestSupport.TestHelper.TestHelper._mTestCaseName = None

staticprotected

The name of the current test case.

Definition at line 326 of file TestHelper.py.

Referenced by getTestCaseName(), and setTestCaseName().

◆ _mTestCaseResultDirectory

TestSupport.TestHelper.TestHelper._mTestCaseResultDirectory = None

staticprotected

The path to the results.

Definition at line 333 of file TestHelper.py.

Referenced by getTestCaseResultDirectory(), and setTestCaseResultDirectory().

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

MeVisLab/Standard/Modules/Scripts/python/TestSupport/TestHelper.py

Public Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __new__()

◆ addExtraTestCaseResult()

◆ clearChangeSet()

◆ getCallerStackFrame()

◆ getChangeSet()

◆ getChangeSetStackLength()

◆ getGlobalContext()

◆ getHelperContext()

◆ getInstance()

◆ getLogHandler()

◆ getMacrosLogOnSuccess()

◆ getModuleName()

◆ getPackageList()

◆ getResultDirectory()

◆ getTestCaseContext()

◆ getTestCaseDataDirectory()

◆ getTestCaseName()

◆ getTestCaseResultDirectory()

◆ hasCallerStackFrame()

◆ hasInstance()

◆ popCallerStackFrame()

◆ popChangeSet()

◆ popEnvironment()

◆ pushCallerStackFrame()

◆ pushChangeSet()

◆ pushEnvironment()

◆ runTestInCurrentMlabInstance()

◆ runTestInSecureMode()

◆ setLogHandler()

◆ setMacrosLogOnSuccess()

◆ setModuleName()

◆ setPackageList()

◆ setTestCaseContext()

◆ setTestCaseDataDirectory()

◆ setTestCaseName()

◆ setTestCaseResultDirectory()

◆ takeExtraTestCaseResults()

◆ testIsRunInSecureMode()

◆ unsetLogHandler()

Member Data Documentation

◆ _mChangeSet

◆ _mChangeSetStack

◆ _mCtx

◆ _mEnvironmentStack

◆ _mExtraTestCaseResults

◆ _mHelperModule

◆ _mLogHandler

◆ _mMacrosLogOnSuccess

◆ _mModuleName

◆ _mPackageList

◆ _mResultDirectory

◆ _mSecureTesting

◆ _mStackFrameStack

◆ _mTestCaseContext

◆ _mTestCaseDataDirectory

◆ _mTestCaseName

◆ _mTestCaseResultDirectory

◆ init()

◆ new()