UnitTestDiscovery.py

Go to the documentation of this file.

#
# Copyright 2017, 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 os
import unittest
 
 
def getSuiteFromPackage(unitTestRootPackage, pattern='test*.py'):
  """
  Creates a Test Suite from all the tests inside a python package which is located in the MeVisLab Repository.
 
  Example usage inside a MeVisLab TestCenter Test:
 
  from TestSupport.UnitTestDiscovery import getSuiteFromPackage
  import my_module.core.tests
 
 
  def UNITTEST_My_Module():
    return getSuiteFromPackage(my_module.core.tests)
 
  :param unitTestRootPackage: the python package in which unit tests are searched
  :type unitTestRootPackage: ModuleType
  :param pattern: Only test files that match the pattern will be loaded.
 
  More details can be found in the documentation of the TestLoader.discover() function.
  """
  searchPath = unitTestRootPackage.__path__[0]
  top_level_dir = _getTopLevelDir(searchPath)
  # The top level dir is passed to the discover method to avoid name conflicts
  # These would otherwise show up when modules with the same names were imported from different packages
  return unittest.TestLoader().discover(searchPath, pattern, top_level_dir=top_level_dir)
 
 
def _getTopLevelDir(searchPath):
  pythonFolder = os.path.join("Scripts", "python")
  top_level_dir = searchPath[0:searchPath.find(pythonFolder) + len(pythonFolder)]
  return top_level_dir
 
 
def getSuiteFromFolder(searchPath, pattern='*.py'):
    """
    Creates a Test Suite from all the tests inside a folder, this could be a TestCenter TestCase folder.
    :param searchPath: the folder where to search for the unit tests.
    :param pattern: Only test files that match the pattern will be loaded.
    """
    return unittest.TestLoader().discover(searchPath, pattern)