← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_errors.py

  • Committer: Robert Collins
  • Date: 2010-04-08 04:34:03 UTC
  • mfrom: (5138 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5139.
  • Revision ID: robertc@robertcollins.net-20100408043403-56z0d07vdqrx7f3t
Update bugfix for 528114 to trunk.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_errors.py
1
 
# Copyright (C) 2006, 2007 Canonical Ltd
2
 
#   Authors: Robert Collins <robert.collins@canonical.com>
3
 
#            and others
 
1
# Copyright (C) 2006-2010 Canonical Ltd
4
2
#
5
3
# This program is free software; you can redistribute it and/or modify
6
4
# it under the terms of the GNU General Public License as published by
14
12
#
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
18
16
 
19
17
"""Tests for the formatting and construction of errors."""
20
18
 
 
19
import socket
 
20
import sys
 
21
 
21
22
from bzrlib import (
22
23
    bzrdir,
23
24
    errors,
 
25
    osutils,
24
26
    symbol_versioning,
 
27
    urlutils,
25
28
    )
26
29
from bzrlib.tests import TestCase, TestCaseWithTransport
27
30
 
28
31
 
29
32
class TestErrors(TestCaseWithTransport):
30
33
 
 
34
    def test_bad_filename_encoding(self):
 
35
        error = errors.BadFilenameEncoding('bad/filen\xe5me', 'UTF-8')
 
36
        self.assertEqualDiff(
 
37
            "Filename 'bad/filen\\xe5me' is not valid in your current"
 
38
            " filesystem encoding UTF-8",
 
39
            str(error))
 
40
 
 
41
    def test_corrupt_dirstate(self):
 
42
        error = errors.CorruptDirstate('path/to/dirstate', 'the reason why')
 
43
        self.assertEqualDiff(
 
44
            "Inconsistency in dirstate file path/to/dirstate.\n"
 
45
            "Error: the reason why",
 
46
            str(error))
 
47
 
 
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\"",
 
53
            str(error))
 
54
 
31
55
    def test_disabled_method(self):
32
56
        error = errors.DisabledMethod("class name")
33
57
        self.assertEqualDiff(
43
67
        self.assertEqualDiff('The prefix foo is in the help search path twice.',
44
68
            str(error))
45
69
 
 
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}",
 
74
                             str(error))
 
75
 
46
76
    def test_incompatibleAPI(self):
47
77
        error = errors.IncompatibleAPI("module", (1, 2, 3), (4, 5, 6), (7, 8, 9))
48
78
        self.assertEqualDiff(
50
80
            'It supports versions "(4, 5, 6)" to "(7, 8, 9)".',
51
81
            str(error))
52
82
 
 
83
    def test_inconsistent_delta(self):
 
84
        error = errors.InconsistentDelta('path', 'file-id', 'reason for foo')
 
85
        self.assertEqualDiff(
 
86
            "An inconsistent delta was supplied involving 'path', 'file-id'\n"
 
87
            "reason: reason for foo",
 
88
            str(error))
 
89
 
 
90
    def test_inconsistent_delta_delta(self):
 
91
        error = errors.InconsistentDeltaDelta([], 'reason')
 
92
        self.assertEqualDiff(
 
93
            "An inconsistent delta was supplied: []\nreason: reason",
 
94
            str(error))
 
95
 
53
96
    def test_in_process_transport(self):
54
97
        error = errors.InProcessTransport('fpp')
55
98
        self.assertEqualDiff(
77
120
            "read without data loss.",
78
121
            str(error))
79
122
 
80
 
    def test_install_failed(self):
81
 
        error = errors.InstallFailed(['rev-one'])
82
 
        self.assertEqual("Could not install revisions:\nrev-one", str(error))
83
 
        error = errors.InstallFailed(['rev-one', 'rev-two'])
84
 
        self.assertEqual("Could not install revisions:\nrev-one, rev-two",
85
 
                         str(error))
