TestCenter Reference
TestCenterAdvanced.Config.Configuration Class Reference

Public Member Functions

 __init__ (self, filePath=None, autoSave=True, isTestCaseManager=False)
 
 fetchMLABSettings (self, xmlRoot)
 
 fetchReportSettings (self, xmlRoot)
 
 fetchReportNodeSettings (self, xmlRoot)
 
 fetchTestCaseManagerSettings (self, xmlRoot)
 
 storeTestCaseManagerSettings (self, xmlRoot)
 
 fetchCoverageSettings (self, xmlRoot)
 
 fetchBullseyeCoverageSettings (self, coverageNode)
 
 fetchUseBullseyeCoverage (self, bullseyeNode)
 
 fetchPythonCoverageSettings (self, coverageNode)
 
 fetchUsePythonCoverage (self, pythonCoverageNode)
 
 fetchUseGlobalPythonCoverage (self, pythonCoverageNode)
 
 fetchPythonCoverageExclusionExpressions (self, coverageNode)
 
 fetchPythonCoverageInclusionExpressions (self, coverageNode)
 
 fetchIPCSettings (self, xmlRoot)
 
 save (self, filename=None)
 Save the configuration variables set to the file with the given name.
 
 getSlaveLogFilePath (self)
 
 setResultDir (self, directory)
 
 getResultDir (self)
 
 getResultFile (self)
 
 getMLABCurrentBinariesPath (self)
 
 getMLABBinariesPath (self)
 
 getMLABUseCurrent (self)
 
 getMLABEffectiveBinariesPath (self)
 
 getMLABExecutableCommand (self)
 
 getMLABArguments (self)
 
 getMLABCompileMode (self)
 
 useMLABDebugVersion (self)
 
 setMLABUseDebug (self, useDebug)
 
 shouldReloadPythonModulesWhenReloadingTestCases (self)
 
 setTestCaseManagerOptions (self, shouldReloadPythonModulesWhenReloadingTestCases)
 
 getMLABTestCenterCommand (self, macroName)
 
 setMLABExecutablePath (self, executablePath)
 
 setMLABUseCurrent (self, usecurrent)
 
 setMLABArguments (self, arguments)
 
 setMLABCompileMode (self, value)
 
 getDefaultTestTimeoutSeconds (self)
 
 getConfigFilePath (self)
 
 getReportOptions (self)
 
 setReportOptions (self, directory, name, timestampTemplate, appendTestCaseName, appendTimestamp, collapseFunctions, showFailedFunctionsOnly, hideInfoMessages, hideSystemMessages)
 
 getReportDirectory (self)
 
 getReportName (self)
 
 getReportTimestampTemplate (self)
 
 appendTestCaseNameToReportName (self)
 
 appendTimestampToReportName (self)
 
 collapseFunctions (self)
 
 showFailedFunctionsOnly (self)
 
 hideInfoMessages (self)
 
 hideSystemMessages (self)
 
 getCoverageExclusions (self)
 
 getCoverageInclusions (self)
 
 isPythonCoverageEnabled (self)
 
 isGlobalPythonCoverageEnabled (self)
 
 setPythonCoverageEnabled (self, value)
 
 setGlobalPythonCoverageEnabled (self, value)
 
 isBullseyeCoverageEnabled (self)
 
 setBullseyeCoverageEnabled (self, value)
 
 getRestartInterval (self)
 
 getMaxTestTimeoutSeconds (self)
 
 getIPCConnectionTimeout (self)
 

Static Public Member Functions

 nodeHasValidText (node)
 
 getBoolean (node, default, attributeName)
 
 getInteger (node, default, attributeName)
 
 findMLABExecutable (basePath, executableName, subPath)
 

Detailed Description

Definition at line 100 of file Config.py.

Constructor & Destructor Documentation

◆ __init__()

TestCenterAdvanced.Config.Configuration.__init__ ( self,
filePath = None,
autoSave = True,
isTestCaseManager = False )
 Loads configuration from given file or creates configuration with default values.
    If a configuration is created and @a autoSave is True then the configuration is
    automatically saved. Otherwise, you have to save is explicitly.

Definition at line 101 of file Config.py.

