← 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: Martin Pool
  • Date: 2007-07-11 01:55:33 UTC
  • mto: This revision was merged to the branch mainline in revision 2599.
  • Revision ID: mbp@sourcefrog.net-20070711015533-dzcxkjg0ujh8yuhl
Option help improvements (thanks jamesw)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_errors.py
1
 
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
 
1
# Copyright (C) 2006, 2007 Canonical Ltd
2
2
#   Authors: Robert Collins <robert.collins@canonical.com>
3
3
#            and others
4
4
#
14
14
#
15
15
# You should have received a copy of the GNU General Public License
16
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
 
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18
18
 
19
19
"""Tests for the formatting and construction of errors."""
20
20
 
21
 
import sys
22
21
from bzrlib import (
23
22
    bzrdir,
24
23
    errors,
25
 
    osutils,
26
 
    symbol_versioning,
27
 
    urlutils,
28
24
    )
29
25
from bzrlib.tests import TestCase, TestCaseWithTransport
30
26
 
31
27
 
 
28
# TODO: Make sure builtin exception class formats are consistent - e.g. should
 
29
# or shouldn't end with a full stop, etc.
 
30
 
 
31
 
32
32
class TestErrors(TestCaseWithTransport):
33
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
 
 
55
34
    def test_disabled_method(self):
56
35
        error = errors.DisabledMethod("class name")
57
36
        self.assertEqualDiff(
67
46
        self.assertEqualDiff('The prefix foo is in the help search path twice.',
68
47
            str(error))
69
48
 
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
 
 
76
49
    def test_incompatibleAPI(self):
77
50
        error = errors.IncompatibleAPI("module", (1, 2, 3), (4, 5, 6), (7, 8, 9))
78
51
        self.assertEqualDiff(
80
53
            'It supports versions "(4, 5, 6)" to "(7, 8, 9)".',
81
54
            str(error))
82
55
 
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
56
    def test_in_process_transport(self):
91
57
        error = errors.InProcessTransport('fpp')
92
58
        self.assertEqualDiff(
93
59
            "The transport 'fpp' is only accessible within this process.",
94
60
            str(error))
95
61
 
96
 
    def test_invalid_http_range(self):
97
 
        error = errors.InvalidHttpRange('path',
98
 
                                        'Content-Range: potatoes 0-00/o0oo0',
99
 
                                        'bad range')
100
 
        self.assertEquals("Invalid http range"
101
 
                          " 'Content-Range: potatoes 0-00/o0oo0'"
102
 
                          " for path: bad range",
103
 
                          str(error))
104
 
 
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",
108
 
                          str(error))
109
 
 
110
62
    def test_inventory_modified(self):
111
63
        error = errors.InventoryModified("a tree to be repred")
112
64
        self.assertEqualDiff("The current inventory for the tree 'a tree to "
114
66
            "read without data loss.",
115
67
            str(error))
116
68
 
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'.",
121
 
            str(error))
 
69
    def test_install_failed(self):
 
70
        error = errors.InstallFailed(['rev-one'])
 
71
        self.assertEqual("Could not install revisions:\nrev-one", str(error))
 
72
        error = errors.InstallFailed(['rev-one', 'rev-two'])
 
73
        self.assertEqual("Could not install revisions:\nrev-one, rev-two",
 
74
                         str(error))
 
75
        error = errors.InstallFailed([None])
 
76
        self.assertEqual("Could not install revisions:\nNone", str(error))
122
77
 
123
78
    def test_lock_active(self):
124
79
        error = errors.LockActive("lock description")
126
81
            "cannot be broken.",
127
82
            str(error))
128
83
 
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))
135
 
 
136
 
    def test_knit_data_stream_unknown(self):
137
 
        error = errors.KnitDataStreamUnknown(
138
 
            'stream format')
139
 
        self.assertEqual('Cannot parse knit data stream of format '
140
 
                         '"stream format".', str(error))
141
 
 
142
84
    def test_knit_header_error(self):
143
85
        error = errors.KnitHeaderError('line foo\n', 'path/to/file')