86
 
        error = errors.InstallFailed([None])
87
 
        self.assertEqual("Could not install revisions:\nNone", str(error))
 
123
    def test_jail_break(self):
 
124
        error = errors.JailBreak("some url")
 
125
        self.assertEqualDiff("An attempt to access a url outside the server"
 
126
            " jail was made: 'some url'.",
 
127
            str(error))
88
128
 
89
129
    def test_lock_active(self):
90
130
        error = errors.LockActive("lock description")
121
161
        error = errors.MediumNotConnected("a medium")
122
162
        self.assertEqualDiff(
123
163
            "The medium 'a medium' is not connected.", str(error))
124
 
        
 
164
 
 
165
    def test_no_public_branch(self):
 
166
        b = self.make_branch('.')
 
167
        error = errors.NoPublicBranch(b)
 
168
        url = urlutils.unescape_for_display(b.base, 'ascii')
 
169
        self.assertEqualDiff(
 
170
            'There is no public branch set for "%s".' % url, str(error))
 
171
 
125
172
    def test_no_repo(self):
126
173
        dir = bzrdir.BzrDir.create(self.get_url())
127
174
        error = errors.NoRepositoryPresent(dir)
128
175
        self.assertNotEqual(-1, str(error).find((dir.transport.clone('..').base)))
129
176
        self.assertEqual(-1, str(error).find((dir.transport.base)))
130
 
        
 
177
 
131
178
    def test_no_smart_medium(self):
132
179
        error = errors.NoSmartMedium("a transport")
133
180
        self.assertEqualDiff("The transport 'a transport' cannot tunnel the "
152
199
                             " tree atree.", str(error))
153
200
        self.assertIsInstance(error, errors.NoSuchRevision)
154
201
 
 
202
    def test_not_stacked(self):
 
203
        error = errors.NotStacked('a branch')
 
204
        self.assertEqualDiff("The branch 'a branch' is not stacked.",
 
205
            str(error))
 
206
 
155
207
    def test_not_write_locked(self):
156
208
        error = errors.NotWriteLocked('a thing to repr')
157
209
        self.assertEqualDiff("'a thing to repr' is not write locked but needs "
158
210
            "to be.",
159
211
            str(error))
160
212
 
161
 
    def test_read_only_lock_error(self):
162
 
        error = self.applyDeprecated(symbol_versioning.zero_ninetytwo,
163
 
            errors.ReadOnlyLockError, 'filename', 'error message')
164
 
        self.assertEqualDiff("Cannot acquire write lock on filename."
165
 
                             " error message", str(error))
166
 
 
167
213
    def test_lock_failed(self):
168
214
        error = errors.LockFailed('http://canonical.com/', 'readonly transport')
169
215
        self.assertEqualDiff("Cannot lock http://canonical.com/: readonly transport",
177
223
            "the currently open request.",
178
224
            str(error))
179
225
 
 
226
    def test_unavailable_representation(self):
 
227
        error = errors.UnavailableRepresentation(('key',), "mpdiff", "fulltext")
 
228
        self.assertEqualDiff("The encoding 'mpdiff' is not available for key "
 
229
            "('key',) which is encoded as 'fulltext'.",
 
230
            str(error))
 
231
 
180
232
    def test_unknown_hook(self):
181
233
        error = errors.UnknownHook("branch", "foo")
182
234
        self.assertEqualDiff("The branch hook 'foo' is unknown in this version"
187
239
            " of bzrlib.",
188
240
            str(error))
189
241
 
 
242
    def test_unstackable_branch_format(self):
 
243
        format = u'foo'
 
244
        url = "/foo"
 
245
        error = errors.UnstackableBranchFormat(format, url)
 
246
        self.assertEqualDiff(
 
247
            "The branch '/foo'(foo) is not a stackable format. "
 
248
            "You will need to upgrade the branch to permit branch stacking.",
 
249
            str(error))
 
250
 
 
251
    def test_unstackable_location(self):
 
