← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_symbol_versioning.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-11-06 16:01:48 UTC
  • mfrom: (5527.1.1 trunk)
  • Revision ID: pqm@pqm.ubuntu.com-20101106160148-8maemz21jbrhpzky
(vila) Move NEWS entry into the correct section (Vincent Ladeuil)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_symbol_versioning.py
1
 
# Copyright (C) 2006, 2007 Canonical Ltd
2
 
#   Authors: Robert Collins <robert.collins@canonical.com>
3
 
#   and others
 
1
# Copyright (C) 2006-2010 Canonical Ltd
4
2
#
5
3
# This program is free software; you can redistribute it and/or modify
6
4
# it under the terms of the GNU General Public License as published by
14
12
#
15
13
# You should have received a copy of the GNU General Public License
16
14
# along with this program; if not, write to the Free Software
17
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
16
 
19
17
"""Symbol versioning tests."""
20
18
 
21
 
import bzrlib.symbol_versioning as symbol_versioning
 
19
import warnings
 
20
 
 
21
from bzrlib import symbol_versioning
 
22
from bzrlib.symbol_versioning import (
 
23
    deprecated_function,
 
24
    deprecated_in,
 
25
    deprecated_list,
 
26
    deprecated_method,
 
27
    )
22
28
from bzrlib.tests import TestCase
23
29
 
24
30
 
25
 
@symbol_versioning.deprecated_function(symbol_versioning.zero_seven)
26
 
def deprecated_function():
 
31
@deprecated_function(deprecated_in((0, 7, 0)))
 
32
def sample_deprecated_function():
27
33
    """Deprecated function docstring."""
28
34
    return 1
29
35
 
30
36
 
31
 
a_deprecated_list = symbol_versioning.deprecated_list(symbol_versioning.zero_nine,
 
37
a_deprecated_list = symbol_versioning.deprecated_list(deprecated_in((0, 9, 0)),
32
38
    'a_deprecated_list', ['one'], extra="Don't use me")
33
39
 
34
40
 
35
41
a_deprecated_dict = symbol_versioning.DeprecatedDict(
36
 
    symbol_versioning.zero_fourteen,
 
42
    deprecated_in((0, 14, 0)),
37
43
    'a_deprecated_dict',
38
44
    dict(a=42),
39
45
    advice='Pull the other one!',
49
55
        super(TestDeprecationWarnings, self).setUp()
50
56
        self._warnings = []
51
57
    
52
 
    @symbol_versioning.deprecated_method(symbol_versioning.zero_seven)
 
58
    @deprecated_method(deprecated_in((0, 7, 0)))
53
59
    def deprecated_method(self):
54
60
        """Deprecated method docstring.
55
 
        
 
61
 
56
62
        This might explain stuff.
57
63
        """
58
64
        return 1
59
65
 
60
66
    @staticmethod
61
 
    @symbol_versioning.deprecated_function(symbol_versioning.zero_seven)
 
67
    @deprecated_function(deprecated_in((0, 7, 0)))
62
68
    def deprecated_static():
63
69
        """Deprecated static."""
64
70
        return 1
70
76
        expected_warning = (
71
77
            "bzrlib.tests.test_symbol_versioning."
72
78
            "deprecated_static "
73
 
            "was deprecated in version 0.7.", DeprecationWarning, 2)
 
79
            "was deprecated in version 0.7.0.", DeprecationWarning, 2)
74
80
        expected_docstring = (
75
81
            'Deprecated static.\n'
76
82
            '\n'
77
 
            'This function was deprecated in version 0.7.\n'
 
83
            'This function was deprecated in version 0.7.0.\n'
78
84
            )
79
85
        self.check_deprecated_callable(
80
86
            expected_warning, expected_docstring,
86
92
        expected_warning = (
87
93
            "bzrlib.tests.test_symbol_versioning."
88
94
            "TestDeprecationWarnings.deprecated_method "
89
 
            "was deprecated in version 0.7.", DeprecationWarning, 2)
90
 
        expected_docstring = ('Deprecated method docstring.\n'
91
 
                              '        \n'
92
 
                              '        This might explain stuff.\n'
93
 
                              '        \n'
94
 
                              '        This method was deprecated in version 0.7.\n'
95
 
                              '        ')
 
95
            "was deprecated in version 0.7.0.", DeprecationWarning, 2)
 
96
        expected_docstring = (
 
97
            'Deprecated method docstring.\n'
 
98
            '\n'
 
99
            '        This might explain stuff.\n'
 
100
            '        \n'
 
101
            '        This method was deprecated in version 0.7.0.\n'
 
102
            '        ')
96
103
        self.check_deprecated_callable(expected_warning, expected_docstring,
97
104
                                       "deprecated_method",
98
105
                                       "bzrlib.tests.test_symbol_versioning",
100
107
 
101
108
    def test_deprecated_function(self):
102
109
        expected_warning = (
103
 
            "bzrlib.tests.test_symbol_versioning.deprecated_function "
104
 
            "was deprecated in version 0.7.", DeprecationWarning, 2)
 
110
            "bzrlib.tests.test_symbol_versioning.sample_deprecated_function "
 
111
            "was deprecated in version 0.7.0.", DeprecationWarning, 2)
105
112
        expected_docstring = ('Deprecated function docstring.\n'
106
113
                              '\n'
107
 
                              'This function was deprecated in version 0.7.\n'
 
114
                              'This function was deprecated in version 0.7.0.\n'
108
115
                              )
109
116
        self.check_deprecated_callable(expected_warning, expected_docstring,
110
 
                                       "deprecated_function",
 
117
                                       "sample_deprecated_function",
111
118
                                       "bzrlib.tests.test_symbol_versioning",
112
 
                                       deprecated_function)
 
119
                                       sample_deprecated_function)