144
86
        self.assertEqual("Knit header error: 'line foo\\n' unexpected"
145
 
                         " for file \"path/to/file\".", str(error))
 
87
                         " for file path/to/file", str(error))
146
88
 
147
89
    def test_knit_index_unknown_method(self):
148
90
        error = errors.KnitIndexUnknownMethod('http://host/foo.kndx',
155
97
        error = errors.MediumNotConnected("a medium")
156
98
        self.assertEqualDiff(
157
99
            "The medium 'a medium' is not connected.", str(error))
158
 
 
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))
165
 
 
 
100
        
166
101
    def test_no_repo(self):
167
102
        dir = bzrdir.BzrDir.create(self.get_url())
168
103
        error = errors.NoRepositoryPresent(dir)
169
104
        self.assertNotEqual(-1, str(error).find((dir.transport.clone('..').base)))
170
105
        self.assertEqual(-1, str(error).find((dir.transport.base)))
171
 
 
 
106
        
172
107
    def test_no_smart_medium(self):
173
108
        error = errors.NoSmartMedium("a transport")
174
109
        self.assertEqualDiff("The transport 'a transport' cannot tunnel the "
183
118
 
184
119
    def test_no_such_id(self):
185
120
        error = errors.NoSuchId("atree", "anid")
186
 
        self.assertEqualDiff("The file id \"anid\" is not present in the tree "
 
121
        self.assertEqualDiff("The file id anid is not present in the tree "
187
122
            "atree.",
188
123
            str(error))
189
124
 
190
125
    def test_no_such_revision_in_tree(self):
191
126
        error = errors.NoSuchRevisionInTree("atree", "anid")
192
 
        self.assertEqualDiff("The revision id {anid} is not present in the"
193
 
                             " tree atree.", str(error))
 
127
        self.assertEqualDiff("The revision id anid is not present in the tree "
 
128
            "atree.",
 
129
            str(error))
194
130
        self.assertIsInstance(error, errors.NoSuchRevision)
195
131
 
196
 
    def test_not_stacked(self):
197
 
        error = errors.NotStacked('a branch')
198
 
        self.assertEqualDiff("The branch 'a branch' is not stacked.",
199
 
            str(error))
200
 
 
201
132
    def test_not_write_locked(self):
202
133
        error = errors.NotWriteLocked('a thing to repr')
203
134
        self.assertEqualDiff("'a thing to repr' is not write locked but needs "
204
135
            "to be.",
205
136
            str(error))
206
137
 
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",
210
 
            str(error))
211
 
        self.assertFalse(error.internal_error)
 
138
    def test_read_only_lock_error(self):
 
139
        error = errors.ReadOnlyLockError('filename', 'error message')
 
140
        self.assertEqualDiff("Cannot acquire write lock on filename."
 
141
                             " error message", str(error))
212
142
 
213
143
    def test_too_many_concurrent_requests(self):
214
144
        error = errors.TooManyConcurrentRequests("a medium")
217
147
            "the currently open request.",
218
148
            str(error))
219
149
 
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'.",
224
 
            str(error))
225
 
 
226
150
    def test_unknown_hook(self):
227
151
        error = errors.UnknownHook("branch", "foo")
228
152
        self.assertEqualDiff("The branch hook 'foo' is unknown in this version"
233
157
            " of bzrlib.",
234
158
            str(error))
235
159
 
236
 
    def test_unstackable_branch_format(self):
237
 
        format = u'foo'
238
 
        url = "/foo"
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.",
243
 
            str(error))
244
 
 
245
 
    def test_unstackable_location(self):
246
 
        error = errors.UnstackableLocationError('foo', 'bar')
247
 
        self.assertEqualDiff("The branch 'foo' cannot be stacked on 'bar'.",
248
 
            str(error))
249
 
 
250
 
    def test_unstackable_repository_format(self):
251
 
        format = u'foo'
252
 
        url = "/foo"
253
 
        error = errors.UnstackableRepositoryFormat(format, url)