References TestCenterAdvanced.Config.Configuration.__configFilePath, TestCenterAdvanced.Config.Configuration.__defaultTestTimeoutSeconds, TestCenterAdvanced.Config.Configuration.__ipcConnectionTimeout, TestCenterAdvanced.Config.Configuration.__load(), TestSupport.FieldValueTests.FieldValueTestCase.__load(), TestCenterAdvanced.Config.Configuration.__maxTestTimeoutSeconds, TestCenterAdvanced.Config.Configuration.__MLABArguments, TestCenterAdvanced.Config.Configuration.__MLABCompileMode, TestCenterAdvanced.Config.Configuration.__MLABCurrentExecutablePath, TestCenterAdvanced.Config.Configuration.__MLABExecutablePath, TestCenterAdvanced.Config.Configuration.__MLABSlaveLogFileName, TestCenterAdvanced.Config.Configuration.__MLABUseCurrent, TestCenterAdvanced.Config.Configuration.__mMLABRestartInterval, TestCenterAdvanced.Config.Configuration.__pythonCoverageExclusionExpressions, TestCenterAdvanced.Config.Configuration.__pythonCoverageInclusionExpressions, TestCenterAdvanced.Config.Configuration.__report, TestCenterAdvanced.Config.Configuration.__resultOutputDirectory, TestCenterAdvanced.Config.Configuration.__setDefaultValues(), TestCenterAdvanced.Config.Configuration.__shouldReloadPythonModulesWhenReloadingTestCases, TestCenterAdvanced.Config.Configuration.__useBullseyeCoverage, TestCenterAdvanced.Config.Configuration.__useGlobalPythonCoverage, TestCenterAdvanced.Config.Configuration.__usePythonCoverage, TestCenterAdvanced.Config.Configuration.__xmlResultFileName, TestCenterAdvanced.Config.Configuration.fetchCoverageSettings(), TestCenterAdvanced.Config.Configuration.fetchIPCSettings(), TestCenterAdvanced.Config.Configuration.fetchMLABSettings(), TestCenterAdvanced.Config.Configuration.fetchReportSettings(), TestCenterAdvanced.Config.Configuration.fetchTestCaseManagerSettings(), TestCenterAdvanced.Config.Configuration.getConfigFilePath(), TestCenterAdvanced.Config.Configuration.getMLABBinariesPath(), TestSupport.FieldValueTests.FieldValueTestCase.FieldListBase.save(), TestSupport.FieldValueTests.FieldValueTestCaseSet.save(), TestCenterAdvanced.Config.Configuration.save(), and TestSupport.FieldValueTests.FieldValueTestCase.save().

Member Function Documentation

◆ appendTestCaseNameToReportName()

TestCenterAdvanced.Config.Configuration.appendTestCaseNameToReportName ( self)

Definition at line 656 of file Config.py.

References TestCenterAdvanced.Config.Configuration.__report.

◆ appendTimestampToReportName()

TestCenterAdvanced.Config.Configuration.appendTimestampToReportName ( self)

Definition at line 660 of file Config.py.

References TestCenterAdvanced.Config.Configuration.__report.

◆ collapseFunctions()

TestCenterAdvanced.Config.Configuration.collapseFunctions ( self)

Definition at line 664 of file Config.py.

References TestCenterAdvanced.Config.Configuration.__report.

◆ fetchBullseyeCoverageSettings()

TestCenterAdvanced.Config.Configuration.fetchBullseyeCoverageSettings ( self,
coverageNode )

◆ fetchCoverageSettings()

TestCenterAdvanced.Config.Configuration.fetchCoverageSettings ( self,
xmlRoot )

◆ fetchIPCSettings()

TestCenterAdvanced.Config.Configuration.fetchIPCSettings ( self,
xmlRoot )

◆ fetchMLABSettings()

◆ fetchPythonCoverageExclusionExpressions()

TestCenterAdvanced.Config.Configuration.fetchPythonCoverageExclusionExpressions ( self,
coverageNode )

◆ fetchPythonCoverageInclusionExpressions()

TestCenterAdvanced.Config.Configuration.fetchPythonCoverageInclusionExpressions ( self,
coverageNode )

◆ fetchPythonCoverageSettings()

◆ fetchReportNodeSettings()

TestCenterAdvanced.Config.Configuration.fetchReportNodeSettings ( self,
xmlRoot )

◆ fetchReportSettings()

◆ fetchTestCaseManagerSettings()

TestCenterAdvanced.Config.Configuration.fetchTestCaseManagerSettings ( self,
xmlRoot )

◆ fetchUseBullseyeCoverage()

TestCenterAdvanced.Config.Configuration.fetchUseBullseyeCoverage ( self,
bullseyeNode )

◆ fetchUseGlobalPythonCoverage()

TestCenterAdvanced.Config.Configuration.fetchUseGlobalPythonCoverage ( self,
pythonCoverageNode )

