/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_symbol_versioning.py

  • Committer: John Arbash Meinel
  • Date: 2006-04-25 15:05:42 UTC
  • mfrom: (1185.85.85 bzr-encoding)
  • mto: This revision was merged to the branch mainline in revision 1752.
  • Revision ID: john@arbash-meinel.com-20060425150542-c7b518dca9928691
[merge] the old bzr-encoding changes, reparenting them on bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_symbol_versioning.py
1
 
# Copyright (C) 2006-2011 Canonical Ltd
 
1
# Copyright (C) 2006 by Canonical Ltd
 
2
#   Authors: Robert Collins <robert.collins@canonical.com>
2
3
#
3
4
# This program is free software; you can redistribute it and/or modify
4
5
# it under the terms of the GNU General Public License as published by
12
13
#
13
14
# You should have received a copy of the GNU General Public License
14
15
# along with this program; if not, write to the Free Software
15
 
# 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
16
17
 
17
18
"""Symbol versioning tests."""
18
19
 
19
 
import warnings
20
 
 
21
 
from breezy import symbol_versioning
22
 
from breezy.sixish import PY3
23
 
from breezy.symbol_versioning import (
24
 
    deprecated_function,
25
 
    deprecated_in,
26
 
    deprecated_method,
27
 
    )
28
 
from breezy.tests import TestCase
29
 
 
30
 
 
31
 
@deprecated_function(deprecated_in((0, 7, 0)))
32
 
def sample_deprecated_function():
 
20
import bzrlib.symbol_versioning as symbol_versioning
 
21
from bzrlib.tests import TestCase
 
22
 
 
23
 
 
24
@symbol_versioning.deprecated_function(symbol_versioning.zero_seven)
 
25
def deprecated_function():
33
26
    """Deprecated function docstring."""
34
27
    return 1
35
28
 
36
29
 
37
 
a_deprecated_list = symbol_versioning.deprecated_list(deprecated_in((0, 9, 0)),
38
 
                                                      'a_deprecated_list', ['one'], extra="Don't use me")
39
 
 
40
 
 
41
 
a_deprecated_dict = symbol_versioning.DeprecatedDict(
42
 
    deprecated_in((0, 14, 0)),
43
 
    'a_deprecated_dict',
44
 
    dict(a=42),
45
 
    advice='Pull the other one!',
46
 
    )
47
 
 
48
 
 
49
30
class TestDeprecationWarnings(TestCase):
50
31
 
51
32
    def capture_warning(self, message, category, stacklevel=None):
54
35
    def setUp(self):
55
36
        super(TestDeprecationWarnings, self).setUp()
56
37
        self._warnings = []
57
 
 
58
 
    @deprecated_method(deprecated_in((0, 7, 0)))
 
38
    
 
39
    @symbol_versioning.deprecated_method(symbol_versioning.zero_seven)
59
40
    def deprecated_method(self):
60
41
        """Deprecated method docstring.
61
 
 
 
42
        
62
43
        This might explain stuff.
63
44
        """
64
45
        return 1
65
46
 
66
 
    @staticmethod
67
 
    @deprecated_function(deprecated_in((0, 7, 0)))
68
 
    def deprecated_static():
69
 
        """Deprecated static."""
70
 
        return 1
71
 
 
72
 
    def test_deprecated_static(self):
73
 
        if PY3:
74
 
            expected_warning = (
75
 
                "breezy.tests.test_symbol_versioning.TestDeprecationWarnings."
76
 
                "deprecated_static "
77
 
                "was deprecated in version 0.7.0.", DeprecationWarning, 2)
78
 
        else:
79
 
            # XXX: The results are not quite right because the class name is not
80
 
            # shown on Python 2- however it is enough to give people a good indication of
81
 
            # where the problem is.
82
 
            expected_warning = (
83
 
                "breezy.tests.test_symbol_versioning."
84
 
                "deprecated_static "
85
 
                "was deprecated in version 0.7.0.", DeprecationWarning, 2)
86
 
        expected_docstring = (
87
 
            'Deprecated static.\n'
88
 
            '\n'
89
 
            'This function was deprecated in version 0.7.0.\n'
90
 
            )
