1
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
2
# Authors: Robert Collins <robert.collins@canonical.com>
5
# This program is free software; you can redistribute it and/or modify
6
# it under the terms of the GNU General Public License as published by
7
# the Free Software Foundation; either version 2 of the License, or
8
# (at your option) any later version.
10
# This program is distributed in the hope that it will be useful,
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
# GNU General Public License for more details.
15
# You should have received a copy of the GNU General Public License
16
# along with this program; if not, write to the Free Software
17
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
"""Tests for the formatting and construction of errors."""
29
from bzrlib.tests import TestCase, TestCaseWithTransport
32
class TestErrors(TestCaseWithTransport):
34
def test_bad_filename_encoding(self):
35
error = errors.BadFilenameEncoding('bad/filen\xe5me', 'UTF-8')
37
"Filename 'bad/filen\\xe5me' is not valid in your current"
38
" filesystem encoding UTF-8",
41
def test_corrupt_dirstate(self):
42
error = errors.CorruptDirstate('path/to/dirstate', 'the reason why')
44
"Inconsistency in dirstate file path/to/dirstate.\n"
45
"Error: the reason why",
48
def test_dirstate_corrupt(self):
49
error = errors.DirstateCorrupt('.bzr/checkout/dirstate',
50
'trailing garbage: "x"')
51
self.assertEqualDiff("The dirstate file (.bzr/checkout/dirstate)"
52
" appears to be corrupt: trailing garbage: \"x\"",
55
def test_disabled_method(self):
56
error = errors.DisabledMethod("class name")
58
"The smart server method 'class name' is disabled.", str(error))
60
def test_duplicate_file_id(self):
61
error = errors.DuplicateFileId('a_file_id', 'foo')
62
self.assertEqualDiff('File id {a_file_id} already exists in inventory'
63
' as foo', str(error))
65
def test_duplicate_help_prefix(self):
66
error = errors.DuplicateHelpPrefix('foo')
67
self.assertEqualDiff('The prefix foo is in the help search path twice.',
70
def test_ghost_revisions_have_no_revno(self):
71
error = errors.GhostRevisionsHaveNoRevno('target', 'ghost_rev')
72
self.assertEqualDiff("Could not determine revno for {target} because"
73
" its ancestry shows a ghost at {ghost_rev}",
76
def test_incompatibleAPI(self):
77
error = errors.IncompatibleAPI("module", (1, 2, 3), (4, 5, 6), (7, 8, 9))
79
'The API for "module" is not compatible with "(1, 2, 3)". '
80
'It supports versions "(4, 5, 6)" to "(7, 8, 9)".',
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_in_process_transport(self):
91
error = errors.InProcessTransport('fpp')
93
"The transport 'fpp' is only accessible within this process.",
96
def test_invalid_http_range(self):
97
error = errors.InvalidHttpRange('path',
98
'Content-Range: potatoes 0-00/o0oo0',
100
self.assertEquals("Invalid http range"
101
" 'Content-Range: potatoes 0-00/o0oo0'"
102
" for path: bad range",
105
def test_invalid_range(self):
106
error = errors.InvalidRange('path', 12, 'bad range')
107
self.assertEquals("Invalid range access in path at 12: bad range",
110
def test_inventory_modified(self):
111
error = errors.InventoryModified("a tree to be repred")
112
self.assertEqualDiff("The current inventory for the tree 'a tree to "
113
"be repred' has been modified, so a clean inventory cannot be "
114
"read without data loss.",
117
def test_jail_break(self):
118
error = errors.JailBreak("some url")
119
self.assertEqualDiff("An attempt to access a url outside the server"
120
" jail was made: 'some url'.",
123
def test_lock_active(self):
124
error = errors.LockActive("lock description")
125
self.assertEqualDiff("The lock for 'lock description' is in use and "
129
def test_knit_data_stream_incompatible(self):
130
error = errors.KnitDataStreamIncompatible(
131
'stream format', 'target format')
132
self.assertEqual('Cannot insert knit data stream of format '
133
'"stream format" into knit of format '
134
'"target format".', str(error))
136
def test_knit_data_stream_unknown(self):
137
error = errors.KnitDataStreamUnknown(
139
self.assertEqual('Cannot parse knit data stream of format '
140
'"stream format".', str(error))
142
def test_knit_header_error(self):
143
error = errors.KnitHeaderError('line foo\n', 'path/to/file')
144
self.assertEqual("Knit header error: 'line foo\\n' unexpected"
145
" for file \"path/to/file\".", str(error))
147
def test_knit_index_unknown_method(self):
148
error = errors.KnitIndexUnknownMethod('http://host/foo.kndx',
150
self.assertEqual("Knit index http://host/foo.kndx does not have a"
151
" known method in options: ['bad', 'no-eol']",
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_public_branch(self):
160
b = self.make_branch('.')
161
error = errors.NoPublicBranch(b)
162
url = urlutils.unescape_for_display(b.base, 'ascii')
163
self.assertEqualDiff(
164
'There is no public branch set for "%s".' % url, str(error))
166
def test_no_repo(self):
167
dir = bzrdir.BzrDir.create(self.get_url())
168
error = errors.NoRepositoryPresent(dir)
169
self.assertNotEqual(-1, str(error).find((dir.transport.clone('..').base)))
170
self.assertEqual(-1, str(error).find((dir.transport.base)))
172
def test_no_smart_medium(self):
173
error = errors.NoSmartMedium("a transport")
174
self.assertEqualDiff("The transport 'a transport' cannot tunnel the "
178
def test_no_help_topic(self):
179
error = errors.NoHelpTopic("topic")
180
self.assertEqualDiff("No help could be found for 'topic'. "
181
"Please use 'bzr help topics' to obtain a list of topics.",
184
def test_no_such_id(self):
185
error = errors.NoSuchId("atree", "anid")
186
self.assertEqualDiff("The file id \"anid\" is not present in the tree "
190
def test_no_such_revision_in_tree(self):
191
error = errors.NoSuchRevisionInTree("atree", "anid")
192
self.assertEqualDiff("The revision id {anid} is not present in the"
193
" tree atree.", str(error))
194
self.assertIsInstance(error, errors.NoSuchRevision)
196
def test_not_stacked(self):
197
error = errors.NotStacked('a branch')
198
self.assertEqualDiff("The branch 'a branch' is not stacked.",
201
def test_not_write_locked(self):
202
error = errors.NotWriteLocked('a thing to repr')
203
self.assertEqualDiff("'a thing to repr' is not write locked but needs "
207
def test_lock_failed(self):
208
error = errors.LockFailed('http://canonical.com/', 'readonly transport')
209
self.assertEqualDiff("Cannot lock http://canonical.com/: readonly transport",
211
self.assertFalse(error.internal_error)
213
def test_too_many_concurrent_requests(self):
214
error = errors.TooManyConcurrentRequests("a medium")
215
self.assertEqualDiff("The medium 'a medium' has reached its concurrent "
216
"request limit. Be sure to finish_writing and finish_reading on "
217
"the currently open request.",
220
def test_unavailable_representation(self):
221
error = errors.UnavailableRepresentation(('key',), "mpdiff", "fulltext")
222
self.assertEqualDiff("The encoding 'mpdiff' is not available for key "
223
"('key',) which is encoded as 'fulltext'.",
226
def test_unknown_hook(self):
227
error = errors.UnknownHook("branch", "foo")
228
self.assertEqualDiff("The branch hook 'foo' is unknown in this version"
231
error = errors.UnknownHook("tree", "bar")
232
self.assertEqualDiff("The tree hook 'bar' is unknown in this version"
236
def test_unstackable_branch_format(self):
239
error = errors.UnstackableBranchFormat(format, url)
240
self.assertEqualDiff(
241
"The branch '/foo'(foo) is not a stackable format. "
242
"You will need to upgrade the branch to permit branch stacking.",
245
def test_unstackable_repository_format(self):
248
error = errors.UnstackableRepositoryFormat(format, url)
249
self.assertEqualDiff(
250
"The repository '/foo'(foo) is not a stackable format. "
251
"You will need to upgrade the repository to permit branch stacking.",
254
def test_up_to_date(self):
255
error = errors.UpToDateFormat(bzrdir.BzrDirFormat4())
256
self.assertEqualDiff("The branch format All-in-one "
257
"format 4 is already at the most "
261
def test_corrupt_repository(self):
262
repo = self.make_repository('.')
263
error = errors.CorruptRepository(repo)
264
self.assertEqualDiff("An error has been detected in the repository %s.\n"
265
"Please run bzr reconcile on this repository." %
266
repo.bzrdir.root_transport.base,
269
def test_read_error(self):
270
# a unicode path to check that %r is being used.
272
error = errors.ReadError(path)
273
self.assertEqualDiff("Error reading from u'a path'.", str(error))
275
def test_bad_index_format_signature(self):
276
error = errors.BadIndexFormatSignature("foo", "bar")
277
self.assertEqual("foo is not an index of type bar.",
280
def test_bad_index_data(self):
281
error = errors.BadIndexData("foo")
282
self.assertEqual("Error in data for index foo.",
285
def test_bad_index_duplicate_key(self):
286
error = errors.BadIndexDuplicateKey("foo", "bar")
287
self.assertEqual("The key 'foo' is already in index 'bar'.",
290
def test_bad_index_key(self):
291
error = errors.BadIndexKey("foo")
292
self.assertEqual("The key 'foo' is not a valid key.",
295
def test_bad_index_options(self):
296
error = errors.BadIndexOptions("foo")
297
self.assertEqual("Could not parse options for index foo.",
300
def test_bad_index_value(self):
301
error = errors.BadIndexValue("foo")
302
self.assertEqual("The value 'foo' is not a valid value.",
305
def test_bzrnewerror_is_deprecated(self):
306
class DeprecatedError(errors.BzrNewError):
308
self.callDeprecated(['BzrNewError was deprecated in bzr 0.13; '
309
'please convert DeprecatedError to use BzrError instead'],
312
def test_bzrerror_from_literal_string(self):
313
# Some code constructs BzrError from a literal string, in which case
314
# no further formatting is done. (I'm not sure raising the base class
315
# is a great idea, but if the exception is not intended to be caught
316
# perhaps no more is needed.)
318
raise errors.BzrError('this is my errors; %d is not expanded')
319
except errors.BzrError, e:
320
self.assertEqual('this is my errors; %d is not expanded', str(e))
322
def test_reading_completed(self):
323
error = errors.ReadingCompleted("a request")
324
self.assertEqualDiff("The MediumRequest 'a request' has already had "
325
"finish_reading called upon it - the request has been completed and"
326
" no more data may be read.",
329
def test_writing_completed(self):
330
error = errors.WritingCompleted("a request")
331
self.assertEqualDiff("The MediumRequest 'a request' has already had "
332
"finish_writing called upon it - accept bytes may not be called "
336
def test_writing_not_completed(self):
337
error = errors.WritingNotComplete("a request")
338
self.assertEqualDiff("The MediumRequest 'a request' has not has "
339
"finish_writing called upon it - until the write phase is complete"
340
" no data may be read.",
343
def test_transport_not_possible(self):
344
error = errors.TransportNotPossible('readonly', 'original error')
345
self.assertEqualDiff('Transport operation not possible:'
346
' readonly original error', str(error))
348
def assertSocketConnectionError(self, expected, *args, **kwargs):
349
"""Check the formatting of a SocketConnectionError exception"""
350
e = errors.SocketConnectionError(*args, **kwargs)
351
self.assertEqual(expected, str(e))
353
def test_socket_connection_error(self):
354
"""Test the formatting of SocketConnectionError"""
356
# There should be a default msg about failing to connect
357
# we only require a host name.
358
self.assertSocketConnectionError(
359
'Failed to connect to ahost',
362
# If port is None, we don't put :None
363
self.assertSocketConnectionError(
364
'Failed to connect to ahost',
366
# But if port is supplied we include it
367
self.assertSocketConnectionError(
368
'Failed to connect to ahost:22',
371
# We can also supply extra information about the error
372
# with or without a port
373
self.assertSocketConnectionError(
374
'Failed to connect to ahost:22; bogus error',
375
'ahost', port=22, orig_error='bogus error')
376
self.assertSocketConnectionError(
377
'Failed to connect to ahost; bogus error',
378
'ahost', orig_error='bogus error')
379
# An exception object can be passed rather than a string
380
orig_error = ValueError('bad value')
381
self.assertSocketConnectionError(
382
'Failed to connect to ahost; %s' % (str(orig_error),),
383
host='ahost', orig_error=orig_error)
385
# And we can supply a custom failure message
386
self.assertSocketConnectionError(
387
'Unable to connect to ssh host ahost:444; my_error',
388
host='ahost', port=444, msg='Unable to connect to ssh host',
389
orig_error='my_error')
391
def test_target_not_branch(self):
392
"""Test the formatting of TargetNotBranch."""
393
error = errors.TargetNotBranch('foo')
395
"Your branch does not have all of the revisions required in "
396
"order to merge this merge directive and the target "
397
"location specified in the merge directive is not a branch: "
400
def test_malformed_bug_identifier(self):
401
"""Test the formatting of MalformedBugIdentifier."""
402
error = errors.MalformedBugIdentifier('bogus', 'reason for bogosity')
404
'Did not understand bug identifier bogus: reason for bogosity. '
405
'See "bzr help bugs" for more information on this feature.',
408
def test_unknown_bug_tracker_abbreviation(self):
409
"""Test the formatting of UnknownBugTrackerAbbreviation."""
410
branch = self.make_branch('some_branch')
411
error = errors.UnknownBugTrackerAbbreviation('xxx', branch)
413
"Cannot find registered bug tracker called xxx on %s" % branch,
416
def test_unexpected_smart_server_response(self):
417
e = errors.UnexpectedSmartServerResponse(('not yes',))
419
"Could not understand response from smart server: ('not yes',)",
422
def test_unknown_container_format(self):
423
"""Test the formatting of UnknownContainerFormatError."""
424
e = errors.UnknownContainerFormatError('bad format string')
426
"Unrecognised container format: 'bad format string'",
429
def test_unexpected_end_of_container(self):
430
"""Test the formatting of UnexpectedEndOfContainerError."""
431
e = errors.UnexpectedEndOfContainerError()
433
"Unexpected end of container stream", str(e))
435
def test_unknown_record_type(self):
436
"""Test the formatting of UnknownRecordTypeError."""
437
e = errors.UnknownRecordTypeError("X")
439
"Unknown record type: 'X'",
442
def test_invalid_record(self):
443
"""Test the formatting of InvalidRecordError."""
444
e = errors.InvalidRecordError("xxx")
446
"Invalid record: xxx",
449
def test_container_has_excess_data(self):
450
"""Test the formatting of ContainerHasExcessDataError."""
451
e = errors.ContainerHasExcessDataError("excess bytes")
453
"Container has data after end marker: 'excess bytes'",
456
def test_duplicate_record_name_error(self):
457
"""Test the formatting of DuplicateRecordNameError."""
458
e = errors.DuplicateRecordNameError(u"n\xe5me".encode('utf-8'))
460
"Container has multiple records with the same name: n\xc3\xa5me",
463
def test_check_error(self):
464
# This has a member called 'message', which is problematic in
465
# python2.5 because that is a slot on the base Exception class
466
e = errors.BzrCheckError('example check failure')
468
"Internal check failed: example check failure",
470
self.assertTrue(e.internal_error)
472
def test_repository_data_stream_error(self):
473
"""Test the formatting of RepositoryDataStreamError."""
474
e = errors.RepositoryDataStreamError(u"my reason")
476
"Corrupt or incompatible data stream: my reason", str(e))
478
def test_immortal_pending_deletion_message(self):
479
err = errors.ImmortalPendingDeletion('foo')
481
"Unable to delete transform temporary directory foo. "
482
"Please examine foo to see if it contains any files "
483
"you wish to keep, and delete it when you are done.",
486
def test_unable_create_symlink(self):
487
err = errors.UnableCreateSymlink()
489
"Unable to create symlink on this platform",
491
err = errors.UnableCreateSymlink(path=u'foo')
493
"Unable to create symlink 'foo' on this platform",
495
err = errors.UnableCreateSymlink(path=u'\xb5')
497
"Unable to create symlink u'\\xb5' on this platform",
500
def test_invalid_url_join(self):
501
"""Test the formatting of InvalidURLJoin."""
502
e = errors.InvalidURLJoin('Reason', 'base path', ('args',))
504
"Invalid URL join request: Reason: 'base path' + ('args',)",
507
def test_incorrect_url(self):
508
err = errors.InvalidBugTrackerURL('foo', 'http://bug.com/')
510
("The URL for bug tracker \"foo\" doesn't contain {id}: "
514
def test_unable_encode_path(self):
515
err = errors.UnableEncodePath('foo', 'executable')
516
self.assertEquals("Unable to encode executable path 'foo' in "
517
"user encoding " + osutils.get_user_encoding(),
520
def test_unknown_format(self):
521
err = errors.UnknownFormatError('bar', kind='foo')
522
self.assertEquals("Unknown foo format: 'bar'", str(err))
524
def test_unknown_rules(self):
525
err = errors.UnknownRules(['foo', 'bar'])
526
self.assertEquals("Unknown rules detected: foo, bar.", str(err))
528
def test_hook_failed(self):
529
# Create an exc_info tuple by raising and catching an exception.
532
except ZeroDivisionError:
533
exc_info = sys.exc_info()
534
err = errors.HookFailed('hook stage', 'hook name', exc_info)
535
self.assertStartsWith(
536
str(err), 'Hook \'hook name\' during hook stage failed:\n')
538
str(err), 'integer division or modulo by zero')
540
def test_tip_change_rejected(self):
541
err = errors.TipChangeRejected(u'Unicode message\N{INTERROBANG}')
543
u'Tip change rejected: Unicode message\N{INTERROBANG}',
546
'Tip change rejected: Unicode message\xe2\x80\xbd',
549
def test_error_from_smart_server(self):
550
error_tuple = ('error', 'tuple')
551
err = errors.ErrorFromSmartServer(error_tuple)
553
"Error received from smart server: ('error', 'tuple')", str(err))
555
def test_untranslateable_error_from_smart_server(self):
556
error_tuple = ('error', 'tuple')
557
orig_err = errors.ErrorFromSmartServer(error_tuple)
558
err = errors.UnknownErrorFromSmartServer(orig_err)
560
"Server sent an unexpected error: ('error', 'tuple')", str(err))
562
def test_smart_message_handler_error(self):
563
# Make an exc_info tuple.
565
raise Exception("example error")
567
exc_info = sys.exc_info()
568
err = errors.SmartMessageHandlerError(exc_info)
569
self.assertStartsWith(
570
str(err), "The message handler raised an exception:\n")
571
self.assertEndsWith(str(err), "Exception: example error\n")
573
def test_must_have_working_tree(self):
574
err = errors.MustHaveWorkingTree('foo', 'bar')
575
self.assertEqual(str(err), "Branching 'bar'(foo) must create a"
578
def test_no_such_view(self):
579
err = errors.NoSuchView('foo')
580
self.assertEquals("No such view: foo.", str(err))
582
def test_views_not_supported(self):
583
err = errors.ViewsNotSupported('atree')
585
self.assertStartsWith(err_str, "Views are not supported by ")
586
self.assertEndsWith(err_str, "; use 'bzr upgrade' to change your "
587
"tree to a later format.")
589
def test_file_outside_view(self):
590
err = errors.FileOutsideView('baz', ['foo', 'bar'])
591
self.assertEquals('Specified file "baz" is outside the current view: '
592
'foo, bar', str(err))
594
def test_invalid_shelf_id(self):
596
err = errors.InvalidShelfId(invalid_id)
597
self.assertEqual('"foo" is not a valid shelf id, '
598
'try a number instead.', str(err))
600
def test_unresumable_write_group(self):
602
wg_tokens = ['token']
604
err = errors.UnresumableWriteGroup(repo, wg_tokens, reason)
606
"Repository dummy repo cannot resume write group "
607
"['token']: a reason", str(err))
609
def test_unsuspendable_write_group(self):
611
err = errors.UnsuspendableWriteGroup(repo)
613
'Repository dummy repo cannot suspend a write group.', str(err))
616
class PassThroughError(errors.BzrError):
618
_fmt = """Pass through %(foo)s and %(bar)s"""
620
def __init__(self, foo, bar):
621
errors.BzrError.__init__(self, foo=foo, bar=bar)
624
class ErrorWithBadFormat(errors.BzrError):
626
_fmt = """One format specifier: %(thing)s"""
629
class ErrorWithNoFormat(errors.BzrError):
630
"""This class has a docstring but no format string."""
633
class TestErrorFormatting(TestCase):
635
def test_always_str(self):
636
e = PassThroughError(u'\xb5', 'bar')
637
self.assertIsInstance(e.__str__(), str)
638
# In Python str(foo) *must* return a real byte string
639
# not a Unicode string. The following line would raise a
640
# Unicode error, because it tries to call str() on the string
641
# returned from e.__str__(), and it has non ascii characters
643
self.assertEqual('Pass through \xc2\xb5 and bar', s)
645
def test_missing_format_string(self):
646
e = ErrorWithNoFormat(param='randomvalue')
647
s = self.callDeprecated(
648
['ErrorWithNoFormat uses its docstring as a format, it should use _fmt instead'],
652
"This class has a docstring but no format string.")
654
def test_mismatched_format_args(self):
655
# Even though ErrorWithBadFormat's format string does not match the
656
# arguments we constructing it with, we can still stringify an instance
657
# of this exception. The resulting string will say its unprintable.
658
e = ErrorWithBadFormat(not_thing='x')
659
self.assertStartsWith(
660
str(e), 'Unprintable exception ErrorWithBadFormat')
added
removed
bzrlib/tests/test_errors.py
