15
13
# You should have received a copy of the GNU General Public License
16
14
# along with this program; if not, write to the Free Software
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
17
"""Tests for the formatting and construction of errors."""
21
24
from bzrlib import (
25
from bzrlib.tests import TestCase, TestCaseWithTransport
28
# TODO: Make sure builtin exception class formats are consistent - e.g. should
29
# or shouldn't end with a full stop, etc.
30
from bzrlib.tests import (
32
TestCaseWithTransport,
32
37
class TestErrors(TestCaseWithTransport):
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
subclasses_present = getattr(errors.BzrError, '__subclasses__', None)
49
if not subclasses_present:
50
raise TestSkipped('__subclasses__ attribute required for classes. '
51
'Requires Python 2.5 or later.')
52
for c in errors.BzrError.__subclasses__():
53
init = getattr(c, '__init__', None)
54
fmt = getattr(c, '_fmt', None)
56
args = inspect.getargspec(init)[0]
57
self.assertFalse('message' in args,
58
('Argument name "message" not allowed for '
59
'"errors.%s.__init__"' % c.__name__))
60
if fmt and fmt_pattern.search(fmt):
61
self.assertFalse(True, ('"message" not allowed in '
62
'"errors.%s._fmt"' % c.__name__))
64
def test_bad_filename_encoding(self):
65
error = errors.BadFilenameEncoding('bad/filen\xe5me', 'UTF-8')
67
"Filename 'bad/filen\\xe5me' is not valid in your current"
68
" filesystem encoding UTF-8",
71
def test_corrupt_dirstate(self):
72
error = errors.CorruptDirstate('path/to/dirstate', 'the reason why')
74
"Inconsistency in dirstate file path/to/dirstate.\n"
75
"Error: the reason why",
78
def test_dirstate_corrupt(self):
79
error = errors.DirstateCorrupt('.bzr/checkout/dirstate',
80
'trailing garbage: "x"')
81
self.assertEqualDiff("The dirstate file (.bzr/checkout/dirstate)"
82
" appears to be corrupt: trailing garbage: \"x\"",
34
85
def test_disabled_method(self):
35
86
error = errors.DisabledMethod("class name")
36
87
self.assertEqualDiff(
46
97
self.assertEqualDiff('The prefix foo is in the help search path twice.',
100
def test_ghost_revisions_have_no_revno(self):
101
error = errors.GhostRevisionsHaveNoRevno('target', 'ghost_rev')
102
self.assertEqualDiff("Could not determine revno for {target} because"
103
" its ancestry shows a ghost at {ghost_rev}",
106
def test_incompatibleAPI(self):
107
error = errors.IncompatibleAPI("module", (1, 2, 3), (4, 5, 6), (7, 8, 9))
108
self.assertEqualDiff(
109
'The API for "module" is not compatible with "(1, 2, 3)". '
110
'It supports versions "(4, 5, 6)" to "(7, 8, 9)".',
113
def test_inconsistent_delta(self):
114
error = errors.InconsistentDelta('path', 'file-id', 'reason for foo')
115
self.assertEqualDiff(
116
"An inconsistent delta was supplied involving 'path', 'file-id'\n"
117
"reason: reason for foo",
120
def test_inconsistent_delta_delta(self):
121
error = errors.InconsistentDeltaDelta([], 'reason')
122
self.assertEqualDiff(
123
"An inconsistent delta was supplied: []\nreason: reason",
126
def test_in_process_transport(self):
127
error = errors.InProcessTransport('fpp')
128
self.assertEqualDiff(
129
"The transport 'fpp' is only accessible within this process.",
132
def test_invalid_http_range(self):
133
error = errors.InvalidHttpRange('path',
134
'Content-Range: potatoes 0-00/o0oo0',
136
self.assertEquals("Invalid http range"
137
" 'Content-Range: potatoes 0-00/o0oo0'"
138
" for path: bad range",
141
def test_invalid_range(self):
142
error = errors.InvalidRange('path', 12, 'bad range')
143
self.assertEquals("Invalid range access in path at 12: bad range",
49
146
def test_inventory_modified(self):
50
147
error = errors.InventoryModified("a tree to be repred")
51
148
self.assertEqualDiff("The current inventory for the tree 'a tree to "
266
459
"Could not understand response from smart server: ('not yes',)",
462
def test_unknown_container_format(self):
463
"""Test the formatting of UnknownContainerFormatError."""
464
e = errors.UnknownContainerFormatError('bad format string')
466
"Unrecognised container format: 'bad format string'",
469
def test_unexpected_end_of_container(self):
470
"""Test the formatting of UnexpectedEndOfContainerError."""
471
e = errors.UnexpectedEndOfContainerError()
473
"Unexpected end of container stream", str(e))
475
def test_unknown_record_type(self):
476
"""Test the formatting of UnknownRecordTypeError."""
477
e = errors.UnknownRecordTypeError("X")
479
"Unknown record type: 'X'",
482
def test_invalid_record(self):
483
"""Test the formatting of InvalidRecordError."""
484
e = errors.InvalidRecordError("xxx")
486
"Invalid record: xxx",
489
def test_container_has_excess_data(self):
490
"""Test the formatting of ContainerHasExcessDataError."""
491
e = errors.ContainerHasExcessDataError("excess bytes")
493
"Container has data after end marker: 'excess bytes'",
496
def test_duplicate_record_name_error(self):
497
"""Test the formatting of DuplicateRecordNameError."""
498
e = errors.DuplicateRecordNameError(u"n\xe5me".encode('utf-8'))
500
"Container has multiple records with the same name: n\xc3\xa5me",
503
def test_check_error(self):
504
# This has a member called 'message', which is problematic in
505
# python2.5 because that is a slot on the base Exception class
506
e = errors.BzrCheckError('example check failure')
508
"Internal check failed: example check failure",
510
self.assertTrue(e.internal_error)
512
def test_repository_data_stream_error(self):
513
"""Test the formatting of RepositoryDataStreamError."""
514
e = errors.RepositoryDataStreamError(u"my reason")
516
"Corrupt or incompatible data stream: my reason", str(e))
518
def test_immortal_pending_deletion_message(self):
519
err = errors.ImmortalPendingDeletion('foo')
521
"Unable to delete transform temporary directory foo. "
522
"Please examine foo to see if it contains any files "
523
"you wish to keep, and delete it when you are done.",
526
def test_unable_create_symlink(self):
527
err = errors.UnableCreateSymlink()
529
"Unable to create symlink on this platform",
531
err = errors.UnableCreateSymlink(path=u'foo')
533
"Unable to create symlink 'foo' on this platform",
535
err = errors.UnableCreateSymlink(path=u'\xb5')
537
"Unable to create symlink u'\\xb5' on this platform",
540
def test_invalid_url_join(self):
541
"""Test the formatting of InvalidURLJoin."""
542
e = errors.InvalidURLJoin('Reason', 'base path', ('args',))
544
"Invalid URL join request: Reason: 'base path' + ('args',)",
547
def test_incorrect_url(self):
548
err = errors.InvalidBugTrackerURL('foo', 'http://bug.com/')
550
("The URL for bug tracker \"foo\" doesn't contain {id}: "
554
def test_unable_encode_path(self):
555
err = errors.UnableEncodePath('foo', 'executable')
556
self.assertEquals("Unable to encode executable path 'foo' in "
557
"user encoding " + osutils.get_user_encoding(),
560
def test_unknown_format(self):
561
err = errors.UnknownFormatError('bar', kind='foo')
562
self.assertEquals("Unknown foo format: 'bar'", str(err))
564
def test_unknown_rules(self):
565
err = errors.UnknownRules(['foo', 'bar'])
566
self.assertEquals("Unknown rules detected: foo, bar.", str(err))
568
def test_tip_change_rejected(self):
569
err = errors.TipChangeRejected(u'Unicode message\N{INTERROBANG}')
571
u'Tip change rejected: Unicode message\N{INTERROBANG}',
574
'Tip change rejected: Unicode message\xe2\x80\xbd',
577
def test_error_from_smart_server(self):
578
error_tuple = ('error', 'tuple')
579
err = errors.ErrorFromSmartServer(error_tuple)
581
"Error received from smart server: ('error', 'tuple')", str(err))
583
def test_untranslateable_error_from_smart_server(self):
584
error_tuple = ('error', 'tuple')
585
orig_err = errors.ErrorFromSmartServer(error_tuple)
586
err = errors.UnknownErrorFromSmartServer(orig_err)
588
"Server sent an unexpected error: ('error', 'tuple')", str(err))
590
def test_smart_message_handler_error(self):
591
# Make an exc_info tuple.
593
raise Exception("example error")
595
err = errors.SmartMessageHandlerError(sys.exc_info())
596
# GZ 2010-11-08: Should not store exc_info in exception instances.
598
self.assertStartsWith(
599
str(err), "The message handler raised an exception:\n")
600
self.assertEndsWith(str(err), "Exception: example error\n")
604
def test_must_have_working_tree(self):
605
err = errors.MustHaveWorkingTree('foo', 'bar')
606
self.assertEqual(str(err), "Branching 'bar'(foo) must create a"
609
def test_no_such_view(self):
610
err = errors.NoSuchView('foo')
611
self.assertEquals("No such view: foo.", str(err))
613
def test_views_not_supported(self):
614
err = errors.ViewsNotSupported('atree')
616
self.assertStartsWith(err_str, "Views are not supported by ")
617
self.assertEndsWith(err_str, "; use 'bzr upgrade' to change your "
618
"tree to a later format.")
620
def test_file_outside_view(self):
621
err = errors.FileOutsideView('baz', ['foo', 'bar'])
622
self.assertEquals('Specified file "baz" is outside the current view: '
623
'foo, bar', str(err))
625
def test_invalid_shelf_id(self):
627
err = errors.InvalidShelfId(invalid_id)
628
self.assertEqual('"foo" is not a valid shelf id, '
629
'try a number instead.', str(err))
631
def test_unresumable_write_group(self):
633
wg_tokens = ['token']
635
err = errors.UnresumableWriteGroup(repo, wg_tokens, reason)
637
"Repository dummy repo cannot resume write group "
638
"['token']: a reason", str(err))
640
def test_unsuspendable_write_group(self):
642
err = errors.UnsuspendableWriteGroup(repo)
644
'Repository dummy repo cannot suspend a write group.', str(err))
646
def test_not_branch_no_args(self):
647
err = errors.NotBranchError('path')
648
self.assertEqual('Not a branch: "path".', str(err))
650
def test_not_branch_bzrdir_with_repo(self):
651
bzrdir = self.make_repository('repo').bzrdir
652
err = errors.NotBranchError('path', bzrdir=bzrdir)
654
'Not a branch: "path": location is a repository.', str(err))
656
def test_not_branch_bzrdir_without_repo(self):
657
bzrdir = self.make_bzrdir('bzrdir')
658
err = errors.NotBranchError('path', bzrdir=bzrdir)
659
self.assertEqual('Not a branch: "path".', str(err))
661
def test_not_branch_bzrdir_with_recursive_not_branch_error(self):
662
class FakeBzrDir(object):
663
def open_repository(self):
664
# str() on the NotBranchError will trigger a call to this,
665
# which in turn will another, identical NotBranchError.
666
raise errors.NotBranchError('path', bzrdir=FakeBzrDir())
667
err = errors.NotBranchError('path', bzrdir=FakeBzrDir())
668
self.assertEqual('Not a branch: "path".', str(err))
670
def test_not_branch_laziness(self):
671
real_bzrdir = self.make_bzrdir('path')
672
class FakeBzrDir(object):
675
def open_repository(self):
676
self.calls.append('open_repository')
677
raise errors.NoRepositoryPresent(real_bzrdir)
678
fake_bzrdir = FakeBzrDir()
679
err = errors.NotBranchError('path', bzrdir=fake_bzrdir)
680
self.assertEqual([], fake_bzrdir.calls)
682
self.assertEqual(['open_repository'], fake_bzrdir.calls)
683
# Stringifying twice doesn't try to open a repository twice.
685
self.assertEqual(['open_repository'], fake_bzrdir.calls)
687
def test_invalid_pattern(self):
688
error = errors.InvalidPattern('Bad pattern msg.')
689
self.assertEqualDiff("Invalid pattern(s) found. Bad pattern msg.",
692
def test_recursive_bind(self):
693
error = errors.RecursiveBind('foo_bar_branch')
694
msg = ('Branch "foo_bar_branch" appears to be bound to itself. '
695
'Please use `bzr unbind` to fix.')
696
self.assertEqualDiff(msg, str(error))
698
def test_retry_with_new_packs(self):
699
fake_exc_info = ('{exc type}', '{exc value}', '{exc traceback}')
700
error = errors.RetryWithNewPacks(
701
'{context}', reload_occurred=False, exc_info=fake_exc_info)
703
'Pack files have changed, reload and retry. context: '
704
'{context} {exc value}', str(error))
270
707
class PassThroughError(errors.BzrError):
272
709
_fmt = """Pass through %(foo)s and %(bar)s"""
274
711
def __init__(self, foo, bar):