91
 
        self.check_deprecated_callable(
92
 
            expected_warning, expected_docstring,
93
 
            "deprecated_static",
94
 
            "breezy.tests.test_symbol_versioning",
95
 
            self.deprecated_static)
96
 
 
97
47
    def test_deprecated_method(self):
98
48
        expected_warning = (
99
 
            "breezy.tests.test_symbol_versioning."
 
49
            "bzrlib.tests.test_symbol_versioning."
100
50
            "TestDeprecationWarnings.deprecated_method "
101
 
            "was deprecated in version 0.7.0.", DeprecationWarning, 2)
102
 
        expected_docstring = (
103
 
            'Deprecated method docstring.\n'
104
 
            '\n'
105
 
            '        This might explain stuff.\n'
106
 
            '        \n'
107
 
            '        This method was deprecated in version 0.7.0.\n'
108
 
            '        ')
 
51
            "was deprecated in version 0.7.", DeprecationWarning, 2)
 
52
        expected_docstring = ('Deprecated method docstring.\n'
 
53
                              '        \n'
 
54
                              '        This might explain stuff.\n'
 
55
                              '        \n'
 
56
                              '        This method was deprecated in version 0.7.\n'
 
57
                              '        ')
109
58
        self.check_deprecated_callable(expected_warning, expected_docstring,
110
59
                                       "deprecated_method",
111
 
                                       "breezy.tests.test_symbol_versioning",
 
60
                                       "bzrlib.tests.test_symbol_versioning",
112
61
                                       self.deprecated_method)
113
62
 
114
63
    def test_deprecated_function(self):
115
64
        expected_warning = (
116
 
            "breezy.tests.test_symbol_versioning.sample_deprecated_function "
117
 
            "was deprecated in version 0.7.0.", DeprecationWarning, 2)
 
65
            "bzrlib.tests.test_symbol_versioning.deprecated_function "
 
66
            "was deprecated in version 0.7.", DeprecationWarning, 2)
118
67
        expected_docstring = ('Deprecated function docstring.\n'
119
68
                              '\n'
120
 
                              'This function was deprecated in version 0.7.0.\n'
 
69
                              'This function was deprecated in version 0.7.\n'
121
70
                              )
122
71
        self.check_deprecated_callable(expected_warning, expected_docstring,
123
 
                                       "sample_deprecated_function",
124
 
                                       "breezy.tests.test_symbol_versioning",
125
 
                                       sample_deprecated_function)
126
 
 
127
 
    def test_deprecated_list(self):
128
 
        expected_warning = (
129
 
            "Modifying a_deprecated_list was deprecated in version 0.9.0."
130
 
            " Don't use me", DeprecationWarning, 3)
131
 
        old_warning_method = symbol_versioning.warn
132
 
        try:
133
 
            symbol_versioning.set_warning_method(self.capture_warning)
134
 
            self.assertEqual(['one'], a_deprecated_list)
135
 
            self.assertEqual([], self._warnings)
136
 
 
137
 
            a_deprecated_list.append('foo')
138
 
            self.assertEqual([expected_warning], self._warnings)
139
 
            self.assertEqual(['one', 'foo'], a_deprecated_list)
140
 
 
141
 
            a_deprecated_list.extend(['bar', 'baz'])
142
 
            self.assertEqual([expected_warning] * 2, self._warnings)
143
 
            self.assertEqual(['one', 'foo', 'bar', 'baz'], a_deprecated_list)
144
 
 
145
 
            a_deprecated_list.insert(1, 'xxx')
146
 
            self.assertEqual([expected_warning] * 3, self._warnings)
147
 
            self.assertEqual(
148
 
                ['one', 'xxx', 'foo', 'bar', 'baz'], a_deprecated_list)
149
 
 
150
 
            a_deprecated_list.remove('foo')
151
 
            self.assertEqual([expected_warning] * 4, self._warnings)
152
 
            self.assertEqual(['one', 'xxx', 'bar', 'baz'], a_deprecated_list)
153
 
 
154
 
            val = a_deprecated_list.pop()
155
 
            self.assertEqual([expected_warning] * 5, self._warnings)
156
 
            self.assertEqual('baz', val)
