TestCenter Reference
TestCenterAdvanced.Master.Master Class Reference

The coordinator of test execution. More...

Public Member Functions

 __init__ (self, cfgFile=None, verbose=False, slave=None, slaveEnvironment=None, isInsideTestCaseManager=False)
 The default constructor.
 
 onExit (self)
 
 __enter__ (self)
 
 __exit__ (self, *_)
 
 __del__ (self)
 
 stop (self)
 
 shouldStop (self)
 
 getTestProgress (self)
 
 resetTestProgress (self, testCaseCount)
 
 updateTestProgress (self, finishedTestCase=None, additionalTestCaseCount=None)
 
 setUpdateProgressFunc (self, updateProgressFunc)
 
 setActiveTestCase (self, testCase)
 
 setTestCaseListener (self, listener)
 
 setTestCases (self, testCaseList)
 Set the list of test cases to execute.
 
 setTestCasesToIgnore (self, testCaseToIgnoreList)
 Set the list of test cases to ignore.
 
 setTestGroups (self, testGroupList)
 Set the list of test groups to respect.
 
 setTestSuites (self, testSuiteList)
 
 setModules (self, moduleList=[], filterList=[])
 Specify the list of modules to test.
 
 setPackages (self, testedPkgList=[], availablePkgList=[], ignoredPkgList=[])
 Specify the packages that should be tested and thought available.
 
 transferNodeFromExecutionToResultXML (self, nodeName, executionNode, testResultNode)
 
 shouldMeasurePythonCoverageGlobally (self)
 
 run (self, funcDict=None, stopSlaveAfterTestRun=True)
 The main method which handles all the request from the master.
 
 reset (self)
 Resets the master to the state after instantiation.
 
 getConfig (self)
 
 logMessageWithPID (self, message)
 
 logDebugWithPID (self, message)
 
 logErrorWithPID (self, message)
 
 logMessageWithLastError (self, message)
 
 stopSlave (self)
 

Public Attributes

 logfileDir
 

Detailed Description

The coordinator of test execution.

The master can be used in two ways: either with tests executed in another MeVisLab instance or in the same. In the first scenario a new MeVisLab instance is started, the TestCenter module loaded via the runMacro parameter and communication handled using socket based interprocess communication. In the second one the slave is instanciated directly in the master.

Definition at line 207 of file Master.py.

Constructor & Destructor Documentation

◆ __init__()

TestCenterAdvanced.Master.Master.__init__ ( self,
cfgFile = None,
verbose = False,
slave = None,
slaveEnvironment = None,
isInsideTestCaseManager = False )

The default constructor.

The constructor is used to make some basic settings, like usage of a given configuration file (the default is tc_cfg_<platform>.xml), being more verbose and offline usage.

Parameters
cfgFileThe configuration file to load.
verboseShow more detailed information.
slaveRun the tests in the same MeVisLab instance using the given slave instance.
slaveEnvironmentEnvironment to use for the MeVisLab slave instance.

Definition at line 247 of file Master.py.

References TestCenterAdvanced.Master.Master.__com, TestCenterAdvanced.Slave.TestCaseRemoteListener.__com, TestCenterAdvanced.Slave.Slave.__com, TestCenterAdvanced.Master.Master.__config, TestCenterAdvanced.Master.Master.__lock, TestCenterAdvanced.Master.SlaveProcess.__logger, TestCenterAdvanced.Master.Master.__logger, TestCenterAdvanced.Master.Master.__shouldStop, TestCenterAdvanced.Master.Master.__slave, TestCenterAdvanced.Master.Master.__slaveEnvironment, TestCenterAdvanced.Master.Master.__testCaseListener, TestCenterAdvanced.Slave.Slave.__testCaseListener, TestCenterAdvanced.TestCase.TestCase.__testCaseListener, TestCenterAdvanced.Master.Master.__testedPkgList, and TestCenterAdvanced.Master.Master.__testProgress.

◆ __del__()

TestCenterAdvanced.Master.Master.__del__ ( self)

Definition at line 318 of file Master.py.

References TestCenterAdvanced.Master.Master.onExit().

Member Function Documentation

◆ __enter__()

TestCenterAdvanced.Master.Master.__enter__ ( self)

Definition at line 312 of file Master.py.

◆ __exit__()

TestCenterAdvanced.Master.Master.__exit__ ( self,
* _ )

Definition at line 315 of file Master.py.

References TestCenterAdvanced.Master.Master.onExit().

