1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
# Copyright (C) 2006 by Canonical Ltd
# Authors: Robert Collins <robert.collins@canonical.com>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
"""Symbol versioning tests."""
import bzrlib.symbol_versioning as symbol_versioning
from bzrlib.tests import TestCase
@symbol_versioning.deprecated_function(symbol_versioning.zero_seven)
def deprecated_function():
"""Deprecated function docstring."""
return 1
class TestDeprecationWarnings(TestCase):
def capture_warning(self, message, category):
self._warnings.append((message, category))
def setUp(self):
super(TestDeprecationWarnings, self).setUp()
self._warnings = []
@symbol_versioning.deprecated_method(symbol_versioning.zero_seven)
def deprecated_method(self):
"""Deprecated method docstring.
This might explain stuff.
"""
return 1
def test_deprecated_method(self):
expected_warning = (
"bzrlib.tests.test_symbol_versioning."
"TestDeprecationWarnings.deprecated_method "
"was deprecated in version 0.7.", DeprecationWarning)
expected_docstring = ('Deprecated method docstring.\n'
' \n'
' This might explain stuff.\n'
' \n'
' This method was deprecated in version 0.7.\n'
' ')
self.check_deprecated_callable(expected_warning, expected_docstring,
"deprecated_method",
"bzrlib.tests.test_symbol_versioning",
self.deprecated_method)
def test_deprecated_function(self):
expected_warning = (
"bzrlib.tests.test_symbol_versioning.deprecated_function "
"was deprecated in version 0.7.", DeprecationWarning)
expected_docstring = ('Deprecated function docstring.\n'
'\n'
'This function was deprecated in version 0.7.\n'
)
self.check_deprecated_callable(expected_warning, expected_docstring,
"deprecated_function",
"bzrlib.tests.test_symbol_versioning",
deprecated_function)
def check_deprecated_callable(self, expected_warning, expected_docstring,
expected_name, expected_module,
deprecated_callable):
old_warning_method = symbol_versioning.warn
try:
symbol_versioning.set_warning_method(self.capture_warning)
self.assertEqual(1, deprecated_callable())
self.assertEqual([expected_warning], self._warnings)
deprecated_callable()
self.assertEqual([expected_warning, expected_warning],
self._warnings)
self.assertEqualDiff(expected_docstring, deprecated_callable.__doc__)
self.assertEqualDiff(expected_name, deprecated_callable.__name__)
self.assertEqualDiff(expected_module, deprecated_callable.__module__)
finally:
symbol_versioning.set_warning_method(old_warning_method)
|