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
17
18
"""Symbol versioning tests."""
21
from bzrlib import symbol_versioning
22
from bzrlib.symbol_versioning import (
20
import bzrlib.symbol_versioning as symbol_versioning
28
21
from bzrlib.tests import TestCase
31
@deprecated_function(deprecated_in((0, 7, 0)))
32
def sample_deprecated_function():
24
@symbol_versioning.deprecated_function(symbol_versioning.zero_seven)
25
def deprecated_function():
33
26
"""Deprecated function docstring."""
37
a_deprecated_list = symbol_versioning.deprecated_list(deprecated_in((0, 9, 0)),
30
a_deprecated_list = symbol_versioning.deprecated_list(symbol_versioning.zero_nine,
38
31
'a_deprecated_list', ['one'], extra="Don't use me")
41
a_deprecated_dict = symbol_versioning.DeprecatedDict(
42
deprecated_in((0, 14, 0)),
45
advice='Pull the other one!',
49
34
class TestDeprecationWarnings(TestCase):
51
36
def capture_warning(self, message, category, stacklevel=None):
55
40
super(TestDeprecationWarnings, self).setUp()
56
41
self._warnings = []
58
@deprecated_method(deprecated_in((0, 7, 0)))
43
@symbol_versioning.deprecated_method(symbol_versioning.zero_seven)
59
44
def deprecated_method(self):
60
45
"""Deprecated method docstring.
62
47
This might explain stuff.
67
@deprecated_function(deprecated_in((0, 7, 0)))
68
def deprecated_static():
69
"""Deprecated static."""
72
def test_deprecated_static(self):
73
# XXX: The results are not quite right because the class name is not
74
# shown - however it is enough to give people a good indication of
75
# where the problem is.
77
"bzrlib.tests.test_symbol_versioning."
79
"was deprecated in version 0.7.", DeprecationWarning, 2)
80
expected_docstring = (
81
'Deprecated static.\n'
83
'This function was deprecated in version 0.7.\n'
85
self.check_deprecated_callable(
86
expected_warning, expected_docstring,
88
"bzrlib.tests.test_symbol_versioning",
89
self.deprecated_static)
91
51
def test_deprecated_method(self):
92
52
expected_warning = (
93
53
"bzrlib.tests.test_symbol_versioning."
94
54
"TestDeprecationWarnings.deprecated_method "
95
55
"was deprecated in version 0.7.", DeprecationWarning, 2)
96
56
expected_docstring = ('Deprecated method docstring.\n'
98
58
' This might explain stuff.\n'
100
60
' This method was deprecated in version 0.7.\n'
107
67
def test_deprecated_function(self):
108
68
expected_warning = (
109
"bzrlib.tests.test_symbol_versioning.sample_deprecated_function "
69
"bzrlib.tests.test_symbol_versioning.deprecated_function "
110
70
"was deprecated in version 0.7.", DeprecationWarning, 2)
111
71
expected_docstring = ('Deprecated function docstring.\n'
113
73
'This function was deprecated in version 0.7.\n'
115
75
self.check_deprecated_callable(expected_warning, expected_docstring,
116
"sample_deprecated_function",
76
"deprecated_function",
117
77
"bzrlib.tests.test_symbol_versioning",
118
sample_deprecated_function)
120
80
def test_deprecated_list(self):
121
81
expected_warning = (
122
82
"Modifying a_deprecated_list was deprecated in version 0.9."
123
83
" Don't use me", DeprecationWarning, 3)
84
expected_doctstring = ('appending to a_deprecated_list is deprecated')
124
86
old_warning_method = symbol_versioning.warn
126
88
symbol_versioning.set_warning_method(self.capture_warning)
156
118
symbol_versioning.set_warning_method(old_warning_method)
158
def test_deprecated_dict(self):
160
"access to a_deprecated_dict was deprecated in version 0.14."
161
" Pull the other one!", DeprecationWarning, 2)
162
old_warning_method = symbol_versioning.warn
164
symbol_versioning.set_warning_method(self.capture_warning)
165
self.assertEqual(len(a_deprecated_dict), 1)
166
self.assertEqual([expected_warning], self._warnings)
168
a_deprecated_dict['b'] = 42
169
self.assertEqual(a_deprecated_dict['b'], 42)
170
self.assertTrue('b' in a_deprecated_dict)
171
del a_deprecated_dict['b']
172
self.assertFalse('b' in a_deprecated_dict)
173
self.assertEqual([expected_warning] * 6, self._warnings)
175
symbol_versioning.set_warning_method(old_warning_method)
178
120
def check_deprecated_callable(self, expected_warning, expected_docstring,
179
121
expected_name, expected_module,
180
122
deprecated_callable):
200
142
self.assertEqual(False,
201
143
symbol_versioning.deprecated_passed(
202
144
symbol_versioning.DEPRECATED_PARAMETER))
204
def test_deprecation_string(self):
205
"""We can get a deprecation string for a method or function."""
206
self.assertEqual('bzrlib.tests.test_symbol_versioning.'
207
'TestDeprecationWarnings.test_deprecation_string was deprecated in '
209
symbol_versioning.deprecation_string(
210
self.test_deprecation_string,
211
deprecated_in((0, 11, 0))))
212
self.assertEqual('bzrlib.symbol_versioning.deprecated_function was '
213
'deprecated in version 0.11.',
214
symbol_versioning.deprecation_string(
215
symbol_versioning.deprecated_function,
216
deprecated_in((0, 11, 0))))
219
class TestSuppressAndActivate(TestCase):
223
existing_filters = list(warnings.filters)
225
warnings.filters[:] = existing_filters
226
self.addCleanup(restore)
227
# Clean out the filters so we have a clean slate.
228
warnings.resetwarnings()
230
def assertFirstWarning(self, action, category):
231
"""Test the first warning in the filters is correct"""
232
first = warnings.filters[0]
233
self.assertEqual((action, category), (first[0], first[2]))
235
def test_suppress_deprecation_warnings(self):
236
"""suppress_deprecation_warnings sets DeprecationWarning to ignored."""
237
symbol_versioning.suppress_deprecation_warnings()
238
self.assertFirstWarning('ignore', DeprecationWarning)
240
def test_suppress_deprecation_with_warning_filter(self):
241
"""don't suppress if we already have a filter"""
242
warnings.filterwarnings('error', category=Warning)
243
self.assertFirstWarning('error', Warning)
244
self.assertEqual(1, len(warnings.filters))
245
symbol_versioning.suppress_deprecation_warnings(override=False)
246
self.assertFirstWarning('error', Warning)
247
self.assertEqual(1, len(warnings.filters))
249
def test_suppress_deprecation_with_filter(self):
250
"""don't suppress if we already have a filter"""
251
warnings.filterwarnings('error', category=DeprecationWarning)
252
self.assertFirstWarning('error', DeprecationWarning)
253
self.assertEqual(1, len(warnings.filters))
254
symbol_versioning.suppress_deprecation_warnings(override=False)
255
self.assertFirstWarning('error', DeprecationWarning)
256
self.assertEqual(1, len(warnings.filters))
257
symbol_versioning.suppress_deprecation_warnings(override=True)
258
self.assertFirstWarning('ignore', DeprecationWarning)
259
self.assertEqual(2, len(warnings.filters))
261
def test_activate_deprecation_no_error(self):
262
# First nuke the filters, so we know it is clean
263
symbol_versioning.activate_deprecation_warnings()
264
self.assertFirstWarning('default', DeprecationWarning)
266
def test_activate_deprecation_with_error(self):
267
# First nuke the filters, so we know it is clean
268
# Add a warning == error rule
269
warnings.filterwarnings('error', category=Warning)
270
self.assertFirstWarning('error', Warning)
271
self.assertEqual(1, len(warnings.filters))
272
symbol_versioning.activate_deprecation_warnings(override=False)
273
# There should not be a new warning
274
self.assertFirstWarning('error', Warning)
275
self.assertEqual(1, len(warnings.filters))
277
def test_activate_deprecation_with_DW_error(self):
278
# First nuke the filters, so we know it is clean
279
# Add a warning == error rule
280
warnings.filterwarnings('error', category=DeprecationWarning)
281
self.assertFirstWarning('error', DeprecationWarning)
282
self.assertEqual(1, len(warnings.filters))
283
symbol_versioning.activate_deprecation_warnings(override=False)
284
# There should not be a new warning
285
self.assertFirstWarning('error', DeprecationWarning)
286
self.assertEqual(1, len(warnings.filters))
287
symbol_versioning.activate_deprecation_warnings(override=True)
288
self.assertFirstWarning('default', DeprecationWarning)
289
self.assertEqual(2, len(warnings.filters))