252
        error = errors.UnstackableLocationError('foo', 'bar')
 
253
        self.assertEqualDiff("The branch 'foo' cannot be stacked on 'bar'.",
 
254
            str(error))
 
255
 
 
256
    def test_unstackable_repository_format(self):
 
257
        format = u'foo'
 
258
        url = "/foo"
 
259
        error = errors.UnstackableRepositoryFormat(format, url)
 
260
        self.assertEqualDiff(
 
261
            "The repository '/foo'(foo) is not a stackable format. "
 
262
            "You will need to upgrade the repository to permit branch stacking.",
 
263
            str(error))
 
264
 
190
265
    def test_up_to_date(self):
191
266
        error = errors.UpToDateFormat(bzrdir.BzrDirFormat4())
192
 
        self.assertEqualDiff("The branch format Bazaar-NG branch, "
193
 
                             "format 0.0.4 is already at the most "
 
267
        self.assertEqualDiff("The branch format All-in-one "
 
268
                             "format 4 is already at the most "
194
269
                             "recent format.",
195
270
                             str(error))
196
271
 
324
399
            host='ahost', port=444, msg='Unable to connect to ssh host',
325
400
            orig_error='my_error')
326
401
 
 
402
    def test_target_not_branch(self):
 
403
        """Test the formatting of TargetNotBranch."""
 
404
        error = errors.TargetNotBranch('foo')
 
405
        self.assertEqual(
 
406
            "Your branch does not have all of the revisions required in "
 
407
            "order to merge this merge directive and the target "
 
408
            "location specified in the merge directive is not a branch: "
 
409
            "foo.", str(error))
 
410
 
327
411
    def test_malformed_bug_identifier(self):
328
412
        """Test the formatting of MalformedBugIdentifier."""
329
413
        error = errors.MalformedBugIdentifier('bogus', 'reason for bogosity')
330
414
        self.assertEqual(
331
 
            "Did not understand bug identifier bogus: reason for bogosity",
 
415
            'Did not understand bug identifier bogus: reason for bogosity. '
 
416
            'See "bzr help bugs" for more information on this feature.',
332
417
            str(error))
333
418
 
334
419
    def test_unknown_bug_tracker_abbreviation(self):
385
470
        self.assertEqual(
386
471
            "Container has multiple records with the same name: n\xc3\xa5me",
387
472
            str(e))
388
 
        
 
473
 
389
474
    def test_check_error(self):
390
475
        # This has a member called 'message', which is problematic in
391
476
        # python2.5 because that is a slot on the base Exception class
423
508
            "Unable to create symlink u'\\xb5' on this platform",
424
509
            str(err))
425
510
 
 
511
    def test_invalid_url_join(self):
 
512
        """Test the formatting of InvalidURLJoin."""
 
513
        e = errors.InvalidURLJoin('Reason', 'base path', ('args',))
 
514
        self.assertEqual(
 
515
            "Invalid URL join request: Reason: 'base path' + ('args',)",
 
516
            str(e))
 
517
 
426
518
    def test_incorrect_url(self):
427
519
        err = errors.InvalidBugTrackerURL('foo', 'http://bug.com/')
428
520
        self.assertEquals(
430
522
             "http://bug.com/"),
431
523
            str(err))
432
524
 
 
525
    def test_unable_encode_path(self):
 
526
        err = errors.UnableEncodePath('foo', 'executable')
 
527
        self.assertEquals("Unable to encode executable path 'foo' in "
 
528
            "user encoding " + osutils.get_user_encoding(),
 
529
            str(err))
 
530
 
 
531
    def test_unknown_format(self):
 
532
        err = errors.UnknownFormatError('bar', kind='foo')
 
533
        self.assertEquals("Unknown foo format: 'bar'", str(err))
 
534
 
 
535
    def test_unknown_rules(self):
 
536
        err = errors.UnknownRules(['foo', 'bar'])
 
