← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/TestUtil.py

  • Committer: Martin Pool
  • Date: 2009-06-19 06:21:13 UTC
  • mto: This revision was merged to the branch mainline in revision 4558.
  • Revision ID: mbp@sourcefrog.net-20090619062113-019bp0a3bl2y4nkx
Un-soft-deprecate _supports_progress - still useful

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/TestUtil.py
 
1
# Copyright (C) 2004, 2005, 2006 Canonical Ltd
 
2
#       Author: Robert Collins <robert.collins@canonical.com>
 
3
#
 
4
# This program is free software; you can redistribute it and/or modify
 
5
# it under the terms of the GNU General Public License as published by
 
6
# the Free Software Foundation; either version 2 of the License, or
 
7
# (at your option) any later version.
 
8
#
 
9
# This program is distributed in the hope that it will be useful,
 
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
12
# GNU General Public License for more details.
 
13
#
 
14
# You should have received a copy of the GNU General Public License
 
15
# along with this program; if not, write to the Free Software
 
16
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
17
#
 
18
 
 
19
import sys
 
20
import logging
 
21
import unittest
 
22
 
 
23
# Mark this python module as being part of the implementation
 
24
# of unittest: this gives us better tracebacks where the last
 
25
# shown frame is the test code, not our assertXYZ.
 
26
__unittest = 1
 
27
 
 
28
 
 
29
class LogCollector(logging.Handler):
 
30
    def __init__(self):
 
31
        logging.Handler.__init__(self)
 
32
        self.records=[]
 
33
    def emit(self, record):
 
34
        self.records.append(record.getMessage())
 
35
 
 
36
 
 
37
def makeCollectingLogger():
 
38
    """I make a logger instance that collects its logs for programmatic analysis
 
39
    -> (logger, collector)"""
 
40
    logger=logging.Logger("collector")
 
41
    handler=LogCollector()
 
42
    handler.setFormatter(logging.Formatter("%(levelname)s: %(message)s"))
 
43
    logger.addHandler(handler)
 
44
    return logger, handler
 
45
 
 
46
 
 
47
def visitTests(suite, visitor):
 
48
    """A foreign method for visiting the tests in a test suite."""
 
49
    for test in suite._tests:
 
50
        #Abusing types to avoid monkey patching unittest.TestCase.
 
51
        # Maybe that would be better?
 
52
        try:
 
53
            test.visit(visitor)
 
54
        except AttributeError:
 
55
            if isinstance(test, unittest.TestCase):
 
56
                visitor.visitCase(test)
 
57
            elif isinstance(test, unittest.TestSuite):
 
58
                visitor.visitSuite(test)
 
59
                visitTests(test, visitor)
 
60
            else:
 
61
                print "unvisitable non-unittest.TestCase element %r (%r)" % (test, test.__class__)
 
62
 
 
63
 
 
64
class TestSuite(unittest.TestSuite):
 
65
    """I am an extended TestSuite with a visitor interface.
 
66
    This is primarily to allow filtering of tests - and suites or
 
67
    more in the future. An iterator of just tests wouldn't scale..."""
 
68
 
 
69
    def visit(self, visitor):
 
70
        """visit the composite. Visiting is depth-first.
 
71
        current callbacks are visitSuite and visitCase."""
 
72
        visitor.visitSuite(self)
 
73
        visitTests(self, visitor)
 
74
 
 
75
 
 
76
class TestLoader(unittest.TestLoader):
 
77
    """Custom TestLoader to extend the stock python one."""
 
78
 
 
79
    suiteClass = TestSuite
 
80
    # Memoize test names by test class dict
 
81
    test_func_names = {}
 
82
 
 
83
    def loadTestsFromModuleNames(self, names):
 
84
        """use a custom means to load tests from modules.
 
85
 
 
86
        There is an undesirable glitch in the python TestLoader where a
 
87
        import error is ignore. We think this can be solved by ensuring the
 
88
        requested name is resolvable, if its not raising the original error.
 
89
        """
 
90
        result = self.suiteClass()
 
91
        for name in names:
 
92
            result.addTests(self.loadTestsFromModuleName(name))
 
93
        return result
 
94
 
 
95
    def loadTestsFromModuleName(self, name):
 
96
        result = self.suiteClass()
 
97
        module = _load_module_by_name(name)
 
98
 
 
99
        result.addTests(self.loadTestsFromModule(module))
 
100
        return result
 
101
 
 
102
    def loadTestsFromModule(self, module):
 
103
        """Load tests from a module object.
 
104
 
 
105
        This extension of the python test loader looks for an attribute
 
106
        load_tests in the module object, and if not found falls back to the
 
107
        regular python loadTestsFromModule.
 
108
 
 
109
        If a load_tests attribute is found, it is called and the result is
 
110
        returned.
 
111
 
 
112
        load_tests should be defined like so:
 
113
        >>> def load_tests(standard_tests, module, loader):
 
114
        >>>    pass
 
115
 
 
116
        standard_tests is the tests found by the stock TestLoader in the
 
117
        module, module and loader are the module and loader instances.
 
118
 
 
119
        For instance, to run every test twice, you might do:
 
120
        >>> def load_tests(standard_tests, module, loader):
 
121
        >>>     result = loader.suiteClass()
 
122
        >>>     for test in iter_suite_tests(standard_tests):
 
123
        >>>         result.addTests([test, test])
 
124
        >>>     return result
 
125
        """
 
126
        basic_tests = super(TestLoader, self).loadTestsFromModule(module)
 
127
        load_tests = getattr(module, "load_tests", None)
 
128
        if load_tests is not None:
 
129
            return load_tests(basic_tests, module, self)
 
130
        else:
 
131
            return basic_tests
 
132
 
 
133
    def getTestCaseNames(self, test_case_class):
 
134
        test_fn_names = self.test_func_names.get(test_case_class, None)
 
135
        if test_fn_names is not None:
 
136
            # We already know them
 
137
            return test_fn_names
 
138
 
 
139
        test_fn_names = unittest.TestLoader.getTestCaseNames(self,
 
140
                                                             test_case_class)
 
141
        self.test_func_names[test_case_class] = test_fn_names
 
142
        return test_fn_names
 
143
 
 
144
 
 
145
class FilteredByModuleTestLoader(TestLoader):
 
146
    """A test loader that import only the needed modules."""
 
147
 
 
148
    def __init__(self, needs_module):
 
149
        """Constructor.
 
150
 
 
151
        :param needs_module: a callable taking a module name as a
 
152
            parameter returing True if the module should be loaded.
 
153
        """
 
154
        TestLoader.__init__(self)
 
155
        self.needs_module = needs_module
 
156
 
 
157
    def loadTestsFromModuleName(self, name):
 
158
        if self.needs_module(name):
 
159
            return TestLoader.loadTestsFromModuleName(self, name)
 
160
        else:
 
161
            return self.suiteClass()
 
162
 
 
163
 
 
164
def _load_module_by_name(mod_name):
 
165
    parts = mod_name.split('.')
 
166
    module = __import__(mod_name)
 
167
    del parts[0]
 
168
    # for historical reasons python returns the top-level module even though
 
169
    # it loads the submodule; we need to walk down to get the one we want.
 
170
    while parts:
 
171
        module = getattr(module, parts.pop(0))
 
172
    return module
 
173
 
 
174
 
 
175
class TestVisitor(object):
 
176
    """A visitor for Tests"""
 
177
    def visitSuite(self, aTestSuite):
 
178
        pass
 
179
    def visitCase(self, aTestCase):
 
180
        pass