1
# Copyright (C) 2006-2012, 2016 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# 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
"""Tests for the formatting and construction of errors."""
31
from ..sixish import (
37
class TestErrors(tests.TestCase):
39
def test_no_arg_named_message(self):
40
"""Ensure the __init__ and _fmt in errors do not have "message" arg.
42
This test fails if __init__ or _fmt in errors has an argument
43
named "message" as this can cause errors in some Python versions.
44
Python 2.5 uses a slot for StandardError.message.
47
fmt_pattern = re.compile("%\\(message\\)[sir]")
48
for c in errors.BzrError.__subclasses__():
49
init = getattr(c, '__init__', None)
50
fmt = getattr(c, '_fmt', None)
53
args = inspect.getfullargspec(init)[0]
55
args = inspect.getargspec(init)[0]
56
self.assertFalse('message' in args,
57
('Argument name "message" not allowed for '
58
'"errors.%s.__init__"' % c.__name__))
59
if fmt and fmt_pattern.search(fmt):
60
self.assertFalse(True, ('"message" not allowed in '
61
'"errors.%s._fmt"' % c.__name__))
63
def test_bad_filename_encoding(self):
64
error = errors.BadFilenameEncoding(b'bad/filen\xe5me', 'UTF-8')
65
self.assertContainsRe(
67
"^Filename b?'bad/filen\\\\xe5me' is not valid in your current"
68
" filesystem encoding UTF-8$")
70
def test_duplicate_file_id(self):
71
error = errors.DuplicateFileId('a_file_id', 'foo')
72
self.assertEqualDiff('File id {a_file_id} already exists in inventory'
73
' as foo', str(error))
75
def test_duplicate_help_prefix(self):
76
error = errors.DuplicateHelpPrefix('foo')
77
self.assertEqualDiff('The prefix foo is in the help search path twice.',
80
def test_ghost_revisions_have_no_revno(self):
81
error = errors.GhostRevisionsHaveNoRevno('target', 'ghost_rev')
82
self.assertEqualDiff("Could not determine revno for {target} because"
83
" its ancestry shows a ghost at {ghost_rev}",
86
def test_incompatibleVersion(self):
87
error = errors.IncompatibleVersion("module", [(4, 5, 6), (7, 8, 9)],
90
'API module is not compatible; one of versions '
91
'[(4, 5, 6), (7, 8, 9)] is required, but current version is '
95
def test_inconsistent_delta(self):
96
error = errors.InconsistentDelta('path', 'file-id', 'reason for foo')
98
"An inconsistent delta was supplied involving 'path', 'file-id'\n"
99
"reason: reason for foo",
102
def test_inconsistent_delta_delta(self):
103
error = errors.InconsistentDeltaDelta([], 'reason')
104
self.assertEqualDiff(
105
"An inconsistent delta was supplied: []\nreason: reason",
108
def test_in_process_transport(self):
109
error = errors.InProcessTransport('fpp')
110
self.assertEqualDiff(
111
"The transport 'fpp' is only accessible within this process.",
114
def test_invalid_http_range(self):
115
error = errors.InvalidHttpRange('path',
116
'Content-Range: potatoes 0-00/o0oo0',
118
self.assertEqual("Invalid http range"
119
" 'Content-Range: potatoes 0-00/o0oo0'"
120
" for path: bad range",
123
def test_invalid_range(self):
124
error = errors.InvalidRange('path', 12, 'bad range')
125
self.assertEqual("Invalid range access in path at 12: bad range",
128
def test_inventory_modified(self):
129
error = errors.InventoryModified("a tree to be repred")
130
self.assertEqualDiff("The current inventory for the tree 'a tree to "
131
"be repred' has been modified, so a clean inventory cannot be "
132
"read without data loss.",
135
def test_jail_break(self):
136
error = errors.JailBreak("some url")
137
self.assertEqualDiff("An attempt to access a url outside the server"
138
" jail was made: 'some url'.",
141
def test_lock_active(self):
142
error = errors.LockActive("lock description")
143
self.assertEqualDiff("The lock for 'lock description' is in use and "
147
def test_lock_corrupt(self):
148
error = errors.LockCorrupt("corruption info")
149
self.assertEqualDiff("Lock is apparently held, but corrupted: "
151
"Use 'brz break-lock' to clear it",
154
def test_medium_not_connected(self):
155
error = errors.MediumNotConnected("a medium")
156
self.assertEqualDiff(
157
"The medium 'a medium' is not connected.", str(error))
159
def test_no_smart_medium(self):
160
error = errors.NoSmartMedium("a transport")
161
self.assertEqualDiff("The transport 'a transport' cannot tunnel the "
165
def test_no_such_id(self):
166
error = errors.NoSuchId("atree", "anid")
167
self.assertEqualDiff("The file id \"anid\" is not present in the tree "
171
def test_no_such_revision_in_tree(self):
172
error = errors.NoSuchRevisionInTree("atree", "anid")
173
self.assertEqualDiff("The revision id {anid} is not present in the"
174
" tree atree.", str(error))
175
self.assertIsInstance(error, errors.NoSuchRevision)
177
def test_not_stacked(self):
178
error = errors.NotStacked('a branch')
179
self.assertEqualDiff("The branch 'a branch' is not stacked.",
182
def test_not_write_locked(self):
183
error = errors.NotWriteLocked('a thing to repr')
184
self.assertEqualDiff("'a thing to repr' is not write locked but needs "
188
def test_lock_failed(self):
189
error = errors.LockFailed(
190
'http://canonical.com/', 'readonly transport')
191
self.assertEqualDiff("Cannot lock http://canonical.com/: readonly transport",
193
self.assertFalse(error.internal_error)
195
def test_too_many_concurrent_requests(self):
196
error = errors.TooManyConcurrentRequests("a medium")
197
self.assertEqualDiff("The medium 'a medium' has reached its concurrent "
198
"request limit. Be sure to finish_writing and finish_reading on "
199
"the currently open request.",
202
def test_unavailable_representation(self):
203
error = errors.UnavailableRepresentation(
204
('key',), "mpdiff", "fulltext")
205
self.assertEqualDiff("The encoding 'mpdiff' is not available for key "
206
"('key',) which is encoded as 'fulltext'.",
209
def test_unstackable_location(self):
210
error = errors.UnstackableLocationError('foo', 'bar')
211
self.assertEqualDiff("The branch 'foo' cannot be stacked on 'bar'.",
214
def test_unstackable_repository_format(self):
217
error = errors.UnstackableRepositoryFormat(format, url)
218
self.assertEqualDiff(
219
"The repository '/foo'(foo) is not a stackable format. "
220
"You will need to upgrade the repository to permit branch stacking.",
223
def test_up_to_date(self):
224
error = errors.UpToDateFormat("someformat")
225
self.assertEqualDiff(
226
"The branch format someformat is already at the most "
227
"recent format.", str(error))
229
def test_read_error(self):
230
# a unicode path to check that %r is being used.
232
error = errors.ReadError(path)
233
self.assertContainsRe(str(error), "^Error reading from u?'a path'.$")
235
def test_bzrerror_from_literal_string(self):
236
# Some code constructs BzrError from a literal string, in which case
237
# no further formatting is done. (I'm not sure raising the base class
238
# is a great idea, but if the exception is not intended to be caught
239
# perhaps no more is needed.)
241
raise errors.BzrError('this is my errors; %d is not expanded')
242
except errors.BzrError as e:
243
self.assertEqual('this is my errors; %d is not expanded', str(e))
245
def test_reading_completed(self):
246
error = errors.ReadingCompleted("a request")
247
self.assertEqualDiff("The MediumRequest 'a request' has already had "
248
"finish_reading called upon it - the request has been completed and"
249
" no more data may be read.",
252
def test_writing_completed(self):
253
error = errors.WritingCompleted("a request")
254
self.assertEqualDiff("The MediumRequest 'a request' has already had "
255
"finish_writing called upon it - accept bytes may not be called "
259
def test_writing_not_completed(self):
260
error = errors.WritingNotComplete("a request")
261
self.assertEqualDiff("The MediumRequest 'a request' has not has "
262
"finish_writing called upon it - until the write phase is complete"
263
" no data may be read.",
266
def test_transport_not_possible(self):
267
error = errors.TransportNotPossible('readonly', 'original error')
268
self.assertEqualDiff('Transport operation not possible:'
269
' readonly original error', str(error))
271
def assertSocketConnectionError(self, expected, *args, **kwargs):
272
"""Check the formatting of a SocketConnectionError exception"""
273
e = errors.SocketConnectionError(*args, **kwargs)
274
self.assertEqual(expected, str(e))
276
def test_socket_connection_error(self):
277
"""Test the formatting of SocketConnectionError"""
279
# There should be a default msg about failing to connect
280
# we only require a host name.
281
self.assertSocketConnectionError(
282
'Failed to connect to ahost',
285
# If port is None, we don't put :None
286
self.assertSocketConnectionError(
287
'Failed to connect to ahost',
289
# But if port is supplied we include it
290
self.assertSocketConnectionError(
291
'Failed to connect to ahost:22',
294
# We can also supply extra information about the error
295
# with or without a port
296
self.assertSocketConnectionError(
297
'Failed to connect to ahost:22; bogus error',
298
'ahost', port=22, orig_error='bogus error')
299
self.assertSocketConnectionError(
300
'Failed to connect to ahost; bogus error',
301
'ahost', orig_error='bogus error')
302
# An exception object can be passed rather than a string
303
orig_error = ValueError('bad value')
304
self.assertSocketConnectionError(
305
'Failed to connect to ahost; %s' % (str(orig_error),),
306
host='ahost', orig_error=orig_error)
308
# And we can supply a custom failure message
309
self.assertSocketConnectionError(
310
'Unable to connect to ssh host ahost:444; my_error',
311
host='ahost', port=444, msg='Unable to connect to ssh host',
312
orig_error='my_error')
314
def test_target_not_branch(self):
315
"""Test the formatting of TargetNotBranch."""
316
error = errors.TargetNotBranch('foo')
318
"Your branch does not have all of the revisions required in "
319
"order to merge this merge directive and the target "
320
"location specified in the merge directive is not a branch: "
323
def test_unexpected_smart_server_response(self):
324
e = errors.UnexpectedSmartServerResponse(('not yes',))
326
"Could not understand response from smart server: ('not yes',)",
329
def test_unknown_container_format(self):
330
"""Test the formatting of UnknownContainerFormatError."""
331
e = errors.UnknownContainerFormatError('bad format string')
333
"Unrecognised container format: 'bad format string'",
336
def test_unexpected_end_of_container(self):
337
"""Test the formatting of UnexpectedEndOfContainerError."""
338
e = errors.UnexpectedEndOfContainerError()
340
"Unexpected end of container stream", str(e))
342
def test_unknown_record_type(self):
343
"""Test the formatting of UnknownRecordTypeError."""
344
e = errors.UnknownRecordTypeError("X")
346
"Unknown record type: 'X'",
349
def test_invalid_record(self):
350
"""Test the formatting of InvalidRecordError."""
351
e = errors.InvalidRecordError("xxx")
353
"Invalid record: xxx",
356
def test_container_has_excess_data(self):
357
"""Test the formatting of ContainerHasExcessDataError."""
358
e = errors.ContainerHasExcessDataError("excess bytes")
360
"Container has data after end marker: 'excess bytes'",
363
def test_duplicate_record_name_error(self):
364
"""Test the formatting of DuplicateRecordNameError."""
365
e = errors.DuplicateRecordNameError(b"n\xc3\xa5me")
367
u"Container has multiple records with the same name: n\xe5me",
370
def test_check_error(self):
371
e = errors.BzrCheckError('example check failure')
373
"Internal check failed: example check failure",
375
self.assertTrue(e.internal_error)
377
def test_repository_data_stream_error(self):
378
"""Test the formatting of RepositoryDataStreamError."""
379
e = errors.RepositoryDataStreamError(u"my reason")
381
"Corrupt or incompatible data stream: my reason", str(e))
383
def test_immortal_pending_deletion_message(self):
384
err = errors.ImmortalPendingDeletion('foo')
386
"Unable to delete transform temporary directory foo. "
387
"Please examine foo to see if it contains any files "
388
"you wish to keep, and delete it when you are done.",
391
def test_unable_create_symlink(self):
392
err = errors.UnableCreateSymlink()
394
"Unable to create symlink on this platform",
396
err = errors.UnableCreateSymlink(path=u'foo')
398
"Unable to create symlink 'foo' on this platform",
400
err = errors.UnableCreateSymlink(path=u'\xb5')
402
"Unable to create symlink %s on this platform" % repr(u'\xb5'),
405
def test_invalid_url_join(self):
406
"""Test the formatting of InvalidURLJoin."""
407
e = urlutils.InvalidURLJoin('Reason', 'base path', ('args',))
409
"Invalid URL join request: Reason: 'base path' + ('args',)",
412
def test_unable_encode_path(self):
413
err = errors.UnableEncodePath('foo', 'executable')
414
self.assertEqual("Unable to encode executable path 'foo' in "
415
"user encoding " + osutils.get_user_encoding(),
418
def test_unknown_format(self):
419
err = errors.UnknownFormatError('bar', kind='foo')
420
self.assertEqual("Unknown foo format: 'bar'", str(err))
422
def test_tip_change_rejected(self):
423
err = errors.TipChangeRejected(u'Unicode message\N{INTERROBANG}')
425
u'Tip change rejected: Unicode message\N{INTERROBANG}',
428
def test_error_from_smart_server(self):
429
error_tuple = ('error', 'tuple')
430
err = errors.ErrorFromSmartServer(error_tuple)
432
"Error received from smart server: ('error', 'tuple')", str(err))
434
def test_untranslateable_error_from_smart_server(self):
435
error_tuple = ('error', 'tuple')
436
orig_err = errors.ErrorFromSmartServer(error_tuple)
437
err = errors.UnknownErrorFromSmartServer(orig_err)
439
"Server sent an unexpected error: ('error', 'tuple')", str(err))
441
def test_smart_message_handler_error(self):
442
# Make an exc_info tuple.
444
raise Exception("example error")
446
err = errors.SmartMessageHandlerError(sys.exc_info())
447
# GZ 2010-11-08: Should not store exc_info in exception instances.
449
self.assertStartsWith(
450
str(err), "The message handler raised an exception:\n")
451
self.assertEndsWith(str(err), "Exception: example error\n")
455
def test_unresumable_write_group(self):
457
wg_tokens = ['token']
459
err = errors.UnresumableWriteGroup(repo, wg_tokens, reason)
461
"Repository dummy repo cannot resume write group "
462
"['token']: a reason", str(err))
464
def test_unsuspendable_write_group(self):
466
err = errors.UnsuspendableWriteGroup(repo)
468
'Repository dummy repo cannot suspend a write group.', str(err))
470
def test_not_branch_no_args(self):
471
err = errors.NotBranchError('path')
472
self.assertEqual('Not a branch: "path".', str(err))
474
def test_not_branch_bzrdir_with_recursive_not_branch_error(self):
475
class FakeBzrDir(object):
476
def open_repository(self):
477
# str() on the NotBranchError will trigger a call to this,
478
# which in turn will another, identical NotBranchError.
479
raise errors.NotBranchError('path', controldir=FakeBzrDir())
480
err = errors.NotBranchError('path', controldir=FakeBzrDir())
481
self.assertEqual('Not a branch: "path": NotBranchError.', str(err))
483
def test_recursive_bind(self):
484
error = errors.RecursiveBind('foo_bar_branch')
485
msg = ('Branch "foo_bar_branch" appears to be bound to itself. '
486
'Please use `brz unbind` to fix.')
487
self.assertEqualDiff(msg, str(error))
489
def test_retry_with_new_packs(self):
490
fake_exc_info = ('{exc type}', '{exc value}', '{exc traceback}')
491
error = errors.RetryWithNewPacks(
492
'{context}', reload_occurred=False, exc_info=fake_exc_info)
494
'Pack files have changed, reload and retry. context: '
495
'{context} {exc value}', str(error))
498
class PassThroughError(errors.BzrError):
500
_fmt = """Pass through %(foo)s and %(bar)s"""
502
def __init__(self, foo, bar):
503
errors.BzrError.__init__(self, foo=foo, bar=bar)
506
class ErrorWithBadFormat(errors.BzrError):
508
_fmt = """One format specifier: %(thing)s"""
511
class ErrorWithNoFormat(errors.BzrError):
512
__doc__ = """This class has a docstring but no format string."""
515
class TestErrorFormatting(tests.TestCase):
517
def test_always_str(self):
518
e = PassThroughError(u'\xb5', 'bar')
519
self.assertIsInstance(e.__str__(), str)
520
# In Python 2 str(foo) *must* return a real byte string
521
# not a Unicode string. The following line would raise a
522
# Unicode error, because it tries to call str() on the string
523
# returned from e.__str__(), and it has non ascii characters
526
self.assertEqual('Pass through \xb5 and bar', s)
528
self.assertEqual('Pass through \xc2\xb5 and bar', s)
530
def test_missing_format_string(self):
531
e = ErrorWithNoFormat(param='randomvalue')
532
self.assertStartsWith(str(e),
533
"Unprintable exception ErrorWithNoFormat")
535
def test_mismatched_format_args(self):
536
# Even though ErrorWithBadFormat's format string does not match the
537
# arguments we constructing it with, we can still stringify an instance
538
# of this exception. The resulting string will say its unprintable.
539
e = ErrorWithBadFormat(not_thing='x')
540
self.assertStartsWith(
541
str(e), 'Unprintable exception ErrorWithBadFormat')
543
def test_cannot_bind_address(self):
544
# see <https://bugs.launchpad.net/bzr/+bug/286871>
545
e = errors.CannotBindAddress('example.com', 22,
546
socket.error(13, 'Permission denied'))
547
self.assertContainsRe(
549
r'Cannot bind address "example\.com:22":.*Permission denied')
551
def test_transform_rename_failed(self):
552
e = errors.TransformRenameFailed(u"from", u"to", "readonly file", 2)
554
u"Failed to rename from to to: readonly file",
558
class TestErrorsUsingTransport(tests.TestCaseWithMemoryTransport):
559
"""Tests for errors that need to use a branch or repo."""
561
def test_no_public_branch(self):
562
b = self.make_branch('.')
563
error = errors.NoPublicBranch(b)
564
url = urlutils.unescape_for_display(b.base, 'ascii')
565
self.assertEqualDiff(
566
'There is no public branch set for "%s".' % url, str(error))
568
def test_no_repo(self):
569
dir = controldir.ControlDir.create(self.get_url())
570
error = errors.NoRepositoryPresent(dir)
571
self.assertNotEqual(-1,
572
str(error).find((dir.transport.clone('..').base)))
573
self.assertEqual(-1, str(error).find((dir.transport.base)))
575
def test_corrupt_repository(self):
576
repo = self.make_repository('.')
577
error = errors.CorruptRepository(repo)
578
self.assertEqualDiff("An error has been detected in the repository %s.\n"
579
"Please run brz reconcile on this repository." %
580
repo.controldir.root_transport.base,
583
def test_not_branch_bzrdir_with_repo(self):
584
controldir = self.make_repository('repo').controldir
585
err = errors.NotBranchError('path', controldir=controldir)
587
'Not a branch: "path": location is a repository.', str(err))
589
def test_not_branch_bzrdir_without_repo(self):
590
controldir = self.make_controldir('bzrdir')
591
err = errors.NotBranchError('path', controldir=controldir)
592
self.assertEqual('Not a branch: "path".', str(err))
594
def test_not_branch_laziness(self):
595
real_bzrdir = self.make_controldir('path')
597
class FakeBzrDir(object):
601
def open_repository(self):
602
self.calls.append('open_repository')
603
raise errors.NoRepositoryPresent(real_bzrdir)
604
fake_bzrdir = FakeBzrDir()
605
err = errors.NotBranchError('path', controldir=fake_bzrdir)
606
self.assertEqual([], fake_bzrdir.calls)
608
self.assertEqual(['open_repository'], fake_bzrdir.calls)
609
# Stringifying twice doesn't try to open a repository twice.
611
self.assertEqual(['open_repository'], fake_bzrdir.calls)
added
removed
breezy/tests/test_errors.py