537
        self.assertEquals("Unknown rules detected: foo, bar.", str(err))
 
538
 
 
539
    def test_hook_failed(self):
 
540
        # Create an exc_info tuple by raising and catching an exception.
 
541
        try:
 
542
            1/0
 
543
        except ZeroDivisionError:
 
544
            exc_info = sys.exc_info()
 
545
        err = errors.HookFailed('hook stage', 'hook name', exc_info, warn=False)
 
546
        self.assertStartsWith(
 
547
            str(err), 'Hook \'hook name\' during hook stage failed:\n')
 
548
        self.assertEndsWith(
 
549
            str(err), 'integer division or modulo by zero')
 
550
 
 
551
    def test_tip_change_rejected(self):
 
552
        err = errors.TipChangeRejected(u'Unicode message\N{INTERROBANG}')
 
553
        self.assertEquals(
 
554
            u'Tip change rejected: Unicode message\N{INTERROBANG}',
 
555
            unicode(err))
 
556
        self.assertEquals(
 
557
            'Tip change rejected: Unicode message\xe2\x80\xbd',
 
558
            str(err))
 
559
 
 
560
    def test_error_from_smart_server(self):
 
561
        error_tuple = ('error', 'tuple')
 
562
        err = errors.ErrorFromSmartServer(error_tuple)
 
563
        self.assertEquals(
 
564
            "Error received from smart server: ('error', 'tuple')", str(err))
 
565
 
 
566
    def test_untranslateable_error_from_smart_server(self):
 
567
        error_tuple = ('error', 'tuple')
 
568
        orig_err = errors.ErrorFromSmartServer(error_tuple)
 
569
        err = errors.UnknownErrorFromSmartServer(orig_err)
 
570
        self.assertEquals(
 
571
            "Server sent an unexpected error: ('error', 'tuple')", str(err))
 
572
 
 
573
    def test_smart_message_handler_error(self):
 
574
        # Make an exc_info tuple.
 
575
        try:
 
576
            raise Exception("example error")
 
577
        except Exception:
 
578
            exc_info = sys.exc_info()
 
579
        err = errors.SmartMessageHandlerError(exc_info)
 
580
        self.assertStartsWith(
 
581
            str(err), "The message handler raised an exception:\n")
 
582
        self.assertEndsWith(str(err), "Exception: example error\n")
 
583
 
 
584
    def test_must_have_working_tree(self):
 
585
        err = errors.MustHaveWorkingTree('foo', 'bar')
 
586
        self.assertEqual(str(err), "Branching 'bar'(foo) must create a"
 
587
                                   " working tree.")
 
588
 
 
589
    def test_no_such_view(self):
 
590
        err = errors.NoSuchView('foo')
 
591
        self.assertEquals("No such view: foo.", str(err))
 
592
 
 
593
    def test_views_not_supported(self):
 
594
        err = errors.ViewsNotSupported('atree')
 
595
        err_str = str(err)
 
596
        self.assertStartsWith(err_str, "Views are not supported by ")
 
597
        self.assertEndsWith(err_str, "; use 'bzr upgrade' to change your "
 
598
            "tree to a later format.")
 
599
 
 
600
    def test_file_outside_view(self):
 
601
        err = errors.FileOutsideView('baz', ['foo', 'bar'])
 
602
        self.assertEquals('Specified file "baz" is outside the current view: '
 
603
            'foo, bar', str(err))
 
604
 
 
605
    def test_invalid_shelf_id(self):
 
606
        invalid_id = "foo"
 
607
        err = errors.InvalidShelfId(invalid_id)
 
608
        self.assertEqual('"foo" is not a valid shelf id, '
 
609
            'try a number instead.', str(err))
 
610
 
 
611
    def test_unresumable_write_group(self):
 
612
        repo = "dummy repo"
 
613
        wg_tokens = ['token']
 
614
        reason = "a reason"
 
615
        err = errors.UnresumableWriteGroup(repo, wg_tokens, reason)
 