254
 
        self.assertEqualDiff(
255
 
            "The repository '/foo'(foo) is not a stackable format. "
256
 
            "You will need to upgrade the repository to permit branch stacking.",
257
 
            str(error))
258
 
 
259
160
    def test_up_to_date(self):
260
161
        error = errors.UpToDateFormat(bzrdir.BzrDirFormat4())
261
 
        self.assertEqualDiff("The branch format All-in-one "
262
 
                             "format 4 is already at the most "
 
162
        self.assertEqualDiff("The branch format Bazaar-NG branch, "
 
163
                             "format 0.0.4 is already at the most "
263
164
                             "recent format.",
264
165
                             str(error))
265
166
 
277
178
        error = errors.ReadError(path)
278
179
        self.assertEqualDiff("Error reading from u'a path'.", str(error))
279
180
 
280
 
    def test_bad_index_format_signature(self):
281
 
        error = errors.BadIndexFormatSignature("foo", "bar")
282
 
        self.assertEqual("foo is not an index of type bar.",
283
 
            str(error))
284
 
 
285
 
    def test_bad_index_data(self):
286
 
        error = errors.BadIndexData("foo")
287
 
        self.assertEqual("Error in data for index foo.",
288
 
            str(error))
289
 
 
290
 
    def test_bad_index_duplicate_key(self):
291
 
        error = errors.BadIndexDuplicateKey("foo", "bar")
292
 
        self.assertEqual("The key 'foo' is already in index 'bar'.",
293
 
            str(error))
294
 
 
295
 
    def test_bad_index_key(self):
296
 
        error = errors.BadIndexKey("foo")
297
 
        self.assertEqual("The key 'foo' is not a valid key.",
298
 
            str(error))
299
 
 
300
 
    def test_bad_index_options(self):
301
 
        error = errors.BadIndexOptions("foo")
302
 
        self.assertEqual("Could not parse options for index foo.",
303
 
            str(error))
304
 
 
305
 
    def test_bad_index_value(self):
306
 
        error = errors.BadIndexValue("foo")
307
 
        self.assertEqual("The value 'foo' is not a valid value.",
308
 
            str(error))
309
181
 
310
182
    def test_bzrnewerror_is_deprecated(self):
311
183
        class DeprecatedError(errors.BzrNewError):
393
265
            host='ahost', port=444, msg='Unable to connect to ssh host',
394
266
            orig_error='my_error')
395
267
 
396
 
    def test_target_not_branch(self):
397
 
        """Test the formatting of TargetNotBranch."""
398
 
        error = errors.TargetNotBranch('foo')
399
 
        self.assertEqual(
400
 
            "Your branch does not have all of the revisions required in "
401
 
            "order to merge this merge directive and the target "
402
 
            "location specified in the merge directive is not a branch: "
403
 
            "foo.", str(error))
404
 
 
405
268
    def test_malformed_bug_identifier(self):
406
269
        """Test the formatting of MalformedBugIdentifier."""
407
270
        error = errors.MalformedBugIdentifier('bogus', 'reason for bogosity')
408
271
        self.assertEqual(
409
 
            'Did not understand bug identifier bogus: reason for bogosity. '
410
 
            'See "bzr help bugs" for more information on this feature.',
 
272
            "Did not understand bug identifier bogus: reason for bogosity",
411
273
            str(error))
412
274
 
413
275
    def test_unknown_bug_tracker_abbreviation(self):
462
324
        """Test the formatting of DuplicateRecordNameError."""
463
325
        e = errors.DuplicateRecordNameError(u"n\xe5me".encode('utf-8'))
464
326
        self.assertEqual(
465
 
            "Container has multiple records with the same name: n\xc3\xa5me",
466
 
            str(e))
467
 
 
468
 
    def test_check_error(self):
469
 
        # This has a member called 'message', which is problematic in
470
 
        # python2.5 because that is a slot on the base Exception class
471
 
        e = errors.BzrCheckError('example check failure')
472
 
        self.assertEqual(
473
 
            "Internal check failed: example check failure",
474
 
            str(e))
475
 
        self.assertTrue(e.internal_error)