◆ fetchUsePythonCoverage()

TestCenterAdvanced.Config.Configuration.fetchUsePythonCoverage ( self,
pythonCoverageNode )

◆ findMLABExecutable()

TestCenterAdvanced.Config.Configuration.findMLABExecutable ( basePath,
executableName,
subPath )
static
Searches for the executable in the basePath and all levels of the provided
subPath in a 'deepest first' manner

Definition at line 526 of file Config.py.

Referenced by TestCenterAdvanced.Config.Configuration.getMLABExecutableCommand().

◆ getBoolean()

◆ getConfigFilePath()

TestCenterAdvanced.Config.Configuration.getConfigFilePath ( self)

◆ getCoverageExclusions()

TestCenterAdvanced.Config.Configuration.getCoverageExclusions ( self)

◆ getCoverageInclusions()

TestCenterAdvanced.Config.Configuration.getCoverageInclusions ( self)

◆ getDefaultTestTimeoutSeconds()

TestCenterAdvanced.Config.Configuration.getDefaultTestTimeoutSeconds ( self)

◆ getInteger()

TestCenterAdvanced.Config.Configuration.getInteger ( node,
default,
attributeName )
static

◆ getIPCConnectionTimeout()

TestCenterAdvanced.Config.Configuration.getIPCConnectionTimeout ( self)

◆ getMaxTestTimeoutSeconds()

TestCenterAdvanced.Config.Configuration.getMaxTestTimeoutSeconds ( self)

◆ getMLABArguments()

TestCenterAdvanced.Config.Configuration.getMLABArguments ( self)

◆ getMLABBinariesPath()

TestCenterAdvanced.Config.Configuration.getMLABBinariesPath ( self)

◆ getMLABCompileMode()

TestCenterAdvanced.Config.Configuration.getMLABCompileMode ( self)

◆ getMLABCurrentBinariesPath()

TestCenterAdvanced.Config.Configuration.getMLABCurrentBinariesPath ( self)

◆ getMLABEffectiveBinariesPath()

◆ getMLABExecutableCommand()

◆ getMLABTestCenterCommand()

TestCenterAdvanced.Config.Configuration.getMLABTestCenterCommand ( self,
macroName )

◆ getMLABUseCurrent()

TestCenterAdvanced.Config.Configuration.getMLABUseCurrent ( self)

◆ getReportDirectory()

TestCenterAdvanced.Config.Configuration.getReportDirectory ( self)

Definition at line 644 of file Config.py.

References TestCenterAdvanced.Config.Configuration.__report.

◆ getReportName()

TestCenterAdvanced.Config.Configuration.getReportName ( self)

Definition at line 648 of file Config.py.

References TestCenterAdvanced.Config.Configuration.__report.

◆ getReportOptions()

TestCenterAdvanced.Config.Configuration.getReportOptions ( self)

Definition at line 621 of file Config.py.

References TestCenterAdvanced.Config.Configuration.__report.

◆ getReportTimestampTemplate()

TestCenterAdvanced.Config.Configuration.getReportTimestampTemplate ( self)

Definition at line 652 of file Config.py.

References TestCenterAdvanced.Config.Configuration.__report.

◆ getRestartInterval()

TestCenterAdvanced.Config.Configuration.getRestartInterval ( self)

◆ getResultDir()

TestCenterAdvanced.Config.Configuration.getResultDir ( self)

◆ getResultFile()

TestCenterAdvanced.Config.Configuration.getResultFile ( self)

◆ getSlaveLogFilePath()

TestCenterAdvanced.Config.Configuration.getSlaveLogFilePath ( self)

◆ hideInfoMessages()

TestCenterAdvanced.Config.Configuration.hideInfoMessages ( self)

Definition at line 672 of file Config.py.

References TestCenterAdvanced.Config.Configuration.__report.

◆ hideSystemMessages()

TestCenterAdvanced.Config.Configuration.hideSystemMessages ( self)

Definition at line 676 of file Config.py.

References TestCenterAdvanced.Config.Configuration.__report.

◆ isBullseyeCoverageEnabled()

TestCenterAdvanced.Config.Configuration.isBullseyeCoverageEnabled ( self)

◆ isGlobalPythonCoverageEnabled()

TestCenterAdvanced.Config.Configuration.isGlobalPythonCoverageEnabled ( self)

◆ isPythonCoverageEnabled()

TestCenterAdvanced.Config.Configuration.isPythonCoverageEnabled ( self)

