/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 breezy/tests/test_symbol_versioning.py

  • Committer: Jelmer Vernooij
  • Date: 2019-08-12 20:24:50 UTC
  • mto: (7290.1.35 work)
  • mto: This revision was merged to the branch mainline in revision 7405.
  • Revision ID: jelmer@jelmer.uk-20190812202450-vdpamxay6sebo93w
Fix path to brz.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/tests/test_symbol_versioning.py
 
1
# Copyright (C) 2006-2011 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# 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
 
 
17
"""Symbol versioning tests."""
 
18
 
 
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():
 
33
    """Deprecated function docstring."""
 
34
    return 1
 
35
 
 
36
 
 
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
class TestDeprecationWarnings(TestCase):
 
50
 
 
51
    def capture_warning(self, message, category, stacklevel=None):
 
52
        self._warnings.append((message, category, stacklevel))
 
53
 
 
54
    def setUp(self):
 
55
        super(TestDeprecationWarnings, self).setUp()
 
56
        self._warnings = []
 
57
 
 
58
    @deprecated_method(deprecated_in((0, 7, 0)))
 
59
    def deprecated_method(self):
 
60
        """Deprecated method docstring.
 
61
 
 
62
        This might explain stuff.
 
63
        """
 
64
        return 1
 
65
 
 
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
    def test_deprecated_method(self):
 
98
        expected_warning = (
 
99
            "breezy.tests.test_symbol_versioning."
 
100
            "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
            '        ')
 
109
        self.check_deprecated_callable(expected_warning, expected_docstring,
 
110
                                       "deprecated_method",
 
111
                                       "breezy.tests.test_symbol_versioning",
 
112
                                       self.deprecated_method)
 
113
 
 
114
    def test_deprecated_function(self):
 
115
        expected_warning = (
 
116
            "breezy.tests.test_symbol_versioning.sample_deprecated_function "
 
117
            "was deprecated in version 0.7.0.", DeprecationWarning, 2)
 
118
        expected_docstring = ('Deprecated function docstring.\n'
 
119
                              '\n'
 
120
                              'This function was deprecated in version 0.7.0.\n'
 
121
                              )
 
122
        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)
 
184
 
 
185
    def check_deprecated_callable(self, expected_warning, expected_docstring,
 
186
                                  expected_name, expected_module,
 
187
                                  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
        old_warning_method = symbol_versioning.warn
 
192
        try:
 
193
            symbol_versioning.set_warning_method(self.capture_warning)
 
194
            self.assertEqual(1, deprecated_callable())
 
195
            self.assertEqual([expected_warning], self._warnings)
 
196
            deprecated_callable()
 
197
            self.assertEqual([expected_warning, expected_warning],
 
198
                             self._warnings)
 
199
            self.assertEqualDiff(expected_docstring,
 
200
                                 deprecated_callable.__doc__)
 
201
            self.assertEqualDiff(expected_name, deprecated_callable.__name__)
 
202
            self.assertEqualDiff(
 
203
                expected_module, deprecated_callable.__module__)
 
204
            self.assertTrue(deprecated_callable.is_deprecated)
 
205
        finally:
 
206
            symbol_versioning.set_warning_method(old_warning_method)
 
207
 
 
208
    def test_deprecated_passed(self):
 
209
        self.assertEqual(True, symbol_versioning.deprecated_passed(None))
 
210
        self.assertEqual(True, symbol_versioning.deprecated_passed(True))
 
211
        self.assertEqual(True, symbol_versioning.deprecated_passed(False))
 
212
        self.assertEqual(False,
 
213
                         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))