476
 
 
477
 
    def test_repository_data_stream_error(self):
478
 
        """Test the formatting of RepositoryDataStreamError."""
479
 
        e = errors.RepositoryDataStreamError(u"my reason")
480
 
        self.assertEqual(
481
 
            "Corrupt or incompatible data stream: my reason", str(e))
482
 
 
483
 
    def test_immortal_pending_deletion_message(self):
484
 
        err = errors.ImmortalPendingDeletion('foo')
485
 
        self.assertEquals(
486
 
            "Unable to delete transform temporary directory foo.  "
487
 
            "Please examine foo to see if it contains any files "
488
 
            "you wish to keep, and delete it when you are done.",
489
 
            str(err))
490
 
 
491
 
    def test_unable_create_symlink(self):
492
 
        err = errors.UnableCreateSymlink()
493
 
        self.assertEquals(
494
 
            "Unable to create symlink on this platform",
495
 
            str(err))
496
 
        err = errors.UnableCreateSymlink(path=u'foo')
497
 
        self.assertEquals(
498
 
            "Unable to create symlink 'foo' on this platform",
499
 
            str(err))
500
 
        err = errors.UnableCreateSymlink(path=u'\xb5')
501
 
        self.assertEquals(
502
 
            "Unable to create symlink u'\\xb5' on this platform",
503
 
            str(err))
504
 
 
505
 
    def test_invalid_url_join(self):
506
 
        """Test the formatting of InvalidURLJoin."""
507
 
        e = errors.InvalidURLJoin('Reason', 'base path', ('args',))
508
 
        self.assertEqual(
509
 
            "Invalid URL join request: Reason: 'base path' + ('args',)",
510
 
            str(e))
511
 
 
512
 
    def test_incorrect_url(self):
513
 
        err = errors.InvalidBugTrackerURL('foo', 'http://bug.com/')
514
 
        self.assertEquals(
515
 
            ("The URL for bug tracker \"foo\" doesn't contain {id}: "
516
 
             "http://bug.com/"),
517
 
            str(err))
518
 
 
519
 
    def test_unable_encode_path(self):
520
 
        err = errors.UnableEncodePath('foo', 'executable')
521
 
        self.assertEquals("Unable to encode executable path 'foo' in "
522
 
            "user encoding " + osutils.get_user_encoding(),
523
 
            str(err))
524
 
 
525
 
    def test_unknown_format(self):
526
 
        err = errors.UnknownFormatError('bar', kind='foo')
527
 
        self.assertEquals("Unknown foo format: 'bar'", str(err))
528
 
 
529
 
    def test_unknown_rules(self):
530
 
        err = errors.UnknownRules(['foo', 'bar'])
531
 
        self.assertEquals("Unknown rules detected: foo, bar.", str(err))
532
 
 
533
 
    def test_hook_failed(self):
534
 
        # Create an exc_info tuple by raising and catching an exception.
535
 
        try:
536
 
            1/0
537
 
        except ZeroDivisionError:
538
 
            exc_info = sys.exc_info()
539
 
        err = errors.HookFailed('hook stage', 'hook name', exc_info)
540
 
        self.assertStartsWith(
541
 
            str(err), 'Hook \'hook name\' during hook stage failed:\n')
542
 
        self.assertEndsWith(
543
 
            str(err), 'integer division or modulo by zero')
544
 
 
545
 
    def test_tip_change_rejected(self):
546
 
        err = errors.TipChangeRejected(u'Unicode message\N{INTERROBANG}')
547
 
        self.assertEquals(
548
 
            u'Tip change rejected: Unicode message\N{INTERROBANG}',
549
 
            unicode(err))
550
 
        self.assertEquals(
551
 
            'Tip change rejected: Unicode message\xe2\x80\xbd',
552
 
            str(err))
553
 
 
554
 
    def test_error_from_smart_server(self):
555
 
        error_tuple = ('error', 'tuple')
556
 
        err = errors.ErrorFromSmartServer(error_tuple)
557
 
        self.assertEquals(
558
 
            "Error received from smart server: ('error', 'tuple')", str(err))
