Generic.py

Go to the documentation of this file.

#
# Copyright 2013, 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
#
 
"""Shared code for generic tests"""
 
from TestSupport import Logging
 
# -- local imports ---------------------------------------------------------{{{-
import mevis
 
TESTS_TO_OMIT_TAG = "testsToOmit"
FORMAL_TEST_IDENTIFIER = "formal"
ALL_TESTS_IDENTIFIER = "all"
EXAMPLE_NETWORK_TEST_IDENTIFIER = "example_network"
PANEL_TEST_IDENTIFIER = "open_panel"
 
 
def getTestsToOmit(moduleName):
    """Return list of tests to omit for this module.
    If the module does not define this tag or if it is empty, an empty list
    is returned.
    """
    moduleInfo = mevis.MLAB.moduleInfo(moduleName)
 
    testsToOmit = []
 
    if TESTS_TO_OMIT_TAG in moduleInfo:
        testsToOmit = moduleInfo[TESTS_TO_OMIT_TAG].lower().split()
 
    return testsToOmit
 
 
def logThatTestWasOmittedByConfiguration(testIdentifier):
    Logging.info('"%s" test was omitted due to the test machine\'s configuration' % testIdentifier)
 
 
def isTestOmittedAndLogIfSo(moduleName, testIdentifier):
    isOmitted = isTestOmitted(moduleName, testIdentifier)
 
    if isOmitted:
        Logging.info('"%s" test was omitted on module demand' % testIdentifier)
 
    return isOmitted
 
 
def isTestOmitted(moduleName, testIdentifier):
    omittedTests = getTestsToOmit(moduleName)
 
    directlyOmitted = testIdentifier in omittedTests
    allOmitted = ALL_TESTS_IDENTIFIER in omittedTests
 
    return directlyOmitted or allOmitted