← 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: 2008-03-16 08:25:21 UTC
  • mto: (3280.2.2 prepare-1.3)
  • mto: This revision was merged to the branch mainline in revision 3284.
  • Revision ID: mbp@sourcefrog.net-20080316082521-xmex8wq1uyj6cxyh
Fix doctest syntax

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_errors.py
1
 
# Copyright (C) 2006 Canonical Ltd
 
1
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
2
2
#   Authors: Robert Collins <robert.collins@canonical.com>
 
3
#            and others
3
4
#
4
5
# This program is free software; you can redistribute it and/or modify
5
6
# it under the terms of the GNU General Public License as published by
20
21
from bzrlib import (
21
22
    bzrdir,
22
23
    errors,
 
24
    osutils,
 
25
    symbol_versioning,
 
26
    urlutils,
23
27
    )
24
28
from bzrlib.tests import TestCase, TestCaseWithTransport
25
29
 
26
30
 
27
 
# TODO: Make sure builtin exception class formats are consistent - e.g. should
28
 
# or shouldn't end with a full stop, etc.
29
 
 
30
 
 
31
31
class TestErrors(TestCaseWithTransport):
32
32
 
 
33
    def test_corrupt_dirstate(self):
 
34
        error = errors.CorruptDirstate('path/to/dirstate', 'the reason why')
 
35
        self.assertEqualDiff(
 
36
            "Inconsistency in dirstate file path/to/dirstate.\n"
 
37
            "Error: the reason why",
 
38
            str(error))
 
39
 
 
40
    def test_disabled_method(self):
 
41
        error = errors.DisabledMethod("class name")
 
42
        self.assertEqualDiff(
 
43
            "The smart server method 'class name' is disabled.", str(error))
 
44
 
 
45
    def test_duplicate_file_id(self):
 
46
        error = errors.DuplicateFileId('a_file_id', 'foo')
 
47
        self.assertEqualDiff('File id {a_file_id} already exists in inventory'
 
48
                             ' as foo', str(error))
 
49
 
 
50
    def test_duplicate_help_prefix(self):
 
51
        error = errors.DuplicateHelpPrefix('foo')
 
52
        self.assertEqualDiff('The prefix foo is in the help search path twice.',
 
53
            str(error))
 
54
 
 
55
    def test_incompatibleAPI(self):
 
56
        error = errors.IncompatibleAPI("module", (1, 2, 3), (4, 5, 6), (7, 8, 9))
 
57
        self.assertEqualDiff(
 
58
            'The API for "module" is not compatible with "(1, 2, 3)". '
 
59
            'It supports versions "(4, 5, 6)" to "(7, 8, 9)".',
 
60
            str(error))
 
61
 
 
62
    def test_inconsistent_delta(self):
 
63
        error = errors.InconsistentDelta('path', 'file-id', 'reason for foo')
 
64
        self.assertEqualDiff(
 
65
            "An inconsistent delta was supplied involving 'path', 'file-id'\n"
 
66
            "reason: reason for foo",
 
67
            str(error))
 
68
 
 
69
    def test_in_process_transport(self):
 
70
        error = errors.InProcessTransport('fpp')
 
71
        self.assertEqualDiff(
 
72
            "The transport 'fpp' is only accessible within this process.",
 
73
            str(error))
 
74
 
 
75
    def test_invalid_http_range(self):
 
76
        error = errors.InvalidHttpRange('path',
 
77
                                        'Content-Range: potatoes 0-00/o0oo0',
 
78
                                        'bad range')
 
79
        self.assertEquals("Invalid http range"
 
80
                          " 'Content-Range: potatoes 0-00/o0oo0'"
 
81
                          " for path: bad range",
 
82
                          str(error))
 
83
 
 
84
    def test_invalid_range(self):
 
85
        error = errors.InvalidRange('path', 12, 'bad range')
 
86
        self.assertEquals("Invalid range access in path at 12: bad range",
 
87
                          str(error))
 
88
 
33
89
    def test_inventory_modified(self):
34
90
        error = errors.InventoryModified("a tree to be repred")