559
 
 
560
 
    def test_untranslateable_error_from_smart_server(self):
561
 
        error_tuple = ('error', 'tuple')
562
 
        orig_err = errors.ErrorFromSmartServer(error_tuple)
563
 
        err = errors.UnknownErrorFromSmartServer(orig_err)
564
 
        self.assertEquals(
565
 
            "Server sent an unexpected error: ('error', 'tuple')", str(err))
566
 
 
567
 
    def test_smart_message_handler_error(self):
568
 
        # Make an exc_info tuple.
569
 
        try:
570
 
            raise Exception("example error")
571
 
        except Exception:
572
 
            exc_info = sys.exc_info()
573
 
        err = errors.SmartMessageHandlerError(exc_info)
574
 
        self.assertStartsWith(
575
 
            str(err), "The message handler raised an exception:\n")
576
 
        self.assertEndsWith(str(err), "Exception: example error\n")
577
 
 
578
 
    def test_must_have_working_tree(self):
579
 
        err = errors.MustHaveWorkingTree('foo', 'bar')
580
 
        self.assertEqual(str(err), "Branching 'bar'(foo) must create a"
581
 
                                   " working tree.")
582
 
 
583
 
    def test_no_such_view(self):
584
 
        err = errors.NoSuchView('foo')
585
 
        self.assertEquals("No such view: foo.", str(err))
586
 
 
587
 
    def test_views_not_supported(self):
588
 
        err = errors.ViewsNotSupported('atree')
589
 
        err_str = str(err)
590
 
        self.assertStartsWith(err_str, "Views are not supported by ")
591
 
        self.assertEndsWith(err_str, "; use 'bzr upgrade' to change your "
592
 
            "tree to a later format.")
593
 
 
594
 
    def test_file_outside_view(self):
595
 
        err = errors.FileOutsideView('baz', ['foo', 'bar'])
596
 
        self.assertEquals('Specified file "baz" is outside the current view: '
597
 
            'foo, bar', str(err))
598
 
 
599
 
    def test_invalid_shelf_id(self):
600
 
        invalid_id = "foo"
601
 
        err = errors.InvalidShelfId(invalid_id)
602
 
        self.assertEqual('"foo" is not a valid shelf id, '
603
 
            'try a number instead.', str(err))
604
 
 
605
 
    def test_unresumable_write_group(self):
606
 
        repo = "dummy repo"
607
 
        wg_tokens = ['token']
608
 
        reason = "a reason"
609
 
        err = errors.UnresumableWriteGroup(repo, wg_tokens, reason)
610
 
        self.assertEqual(
611
 
            "Repository dummy repo cannot resume write group "
612
 
            "['token']: a reason", str(err))
613
 
 
614
 
    def test_unsuspendable_write_group(self):
615
 
        repo = "dummy repo"
616
 
        err = errors.UnsuspendableWriteGroup(repo)
617
 
        self.assertEqual(
618
 
            'Repository dummy repo cannot suspend a write group.', str(err))
 
327
            "Container has multiple records with the same name: \"n\xc3\xa5me\"",
 
328
            str(e))
619
329
 
620
330
 
621
331
class PassThroughError(errors.BzrError):
622
 
 
 
332
    
623
333
    _fmt = """Pass through %(foo)s and %(bar)s"""
624
334
 
625
335
    def __init__(self, foo, bar):
636
346
 
637
347
 
638
348
class TestErrorFormatting(TestCase):
639
 
 
 
349
    
640
350
    def test_always_str(self):
641
351
        e = PassThroughError(u'\xb5', 'bar')
642
352
        self.assertIsInstance(e.__str__(), str)
653
363
                ['ErrorWithNoFormat uses its docstring as a format, it should use _fmt instead'],
654
364
                lambda x: str(x), e)
655
365
        ## s = str(e)
656
 
        self.assertEqual(s,
 
366
        self.assertEqual(s, 
657
367
                "This class has a docstring but no format string.")
658
368
 
659
369
    def test_mismatched_format_args(self):