← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/TestUtil.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-01-21 10:00:42 UTC
  • mfrom: (4978.1.2 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20100121100042-77858a88k2zpec7b
(nmb) Add documentation for multi-parent merges

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/TestUtil.py
1
 
# Copyright (c) 2004 Canonical Limited
 
1
# Copyright (C) 2004, 2005, 2006 Canonical Ltd
2
2
#       Author: Robert Collins <robert.collins@canonical.com>
3
3
#
4
4
# This program is free software; you can redistribute it and/or modify
13
13
#
14
14
# You should have received a copy of the GNU General Public License
15
15
# along with this program; if not, write to the Free Software
16
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
17
#
18
18
 
19
19
import sys
20
20
import logging
21
21
import unittest
22
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
 
23
28
 
24
29
class LogCollector(logging.Handler):
25
30
    def __init__(self):
42
47
def visitTests(suite, visitor):
43
48
    """A foreign method for visiting the tests in a test suite."""
44
49
    for test in suite._tests:
45
 
        #Abusing types to avoid monkey patching unittest.TestCase. 
 
50
        #Abusing types to avoid monkey patching unittest.TestCase.
46
51
        # Maybe that would be better?
47
52
        try:
48
53
            test.visit(visitor)
54
59
                visitTests(test, visitor)
55
60
            else:
56
61
                print "unvisitable non-unittest.TestCase element %r (%r)" % (test, test.__class__)
57
 
    
 
62
 
58
63
 
59
64
class TestSuite(unittest.TestSuite):
60
65
    """I am an extended TestSuite with a visitor interface.
67
72
        visitor.visitSuite(self)
68
73
        visitTests(self, visitor)
69
74
 
 
75
    def run(self, result):
 
76
        """Run the tests in the suite, discarding references after running."""
 
77
        tests = list(self)
 
78
        tests.reverse()
 
79
        self._tests = []
 
80
        while tests:
 
81
            if result.shouldStop:
 
82
                self._tests = reversed(tests)
 
83
                break
 
84
            tests.pop().run(result)
 
85
        return result
 
86
 
70
87
 
71
88
class TestLoader(unittest.TestLoader):
72
 
    """Custome TestLoader to set the right TestSuite class."""
 
89
    """Custom TestLoader to extend the stock python one."""
 
90
 
73
91
    suiteClass = TestSuite
 
92
    # Memoize test names by test class dict
 
93
    test_func_names = {}
 
94
 
 
95
    def loadTestsFromModuleNames(self, names):
 
96
        """use a custom means to load tests from modules.
 
97
 
 
98
        There is an undesirable glitch in the python TestLoader where a
 
99
        import error is ignore. We think this can be solved by ensuring the
 
100
        requested name is resolvable, if its not raising the original error.
 
101
        """
 
102
        result = self.suiteClass()
 
103
        for name in names:
 
104
            result.addTests(self.loadTestsFromModuleName(name))
 
105
        return result
 
106
 
 
107
    def loadTestsFromModuleName(self, name):
 
108
        result = self.suiteClass()
 
109
        module = _load_module_by_name(name)
 
110
 
 
111
        result.addTests(self.loadTestsFromModule(module))
 
112
        return result
 
113
 
 
114
    def loadTestsFromModule(self, module):
 
115
        """Load tests from a module object.
 
116
 
 
117
        This extension of the python test loader looks for an attribute
 
118
        load_tests in the module object, and if not found falls back to the
 
119
        regular python loadTestsFromModule.
 
120
 
 
121
        If a load_tests attribute is found, it is called and the result is
 
122
        returned.
 
123
 
 
124
        load_tests should be defined like so:
 
125
        >>> def load_tests(standard_tests, module, loader):
 
126
        >>>    pass
 
127
 
 
128
        standard_tests is the tests found by the stock TestLoader in the
 
129
        module, module and loader are the module and loader instances.
 
130
 
 
131
        For instance, to run every test twice, you might do:
 
132
        >>> def load_tests(standard_tests, module, loader):
 
133
        >>>     result = loader.suiteClass()
 
134
        >>>     for test in iter_suite_tests(standard_tests):
 
135
        >>>         result.addTests([test, test])
 
136
        >>>     return result
 
137
        """
 
138
        basic_tests = super(TestLoader, self).loadTestsFromModule(module)
 
139
        load_tests = getattr(module, "load_tests", None)
 
140
        if load_tests is not None:
 
141
            return load_tests(basic_tests, module, self)
 
142
        else:
 
143
            return basic_tests
 
144
 
 
145
    def getTestCaseNames(self, test_case_class):
 
146
        test_fn_names = self.test_func_names.get(test_case_class, None)
 
147
        if test_fn_names is not None:
 
148
            # We already know them
 
149
            return test_fn_names
 
150
 
 
151
        test_fn_names = unittest.TestLoader.getTestCaseNames(self,
 
152
                                                             test_case_class)
 
153
        self.test_func_names[test_case_class] = test_fn_names
 
154
        return test_fn_names
 
155
 
 
156
 
 
157
class FilteredByModuleTestLoader(TestLoader):
 
158
    """A test loader that import only the needed modules."""
 
159
 
 
160
    def __init__(self, needs_module):
 
161
        """Constructor.
 
162
 
 
163
        :param needs_module: a callable taking a module name as a
 
164
            parameter returing True if the module should be loaded.
 
165
        """
 
166
        TestLoader.__init__(self)
 
167
        self.needs_module = needs_module
 
168
 
 
169
    def loadTestsFromModuleName(self, name):
 
170
        if self.needs_module(name):
 
171
            return TestLoader.loadTestsFromModuleName(self, name)
 
172
        else:
 
173
            return self.suiteClass()
 
174
 
 
175
 
 
176
def _load_module_by_name(mod_name):
 
177
    parts = mod_name.split('.')
 
178
    module = __import__(mod_name)
 
179
    del parts[0]
 
180
    # for historical reasons python returns the top-level module even though
 
181
    # it loads the submodule; we need to walk down to get the one we want.
 
182
    while parts:
 
183
        module = getattr(module, parts.pop(0))
 
184
    return module
 
185
 
74
186
 
75
187
class TestVisitor(object):
76
188
    """A visitor for Tests"""