TestCenter Reference
TestCenterAdvanced.Config.Configuration Class Reference

Public Member Functions

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

Static Public Member Functions

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

Detailed Description

Definition at line 104 of file Config.py.

Constructor & Destructor Documentation

◆ __init__()

def 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 105 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()

def TestCenterAdvanced.Config.Configuration.appendTestCaseNameToReportName (   self)

Definition at line 634 of file Config.py.

References TestCenterAdvanced.Config.Configuration.__report.

◆ appendTimestampToReportName()

def TestCenterAdvanced.Config.Configuration.appendTimestampToReportName (   self)

Definition at line 637 of file Config.py.

References TestCenterAdvanced.Config.Configuration.__report.

◆ collapseFunctions()

def TestCenterAdvanced.Config.Configuration.collapseFunctions (   self)

Definition at line 640 of file Config.py.

References TestCenterAdvanced.Config.Configuration.__report.

◆ fetchBullseyeCoverageSettings()

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

◆ fetchCoverageSettings()

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

◆ fetchIPCSettings()

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

◆ fetchMLABSettings()

◆ fetchPythonCoverageExclusionExpressions()

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

◆ fetchPythonCoverageInclusionExpressions()

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

◆ fetchPythonCoverageSettings()

◆ fetchReportNodeSettings()

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

◆ fetchReportSettings()

def TestCenterAdvanced.Config.Configuration.fetchReportSettings (   self,
  xmlRoot 
)

◆ fetchTestCaseManagerSettings()

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

◆ fetchUseBullseyeCoverage()

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

◆ fetchUseGlobalPythonCoverage()

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

◆ fetchUsePythonCoverage()

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

◆ findMLABExecutable()

def 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 509 of file Config.py.

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

◆ getBoolean()

◆ getConfigFilePath()

def TestCenterAdvanced.Config.Configuration.getConfigFilePath (   self)

◆ getCoverageExclusions()

def TestCenterAdvanced.Config.Configuration.getCoverageExclusions (   self)

◆ getCoverageInclusions()

def TestCenterAdvanced.Config.Configuration.getCoverageInclusions (   self)

◆ getDefaultTestTimeoutSeconds()

def TestCenterAdvanced.Config.Configuration.getDefaultTestTimeoutSeconds (   self)

◆ getInteger()

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

◆ getIPCConnectionTimeout()

def TestCenterAdvanced.Config.Configuration.getIPCConnectionTimeout (   self)

◆ getMaxTestTimeoutSeconds()

def TestCenterAdvanced.Config.Configuration.getMaxTestTimeoutSeconds (   self)

◆ getMLABArguments()

def TestCenterAdvanced.Config.Configuration.getMLABArguments (   self)

◆ getMLABBinariesPath()

def TestCenterAdvanced.Config.Configuration.getMLABBinariesPath (   self)

◆ getMLABCompileMode()

def TestCenterAdvanced.Config.Configuration.getMLABCompileMode (   self)

◆ getMLABCurrentBinariesPath()

def TestCenterAdvanced.Config.Configuration.getMLABCurrentBinariesPath (   self)

◆ getMLABEffectiveBinariesPath()

◆ getMLABExecutableCommand()

◆ getMLABTestCenterCommand()

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

◆ getMLABUseCurrent()

def TestCenterAdvanced.Config.Configuration.getMLABUseCurrent (   self)

◆ getReportDirectory()

def TestCenterAdvanced.Config.Configuration.getReportDirectory (   self)

Definition at line 625 of file Config.py.

References TestCenterAdvanced.Config.Configuration.__report.

◆ getReportName()

def TestCenterAdvanced.Config.Configuration.getReportName (   self)

Definition at line 628 of file Config.py.

References TestCenterAdvanced.Config.Configuration.__report.

◆ getReportOptions()

def TestCenterAdvanced.Config.Configuration.getReportOptions (   self)

Definition at line 598 of file Config.py.

References TestCenterAdvanced.Config.Configuration.__report.

◆ getReportTimestampTemplate()

def TestCenterAdvanced.Config.Configuration.getReportTimestampTemplate (   self)

Definition at line 631 of file Config.py.

References TestCenterAdvanced.Config.Configuration.__report.

◆ getRestartInterval()

def TestCenterAdvanced.Config.Configuration.getRestartInterval (   self)

◆ getResultDir()

def TestCenterAdvanced.Config.Configuration.getResultDir (   self)

◆ getResultFile()

def TestCenterAdvanced.Config.Configuration.getResultFile (   self)

◆ getSlaveLogFilePath()

def TestCenterAdvanced.Config.Configuration.getSlaveLogFilePath (   self)

◆ hideInfoMessages()

def TestCenterAdvanced.Config.Configuration.hideInfoMessages (   self)

Definition at line 646 of file Config.py.

References TestCenterAdvanced.Config.Configuration.__report.

◆ hideSystemMessages()

def TestCenterAdvanced.Config.Configuration.hideSystemMessages (   self)

Definition at line 649 of file Config.py.

References TestCenterAdvanced.Config.Configuration.__report.

◆ isBullseyeCoverageEnabled()

def TestCenterAdvanced.Config.Configuration.isBullseyeCoverageEnabled (   self)

◆ isGlobalPythonCoverageEnabled()

def TestCenterAdvanced.Config.Configuration.isGlobalPythonCoverageEnabled (   self)

◆ isPythonCoverageEnabled()

def TestCenterAdvanced.Config.Configuration.isPythonCoverageEnabled (   self)

◆ nodeHasValidText()

def TestCenterAdvanced.Config.Configuration.nodeHasValidText (   node)
static

◆ save()

def 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 421 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()

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

◆ setGlobalPythonCoverageEnabled()

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

◆ setMLABArguments()

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

◆ setMLABCompileMode()

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

◆ setMLABExecutablePath()

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

◆ setMLABUseCurrent()

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

◆ setMLABUseDebug()

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

◆ setPythonCoverageEnabled()

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

◆ setReportOptions()

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

Definition at line 601 of file Config.py.

References TestCenterAdvanced.Config.Configuration.__report.

◆ setResultDir()

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

◆ setTestCaseManagerOptions()

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

◆ shouldReloadPythonModulesWhenReloadingTestCases()

def TestCenterAdvanced.Config.Configuration.shouldReloadPythonModulesWhenReloadingTestCases (   self)

◆ showFailedFunctionsOnly()

def TestCenterAdvanced.Config.Configuration.showFailedFunctionsOnly (   self)

Definition at line 643 of file Config.py.

References TestCenterAdvanced.Config.Configuration.__report.

◆ storeTestCaseManagerSettings()

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

◆ useMLABDebugVersion()

def TestCenterAdvanced.Config.Configuration.useMLABDebugVersion (   self)

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