◆ nodeHasValidText()

TestCenterAdvanced.Config.Configuration.nodeHasValidText ( node)
static

◆ save()

TestCenterAdvanced.Config.Configuration.save ( self,
filename = None )

Save the configuration variables set to the file with the given name.

Attention
If the given filename does exists the file is overwritten! This method is made public such that external changes can be saved.

Definition at line 429 of file Config.py.

References TestCenterAdvanced.Config.Configuration.__configFilePath, TestCenterAdvanced.Config.Configuration.__defaultTestTimeoutSeconds, TestCenterAdvanced.Config.Configuration.__ipcConnectionTimeout, TestCenterAdvanced.Config.Configuration.__maxTestTimeoutSeconds, TestCenterAdvanced.Config.Configuration.__MLABArguments, TestCenterAdvanced.Config.Configuration.__MLABCompileMode, TestCenterAdvanced.Config.Configuration.__MLABExecutablePath, TestCenterAdvanced.Config.Configuration.__MLABSlaveLogFileName, TestCenterAdvanced.Config.Configuration.__MLABUseCurrent, TestCenterAdvanced.Config.Configuration.__mMLABRestartInterval, TestCenterAdvanced.Config.Configuration.__pythonCoverageExclusionExpressions, TestCenterAdvanced.Config.Configuration.__pythonCoverageInclusionExpressions, TestCenterAdvanced.Config.Configuration.__report, TestCenterAdvanced.Config.Configuration.__resultOutputDirectory, TestCenterAdvanced.Config.Configuration.__useBullseyeCoverage, TestCenterAdvanced.Config.Configuration.__useGlobalPythonCoverage, TestCenterAdvanced.Config.Configuration.__usePythonCoverage, TestCenterAdvanced.Config.Configuration.__xmlResultFileName, TestCenterAdvanced.Config.Configuration.storeTestCaseManagerSettings(), and TestCenterAdvanced.Config.unicode.

Referenced by TestCenterAdvanced.Config.Configuration.__init__().

◆ setBullseyeCoverageEnabled()

TestCenterAdvanced.Config.Configuration.setBullseyeCoverageEnabled ( self,
value )

◆ setGlobalPythonCoverageEnabled()

TestCenterAdvanced.Config.Configuration.setGlobalPythonCoverageEnabled ( self,
value )

◆ setMLABArguments()

TestCenterAdvanced.Config.Configuration.setMLABArguments ( self,
arguments )

◆ setMLABCompileMode()

TestCenterAdvanced.Config.Configuration.setMLABCompileMode ( self,
value )

◆ setMLABExecutablePath()

TestCenterAdvanced.Config.Configuration.setMLABExecutablePath ( self,
executablePath )

◆ setMLABUseCurrent()

TestCenterAdvanced.Config.Configuration.setMLABUseCurrent ( self,
usecurrent )

◆ setMLABUseDebug()

TestCenterAdvanced.Config.Configuration.setMLABUseDebug ( self,
useDebug )

◆ setPythonCoverageEnabled()

TestCenterAdvanced.Config.Configuration.setPythonCoverageEnabled ( self,
value )

◆ setReportOptions()

TestCenterAdvanced.Config.Configuration.setReportOptions ( self,
directory,
name,
timestampTemplate,
appendTestCaseName,
appendTimestamp,
collapseFunctions,
showFailedFunctionsOnly,
hideInfoMessages,
hideSystemMessages )

Definition at line 624 of file Config.py.

References TestCenterAdvanced.Config.Configuration.__report.

◆ setResultDir()

TestCenterAdvanced.Config.Configuration.setResultDir ( self,
directory )

◆ setTestCaseManagerOptions()

TestCenterAdvanced.Config.Configuration.setTestCaseManagerOptions ( self,
shouldReloadPythonModulesWhenReloadingTestCases )

◆ shouldReloadPythonModulesWhenReloadingTestCases()

TestCenterAdvanced.Config.Configuration.shouldReloadPythonModulesWhenReloadingTestCases ( self)

◆ showFailedFunctionsOnly()

TestCenterAdvanced.Config.Configuration.showFailedFunctionsOnly ( self)

Definition at line 668 of file Config.py.

References TestCenterAdvanced.Config.Configuration.__report.

◆ storeTestCaseManagerSettings()

TestCenterAdvanced.Config.Configuration.storeTestCaseManagerSettings ( self,
xmlRoot )

◆ useMLABDebugVersion()

TestCenterAdvanced.Config.Configuration.useMLABDebugVersion ( self)

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