TestCaseGeneric.py

Go to the documentation of this file.

#
# Copyright 2009, MeVis Medical Solutions AG
#
# The user may use this file in accordance with the license agreement provided with
# the Software or, alternatively, in accordance with the terms contained in a
# written agreement between the user and MeVis Medical Solutions AG.
#
# For further information use the contact form at https://www.mevislab.de/contact
#
 
 
 
import mevis
from .TestCase import TestCase
from TestSupport.TestHelper import TestHelper
 
 
class GenericTestCase(TestCase):
    """TestCase superclass for generic testing"""
 
    def __init__(self, testCaseName, moduleName=None):
        self._moduleName = moduleName
        TestCase.__init__(self, testCaseName)
 
    def getType(self):
        return "GenericTestCase"
 
    def run(self, xmlNode):
        """Prior to running the actual test the module name is set to the result node."""
        if not self._moduleName:
            raise Exception("No module name set for test %s." % self._testCaseName_testCaseName)
        self._testHelper.setModuleName(self._moduleName)
        TestCase.run(self, xmlNode)
        self._testHelper.setModuleName(None)
 
    def __testModule(self, moduleName):
        """Verify whether module should be tested or not.
        If a generic test has a method "testModule" it is called. The result must be a boolean value
        that indicates whether the given module should be tested. The default return value is True.
        """
        if "testModule" in self._ctx.callableFunctions():
            return self._ctx.call(
                "testModule",
                [
                    moduleName,
                ],
            )
        return True
 
    def getName(self):
        """Return the name of the test case."""
        return "%s::%s" % (self._testCaseName_testCaseName, self._moduleName)
 
    def getModulesToTest(self, moduleList, packageList):
        """Get the list of modules to test."""
        availableModuleList = []
 
        for packageIdentifier in packageList:
            availableModuleList.extend(mevis.MLAB.allModulesForPackageIdentifier(packageIdentifier))
 
        # Testing myself wouldn't be a good idea (recursive adding of module is not supported).
        testerName = TestHelper.getInstance().getGlobalContext().name
        if testerName in availableModuleList:
            availableModuleList.remove(testerName)
 
        modulesToTest = []
        modulesNotToTest = []
        for moduleName in moduleList:
            if moduleName in availableModuleList:
                if self.__testModule(moduleName):
                    modulesToTest.append(moduleName)
                else:
                    modulesNotToTest.append(moduleName)
        return modulesToTest, modulesNotToTest