13
15
# You should have received a copy of the GNU General Public License
14
16
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
19
"""Symbol versioning tests."""
21
from bzrlib import symbol_versioning
22
from bzrlib.symbol_versioning import (
21
import bzrlib.symbol_versioning as symbol_versioning
28
22
from bzrlib.tests import TestCase
31
@deprecated_function(deprecated_in((0, 7, 0)))
32
def sample_deprecated_function():
25
@symbol_versioning.deprecated_function(symbol_versioning.zero_seven)
26
def deprecated_function():
33
27
"""Deprecated function docstring."""
37
a_deprecated_list = symbol_versioning.deprecated_list(deprecated_in((0, 9, 0)),
31
a_deprecated_list = symbol_versioning.deprecated_list(symbol_versioning.zero_nine,
38
32
'a_deprecated_list', ['one'], extra="Don't use me")
41
35
a_deprecated_dict = symbol_versioning.DeprecatedDict(
42
deprecated_in((0, 14, 0)),
36
symbol_versioning.zero_fourteen,
43
37
'a_deprecated_dict',
45
39
advice='Pull the other one!',
207
201
'TestDeprecationWarnings.test_deprecation_string was deprecated in '
209
203
symbol_versioning.deprecation_string(
210
self.test_deprecation_string,
211
deprecated_in((0, 11, 0))))
204
self.test_deprecation_string, symbol_versioning.zero_eleven))
212
205
self.assertEqual('bzrlib.symbol_versioning.deprecated_function was '
213
206
'deprecated in version 0.11.',
214
207
symbol_versioning.deprecation_string(
215
208
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))
209
symbol_versioning.zero_eleven))