35
91
        self.assertEqualDiff("The current inventory for the tree 'a tree to "
46
102
        error = errors.InstallFailed([None])
47
103
        self.assertEqual("Could not install revisions:\nNone", str(error))
48
104
 
 
105
    def test_lock_active(self):
 
106
        error = errors.LockActive("lock description")
 
107
        self.assertEqualDiff("The lock for 'lock description' is in use and "
 
108
            "cannot be broken.",
 
109
            str(error))
 
110
 
 
111
    def test_knit_data_stream_incompatible(self):
 
112
        error = errors.KnitDataStreamIncompatible(
 
113
            'stream format', 'target format')
 
114
        self.assertEqual('Cannot insert knit data stream of format '
 
115
                         '"stream format" into knit of format '
 
116
                         '"target format".', str(error))
 
117
 
 
118
    def test_knit_data_stream_unknown(self):
 
119
        error = errors.KnitDataStreamUnknown(
 
120
            'stream format')
 
121
        self.assertEqual('Cannot parse knit data stream of format '
 
122
                         '"stream format".', str(error))
 
123
 
49
124
    def test_knit_header_error(self):
50
125
        error = errors.KnitHeaderError('line foo\n', 'path/to/file')
51
126
        self.assertEqual("Knit header error: 'line foo\\n' unexpected"
52
 
                         " for file path/to/file", str(error))
 
127
                         " for file \"path/to/file\".", str(error))
53
128
 
54
129
    def test_knit_index_unknown_method(self):
55
130
        error = errors.KnitIndexUnknownMethod('http://host/foo.kndx',
62
137
        error = errors.MediumNotConnected("a medium")
63
138
        self.assertEqualDiff(
64
139
            "The medium 'a medium' is not connected.", str(error))
65
 
        
 
140
 
 
141
    def test_no_public_branch(self):
 
142
        b = self.make_branch('.')
 
143
        error = errors.NoPublicBranch(b)
 
144
        url = urlutils.unescape_for_display(b.base, 'ascii')
 
145
        self.assertEqualDiff(
 
146
            'There is no public branch set for "%s".' % url, str(error))
 
147
 
66
148
    def test_no_repo(self):
67
149
        dir = bzrdir.BzrDir.create(self.get_url())
68
150
        error = errors.NoRepositoryPresent(dir)
75
157
            "smart protocol.",
76
158
            str(error))
77
159
 
 
160
    def test_no_help_topic(self):
 
161
        error = errors.NoHelpTopic("topic")
 
162
        self.assertEqualDiff("No help could be found for 'topic'. "
 
163
            "Please use 'bzr help topics' to obtain a list of topics.",
 
164
            str(error))
 
165
 
78
166
    def test_no_such_id(self):
79
167
        error = errors.NoSuchId("atree", "anid")
80
 
        self.assertEqualDiff("The file id anid is not present in the tree "
 
168
        self.assertEqualDiff("The file id \"anid\" is not present in the tree "
81
169
            "atree.",
82
170
            str(error))
83
171
 
84
172
    def test_no_such_revision_in_tree(self):
85
173
        error = errors.NoSuchRevisionInTree("atree", "anid")
86
 
        self.assertEqualDiff("The revision id anid is not present in the tree "
87
 
            "atree.",
88
 
            str(error))
 
174
        self.assertEqualDiff("The revision id {anid} is not present in the"
 
175
                             " tree atree.", str(error))
89
176
        self.assertIsInstance(error, errors.NoSuchRevision)
90
177
 
91
178
    def test_not_write_locked(self):
94
181
            "to be.",
95
182
            str(error))
96
183
 
 
184
    def test_read_only_lock_error(self):
 
185
        error = self.applyDeprecated(symbol_versioning.zero_ninetytwo,
 
186
            errors.ReadOnlyLockError, 'filename', 'error message')
 
187
        self.assertEqualDiff("Cannot acquire write lock on filename."
 
188
                             " error message", str(error))
 
189
 
 
190
    def test_lock_failed(self):
 
191
        error = errors.LockFailed('http://canonical.com/', 'readonly transport')
 
192
        self.assertEqualDiff("Cannot lock http://canonical.com/: readonly transport",
 
193
            str(error))
 
194
        self.assertFalse(error.internal_error)
 
195
 
97
196
    def test_too_many_concurrent_requests(self):
98
197
        error = errors.TooManyConcurrentRequests("a medium")
99
198
        self.assertEqualDiff("The medium 'a medium' has reached its concurrent "
100
199
            "request limit. Be sure to finish_writing and finish_reading on "
101
 
            "the current request that is open.",
 
200
            "the currently open request.",
102
201
            str(error))