◆ getConfig()

TestCenterAdvanced.Master.Master.getConfig ( self)

◆ getTestProgress()

TestCenterAdvanced.Master.Master.getTestProgress ( self)

◆ logDebugWithPID()

◆ logErrorWithPID()

◆ logMessageWithLastError()

TestCenterAdvanced.Master.Master.logMessageWithLastError ( self,
message )

◆ logMessageWithPID()

◆ onExit()

◆ reset()

TestCenterAdvanced.Master.Master.reset ( self)

Resets the master to the state after instantiation.

In particular, it removes the configuration and the results of the last test run. After resetting the master you can start another test run with other tests.

Definition at line 1022 of file Master.py.

References TestCenterAdvanced.Master.Master.__testCfg, TestCenterAdvanced.Slave.Slave.__testCfg, TestCenterAdvanced.Master.Master.__testConfigSkeleton(), TestCenterAdvanced.Master.Master.__xmlRoot, TestCenterAdvanced.TestCase.TestCase.__xmlRoot, and TestSupport.FieldValueTests.FieldValueTestCaseSet.__xmlRoot.

Referenced by TestCenterAdvanced.Master.Master.resetTestProgress().

◆ resetTestProgress()

TestCenterAdvanced.Master.Master.resetTestProgress ( self,
testCaseCount )

◆ run()

TestCenterAdvanced.Master.Master.run ( self,
funcDict = None,
stopSlaveAfterTestRun = True )

The main method which handles all the request from the master.

The master asks the slave to serve some request. This is divided into two major blocks; on the first hand verifying whether the given information is valid and what tests to execute and on the second hand to process the given tests.

Parameters
funcDictA dictionary with information which test functions for which test cases should be executed.
stopSlaveAfterTestRunIf False, then the slave can be re-used for another test run after resetting the master.

Definition at line 885 of file Master.py.

References TestCenterAdvanced.Master.Master.__buildTestAgenda(), TestCenterAdvanced.Slave.Slave.__buildTestAgenda(), TestCenterAdvanced.Slave.Slave.__buildTestCaseAgenda(), TestCenterAdvanced.Master.Master.__buildTestCaseAgenda(), TestCenterAdvanced.Master.Master.__config, TestCenterAdvanced.Master.Master.__doTest(), TestCenterAdvanced.Slave.Slave.__doTest(), TestCenterAdvanced.Master.Master.__handleExtraTestCaseResults(), TestCenterAdvanced.Master.SlaveProcess.__logger, TestCenterAdvanced.Master.Master.__logger, TestCenterAdvanced.Master.Master.__slave, TestCenterAdvanced.Master.Master.__slaveProc, TestCenterAdvanced.Master.Master.__startSlave(), TestCenterAdvanced.Master.Master.__testCaseListener, TestCenterAdvanced.Slave.Slave.__testCaseListener, TestCenterAdvanced.TestCase.TestCase.__testCaseListener, TestCenterAdvanced.Master.Master.__testTypeAndName(), TestCenterAdvanced.Master.Master.__updateProgressFunc, TestCenterAdvanced.Master.Master.__xmlRoot, TestCenterAdvanced.TestCase.TestCase.__xmlRoot, TestSupport.FieldValueTests.FieldValueTestCaseSet.__xmlRoot, TestCenterAdvanced.Master.Master.resetTestProgress(), TestCenterAdvanced.Master.Master.setActiveTestCase(), TestCenterAdvanced.Master.Master.shouldMeasurePythonCoverageGlobally(), TestCenterAdvanced.Master.Master.stopSlave(), TestCenterAdvanced.Master.unicode, and TestCenterAdvanced.Master.Master.updateTestProgress().

◆ setActiveTestCase()

TestCenterAdvanced.Master.Master.setActiveTestCase ( self,
testCase )

◆ setModules()

TestCenterAdvanced.Master.Master.setModules ( self,
moduleList = [],
filterList = [] )

Specify the list of modules to test.

The filters can be used to specify a larger list of modules, for example all the modules of a certain author ("author:Jon Doe").

Parameters
moduleListList of names of modules to take into account.
filterListList of filters to select modules.

Definition at line 442 of file Master.py.

References TestCenterAdvanced.Master.Master.__testCfg, TestCenterAdvanced.Slave.Slave.__testCfg, TestCenterAdvanced.Master.Master.__xmlRoot, TestCenterAdvanced.TestCase.TestCase.__xmlRoot, and TestSupport.FieldValueTests.FieldValueTestCaseSet.__xmlRoot.