157
 
            self.assertEqual(['one', 'xxx', 'bar'], a_deprecated_list)
158
 
 
159
 
            val = a_deprecated_list.pop(1)
160
 
            self.assertEqual([expected_warning] * 6, self._warnings)
161
 
            self.assertEqual('xxx', val)
162
 
            self.assertEqual(['one', 'bar'], a_deprecated_list)
163
 
        finally:
164
 
            symbol_versioning.set_warning_method(old_warning_method)
165
 
 
166
 
    def test_deprecated_dict(self):
167
 
        expected_warning = (
168
 
            "access to a_deprecated_dict was deprecated in version 0.14.0."
169
 
            " Pull the other one!", DeprecationWarning, 2)
170
 
        old_warning_method = symbol_versioning.warn
171
 
        try:
172
 
            symbol_versioning.set_warning_method(self.capture_warning)
173
 
            self.assertEqual(len(a_deprecated_dict), 1)
174
 
            self.assertEqual([expected_warning], self._warnings)
175
 
 
176
 
            a_deprecated_dict['b'] = 42
177
 
            self.assertEqual(a_deprecated_dict['b'], 42)
178
 
            self.assertTrue('b' in a_deprecated_dict)
179
 
            del a_deprecated_dict['b']
180
 
            self.assertFalse('b' in a_deprecated_dict)
181
 
            self.assertEqual([expected_warning] * 6, self._warnings)
182
 
        finally:
183
 
            symbol_versioning.set_warning_method(old_warning_method)
 
72
                                       "deprecated_function",
 
73
                                       "bzrlib.tests.test_symbol_versioning",
 
74
                                       deprecated_function)
184
75
 
185
76
    def check_deprecated_callable(self, expected_warning, expected_docstring,
186
77
                                  expected_name, expected_module,
187
78
                                  deprecated_callable):
188
 
        if __doc__ is None:
189
 
            # With -OO the docstring should just be the deprecated version
190
 
            expected_docstring = expected_docstring.split('\n')[-2].lstrip()
191
79
        old_warning_method = symbol_versioning.warn
192
80
        try:
193
81
            symbol_versioning.set_warning_method(self.capture_warning)
196
84
            deprecated_callable()
197
85
            self.assertEqual([expected_warning, expected_warning],
198
86
                             self._warnings)
199
 
            self.assertEqualDiff(expected_docstring,
200
 
                                 deprecated_callable.__doc__)
 
87
            self.assertEqualDiff(expected_docstring, deprecated_callable.__doc__)
201
88
            self.assertEqualDiff(expected_name, deprecated_callable.__name__)
202
 
            self.assertEqualDiff(
203
 
                expected_module, deprecated_callable.__module__)
 
89
            self.assertEqualDiff(expected_module, deprecated_callable.__module__)
204
90
            self.assertTrue(deprecated_callable.is_deprecated)
205
91
        finally:
206
92
            symbol_versioning.set_warning_method(old_warning_method)
207
 
 
 
93
    
208
94
    def test_deprecated_passed(self):
209
95
        self.assertEqual(True, symbol_versioning.deprecated_passed(None))
210
96
        self.assertEqual(True, symbol_versioning.deprecated_passed(True))
211
97
        self.assertEqual(True, symbol_versioning.deprecated_passed(False))
212
98
        self.assertEqual(False,
213
99
                         symbol_versioning.deprecated_passed(
214
 
                             symbol_versioning.DEPRECATED_PARAMETER))
215
 
 
216
 
    def test_deprecation_string(self):
217
 
        """We can get a deprecation string for a method or function."""
218
 
        err_message = symbol_versioning.deprecation_string(
219
 
            self.test_deprecation_string,
220
 
            deprecated_in((0, 11, 0)))
221
 
        self.assertEqual(err_message,
222
 
                         'breezy.tests.test_symbol_versioning.TestDeprecationWarnings.'
223
 
                         'test_deprecation_string was deprecated in '
224
 
                         'version 0.11.0.')
225
 
 
226
 
        self.assertEqual('breezy.symbol_versioning.deprecated_function was '
227
 
                         'deprecated in version 0.11.0.',
228
 
                         symbol_versioning.deprecation_string(
229
 
                             symbol_versioning.deprecated_function,
230
 
                             deprecated_in((0, 11, 0))))
