13
14
# You should have received a copy of the GNU General Public License
14
15
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
18
"""Tests for the formatting and construction of errors."""
33
class TestErrors(tests.TestCase):
35
def test_no_arg_named_message(self):
36
"""Ensure the __init__ and _fmt in errors do not have "message" arg.
38
This test fails if __init__ or _fmt in errors has an argument
39
named "message" as this can cause errors in some Python versions.
40
Python 2.5 uses a slot for StandardError.message.
43
fmt_pattern = re.compile("%\\(message\\)[sir]")
44
for c in errors.BzrError.__subclasses__():
45
init = getattr(c, '__init__', None)
46
fmt = getattr(c, '_fmt', None)
48
args = inspect.getfullargspec(init)[0]
49
self.assertFalse('message' in args,
50
('Argument name "message" not allowed for '
51
'"errors.%s.__init__"' % c.__name__))
52
if fmt and fmt_pattern.search(fmt):
53
self.assertFalse(True, ('"message" not allowed in '
54
'"errors.%s._fmt"' % c.__name__))
56
def test_bad_filename_encoding(self):
57
error = errors.BadFilenameEncoding(b'bad/filen\xe5me', 'UTF-8')
58
self.assertContainsRe(
60
"^Filename b?'bad/filen\\\\xe5me' is not valid in your current"
61
" filesystem encoding UTF-8$")
63
def test_duplicate_help_prefix(self):
64
error = errors.DuplicateHelpPrefix('foo')
65
self.assertEqualDiff('The prefix foo is in the help search path twice.',
68
def test_ghost_revisions_have_no_revno(self):
69
error = errors.GhostRevisionsHaveNoRevno('target', 'ghost_rev')
70
self.assertEqualDiff("Could not determine revno for {target} because"
71
" its ancestry shows a ghost at {ghost_rev}",
74
def test_incompatibleVersion(self):
75
error = errors.IncompatibleVersion("module", [(4, 5, 6), (7, 8, 9)],
78
'API module is not compatible; one of versions '
79
'[(4, 5, 6), (7, 8, 9)] is required, but current version is '
83
def test_inconsistent_delta(self):
84
error = errors.InconsistentDelta('path', 'file-id', 'reason for foo')
86
"An inconsistent delta was supplied involving 'path', 'file-id'\n"
87
"reason: reason for foo",
90
def test_inconsistent_delta_delta(self):
91
error = errors.InconsistentDeltaDelta([], 'reason')
93
"An inconsistent delta was supplied: []\nreason: reason",
96
def test_in_process_transport(self):
97
error = errors.InProcessTransport('fpp')
99
"The transport 'fpp' is only accessible within this process.",
102
def test_invalid_http_range(self):
103
error = errors.InvalidHttpRange('path',
104
'Content-Range: potatoes 0-00/o0oo0',
106
self.assertEqual("Invalid http range"
107
" 'Content-Range: potatoes 0-00/o0oo0'"
108
" for path: bad range",
111
def test_invalid_range(self):
112
error = errors.InvalidRange('path', 12, 'bad range')
113
self.assertEqual("Invalid range access in path at 12: bad range",
116
def test_jail_break(self):
117
error = errors.JailBreak("some url")
118
self.assertEqualDiff("An attempt to access a url outside the server"
119
" jail was made: 'some url'.",
24
from bzrlib.tests import TestCase, TestCaseWithTransport
27
# TODO: Make sure builtin exception class formats are consistent - e.g. should
28
# or shouldn't end with a full stop, etc.
31
class TestErrors(TestCaseWithTransport):
33
def test_disabled_method(self):
34
error = errors.DisabledMethod("class name")
36
"The smart server method 'class name' is disabled.", str(error))
38
def test_duplicate_file_id(self):
39
error = errors.DuplicateFileId('a_file_id', 'foo')
40
self.assertEqualDiff('File id {a_file_id} already exists in inventory'
41
' as foo', str(error))
43
def test_inventory_modified(self):
44
error = errors.InventoryModified("a tree to be repred")
45
self.assertEqualDiff("The current inventory for the tree 'a tree to "
46
"be repred' has been modified, so a clean inventory cannot be "
47
"read without data loss.",
50
def test_install_failed(self):
51
error = errors.InstallFailed(['rev-one'])
52
self.assertEqual("Could not install revisions:\nrev-one", str(error))
53
error = errors.InstallFailed(['rev-one', 'rev-two'])
54
self.assertEqual("Could not install revisions:\nrev-one, rev-two",
56
error = errors.InstallFailed([None])
57
self.assertEqual("Could not install revisions:\nNone", str(error))
122
59
def test_lock_active(self):
123
60
error = errors.LockActive("lock description")
124
61
self.assertEqualDiff("The lock for 'lock description' is in use and "
128
def test_lock_corrupt(self):
129
error = errors.LockCorrupt("corruption info")
130
self.assertEqualDiff("Lock is apparently held, but corrupted: "
132
"Use 'brz break-lock' to clear it",
65
def test_knit_header_error(self):
66
error = errors.KnitHeaderError('line foo\n', 'path/to/file')
67
self.assertEqual("Knit header error: 'line foo\\n' unexpected"
68
" for file path/to/file", str(error))
70
def test_knit_index_unknown_method(self):
71
error = errors.KnitIndexUnknownMethod('http://host/foo.kndx',
73
self.assertEqual("Knit index http://host/foo.kndx does not have a"
74
" known method in options: ['bad', 'no-eol']",
135
77
def test_medium_not_connected(self):
136
78
error = errors.MediumNotConnected("a medium")
137
79
self.assertEqualDiff(
138
80
"The medium 'a medium' is not connected.", str(error))
82
def test_no_repo(self):
83
dir = bzrdir.BzrDir.create(self.get_url())
84
error = errors.NoRepositoryPresent(dir)
85
self.assertNotEqual(-1, str(error).find((dir.transport.clone('..').base)))
86
self.assertEqual(-1, str(error).find((dir.transport.base)))
140
88
def test_no_smart_medium(self):
141
89
error = errors.NoSmartMedium("a transport")
142
90
self.assertEqualDiff("The transport 'a transport' cannot tunnel the "
146
94
def test_no_such_id(self):
147
95
error = errors.NoSuchId("atree", "anid")
148
self.assertEqualDiff("The file id \"anid\" is not present in the tree "
96
self.assertEqualDiff("The file id anid is not present in the tree "
152
100
def test_no_such_revision_in_tree(self):
153
101
error = errors.NoSuchRevisionInTree("atree", "anid")
154
self.assertEqualDiff("The revision id {anid} is not present in the"
155
" tree atree.", str(error))
102
self.assertEqualDiff("The revision id anid is not present in the tree "
156
105
self.assertIsInstance(error, errors.NoSuchRevision)
158
def test_not_stacked(self):
159
error = errors.NotStacked('a branch')
160
self.assertEqualDiff("The branch 'a branch' is not stacked.",
163
107
def test_not_write_locked(self):
164
108
error = errors.NotWriteLocked('a thing to repr')
165
109
self.assertEqualDiff("'a thing to repr' is not write locked but needs "
169
def test_lock_failed(self):
170
error = errors.LockFailed(
171
'http://canonical.com/', 'readonly transport')
172
self.assertEqualDiff("Cannot lock http://canonical.com/: readonly transport",
174
self.assertFalse(error.internal_error)
113
def test_read_only_lock_error(self):
114
error = errors.ReadOnlyLockError('filename', 'error message')
115
self.assertEqualDiff("Cannot acquire write lock on filename."
116
" error message", str(error))
176
118
def test_too_many_concurrent_requests(self):
177
119
error = errors.TooManyConcurrentRequests("a medium")
178
120
self.assertEqualDiff("The medium 'a medium' has reached its concurrent "
179
"request limit. Be sure to finish_writing and finish_reading on "
180
"the currently open request.",
183
def test_unstackable_location(self):
184
error = errors.UnstackableLocationError('foo', 'bar')
185
self.assertEqualDiff("The branch 'foo' cannot be stacked on 'bar'.",
188
def test_unstackable_repository_format(self):
191
error = errors.UnstackableRepositoryFormat(format, url)
192
self.assertEqualDiff(
193
"The repository '/foo'(foo) is not a stackable format. "
194
"You will need to upgrade the repository to permit branch stacking.",
121
"request limit. Be sure to finish_writing and finish_reading on "
122
"the current request that is open.",
125
def test_unknown_hook(self):
126
error = errors.UnknownHook("branch", "foo")
127
self.assertEqualDiff("The branch hook 'foo' is unknown in this version"
130
error = errors.UnknownHook("tree", "bar")
131
self.assertEqualDiff("The tree hook 'bar' is unknown in this version"
197
135
def test_up_to_date(self):
198
error = errors.UpToDateFormat("someformat")
199
self.assertEqualDiff(
200
"The branch format someformat is already at the most "
201
"recent format.", str(error))
203
def test_read_error(self):
204
# a unicode path to check that %r is being used.
206
error = errors.ReadError(path)
207
self.assertContainsRe(str(error), "^Error reading from u?'a path'.$")
136
error = errors.UpToDateFormat(bzrdir.BzrDirFormat4())
137
self.assertEqualDiff("The branch format Bazaar-NG branch, "
138
"format 0.0.4 is already at the most "
142
def test_corrupt_repository(self):
143
repo = self.make_repository('.')
144
error = errors.CorruptRepository(repo)
145
self.assertEqualDiff("An error has been detected in the repository %s.\n"
146
"Please run bzr reconcile on this repository." %
147
repo.bzrdir.root_transport.base,
150
def test_bzrnewerror_is_deprecated(self):
151
class DeprecatedError(errors.BzrNewError):
153
self.callDeprecated(['BzrNewError was deprecated in bzr 0.13; '
154
'please convert DeprecatedError to use BzrError instead'],
209
157
def test_bzrerror_from_literal_string(self):
210
158
# Some code constructs BzrError from a literal string, in which case
285
233
host='ahost', port=444, msg='Unable to connect to ssh host',
286
234
orig_error='my_error')
288
def test_target_not_branch(self):
289
"""Test the formatting of TargetNotBranch."""
290
error = errors.TargetNotBranch('foo')
292
"Your branch does not have all of the revisions required in "
293
"order to merge this merge directive and the target "
294
"location specified in the merge directive is not a branch: "
297
def test_unexpected_smart_server_response(self):
298
e = errors.UnexpectedSmartServerResponse(('not yes',))
300
"Could not understand response from smart server: ('not yes',)",
303
def test_unknown_container_format(self):
304
"""Test the formatting of UnknownContainerFormatError."""
305
e = errors.UnknownContainerFormatError('bad format string')
307
"Unrecognised container format: 'bad format string'",
310
def test_unexpected_end_of_container(self):
311
"""Test the formatting of UnexpectedEndOfContainerError."""
312
e = errors.UnexpectedEndOfContainerError()
314
"Unexpected end of container stream", str(e))
316
def test_unknown_record_type(self):
317
"""Test the formatting of UnknownRecordTypeError."""
318
e = errors.UnknownRecordTypeError("X")
320
"Unknown record type: 'X'",
323
def test_invalid_record(self):
324
"""Test the formatting of InvalidRecordError."""
325
e = errors.InvalidRecordError("xxx")
327
"Invalid record: xxx",
330
def test_container_has_excess_data(self):
331
"""Test the formatting of ContainerHasExcessDataError."""
332
e = errors.ContainerHasExcessDataError("excess bytes")
334
"Container has data after end marker: 'excess bytes'",
337
def test_duplicate_record_name_error(self):
338
"""Test the formatting of DuplicateRecordNameError."""
339
e = errors.DuplicateRecordNameError(b"n\xc3\xa5me")
341
u"Container has multiple records with the same name: n\xe5me",
344
def test_check_error(self):
345
e = errors.BzrCheckError('example check failure')
347
"Internal check failed: example check failure",
349
self.assertTrue(e.internal_error)
351
def test_repository_data_stream_error(self):
352
"""Test the formatting of RepositoryDataStreamError."""
353
e = errors.RepositoryDataStreamError(u"my reason")
355
"Corrupt or incompatible data stream: my reason", str(e))
357
def test_immortal_pending_deletion_message(self):
358
err = errors.ImmortalPendingDeletion('foo')
360
"Unable to delete transform temporary directory foo. "
361
"Please examine foo to see if it contains any files "
362
"you wish to keep, and delete it when you are done.",
365
def test_invalid_url_join(self):
366
"""Test the formatting of InvalidURLJoin."""
367
e = urlutils.InvalidURLJoin('Reason', 'base path', ('args',))
369
"Invalid URL join request: Reason: 'base path' + ('args',)",
372
def test_unable_encode_path(self):
373
err = errors.UnableEncodePath('foo', 'executable')
374
self.assertEqual("Unable to encode executable path 'foo' in "
375
"user encoding " + osutils.get_user_encoding(),
378
def test_unknown_format(self):
379
err = errors.UnknownFormatError('bar', kind='foo')
380
self.assertEqual("Unknown foo format: 'bar'", str(err))
382
def test_tip_change_rejected(self):
383
err = errors.TipChangeRejected(u'Unicode message\N{INTERROBANG}')
385
u'Tip change rejected: Unicode message\N{INTERROBANG}',
388
def test_error_from_smart_server(self):
389
error_tuple = ('error', 'tuple')
390
err = errors.ErrorFromSmartServer(error_tuple)
392
"Error received from smart server: ('error', 'tuple')", str(err))
394
def test_untranslateable_error_from_smart_server(self):
395
error_tuple = ('error', 'tuple')
396
orig_err = errors.ErrorFromSmartServer(error_tuple)
397
err = errors.UnknownErrorFromSmartServer(orig_err)
399
"Server sent an unexpected error: ('error', 'tuple')", str(err))
401
def test_smart_message_handler_error(self):
402
# Make an exc_info tuple.
404
raise Exception("example error")
406
err = errors.SmartMessageHandlerError(sys.exc_info())
407
# GZ 2010-11-08: Should not store exc_info in exception instances.
409
self.assertStartsWith(
410
str(err), "The message handler raised an exception:\n")
411
self.assertEndsWith(str(err), "Exception: example error\n")
415
def test_unresumable_write_group(self):
417
wg_tokens = ['token']
419
err = errors.UnresumableWriteGroup(repo, wg_tokens, reason)
421
"Repository dummy repo cannot resume write group "
422
"['token']: a reason", str(err))
424
def test_unsuspendable_write_group(self):
426
err = errors.UnsuspendableWriteGroup(repo)
428
'Repository dummy repo cannot suspend a write group.', str(err))
430
def test_not_branch_no_args(self):
431
err = errors.NotBranchError('path')
432
self.assertEqual('Not a branch: "path".', str(err))
434
def test_not_branch_bzrdir_with_recursive_not_branch_error(self):
435
class FakeBzrDir(object):
436
def open_repository(self):
437
# str() on the NotBranchError will trigger a call to this,
438
# which in turn will another, identical NotBranchError.
439
raise errors.NotBranchError('path', controldir=FakeBzrDir())
440
err = errors.NotBranchError('path', controldir=FakeBzrDir())
441
self.assertEqual('Not a branch: "path": NotBranchError.', str(err))
443
def test_recursive_bind(self):
444
error = errors.RecursiveBind('foo_bar_branch')
445
msg = ('Branch "foo_bar_branch" appears to be bound to itself. '
446
'Please use `brz unbind` to fix.')
447
self.assertEqualDiff(msg, str(error))
449
def test_retry_with_new_packs(self):
450
fake_exc_info = ('{exc type}', '{exc value}', '{exc traceback}')
451
error = errors.RetryWithNewPacks(
452
'{context}', reload_occurred=False, exc_info=fake_exc_info)
454
'Pack files have changed, reload and retry. context: '
455
'{context} {exc value}', str(error))
458
238
class PassThroughError(errors.BzrError):
460
240
_fmt = """Pass through %(foo)s and %(bar)s"""
462
242
def __init__(self, foo, bar):
497
281
self.assertStartsWith(
498
282
str(e), 'Unprintable exception ErrorWithBadFormat')
500
def test_cannot_bind_address(self):
501
# see <https://bugs.launchpad.net/bzr/+bug/286871>
502
e = errors.CannotBindAddress('example.com', 22,
503
socket.error(13, 'Permission denied'))
504
self.assertContainsRe(
506
r'Cannot bind address "example\.com:22":.*Permission denied')
509
class TestErrorsUsingTransport(tests.TestCaseWithMemoryTransport):
510
"""Tests for errors that need to use a branch or repo."""
512
def test_no_public_branch(self):
513
b = self.make_branch('.')
514
error = errors.NoPublicBranch(b)
515
url = urlutils.unescape_for_display(b.base, 'ascii')
516
self.assertEqualDiff(
517
'There is no public branch set for "%s".' % url, str(error))
519
def test_no_repo(self):
520
dir = controldir.ControlDir.create(self.get_url())
521
error = errors.NoRepositoryPresent(dir)
522
self.assertNotEqual(-1,
523
str(error).find((dir.transport.clone('..').base)))
524
self.assertEqual(-1, str(error).find((dir.transport.base)))
526
def test_corrupt_repository(self):
527
repo = self.make_repository('.')
528
error = errors.CorruptRepository(repo)
529
self.assertEqualDiff("An error has been detected in the repository %s.\n"
530
"Please run brz reconcile on this repository." %
531
repo.controldir.root_transport.base,
534
def test_not_branch_bzrdir_with_repo(self):
535
controldir = self.make_repository('repo').controldir
536
err = errors.NotBranchError('path', controldir=controldir)
538
'Not a branch: "path": location is a repository.', str(err))
540
def test_not_branch_bzrdir_without_repo(self):
541
controldir = self.make_controldir('bzrdir')
542
err = errors.NotBranchError('path', controldir=controldir)
543
self.assertEqual('Not a branch: "path".', str(err))
545
def test_not_branch_laziness(self):
546
real_bzrdir = self.make_controldir('path')
548
class FakeBzrDir(object):
552
def open_repository(self):
553
self.calls.append('open_repository')
554
raise errors.NoRepositoryPresent(real_bzrdir)
555
fake_bzrdir = FakeBzrDir()
556
err = errors.NotBranchError('path', controldir=fake_bzrdir)
557
self.assertEqual([], fake_bzrdir.calls)
559
self.assertEqual(['open_repository'], fake_bzrdir.calls)
560
# Stringifying twice doesn't try to open a repository twice.
562
self.assertEqual(['open_repository'], fake_bzrdir.calls)
added
removed
bzrlib/tests/test_errors.py