◆ setPackages()

TestCenterAdvanced.Master.Master.setPackages ( self,
testedPkgList = [],
availablePkgList = [],
ignoredPkgList = [] )

Specify the packages that should be tested and thought available.

The packages tested are those that test cases are taken from. The available packages are those that should be expected to be there. This is important for checking the meta information like the seeAlso tags. In released installers all seeAlso links should only point to modules being the public packages.

Parameters
testedPkgListThe list of packages tests are taken from.
availablePkgListList of packages that should be available.
ignoredPkgListList of package that should be ignored when using wildcard

Definition at line 462 of file Master.py.

References TestCenterAdvanced.Master.Master.__buildListOfTestFunctionsToExecute(), TestCenterAdvanced.Master.Master.__config, TestCenterAdvanced.Master.Master.__createTimeoutTooHighErrorFunction(), TestCenterAdvanced.Master.Master.__executeTestFunctions(), TestCenterAdvanced.Master.SlaveProcess.__logger, TestCenterAdvanced.Master.Master.__logger, TestCenterAdvanced.Master.Master.__sendRequest(), TestCenterAdvanced.Master.Master.__stackTraceFile, TestCenterAdvanced.Master.Master.__statusMessage(), TestCenterAdvanced.Master.Master.__testCaseListener, TestCenterAdvanced.Slave.Slave.__testCaseListener, TestCenterAdvanced.TestCase.TestCase.__testCaseListener, TestCenterAdvanced.Master.Master.__testCasesToIgnoreList, TestCenterAdvanced.Master.Master.__testCfg, TestCenterAdvanced.Slave.Slave.__testCfg, TestCenterAdvanced.Master.Master.__testedPkgList, TestCenterAdvanced.Master.Master.__testTypeAndName(), TestCenterAdvanced.Master.Master.__verifyConfiguration(), TestCenterAdvanced.Master.Master.__xmlRoot, TestCenterAdvanced.TestCase.TestCase.__xmlRoot, TestSupport.FieldValueTests.FieldValueTestCaseSet.__xmlRoot, and TestCenterAdvanced.Master.unicode.

◆ setTestCaseListener()

TestCenterAdvanced.Master.Master.setTestCaseListener ( self,
listener )

◆ setTestCases()

TestCenterAdvanced.Master.Master.setTestCases ( self,
testCaseList )

◆ setTestCasesToIgnore()

TestCenterAdvanced.Master.Master.setTestCasesToIgnore ( self,
testCaseToIgnoreList )

Set the list of test cases to ignore.

Parameters
testCaseToIgnoreListList of names of test cases to ignore.

Definition at line 413 of file Master.py.

References TestCenterAdvanced.Master.Master.__testCasesToIgnoreList.

◆ setTestGroups()

TestCenterAdvanced.Master.Master.setTestGroups ( self,
testGroupList )

Set the list of test groups to respect.

Parameters
testGroupListList of test groups to take into account.

Definition at line 420 of file Master.py.

References TestCenterAdvanced.Master.Master.__testCfg, TestCenterAdvanced.Slave.Slave.__testCfg, TestCenterAdvanced.Master.Master.__xmlRoot, TestCenterAdvanced.TestCase.TestCase.__xmlRoot, and TestSupport.FieldValueTests.FieldValueTestCaseSet.__xmlRoot.

◆ setTestSuites()

◆ setUpdateProgressFunc()

TestCenterAdvanced.Master.Master.setUpdateProgressFunc ( self,
updateProgressFunc )

Definition at line 370 of file Master.py.

References TestCenterAdvanced.Master.Master.__updateProgressFunc.

◆ shouldMeasurePythonCoverageGlobally()

TestCenterAdvanced.Master.Master.shouldMeasurePythonCoverageGlobally ( self)

◆ shouldStop()

TestCenterAdvanced.Master.Master.shouldStop ( self)

◆ stop()

TestCenterAdvanced.Master.Master.stop ( self)

◆ stopSlave()

◆ transferNodeFromExecutionToResultXML()

◆ updateTestProgress()

TestCenterAdvanced.Master.Master.updateTestProgress ( self,
finishedTestCase = None,
additionalTestCaseCount = None )

Member Data Documentation

◆ logfileDir

TestCenterAdvanced.Master.Master.logfileDir

Definition at line 270 of file Master.py.

Referenced by TestCenterAdvanced.Master.Master.logMessageWithLastError().


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