231
 
 
232
 
 
233
 
class TestSuppressAndActivate(TestCase):
234
 
 
235
 
    def setUp(self):
236
 
        super(TestSuppressAndActivate, self).setUp()
237
 
        existing_filters = list(warnings.filters)
238
 
 
239
 
        def restore():
240
 
            warnings.filters[:] = existing_filters
241
 
        self.addCleanup(restore)
242
 
        # Clean out the filters so we have a clean slate.
243
 
        warnings.resetwarnings()
244
 
 
245
 
    def assertFirstWarning(self, action, category):
246
 
        """Test the first warning in the filters is correct"""
247
 
        first = warnings.filters[0]
248
 
        self.assertEqual((action, category), (first[0], first[2]))
249
 
 
250
 
    def test_suppress_deprecation_warnings(self):
251
 
        """suppress_deprecation_warnings sets DeprecationWarning to ignored."""
252
 
        symbol_versioning.suppress_deprecation_warnings()
253
 
        self.assertFirstWarning('ignore', DeprecationWarning)
254
 
 
255
 
    def test_set_restore_filters(self):
256
 
        original_filters = warnings.filters[:]
257
 
        symbol_versioning.suppress_deprecation_warnings()()
258
 
        self.assertEqual(original_filters, warnings.filters)
259
 
 
260
 
    def test_suppress_deprecation_with_warning_filter(self):
261
 
        """don't suppress if we already have a filter"""
262
 
        warnings.filterwarnings('error', category=Warning)
263
 
        self.assertFirstWarning('error', Warning)
264
 
        self.assertEqual(1, len(warnings.filters))
265
 
        symbol_versioning.suppress_deprecation_warnings(override=False)
266
 
        self.assertFirstWarning('error', Warning)
267
 
        self.assertEqual(1, len(warnings.filters))
268
 
 
269
 
    def test_suppress_deprecation_with_filter(self):
270
 
        """don't suppress if we already have a filter"""
271
 
        warnings.filterwarnings('error', category=DeprecationWarning)
272
 
        self.assertFirstWarning('error', DeprecationWarning)
273
 
        self.assertEqual(1, len(warnings.filters))
274
 
        symbol_versioning.suppress_deprecation_warnings(override=False)
275
 
        self.assertFirstWarning('error', DeprecationWarning)
276
 
        self.assertEqual(1, len(warnings.filters))
277
 
        symbol_versioning.suppress_deprecation_warnings(override=True)
278
 
        self.assertFirstWarning('ignore', DeprecationWarning)
279
 
        self.assertEqual(2, len(warnings.filters))
280
 
 
281
 
    def test_activate_deprecation_no_error(self):
282
 
        # First nuke the filters, so we know it is clean
283
 
        symbol_versioning.activate_deprecation_warnings()
284
 
        self.assertFirstWarning('default', DeprecationWarning)
285
 
 
286
 
    def test_activate_deprecation_with_error(self):
287
 
        # First nuke the filters, so we know it is clean
288
 
        # Add a warning == error rule
289
 
        warnings.filterwarnings('error', category=Warning)
290
 
        self.assertFirstWarning('error', Warning)
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', Warning)
295
 
        self.assertEqual(1, len(warnings.filters))
296
 
 
297
 
    def test_activate_deprecation_with_DW_error(self):
298
 
        # First nuke the filters, so we know it is clean
299
 
        # Add a warning == error rule
300
 
        warnings.filterwarnings('error', category=DeprecationWarning)
301
 
        self.assertFirstWarning('error', DeprecationWarning)
302
 
        self.assertEqual(1, len(warnings.filters))
303
 
        symbol_versioning.activate_deprecation_warnings(override=False)
304
 
        # There should not be a new warning
305
 
        self.assertFirstWarning('error', DeprecationWarning)
306
 
        self.assertEqual(1, len(warnings.filters))
307
 
        symbol_versioning.activate_deprecation_warnings(override=True)
308
 
        self.assertFirstWarning('default', DeprecationWarning)
309
 
        self.assertEqual(2, len(warnings.filters))
 
100
                            symbol_versioning.DEPRECATED_PARAMETER))