b9c1b51e45
*** to conform to clang-format’s LLVM style. This kind of mass change has
*** two obvious implications:
Firstly, merging this particular commit into a downstream fork may be a huge
effort. Alternatively, it may be worth merging all changes up to this commit,
performing the same reformatting operation locally, and then discarding the
merge for this particular commit. The commands used to accomplish this
reformatting were as follows (with current working directory as the root of
the repository):
find . \( -iname "*.c" -or -iname "*.cpp" -or -iname "*.h" -or -iname "*.mm" \) -exec clang-format -i {} +
find . -iname "*.py" -exec autopep8 --in-place --aggressive --aggressive {} + ;
The version of clang-format used was 3.9.0, and autopep8 was 1.2.4.
Secondly, “blame” style tools will generally point to this commit instead of
a meaningful prior commit. There are alternatives available that will attempt
to look through this change and find the appropriate prior commit. YMMV.
llvm-svn: 280751
340 lines
13 KiB
Python
340 lines
13 KiB
Python
"""Loading unittests."""
|
|
|
|
import functools
|
|
import os
|
|
import re
|
|
import sys
|
|
import traceback
|
|
import types
|
|
import unittest
|
|
|
|
from fnmatch import fnmatch
|
|
|
|
from unittest2 import case, suite, cmp_
|
|
|
|
try:
|
|
from os.path import relpath
|
|
except ImportError:
|
|
from unittest2.compatibility import relpath
|
|
|
|
__unittest = True
|
|
|
|
# what about .pyc or .pyo (etc)
|
|
# we would need to avoid loading the same tests multiple times
|
|
# from '.py', '.pyc' *and* '.pyo'
|
|
VALID_MODULE_NAME = re.compile(r'[_a-z]\w*\.py$', re.IGNORECASE)
|
|
|
|
|
|
def _make_failed_import_test(name, suiteClass):
|
|
message = 'Failed to import test module: %s' % name
|
|
if hasattr(traceback, 'format_exc'):
|
|
# Python 2.3 compatibility
|
|
# format_exc returns two frames of discover.py as well
|
|
message += '\n%s' % traceback.format_exc()
|
|
return _make_failed_test('ModuleImportFailure', name, ImportError(message),
|
|
suiteClass)
|
|
|
|
|
|
def _make_failed_load_tests(name, exception, suiteClass):
|
|
return _make_failed_test('LoadTestsFailure', name, exception, suiteClass)
|
|
|
|
|
|
def _make_failed_test(classname, methodname, exception, suiteClass):
|
|
def testFailure(self):
|
|
raise exception
|
|
attrs = {methodname: testFailure}
|
|
TestClass = type(classname, (case.TestCase,), attrs)
|
|
return suiteClass((TestClass(methodname),))
|
|
|
|
|
|
class TestLoader(unittest.TestLoader):
|
|
"""
|
|
This class is responsible for loading tests according to various criteria
|
|
and returning them wrapped in a TestSuite
|
|
"""
|
|
|
|
def __init__(self):
|
|
self.testMethodPrefix = 'test'
|
|
self.sortTestMethodsUsing = cmp_
|
|
self.suiteClass = suite.TestSuite
|
|
self._top_level_dir = None
|
|
|
|
def loadTestsFromTestCase(self, testCaseClass):
|
|
"""Return a suite of all tests cases contained in testCaseClass"""
|
|
if issubclass(testCaseClass, suite.TestSuite):
|
|
raise TypeError("Test cases should not be derived from TestSuite."
|
|
" Maybe you meant to derive from TestCase?")
|
|
testCaseNames = self.getTestCaseNames(testCaseClass)
|
|
if not testCaseNames and hasattr(testCaseClass, 'runTest'):
|
|
testCaseNames = ['runTest']
|
|
loaded_suite = self.suiteClass(map(testCaseClass, testCaseNames))
|
|
return loaded_suite
|
|
|
|
def loadTestsFromModule(self, module, use_load_tests=True):
|
|
"""Return a suite of all tests cases contained in the given module"""
|
|
tests = []
|
|
for name in dir(module):
|
|
obj = getattr(module, name)
|
|
if isinstance(obj, type) and issubclass(obj, unittest.TestCase):
|
|
tests.append(self.loadTestsFromTestCase(obj))
|
|
|
|
load_tests = getattr(module, 'load_tests', None)
|
|
tests = self.suiteClass(tests)
|
|
if use_load_tests and load_tests is not None:
|
|
try:
|
|
return load_tests(self, tests, None)
|
|
except Exception as e:
|
|
return _make_failed_load_tests(module.__name__, e,
|
|
self.suiteClass)
|
|
return tests
|
|
|
|
def loadTestsFromName(self, name, module=None):
|
|
"""Return a suite of all tests cases given a string specifier.
|
|
|
|
The name may resolve either to a module, a test case class, a
|
|
test method within a test case class, or a callable object which
|
|
returns a TestCase or TestSuite instance.
|
|
|
|
The method optionally resolves the names relative to a given module.
|
|
"""
|
|
parts = name.split('.')
|
|
if module is None:
|
|
parts_copy = parts[:]
|
|
while parts_copy:
|
|
try:
|
|
module = __import__('.'.join(parts_copy))
|
|
break
|
|
except ImportError:
|
|
del parts_copy[-1]
|
|
if not parts_copy:
|
|
raise
|
|
parts = parts[1:]
|
|
obj = module
|
|
for part in parts:
|
|
parent, obj = obj, getattr(obj, part)
|
|
|
|
if isinstance(obj, types.ModuleType):
|
|
return self.loadTestsFromModule(obj)
|
|
elif isinstance(obj, type) and issubclass(obj, unittest.TestCase):
|
|
return self.loadTestsFromTestCase(obj)
|
|
elif (isinstance(obj, types.UnboundMethodType) and
|
|
isinstance(parent, type) and
|
|
issubclass(parent, case.TestCase)):
|
|
return self.suiteClass([parent(obj.__name__)])
|
|
elif isinstance(obj, unittest.TestSuite):
|
|
return obj
|
|
elif hasattr(obj, '__call__'):
|
|
test = obj()
|
|
if isinstance(test, unittest.TestSuite):
|
|
return test
|
|
elif isinstance(test, unittest.TestCase):
|
|
return self.suiteClass([test])
|
|
else:
|
|
raise TypeError("calling %s returned %s, not a test" %
|
|
(obj, test))
|
|
else:
|
|
raise TypeError("don't know how to make test from: %s" % obj)
|
|
|
|
def loadTestsFromNames(self, names, module=None):
|
|
"""Return a suite of all tests cases found using the given sequence
|
|
of string specifiers. See 'loadTestsFromName()'.
|
|
"""
|
|
suites = [self.loadTestsFromName(name, module) for name in names]
|
|
return self.suiteClass(suites)
|
|
|
|
def getTestCaseNames(self, testCaseClass):
|
|
"""Return a sorted sequence of method names found within testCaseClass
|
|
"""
|
|
def isTestMethod(attrname, testCaseClass=testCaseClass,
|
|
prefix=self.testMethodPrefix):
|
|
return attrname.startswith(prefix) and \
|
|
hasattr(getattr(testCaseClass, attrname), '__call__')
|
|
testFnNames = list(filter(isTestMethod, dir(testCaseClass)))
|
|
if self.sortTestMethodsUsing:
|
|
testFnNames.sort(
|
|
key=functools.cmp_to_key(
|
|
self.sortTestMethodsUsing))
|
|
return testFnNames
|
|
|
|
def discover(self, start_dir, pattern='test*.py', top_level_dir=None):
|
|
"""Find and return all test modules from the specified start
|
|
directory, recursing into subdirectories to find them. Only test files
|
|
that match the pattern will be loaded. (Using shell style pattern
|
|
matching.)
|
|
|
|
All test modules must be importable from the top level of the project.
|
|
If the start directory is not the top level directory then the top
|
|
level directory must be specified separately.
|
|
|
|
If a test package name (directory with '__init__.py') matches the
|
|
pattern then the package will be checked for a 'load_tests' function. If
|
|
this exists then it will be called with loader, tests, pattern.
|
|
|
|
If load_tests exists then discovery does *not* recurse into the package,
|
|
load_tests is responsible for loading all tests in the package.
|
|
|
|
The pattern is deliberately not stored as a loader attribute so that
|
|
packages can continue discovery themselves. top_level_dir is stored so
|
|
load_tests does not need to pass this argument in to loader.discover().
|
|
"""
|
|
set_implicit_top = False
|
|
if top_level_dir is None and self._top_level_dir is not None:
|
|
# make top_level_dir optional if called from load_tests in a
|
|
# package
|
|
top_level_dir = self._top_level_dir
|
|
elif top_level_dir is None:
|
|
set_implicit_top = True
|
|
top_level_dir = start_dir
|
|
|
|
top_level_dir = os.path.abspath(top_level_dir)
|
|
|
|
if top_level_dir not in sys.path:
|
|
# all test modules must be importable from the top level directory
|
|
# should we *unconditionally* put the start directory in first
|
|
# in sys.path to minimise likelihood of conflicts between installed
|
|
# modules and development versions?
|
|
sys.path.insert(0, top_level_dir)
|
|
self._top_level_dir = top_level_dir
|
|
|
|
is_not_importable = False
|
|
if os.path.isdir(os.path.abspath(start_dir)):
|
|
start_dir = os.path.abspath(start_dir)
|
|
if start_dir != top_level_dir:
|
|
is_not_importable = not os.path.isfile(
|
|
os.path.join(start_dir, '__init__.py'))
|
|
else:
|
|
# support for discovery from dotted module names
|
|
try:
|
|
__import__(start_dir)
|
|
except ImportError:
|
|
is_not_importable = True
|
|
else:
|
|
the_module = sys.modules[start_dir]
|
|
top_part = start_dir.split('.')[0]
|
|
start_dir = os.path.abspath(
|
|
os.path.dirname((the_module.__file__)))
|
|
if set_implicit_top:
|
|
self._top_level_dir = os.path.abspath(os.path.dirname(
|
|
os.path.dirname(sys.modules[top_part].__file__)))
|
|
sys.path.remove(top_level_dir)
|
|
|
|
if is_not_importable:
|
|
raise ImportError(
|
|
'Start directory is not importable: %r' %
|
|
start_dir)
|
|
|
|
tests = list(self._find_tests(start_dir, pattern))
|
|
return self.suiteClass(tests)
|
|
|
|
def _get_name_from_path(self, path):
|
|
path = os.path.splitext(os.path.normpath(path))[0]
|
|
|
|
_relpath = relpath(path, self._top_level_dir)
|
|
assert not os.path.isabs(_relpath), "Path must be within the project"
|
|
assert not _relpath.startswith('..'), "Path must be within the project"
|
|
|
|
name = _relpath.replace(os.path.sep, '.')
|
|
return name
|
|
|
|
def _get_module_from_name(self, name):
|
|
__import__(name)
|
|
return sys.modules[name]
|
|
|
|
def _match_path(self, path, full_path, pattern):
|
|
# override this method to use alternative matching strategy
|
|
return fnmatch(path, pattern)
|
|
|
|
def _find_tests(self, start_dir, pattern):
|
|
"""Used by discovery. Yields test suites it loads."""
|
|
paths = os.listdir(start_dir)
|
|
|
|
for path in paths:
|
|
full_path = os.path.join(start_dir, path)
|
|
if os.path.isfile(full_path):
|
|
if not VALID_MODULE_NAME.match(path):
|
|
# valid Python identifiers only
|
|
continue
|
|
if not self._match_path(path, full_path, pattern):
|
|
continue
|
|
# if the test file matches, load it
|
|
name = self._get_name_from_path(full_path)
|
|
try:
|
|
module = self._get_module_from_name(name)
|
|
except:
|
|
yield _make_failed_import_test(name, self.suiteClass)
|
|
else:
|
|
mod_file = os.path.abspath(
|
|
getattr(module, '__file__', full_path))
|
|
realpath = os.path.splitext(mod_file)[0]
|
|
fullpath_noext = os.path.splitext(full_path)[0]
|
|
if realpath.lower() != fullpath_noext.lower():
|
|
module_dir = os.path.dirname(realpath)
|
|
mod_name = os.path.splitext(
|
|
os.path.basename(full_path))[0]
|
|
expected_dir = os.path.dirname(full_path)
|
|
msg = (
|
|
"%r module incorrectly imported from %r. Expected %r. "
|
|
"Is this module globally installed?")
|
|
raise ImportError(msg %
|
|
(mod_name, module_dir, expected_dir))
|
|
yield self.loadTestsFromModule(module)
|
|
elif os.path.isdir(full_path):
|
|
if not os.path.isfile(os.path.join(full_path, '__init__.py')):
|
|
continue
|
|
|
|
load_tests = None
|
|
tests = None
|
|
if fnmatch(path, pattern):
|
|
# only check load_tests if the package directory itself
|
|
# matches the filter
|
|
name = self._get_name_from_path(full_path)
|
|
package = self._get_module_from_name(name)
|
|
load_tests = getattr(package, 'load_tests', None)
|
|
tests = self.loadTestsFromModule(
|
|
package, use_load_tests=False)
|
|
|
|
if load_tests is None:
|
|
if tests is not None:
|
|
# tests loaded from package file
|
|
yield tests
|
|
# recurse into the package
|
|
for test in self._find_tests(full_path, pattern):
|
|
yield test
|
|
else:
|
|
try:
|
|
yield load_tests(self, tests, pattern)
|
|
except Exception as e:
|
|
yield _make_failed_load_tests(package.__name__, e,
|
|
self.suiteClass)
|
|
|
|
defaultTestLoader = TestLoader()
|
|
|
|
|
|
def _makeLoader(prefix, sortUsing, suiteClass=None):
|
|
loader = TestLoader()
|
|
loader.sortTestMethodsUsing = sortUsing
|
|
loader.testMethodPrefix = prefix
|
|
if suiteClass:
|
|
loader.suiteClass = suiteClass
|
|
return loader
|
|
|
|
|
|
def getTestCaseNames(testCaseClass, prefix, sortUsing=cmp_):
|
|
return _makeLoader(prefix, sortUsing).getTestCaseNames(testCaseClass)
|
|
|
|
|
|
def makeSuite(testCaseClass, prefix='test', sortUsing=cmp_,
|
|
suiteClass=suite.TestSuite):
|
|
return _makeLoader(
|
|
prefix,
|
|
sortUsing,
|
|
suiteClass).loadTestsFromTestCase(testCaseClass)
|
|
|
|
|
|
def findTestCases(module, prefix='test', sortUsing=cmp_,
|
|
suiteClass=suite.TestSuite):
|
|
return _makeLoader(
|
|
prefix,
|
|
sortUsing,
|
|
suiteClass).loadTestsFromModule(module)
|