14
13
# You should have received a copy of the GNU General Public License
15
14
# along with this program; if not, write to the Free Software
16
# 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
17
"""Symbol versioning tests."""
20
import bzrlib.symbol_versioning as symbol_versioning
21
from bzrlib import symbol_versioning
22
from bzrlib.symbol_versioning import (
21
28
from bzrlib.tests import TestCase
24
@symbol_versioning.deprecated_function(symbol_versioning.zero_seven)
25
def deprecated_function():
31
@deprecated_function(deprecated_in((0, 7, 0)))
32
def sample_deprecated_function():
26
33
"""Deprecated function docstring."""
30
a_deprecated_list = symbol_versioning.deprecated_list(symbol_versioning.zero_nine,
37
a_deprecated_list = symbol_versioning.deprecated_list(deprecated_in((0, 9, 0)),
31
38
'a_deprecated_list', ['one'], extra="Don't use me")
34
41
a_deprecated_dict = symbol_versioning.DeprecatedDict(
35
symbol_versioning.zero_fourteen,
42
deprecated_in((0, 14, 0)),
36
43
'a_deprecated_dict',
38
45
advice='Pull the other one!',
48
55
super(TestDeprecationWarnings, self).setUp()
49
56
self._warnings = []
51
@symbol_versioning.deprecated_method(symbol_versioning.zero_seven)
58
@deprecated_method(deprecated_in((0, 7, 0)))
52
59
def deprecated_method(self):
53
60
"""Deprecated method docstring.
55
62
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.0.", DeprecationWarning, 2)
80
expected_docstring = (
81
'Deprecated static.\n'
83
'This function was deprecated in version 0.7.0.\n'
85
self.check_deprecated_callable(
86
expected_warning, expected_docstring,
88
"bzrlib.tests.test_symbol_versioning",
89
self.deprecated_static)
59
91
def test_deprecated_method(self):
60
92
expected_warning = (
61
93
"bzrlib.tests.test_symbol_versioning."
62
94
"TestDeprecationWarnings.deprecated_method "
63
"was deprecated in version 0.7.", DeprecationWarning, 2)
64
expected_docstring = ('Deprecated method docstring.\n'
66
' This might explain stuff.\n'
68
' This method was deprecated in version 0.7.\n'
95
"was deprecated in version 0.7.0.", DeprecationWarning, 2)
96
expected_docstring = (
97
'Deprecated method docstring.\n'
99
' This might explain stuff.\n'
101
' This method was deprecated in version 0.7.0.\n'
70
103
self.check_deprecated_callable(expected_warning, expected_docstring,
71
104
"deprecated_method",
72
105
"bzrlib.tests.test_symbol_versioning",
75
108
def test_deprecated_function(self):
76
109
expected_warning = (
77
"bzrlib.tests.test_symbol_versioning.deprecated_function "
78
"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)
79
112
expected_docstring = ('Deprecated function docstring.\n'
81
'This function was deprecated in version 0.7.\n'
114
'This function was deprecated in version 0.7.0.\n'
83
116
self.check_deprecated_callable(expected_warning, expected_docstring,
84
"deprecated_function",
117
"sample_deprecated_function",
85
118
"bzrlib.tests.test_symbol_versioning",
119
sample_deprecated_function)
88
121
def test_deprecated_list(self):
89
122
expected_warning = (
90
"Modifying a_deprecated_list was deprecated in version 0.9."
123
"Modifying a_deprecated_list was deprecated in version 0.9.0."
91
124
" Don't use me", DeprecationWarning, 3)
92
125
old_warning_method = symbol_versioning.warn
173
206
"""We can get a deprecation string for a method or function."""
174
207
self.assertEqual('bzrlib.tests.test_symbol_versioning.'
175
208
'TestDeprecationWarnings.test_deprecation_string was deprecated in '
177
210
symbol_versioning.deprecation_string(
178
self.test_deprecation_string, symbol_versioning.zero_eleven))
211
self.test_deprecation_string,
212
deprecated_in((0, 11, 0))))
179
213
self.assertEqual('bzrlib.symbol_versioning.deprecated_function was '
180
'deprecated in version 0.11.',
214
'deprecated in version 0.11.0.',
181
215
symbol_versioning.deprecation_string(
182
216
symbol_versioning.deprecated_function,
183
symbol_versioning.zero_eleven))
217
deprecated_in((0, 11, 0))))
220
class TestSuppressAndActivate(TestCase):
224
existing_filters = list(warnings.filters)
226
warnings.filters[:] = existing_filters
227
self.addCleanup(restore)
228
# Clean out the filters so we have a clean slate.
229
warnings.resetwarnings()
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]))
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)
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))
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))
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)
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))
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))