103
202
 
104
203
    def test_unknown_hook(self):
126
225
                             repo.bzrdir.root_transport.base,
127
226
                             str(error))
128
227
 
 
228
    def test_read_error(self):
 
229
        # a unicode path to check that %r is being used.
 
230
        path = u'a path'
 
231
        error = errors.ReadError(path)
 
232
        self.assertEqualDiff("Error reading from u'a path'.", str(error))
 
233
 
 
234
    def test_bad_index_format_signature(self):
 
235
        error = errors.BadIndexFormatSignature("foo", "bar")
 
236
        self.assertEqual("foo is not an index of type bar.",
 
237
            str(error))
 
238
 
 
239
    def test_bad_index_data(self):
 
240
        error = errors.BadIndexData("foo")
 
241
        self.assertEqual("Error in data for index foo.",
 
242
            str(error))
 
243
 
 
244
    def test_bad_index_duplicate_key(self):
 
245
        error = errors.BadIndexDuplicateKey("foo", "bar")
 
246
        self.assertEqual("The key 'foo' is already in index 'bar'.",
 
247
            str(error))
 
248
 
 
249
    def test_bad_index_key(self):
 
250
        error = errors.BadIndexKey("foo")
 
251
        self.assertEqual("The key 'foo' is not a valid key.",
 
252
            str(error))
 
253
 
 
254
    def test_bad_index_options(self):
 
255
        error = errors.BadIndexOptions("foo")
 
256
        self.assertEqual("Could not parse options for index foo.",
 
257
            str(error))
 
258
 
 
259
    def test_bad_index_value(self):
 
260
        error = errors.BadIndexValue("foo")
 
261
        self.assertEqual("The value 'foo' is not a valid value.",
 
262
            str(error))
 
263
 
129
264
    def test_bzrnewerror_is_deprecated(self):
130
265
        class DeprecatedError(errors.BzrNewError):
131
266
            pass
165
300
            str(error))
166
301
 
167
302
    def test_transport_not_possible(self):
168
 
        e = errors.TransportNotPossible('readonly', 'original error')
169
 
        self.assertEqual('Transport operation not possible:'
170
 
                         ' readonly original error', str(e))
 
303
        error = errors.TransportNotPossible('readonly', 'original error')
 
304
        self.assertEqualDiff('Transport operation not possible:'
 
305
                         ' readonly original error', str(error))
171
306
 
172
307
    def assertSocketConnectionError(self, expected, *args, **kwargs):
173
308
        """Check the formatting of a SocketConnectionError exception"""
212
347
            host='ahost', port=444, msg='Unable to connect to ssh host',
213
348
            orig_error='my_error')
214
349
 
 
350
    def test_malformed_bug_identifier(self):
 
351
        """Test the formatting of MalformedBugIdentifier."""
 
352
        error = errors.MalformedBugIdentifier('bogus', 'reason for bogosity')
 
353
        self.assertEqual(
 
354
            "Did not understand bug identifier bogus: reason for bogosity",
 
355
            str(error))
 
356
 
 
357
    def test_unknown_bug_tracker_abbreviation(self):
 
358
        """Test the formatting of UnknownBugTrackerAbbreviation."""
 
359
        branch = self.make_branch('some_branch')
 
360
        error = errors.UnknownBugTrackerAbbreviation('xxx', branch)
 
361
        self.assertEqual(
 
362
            "Cannot find registered bug tracker called xxx on %s" % branch,
 
363
            str(error))
 
364
 
 
365
    def test_unexpected_smart_server_response(self):
 
366
        e = errors.UnexpectedSmartServerResponse(('not yes',))
 
367
        self.assertEqual(
 
368
            "Could not understand response from smart server: ('not yes',)",
 
369
            str(e))
 
370
 
 
371
    def test_unknown_container_format(self):
 
372
        """Test the formatting of UnknownContainerFormatError."""
 
373
        e = errors.UnknownContainerFormatError('bad format string')
 
374
        self.assertEqual(
 
375
            "Unrecognised container format: 'bad format string'",
 
376
            str(e))
 
377
 
 
378
    def test_unexpected_end_of_container(self):
 
379
        """Test the formatting of UnexpectedEndOfContainerError."""
 