113
120
 
114
121
    def test_deprecated_list(self):
115
122
        expected_warning = (
116
 
            "Modifying a_deprecated_list was deprecated in version 0.9."
 
123
            "Modifying a_deprecated_list was deprecated in version 0.9.0."
117
124
            " Don't use me", DeprecationWarning, 3)
118
125
        old_warning_method = symbol_versioning.warn
119
126
        try:
151
158
 
152
159
    def test_deprecated_dict(self):
153
160
        expected_warning = (
154
 
            "access to a_deprecated_dict was deprecated in version 0.14."
 
161
            "access to a_deprecated_dict was deprecated in version 0.14.0."
155
162
            " Pull the other one!", DeprecationWarning, 2)
156
163
        old_warning_method = symbol_versioning.warn
157
164
        try:
172
179
    def check_deprecated_callable(self, expected_warning, expected_docstring,
173
180
                                  expected_name, expected_module,
174
181
                                  deprecated_callable):
 
182
        if __doc__ is None:
 
183
            # With -OO the docstring should just be the deprecated version
 
184
            expected_docstring = expected_docstring.split('\n')[-2].lstrip()
175
185
        old_warning_method = symbol_versioning.warn
176
186
        try:
177
187
            symbol_versioning.set_warning_method(self.capture_warning)
186
196
            self.assertTrue(deprecated_callable.is_deprecated)
187
197
        finally:
188
198
            symbol_versioning.set_warning_method(old_warning_method)
189
 
    
 
199
 
190
200
    def test_deprecated_passed(self):
191
201
        self.assertEqual(True, symbol_versioning.deprecated_passed(None))
192
202
        self.assertEqual(True, symbol_versioning.deprecated_passed(True))
199
209
        """We can get a deprecation string for a method or function."""
200
210
        self.assertEqual('bzrlib.tests.test_symbol_versioning.'
201
211
            'TestDeprecationWarnings.test_deprecation_string was deprecated in '
202
 
            'version 0.11.',
 
212
            'version 0.11.0.',
203
213
            symbol_versioning.deprecation_string(
204
 
            self.test_deprecation_string, symbol_versioning.zero_eleven))
 
214
            self.test_deprecation_string,
 
215
            deprecated_in((0, 11, 0))))
205
216
        self.assertEqual('bzrlib.symbol_versioning.deprecated_function was '
206
 
            'deprecated in version 0.11.',
 
217
            'deprecated in version 0.11.0.',
207
218
            symbol_versioning.deprecation_string(
208
219
                symbol_versioning.deprecated_function,
209
 
                symbol_versioning.zero_eleven))
 
220
                deprecated_in((0, 11, 0))))
 
