The coordinator of test execution. More...

Public Member Functions
def	__init__ (self, cfgFile=None, verbose=False, slave=None, slaveEnvironment=None, isInsideTestCaseManager=False)
	The default constructor. More...

def	onExit (self)

def	__enter__ (self)

def	__exit__ (self, *_)

def	__del__ (self)

def	stop (self)

def	shouldStop (self)

def	getTestProgress (self)

def	resetTestProgress (self, testCaseCount)

def	updateTestProgress (self, finishedTestCase=None, additionalTestCaseCount=None)

def	setUpdateProgressFunc (self, updateProgressFunc)

def	setActiveTestCase (self, testCase)

def	setTestCaseListener (self, listener)

def	setTestCases (self, testCaseList)
	Set the list of test cases to execute. More...

def	setTestCasesToIgnore (self, testCaseToIgnoreList)
	Set the list of test cases to ignore. More...

def	setTestGroups (self, testGroupList)
	Set the list of test groups to respect. More...

def	setTestSuites (self, testSuiteList)

def	setModules (self, moduleList=[], filterList=[])
	Specify the list of modules to test. More...

def	setPackages (self, testedPkgList=[], availablePkgList=[], ignoredPkgList=[])
	Specify the packages that should be tested and thought available. More...

def	transferNodeFromExecutionToResultXML (self, nodeName, executionNode, testResultNode)

def	shouldMeasurePythonCoverageGlobally (self)

def	run (self, funcDict=None, stopSlaveAfterTestRun=True)
	The main method which handles all the request from the master. More...

def	reset (self)
	Resets the master to the state after instantiation. More...

def	getConfig (self)

def	logMessageWithPID (self, message)

def	logDebugWithPID (self, message)

def	logErrorWithPID (self, message)

def	logMessageWithLastError (self, message)

def	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 217 of file Master.py.

Constructor & Destructor Documentation

◆ init()

def 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

cfgFile	The configuration file to load.
verbose	Show more detailed information.
slave	Run the tests in the same MeVisLab instance using the given slave instance.
slaveEnvironment	Environment to use for the MeVisLab slave instance.

Definition at line 257 of file Master.py.

◆ del()

def TestCenterAdvanced.Master.Master.__del__ ( self )

Definition at line 328 of file Master.py.

References TestCenterAdvanced.Master.Master.onExit().

Member Function Documentation

◆ enter()

def TestCenterAdvanced.Master.Master.__enter__ ( self )

Definition at line 322 of file Master.py.

◆ exit()

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

Definition at line 325 of file Master.py.

References TestCenterAdvanced.Master.Master.onExit().

◆ getConfig()

def TestCenterAdvanced.Master.Master.getConfig ( self )

Definition at line 1132 of file Master.py.

References TestCenterAdvanced.Master.Master.__config, TestCenterAdvanced.Master.Master.__isSlaveRunning(), and TestCenterAdvanced.Master.Master.__slaveProc.

◆ getTestProgress()

def TestCenterAdvanced.Master.Master.getTestProgress ( self )

Definition at line 344 of file Master.py.

References TestCenterAdvanced.Master.Master.__lock, and TestCenterAdvanced.Master.Master.__testProgress.

◆ logDebugWithPID()

def TestCenterAdvanced.Master.Master.logDebugWithPID	(	self,
		message
	)

Definition at line 1152 of file Master.py.

References TestCenterAdvanced.Master.SlaveProcess.__logger, TestCenterAdvanced.Master.Master.__logger, TestCenterAdvanced.Master.SlaveProcess.logMessageWithPID(), and TestCenterAdvanced.Master.Master.logMessageWithPID().

Referenced by TestCenterAdvanced.Master.Master.logMessageWithLastError(), and TestCenterAdvanced.Master.Master.stopSlave().

◆ logErrorWithPID()

def TestCenterAdvanced.Master.Master.logErrorWithPID	(	self,
		message
	)

Definition at line 1155 of file Master.py.

References TestCenterAdvanced.Master.SlaveProcess.__logger, TestCenterAdvanced.Master.Master.__logger, TestSupport.Logging.error(), TestCenterAdvanced.Master.SlaveProcess.logMessageWithPID(), and TestCenterAdvanced.Master.Master.logMessageWithPID().

Referenced by TestCenterAdvanced.Master.SlaveProcess.finish(), TestCenterAdvanced.Master.Master.logMessageWithLastError(), TestCenterAdvanced.Master.Master.stopSlave(), and TestCenterAdvanced.Master.SlaveProcess.wasKilled().

◆ logMessageWithLastError()

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

Definition at line 1158 of file Master.py.

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

◆ logMessageWithPID()

def TestCenterAdvanced.Master.Master.logMessageWithPID	(	self,
		message
	)

Definition at line 1147 of file Master.py.

References TestCenterAdvanced.Master.Master.__slaveProc.

Referenced by TestCenterAdvanced.Master.SlaveProcess.finish(), TestCenterAdvanced.Master.SlaveProcess.logDebugWithPID(), TestCenterAdvanced.Master.Master.logDebugWithPID(), TestCenterAdvanced.Master.SlaveProcess.logErrorWithPID(), and TestCenterAdvanced.Master.Master.logErrorWithPID().

◆ onExit()

def TestCenterAdvanced.Master.Master.onExit ( self )

Definition at line 315 of file Master.py.

References TestCenterAdvanced.Master.Master.__hangingSlaves, TestCenterAdvanced.Master.SlaveProcess.__logger, TestCenterAdvanced.Master.Master.__logger, and TestSupport.Logging.error().

Referenced by TestCenterAdvanced.Master.Master.__del__(), and TestCenterAdvanced.Master.Master.__exit__().

◆ reset()

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

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

Definition at line 350 of file Master.py.

References TestCenterAdvanced.Master.Master.__lock, TestCenterAdvanced.Master.Master.__testProgress, and TestCenterAdvanced.Master.Master.reset().

Referenced by TestCenterAdvanced.Master.Master.run().

◆ run()

def 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

funcDict	A dictionary with information which test functions for which test cases should be executed.
stopSlaveAfterTestRun	If False, then the slave can be re-used for another test run after resetting the master.

Definition at line 970 of file Master.py.

◆ setActiveTestCase()

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

Definition at line 389 of file Master.py.

References TestCenterAdvanced.Master.Master.__lock, and TestCenterAdvanced.Master.Master.__testProgress.

Referenced by TestCenterAdvanced.Master.Master.run().

◆ setModules()

def 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

moduleList	List of names of modules to take into account.
filterList	List of filters to select modules.

Definition at line 463 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()

def 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

testedPkgList	The list of packages tests are taken from.
availablePkgList	List of packages that should be available.
ignoredPkgList	List of package that should be ignored when using wildcard

Definition at line 484 of file Master.py.