← 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: 2007-07-13 04:22:17 UTC
  • mto: This revision was merged to the branch mainline in revision 2618.
  • Revision ID: mbp@sourcefrog.net-20070713042217-mnkwb9przs8x2de0
Move bencode tests from within their module into our test suite

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/TestUtil.py
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
17
#
18
18
 
19
19
import sys
20
20
import logging
21
21
import unittest
22
22
 
23
 
from bzrlib import pyutils
24
 
 
25
23
# Mark this python module as being part of the implementation
26
24
# of unittest: this gives us better tracebacks where the last
27
25
# shown frame is the test code, not our assertXYZ.
29
27
 
30
28
 
31
29
class LogCollector(logging.Handler):
32
 
 
33
30
    def __init__(self):
34
31
        logging.Handler.__init__(self)
35
32
        self.records=[]
36
 
 
37
33
    def emit(self, record):
38
34
        self.records.append(record.getMessage())
39
35
 
51
47
def visitTests(suite, visitor):
52
48
    """A foreign method for visiting the tests in a test suite."""
53
49
    for test in suite._tests:
54
 
        #Abusing types to avoid monkey patching unittest.TestCase.
 
50
        #Abusing types to avoid monkey patching unittest.TestCase. 
55
51
        # Maybe that would be better?
56
52
        try:
57
53
            test.visit(visitor)
62
58
                visitor.visitSuite(test)
63
59
                visitTests(test, visitor)
64
60
            else:
65
 
                print "unvisitable non-unittest.TestCase element %r (%r)" % (
66
 
                    test, test.__class__)
67
 
 
 
61
                print "unvisitable non-unittest.TestCase element %r (%r)" % (test, test.__class__)
 
62
    
68
63
 
69
64
class TestSuite(unittest.TestSuite):
70
65
    """I am an extended TestSuite with a visitor interface.
77
72
        visitor.visitSuite(self)
78
73
        visitTests(self, visitor)
79
74
 
80
 
    def run(self, result):
81
 
        """Run the tests in the suite, discarding references after running."""
82
 
        tests = list(self)
83
 
        tests.reverse()
84
 
        self._tests = []
85
 
        while tests:
86
 
            if result.shouldStop:
87
 
                self._tests = reversed(tests)
88
 
                break
89
 
            tests.pop().run(result)
90
 
        return result
91
 
 
92
75
 
93
76
class TestLoader(unittest.TestLoader):
94
 
    """Custom TestLoader to extend the stock python one."""
95
 
 
 
77
    """Custom  TestLoader to address some quirks in the stock python one."""
96
78
    suiteClass = TestSuite
97
 
    # Memoize test names by test class dict
98
 
    test_func_names = {}
99
79
 
100
80
    def loadTestsFromModuleNames(self, names):
101
81
        """use a custom means to load tests from modules.
102
82
 
103
 
        There is an undesirable glitch in the python TestLoader where a
104
 
        import error is ignore. We think this can be solved by ensuring the
 
83
        There is an undesirable glitch in the python TestLoader where a 
 
84
        import error is ignore. We think this can be solved by ensuring the 
105
85
        requested name is resolvable, if its not raising the original error.
106
86
        """
107
87
        result = self.suiteClass()
108
88
        for name in names:
109
 
            result.addTests(self.loadTestsFromModuleName(name))
110
 
        return result
111
 
 
112
 
    def loadTestsFromModuleName(self, name):
113
 
        result = self.suiteClass()
114
 
        module = pyutils.get_named_object(name)
115
 
 
116
 
        result.addTests(self.loadTestsFromModule(module))
117
 
        return result
118
 
 
119
 
    def loadTestsFromModule(self, module):
120
 
        """Load tests from a module object.
121
 
 
122
 
        This extension of the python test loader looks for an attribute
123
 
        load_tests in the module object, and if not found falls back to the
124
 
        regular python loadTestsFromModule.
125
 
 
126
 
        If a load_tests attribute is found, it is called and the result is
127
 
        returned.
128
 
 
129
 
        load_tests should be defined like so:
130
 
        >>> def load_tests(standard_tests, module, loader):
131
 
        >>>    pass
132
 
 
133
 
        standard_tests is the tests found by the stock TestLoader in the
134
 
        module, module and loader are the module and loader instances.
135
 
 
136
 
        For instance, to run every test twice, you might do:
137
 
        >>> def load_tests(standard_tests, module, loader):
138
 
        >>>     result = loader.suiteClass()
139
 
        >>>     for test in iter_suite_tests(standard_tests):
140
 
        >>>         result.addTests([test, test])
141
 
        >>>     return result
142
 
        """
143
 
        if sys.version_info < (2, 7):
144
 
            basic_tests = super(TestLoader, self).loadTestsFromModule(module)
145
 
        else:
146
 
            # GZ 2010-07-19: Python 2.7 unittest also uses load_tests but with
147
 
            #                a different and incompatible signature
148
 
            basic_tests = super(TestLoader, self).loadTestsFromModule(module,
149
 
                use_load_tests=False)
150
 
        load_tests = getattr(module, "load_tests", None)
151
 
        if load_tests is not None:
152
 
            return load_tests(basic_tests, module, self)
153
 
        else:
154
 
            return basic_tests
155
 
 
156
 
    def getTestCaseNames(self, test_case_class):
157
 
        test_fn_names = self.test_func_names.get(test_case_class, None)
158
 
        if test_fn_names is not None:
159
 
            # We already know them
160
 
            return test_fn_names
161
 
 
162
 
        test_fn_names = unittest.TestLoader.getTestCaseNames(self,
163
 
                                                             test_case_class)
164
 
        self.test_func_names[test_case_class] = test_fn_names
165
 
        return test_fn_names
166
 
 
167
 
 
168
 
class FilteredByModuleTestLoader(TestLoader):
169
 
    """A test loader that import only the needed modules."""
170
 
 
171
 
    def __init__(self, needs_module):
172
 
        """Constructor.
173
 
 
174
 
        :param needs_module: a callable taking a module name as a
175
 
            parameter returing True if the module should be loaded.
176
 
        """
177
 
        TestLoader.__init__(self)
178
 
        self.needs_module = needs_module
179
 
 
180
 
    def loadTestsFromModuleName(self, name):
181
 
        if self.needs_module(name):
182
 
            return TestLoader.loadTestsFromModuleName(self, name)
183
 
        else:
184
 
            return self.suiteClass()
 
89
            _load_module_by_name(name)
 
90
            result.addTests(self.loadTestsFromName(name))
 
91
        return result
 
92
 
 
93
 
 
94
def _load_module_by_name(mod_name):
 
95
    parts = mod_name.split('.')
 
96
    module = __import__(mod_name)
 
97
    del parts[0]
 
98
    # for historical reasons python returns the top-level module even though
 
99
    # it loads the submodule; we need to walk down to get the one we want.
 
100
    while parts:
 
101
        module = getattr(module, parts.pop(0))
 
102
    return module
185
103
 
186
104
 
187
105
class TestVisitor(object):
188
106
    """A visitor for Tests"""
189
 
 
190
107
    def visitSuite(self, aTestSuite):
191
108
        pass
192
 
 
193
109
    def visitCase(self, aTestCase):
194
110
        pass