1
# Copyright (C) 2006 by Canonical Ltd
2
# Authors: Robert Collins <robert.collins@canonical.com>
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
"""Symbol versioning tests."""
20
import bzrlib.symbol_versioning as symbol_versioning
21
from bzrlib.tests import TestCase
24
@symbol_versioning.deprecated_function(symbol_versioning.zero_seven)
25
def deprecated_function():
26
"""Deprecated function docstring."""
30
a_deprecated_list = symbol_versioning.deprecated_list(symbol_versioning.zero_nine,
31
'a_deprecated_list', ['one'], extra="Don't use me")
34
class TestDeprecationWarnings(TestCase):
36
def capture_warning(self, message, category, stacklevel=None):
37
self._warnings.append((message, category, stacklevel))
40
super(TestDeprecationWarnings, self).setUp()
43
@symbol_versioning.deprecated_method(symbol_versioning.zero_seven)
44
def deprecated_method(self):
45
"""Deprecated method docstring.
47
This might explain stuff.
51
def test_deprecated_method(self):
53
"bzrlib.tests.test_symbol_versioning."
54
"TestDeprecationWarnings.deprecated_method "
55
"was deprecated in version 0.7.", DeprecationWarning, 2)
56
expected_docstring = ('Deprecated method docstring.\n'
58
' This might explain stuff.\n'
60
' This method was deprecated in version 0.7.\n'
62
self.check_deprecated_callable(expected_warning, expected_docstring,
64
"bzrlib.tests.test_symbol_versioning",
65
self.deprecated_method)
67
def test_deprecated_function(self):
69
"bzrlib.tests.test_symbol_versioning.deprecated_function "
70
"was deprecated in version 0.7.", DeprecationWarning, 2)
71
expected_docstring = ('Deprecated function docstring.\n'
73
'This function was deprecated in version 0.7.\n'
75
self.check_deprecated_callable(expected_warning, expected_docstring,
76
"deprecated_function",
77
"bzrlib.tests.test_symbol_versioning",
80
def test_deprecated_list(self):
82
"Modifying a_deprecated_list was deprecated in version 0.9."
83
" Don't use me", DeprecationWarning, 3)
84
expected_doctstring = ('appending to a_deprecated_list is deprecated')
86
old_warning_method = symbol_versioning.warn
88
symbol_versioning.set_warning_method(self.capture_warning)
89
self.assertEqual(['one'], a_deprecated_list)
90
self.assertEqual([], self._warnings)
92
a_deprecated_list.append('foo')
93
self.assertEqual([expected_warning], self._warnings)
94
self.assertEqual(['one', 'foo'], a_deprecated_list)
96
a_deprecated_list.extend(['bar', 'baz'])
97
self.assertEqual([expected_warning]*2, self._warnings)
98
self.assertEqual(['one', 'foo', 'bar', 'baz'], a_deprecated_list)
100
a_deprecated_list.insert(1, 'xxx')
101
self.assertEqual([expected_warning]*3, self._warnings)
102
self.assertEqual(['one', 'xxx', 'foo', 'bar', 'baz'], a_deprecated_list)
104
a_deprecated_list.remove('foo')
105
self.assertEqual([expected_warning]*4, self._warnings)
106
self.assertEqual(['one', 'xxx', 'bar', 'baz'], a_deprecated_list)
108
val = a_deprecated_list.pop()
109
self.assertEqual([expected_warning]*5, self._warnings)
110
self.assertEqual('baz', val)
111
self.assertEqual(['one', 'xxx', 'bar'], a_deprecated_list)
113
val = a_deprecated_list.pop(1)
114
self.assertEqual([expected_warning]*6, self._warnings)
115
self.assertEqual('xxx', val)
116
self.assertEqual(['one', 'bar'], a_deprecated_list)
118
symbol_versioning.set_warning_method(old_warning_method)
120
def check_deprecated_callable(self, expected_warning, expected_docstring,
121
expected_name, expected_module,
122
deprecated_callable):
123
old_warning_method = symbol_versioning.warn
125
symbol_versioning.set_warning_method(self.capture_warning)
126
self.assertEqual(1, deprecated_callable())
127
self.assertEqual([expected_warning], self._warnings)
128
deprecated_callable()
129
self.assertEqual([expected_warning, expected_warning],
131
self.assertEqualDiff(expected_docstring, deprecated_callable.__doc__)
132
self.assertEqualDiff(expected_name, deprecated_callable.__name__)
133
self.assertEqualDiff(expected_module, deprecated_callable.__module__)
134
self.assertTrue(deprecated_callable.is_deprecated)
136
symbol_versioning.set_warning_method(old_warning_method)
138
def test_deprecated_passed(self):
139
self.assertEqual(True, symbol_versioning.deprecated_passed(None))
140
self.assertEqual(True, symbol_versioning.deprecated_passed(True))
141
self.assertEqual(True, symbol_versioning.deprecated_passed(False))
142
self.assertEqual(False,
143
symbol_versioning.deprecated_passed(
144
symbol_versioning.DEPRECATED_PARAMETER))
146
def test_deprecation_string(self):
147
"""We can get a deprecation string for a method or function."""
148
self.assertEqual('bzrlib.tests.test_symbol_versioning.'
149
'TestDeprecationWarnings.test_deprecation_string was deprecated in '
151
symbol_versioning.deprecation_string(
152
self.test_deprecation_string, symbol_versioning.zero_eleven))
153
self.assertEqual('bzrlib.symbol_versioning.deprecated_function was '
154
'deprecated in version 0.11.',
155
symbol_versioning.deprecation_string(
156
symbol_versioning.deprecated_function,
157
symbol_versioning.zero_eleven))
added
removed
bzrlib/tests/test_symbol_versioning.py
