UnitTestSupport.py

Go to the documentation of this file.

#
# Copyright 2018, 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 unittest
import inspect
import os
 
# This module contains methods that are handy when using the python unittest framework within the TestCenter.
 
class TestCaseWithSupportData(unittest.TestCase):
  """
  This is a helper class that can be used instead of TestSupport.Base.getDataDirectory()
  It allows you to access the Tests Data directory from a unittest, no matter whether it's wrapped in a TestCenter test
  or whether you call it directly from python.
  In the latter case, the Data directory is expected to be in the folder where your python TestCase is defined.
  To access the folder, use self.getTestSupportDataDirectory() or self.getFileInTestSupportDataDirectory("example.txt")
 
  E.g.:
  MyTestCase
   - MyTestCase.def
   - MyTestCase.py
   - Data
    - exampleInput.txt
  """
 
  @classmethod
  def getTestSupportDataDirectory(cls):
    return _getDataDirectory(cls)
 
  @classmethod
  def getFileInTestSupportDataDirectory(cls, filename):
    return os.path.join(cls.getTestSupportDataDirectorygetTestSupportDataDirectory(), filename)
 
 
def _isTestHelperAvailable():
  try:
    from TestSupport.Base import TestHelper
    TestHelper()
    return True
  except (ImportError, Exception):
    return False
 
if _isTestHelperAvailable():
  from TestSupport.Base import getDataDirectory as getTestSupportDataDirectory
 
  def _getDataDirectory(testCaseClass):
    # inspect.getfile() would not work inside MeVisLab, therefore rely on the TestSupport function:
    return getTestSupportDataDirectory()
else:
  def _getDataDirectory(testCaseClass):
    sourcePath = inspect.getfile(testCaseClass)
    return os.path.join(os.path.dirname(sourcePath), "Data")