616
        self.assertEqual(
 
617
            "Repository dummy repo cannot resume write group "
 
618
            "['token']: a reason", str(err))
 
619
 
 
620
    def test_unsuspendable_write_group(self):
 
621
        repo = "dummy repo"
 
622
        err = errors.UnsuspendableWriteGroup(repo)
 
623
        self.assertEqual(
 
624
            'Repository dummy repo cannot suspend a write group.', str(err))
 
625
 
 
626
    def test_not_branch_no_args(self):
 
627
        err = errors.NotBranchError('path')
 
628
        self.assertEqual('Not a branch: "path".', str(err))
 
629
 
 
630
    def test_not_branch_bzrdir_with_repo(self):
 
631
        bzrdir = self.make_repository('repo').bzrdir
 
632
        err = errors.NotBranchError('path', bzrdir=bzrdir)
 
633
        self.assertEqual(
 
634
            'Not a branch: "path": location is a repository.', str(err))
 
635
 
 
636
    def test_not_branch_bzrdir_without_repo(self):
 
637
        bzrdir = self.make_bzrdir('bzrdir')
 
638
        err = errors.NotBranchError('path', bzrdir=bzrdir)
 
639
        self.assertEqual('Not a branch: "path".', str(err))
 
640
 
 
641
    def test_not_branch_laziness(self):
 
642
        real_bzrdir = self.make_bzrdir('path')
 
643
        class FakeBzrDir(object):
 
644
            def __init__(self):
 
645
                self.calls = []
 
646
            def open_repository(self):
 
647
                self.calls.append('open_repository')
 
648
                raise errors.NoRepositoryPresent(real_bzrdir)
 
649
        fake_bzrdir = FakeBzrDir()
 
650
        err = errors.NotBranchError('path', bzrdir=fake_bzrdir)
 
651
        self.assertEqual([], fake_bzrdir.calls)
 
652
        str(err)
 
653
        self.assertEqual(['open_repository'], fake_bzrdir.calls)
 
654
        # Stringifying twice doesn't try to open a repository twice.
 
655
        str(err)
 
656
        self.assertEqual(['open_repository'], fake_bzrdir.calls)
 
657
 
433
658
 
434
659
class PassThroughError(errors.BzrError):
435
 
    
 
660
 
436
661
    _fmt = """Pass through %(foo)s and %(bar)s"""
437
662
 
438
663
    def __init__(self, foo, bar):
449
674
 
450
675
 
451
676
class TestErrorFormatting(TestCase):
452
 
    
 
677
 
453
678
    def test_always_str(self):
454
679
        e = PassThroughError(u'\xb5', 'bar')
455
680
        self.assertIsInstance(e.__str__(), str)
466
691
                ['ErrorWithNoFormat uses its docstring as a format, it should use _fmt instead'],
467
692
                lambda x: str(x), e)
468
693
        ## s = str(e)
469
 
        self.assertEqual(s, 
 
694
        self.assertEqual(s,
470
695
                "This class has a docstring but no format string.")
471
696
 
472
697
    def test_mismatched_format_args(self):
476
701
        e = ErrorWithBadFormat(not_thing='x')
477
702
        self.assertStartsWith(
478
703
            str(e), 'Unprintable exception ErrorWithBadFormat')
 
704
 
 
705
    def test_cannot_bind_address(self):
 
706
        # see <https://bugs.edge.launchpad.net/bzr/+bug/286871>
 
707
        e = errors.CannotBindAddress('example.com', 22,
 
708
            socket.error(13, 'Permission denied'))
 
709
        self.assertContainsRe(str(e),
 
710
            r'Cannot bind address "example\.com:22":.*Permission denied')
 
711
 
 
712
    def test_file_timestamp_unavailable(self):            
 
713
        e = errors.FileTimestampUnavailable("/path/foo")
 
714
        self.assertEquals("The filestamp for /path/foo is not available.",
 
715
            str(e))