221
 
 
222
 
 
223
class TestSuppressAndActivate(TestCase):
 
224
 
 
225
    def setUp(self):
 
226
        TestCase.setUp(self)
 
227
        existing_filters = list(warnings.filters)
 
228
        def restore():
 
229
            warnings.filters[:] = existing_filters
 
230
        self.addCleanup(restore)
 
231
        # Clean out the filters so we have a clean slate.
 
232
        warnings.resetwarnings()
 
233
 
 
234
    def assertFirstWarning(self, action, category):
 
235
        """Test the first warning in the filters is correct"""
 
236
        first = warnings.filters[0]
 
237
        self.assertEqual((action, category), (first[0], first[2]))
 
238
 
 
239
    def test_suppress_deprecation_warnings(self):
 
240
        """suppress_deprecation_warnings sets DeprecationWarning to ignored."""
 
241
        symbol_versioning.suppress_deprecation_warnings()
 
242
        self.assertFirstWarning('ignore', DeprecationWarning)
 
243
 
 
244
    def test_set_restore_filters(self):
 
245
        original_filters = warnings.filters[:]
 
246
        symbol_versioning.suppress_deprecation_warnings()()
 
247
        self.assertEqual(original_filters, warnings.filters)
 
248
 
 
249
    def test_suppress_deprecation_with_warning_filter(self):
 
250
        """don't suppress if we already have a filter"""
 
251
        warnings.filterwarnings('error', category=Warning)
 
252
        self.assertFirstWarning('error', Warning)
 
253
        self.assertEqual(1, len(warnings.filters))
 
254
        symbol_versioning.suppress_deprecation_warnings(override=False)
 
255
        self.assertFirstWarning('error', Warning)
 
256
        self.assertEqual(1, len(warnings.filters))
 
257
 
 
258
    def test_suppress_deprecation_with_filter(self):
 
259
        """don't suppress if we already have a filter"""
 
260
        warnings.filterwarnings('error', category=DeprecationWarning)
 
261
        self.assertFirstWarning('error', DeprecationWarning)
 
262
        self.assertEqual(1, len(warnings.filters))
 
263
        symbol_versioning.suppress_deprecation_warnings(override=False)
 
264
        self.assertFirstWarning('error', DeprecationWarning)
 
265
        self.assertEqual(1, len(warnings.filters))
 
266
        symbol_versioning.suppress_deprecation_warnings(override=True)
 
267
        self.assertFirstWarning('ignore', DeprecationWarning)
 
268
        self.assertEqual(2, len(warnings.filters))
 
269
 
 
270
    def test_activate_deprecation_no_error(self):
 
271
        # First nuke the filters, so we know it is clean
 
272
        symbol_versioning.activate_deprecation_warnings()
 
273
        self.assertFirstWarning('default', DeprecationWarning)
 
274
 
 
275
    def test_activate_deprecation_with_error(self):
 
276
        # First nuke the filters, so we know it is clean
 
277
        # Add a warning == error rule
 
278
        warnings.filterwarnings('error', category=Warning)
 
279
        self.assertFirstWarning('error', Warning)
 
280
        self.assertEqual(1, len(warnings.filters))
 
281
        symbol_versioning.activate_deprecation_warnings(override=False)
 
282
        # There should not be a new warning
 
283
        self.assertFirstWarning('error', Warning)
 
284
        self.assertEqual(1, len(warnings.filters))
 
285
 
 
286
    def test_activate_deprecation_with_DW_error(self):
 
287
        # First nuke the filters, so we know it is clean
 
288
        # Add a warning == error rule
 
289
        warnings.filterwarnings('error', category=DeprecationWarning)
 
290
        self.assertFirstWarning('error', DeprecationWarning)
 
291
        self.assertEqual(1, len(warnings.filters))
 
292
        symbol_versioning.activate_deprecation_warnings(override=False)
 
293
        # There should not be a new warning
 
294
        self.assertFirstWarning('error', DeprecationWarning)
 
295
        self.assertEqual(1, len(warnings.filters))
 
296
        symbol_versioning.activate_deprecation_warnings(override=True)
 
297
        self.assertFirstWarning('default', DeprecationWarning)
 
298
        self.assertEqual(2, len(warnings.filters))