380
        e = errors.UnexpectedEndOfContainerError()
 
381
        self.assertEqual(
 
382
            "Unexpected end of container stream", str(e))
 
383
 
 
384
    def test_unknown_record_type(self):
 
385
        """Test the formatting of UnknownRecordTypeError."""
 
386
        e = errors.UnknownRecordTypeError("X")
 
387
        self.assertEqual(
 
388
            "Unknown record type: 'X'",
 
389
            str(e))
 
390
 
 
391
    def test_invalid_record(self):
 
392
        """Test the formatting of InvalidRecordError."""
 
393
        e = errors.InvalidRecordError("xxx")
 
394
        self.assertEqual(
 
395
            "Invalid record: xxx",
 
396
            str(e))
 
397
 
 
398
    def test_container_has_excess_data(self):
 
399
        """Test the formatting of ContainerHasExcessDataError."""
 
400
        e = errors.ContainerHasExcessDataError("excess bytes")
 
401
        self.assertEqual(
 
402
            "Container has data after end marker: 'excess bytes'",
 
403
            str(e))
 
404
 
 
405
    def test_duplicate_record_name_error(self):
 
406
        """Test the formatting of DuplicateRecordNameError."""
 
407
        e = errors.DuplicateRecordNameError(u"n\xe5me".encode('utf-8'))
 
408
        self.assertEqual(
 
409
            "Container has multiple records with the same name: n\xc3\xa5me",
 
410
            str(e))
 
411
        
 
412
    def test_check_error(self):
 
413
        # This has a member called 'message', which is problematic in
 
414
        # python2.5 because that is a slot on the base Exception class
 
415
        e = errors.BzrCheckError('example check failure')
 
416
        self.assertEqual(
 
417
            "Internal check failed: example check failure",
 
418
            str(e))
 
419
        self.assertTrue(e.internal_error)
 
420
 
 
421
    def test_repository_data_stream_error(self):
 
422
        """Test the formatting of RepositoryDataStreamError."""
 
423
        e = errors.RepositoryDataStreamError(u"my reason")
 
424
        self.assertEqual(
 
425
            "Corrupt or incompatible data stream: my reason", str(e))
 
426
 
 
427
    def test_immortal_pending_deletion_message(self):
 
428
        err = errors.ImmortalPendingDeletion('foo')
 
429
        self.assertEquals(
 
430
            "Unable to delete transform temporary directory foo.  "
 
431
            "Please examine foo to see if it contains any files "
 
432
            "you wish to keep, and delete it when you are done.",
 
433
            str(err))
 
434
 
 
435
    def test_unable_create_symlink(self):
 
436
        err = errors.UnableCreateSymlink()
 
437
        self.assertEquals(
 
438
            "Unable to create symlink on this platform",
 
439
            str(err))
 
440
        err = errors.UnableCreateSymlink(path=u'foo')
 
441
        self.assertEquals(
 
442
            "Unable to create symlink 'foo' on this platform",
 
443
            str(err))
 
444
        err = errors.UnableCreateSymlink(path=u'\xb5')
 
445
        self.assertEquals(
 
446
            "Unable to create symlink u'\\xb5' on this platform",
 
447
            str(err))
 
448
 
 
449
    def test_incorrect_url(self):
 
450
        err = errors.InvalidBugTrackerURL('foo', 'http://bug.com/')
 
451
        self.assertEquals(
 
452
            ("The URL for bug tracker \"foo\" doesn't contain {id}: "
 
453
             "http://bug.com/"),
 
454
            str(err))
 
455
 
 
456
    def test_unable_encode_path(self):
 
457
        err = errors.UnableEncodePath('foo', 'executable')
 
458
        self.assertEquals("Unable to encode executable path 'foo' in "
 
459
            "user encoding " + osutils.get_user_encoding(),
 
460
            str(err))
 
461
 
 
462
    def test_unknown_format(self):
 
463
        err = errors.UnknownFormatError('bar', kind='foo')
 
464
        self.assertEquals("Unknown foo format: 'bar'", str(err))
215
465
 
216
466
 
217
467
class PassThroughError(errors.BzrError):
259
509
        e = ErrorWithBadFormat(not_thing='x')
260
510
        self.assertStartsWith(
261
511
            str(e), 'Unprintable exception ErrorWithBadFormat')
262