← 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: Robert Collins
  • Date: 2010-04-08 04:34:03 UTC
  • mfrom: (5138 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5139.
  • Revision ID: robertc@robertcollins.net-20100408043403-56z0d07vdqrx7f3t
Update bugfix for 528114 to trunk.

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, 2007, 2009 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:
186
193
            self.assertTrue(deprecated_callable.is_deprecated)
187
194
        finally:
188
195
            symbol_versioning.set_warning_method(old_warning_method)
189
 
    
 
196
 
190
197
    def test_deprecated_passed(self):
191
198
        self.assertEqual(True, symbol_versioning.deprecated_passed(None))
192
199
        self.assertEqual(True, symbol_versioning.deprecated_passed(True))
199
206
        """We can get a deprecation string for a method or function."""
200
207
        self.assertEqual('bzrlib.tests.test_symbol_versioning.'
201
208
            'TestDeprecationWarnings.test_deprecation_string was deprecated in '
202
 
            'version 0.11.',
 
209
            'version 0.11.0.',
203
210
            symbol_versioning.deprecation_string(
204
 
            self.test_deprecation_string, symbol_versioning.zero_eleven))
 
211
            self.test_deprecation_string,
 
212
            deprecated_in((0, 11, 0))))
205
213
        self.assertEqual('bzrlib.symbol_versioning.deprecated_function was '
206
 
            'deprecated in version 0.11.',
 
214
            'deprecated in version 0.11.0.',
207
215
            symbol_versioning.deprecation_string(
208
216
                symbol_versioning.deprecated_function,
209
 
                symbol_versioning.zero_eleven))
 
217
                deprecated_in((0, 11, 0))))
 
218
 
 
219
 
 
220
class TestSuppressAndActivate(TestCase):
 
221
 
 
222
    def setUp(self):
 
223
        TestCase.setUp(self)
 
224
        existing_filters = list(warnings.filters)
 
225
        def restore():
 
226
            warnings.filters[:] = existing_filters
 
227
        self.addCleanup(restore)
 
228
        # Clean out the filters so we have a clean slate.
 
229
        warnings.resetwarnings()
 
230
 
 
231
    def assertFirstWarning(self, action, category):
 
232
        """Test the first warning in the filters is correct"""
 
233
        first = warnings.filters[0]
 
234
        self.assertEqual((action, category), (first[0], first[2]))
 
235
 
 
236
    def test_suppress_deprecation_warnings(self):
 
237
        """suppress_deprecation_warnings sets DeprecationWarning to ignored."""
 
238
        symbol_versioning.suppress_deprecation_warnings()
 
239
        self.assertFirstWarning('ignore', DeprecationWarning)
 
240
 
 
241
    def test_suppress_deprecation_with_warning_filter(self):
 
242
        """don't suppress if we already have a filter"""
 
243
        warnings.filterwarnings('error', category=Warning)
 
244
        self.assertFirstWarning('error', Warning)
 
245
        self.assertEqual(1, len(warnings.filters))
 
246
        symbol_versioning.suppress_deprecation_warnings(override=False)
 
247
        self.assertFirstWarning('error', Warning)
 
248
        self.assertEqual(1, len(warnings.filters))
 
249
 
 
250
    def test_suppress_deprecation_with_filter(self):
 
251
        """don't suppress if we already have a filter"""
 
252
        warnings.filterwarnings('error', category=DeprecationWarning)
 
253
        self.assertFirstWarning('error', DeprecationWarning)
 
254
        self.assertEqual(1, len(warnings.filters))
 
255
        symbol_versioning.suppress_deprecation_warnings(override=False)
 
256
        self.assertFirstWarning('error', DeprecationWarning)
 
257
        self.assertEqual(1, len(warnings.filters))
 
258
        symbol_versioning.suppress_deprecation_warnings(override=True)
 
259
        self.assertFirstWarning('ignore', DeprecationWarning)
 
260
        self.assertEqual(2, len(warnings.filters))
 
261
 
 
262
    def test_activate_deprecation_no_error(self):
 
263
        # First nuke the filters, so we know it is clean
 
264
        symbol_versioning.activate_deprecation_warnings()
 
265
        self.assertFirstWarning('default', DeprecationWarning)
 
266
 
 
267
    def test_activate_deprecation_with_error(self):
 
268
        # First nuke the filters, so we know it is clean
 
269
        # Add a warning == error rule
 
270
        warnings.filterwarnings('error', category=Warning)
 
271
        self.assertFirstWarning('error', Warning)
 
272
        self.assertEqual(1, len(warnings.filters))
 
273
        symbol_versioning.activate_deprecation_warnings(override=False)
 
274
        # There should not be a new warning
 
275
        self.assertFirstWarning('error', Warning)
 
276
        self.assertEqual(1, len(warnings.filters))
 
277
 
 
278
    def test_activate_deprecation_with_DW_error(self):
 
279
        # First nuke the filters, so we know it is clean
 
280
        # Add a warning == error rule
 
281
        warnings.filterwarnings('error', category=DeprecationWarning)
 
282
        self.assertFirstWarning('error', DeprecationWarning)
 
283
        self.assertEqual(1, len(warnings.filters))
 
284
        symbol_versioning.activate_deprecation_warnings(override=False)
 
285
        # There should not be a new warning
 
286
        self.assertFirstWarning('error', DeprecationWarning)
 
287
        self.assertEqual(1, len(warnings.filters))
 
288
        symbol_versioning.activate_deprecation_warnings(override=True)
 
289
        self.assertFirstWarning('default', DeprecationWarning)
 
290
        self.assertEqual(2, len(warnings.filters))