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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
"""Tests for the formatting and construction of errors."""
27
from bzrlib.tests import TestCase, TestCaseWithTransport
30
class TestErrors(TestCaseWithTransport):
32
def test_corrupt_dirstate(self):
33
error = errors.CorruptDirstate('path/to/dirstate', 'the reason why')
35
"Inconsistency in dirstate file path/to/dirstate.\n"
36
"Error: the reason why",
39
def test_disabled_method(self):
40
error = errors.DisabledMethod("class name")
42
"The smart server method 'class name' is disabled.", str(error))
44
def test_duplicate_file_id(self):
45
error = errors.DuplicateFileId('a_file_id', 'foo')
46
self.assertEqualDiff('File id {a_file_id} already exists in inventory'
47
' as foo', str(error))
49
def test_duplicate_help_prefix(self):
50
error = errors.DuplicateHelpPrefix('foo')
51
self.assertEqualDiff('The prefix foo is in the help search path twice.',
54
def test_incompatibleAPI(self):
55
error = errors.IncompatibleAPI("module", (1, 2, 3), (4, 5, 6), (7, 8, 9))
57
'The API for "module" is not compatible with "(1, 2, 3)". '
58
'It supports versions "(4, 5, 6)" to "(7, 8, 9)".',
61
def test_inconsistent_delta(self):
62
error = errors.InconsistentDelta('path', 'file-id', 'reason for foo')
64
"An inconsistent delta was supplied involving 'path', 'file-id'\n"
65
"reason: reason for foo",
68
def test_in_process_transport(self):
69
error = errors.InProcessTransport('fpp')
71
"The transport 'fpp' is only accessible within this process.",
74
def test_invalid_http_range(self):
75
error = errors.InvalidHttpRange('path',
76
'Content-Range: potatoes 0-00/o0oo0',
78
self.assertEquals("Invalid http range"
79
" 'Content-Range: potatoes 0-00/o0oo0'"
80
" for path: bad range",
83
def test_invalid_range(self):
84
error = errors.InvalidRange('path', 12, 'bad range')
85
self.assertEquals("Invalid range access in path at 12: bad range",
88
def test_inventory_modified(self):
89
error = errors.InventoryModified("a tree to be repred")
90
self.assertEqualDiff("The current inventory for the tree 'a tree to "
91
"be repred' has been modified, so a clean inventory cannot be "
92
"read without data loss.",
95
def test_install_failed(self):
96
error = errors.InstallFailed(['rev-one'])
97
self.assertEqual("Could not install revisions:\nrev-one", str(error))
98
error = errors.InstallFailed(['rev-one', 'rev-two'])
99
self.assertEqual("Could not install revisions:\nrev-one, rev-two",
101
error = errors.InstallFailed([None])
102
self.assertEqual("Could not install revisions:\nNone", str(error))
104
def test_lock_active(self):
105
error = errors.LockActive("lock description")
106
self.assertEqualDiff("The lock for 'lock description' is in use and "
110
def test_knit_data_stream_incompatible(self):
111
error = errors.KnitDataStreamIncompatible(
112
'stream format', 'target format')
113
self.assertEqual('Cannot insert knit data stream of format '
114
'"stream format" into knit of format '
115
'"target format".', str(error))
117
def test_knit_data_stream_unknown(self):
118
error = errors.KnitDataStreamUnknown(
120
self.assertEqual('Cannot parse knit data stream of format '
121
'"stream format".', str(error))
123
def test_knit_header_error(self):
124
error = errors.KnitHeaderError('line foo\n', 'path/to/file')
125
self.assertEqual("Knit header error: 'line foo\\n' unexpected"
126
" for file \"path/to/file\".", str(error))
128
def test_knit_index_unknown_method(self):
129
error = errors.KnitIndexUnknownMethod('http://host/foo.kndx',
131
self.assertEqual("Knit index http://host/foo.kndx does not have a"
132
" known method in options: ['bad', 'no-eol']",
135
def test_medium_not_connected(self):
136
error = errors.MediumNotConnected("a medium")
137
self.assertEqualDiff(
138
"The medium 'a medium' is not connected.", str(error))
140
def test_no_public_branch(self):
141
b = self.make_branch('.')
142
error = errors.NoPublicBranch(b)
143
url = urlutils.unescape_for_display(b.base, 'ascii')
144
self.assertEqualDiff(
145
'There is no public branch set for "%s".' % url, str(error))
147
def test_no_repo(self):
148
dir = bzrdir.BzrDir.create(self.get_url())
149
error = errors.NoRepositoryPresent(dir)
150
self.assertNotEqual(-1, str(error).find((dir.transport.clone('..').base)))
151
self.assertEqual(-1, str(error).find((dir.transport.base)))
153
def test_no_smart_medium(self):
154
error = errors.NoSmartMedium("a transport")
155
self.assertEqualDiff("The transport 'a transport' cannot tunnel the "
159
def test_no_help_topic(self):
160
error = errors.NoHelpTopic("topic")
161
self.assertEqualDiff("No help could be found for 'topic'. "
162
"Please use 'bzr help topics' to obtain a list of topics.",
165
def test_no_such_id(self):
166
error = errors.NoSuchId("atree", "anid")
167
self.assertEqualDiff("The file id \"anid\" is not present in the tree "
171
def test_no_such_revision_in_tree(self):
172
error = errors.NoSuchRevisionInTree("atree", "anid")
173
self.assertEqualDiff("The revision id {anid} is not present in the"
174
" tree atree.", str(error))
175
self.assertIsInstance(error, errors.NoSuchRevision)
177
def test_not_write_locked(self):
178
error = errors.NotWriteLocked('a thing to repr')
179
self.assertEqualDiff("'a thing to repr' is not write locked but needs "
183
def test_read_only_lock_error(self):
184
error = self.applyDeprecated(symbol_versioning.zero_ninetytwo,
185
errors.ReadOnlyLockError, 'filename', 'error message')
186
self.assertEqualDiff("Cannot acquire write lock on filename."
187
" error message", str(error))
189
def test_lock_failed(self):
190
error = errors.LockFailed('http://canonical.com/', 'readonly transport')
191
self.assertEqualDiff("Cannot lock http://canonical.com/: readonly transport",
193
self.assertFalse(error.internal_error)
195
def test_too_many_concurrent_requests(self):
196
error = errors.TooManyConcurrentRequests("a medium")
197
self.assertEqualDiff("The medium 'a medium' has reached its concurrent "
198
"request limit. Be sure to finish_writing and finish_reading on "
199
"the currently open request.",
202
def test_unknown_hook(self):
203
error = errors.UnknownHook("branch", "foo")
204
self.assertEqualDiff("The branch hook 'foo' is unknown in this version"
207
error = errors.UnknownHook("tree", "bar")
208
self.assertEqualDiff("The tree hook 'bar' is unknown in this version"
212
def test_up_to_date(self):
213
error = errors.UpToDateFormat(bzrdir.BzrDirFormat4())
214
self.assertEqualDiff("The branch format Bazaar-NG branch, "
215
"format 0.0.4 is already at the most "
219
def test_corrupt_repository(self):
220
repo = self.make_repository('.')
221
error = errors.CorruptRepository(repo)
222
self.assertEqualDiff("An error has been detected in the repository %s.\n"
223
"Please run bzr reconcile on this repository." %
224
repo.bzrdir.root_transport.base,
227
def test_read_error(self):
228
# a unicode path to check that %r is being used.
230
error = errors.ReadError(path)
231
self.assertEqualDiff("Error reading from u'a path'.", str(error))
233
def test_bad_index_format_signature(self):
234
error = errors.BadIndexFormatSignature("foo", "bar")
235
self.assertEqual("foo is not an index of type bar.",
238
def test_bad_index_data(self):
239
error = errors.BadIndexData("foo")
240
self.assertEqual("Error in data for index foo.",
243
def test_bad_index_duplicate_key(self):
244
error = errors.BadIndexDuplicateKey("foo", "bar")
245
self.assertEqual("The key 'foo' is already in index 'bar'.",
248
def test_bad_index_key(self):
249
error = errors.BadIndexKey("foo")
250
self.assertEqual("The key 'foo' is not a valid key.",
253
def test_bad_index_options(self):
254
error = errors.BadIndexOptions("foo")
255
self.assertEqual("Could not parse options for index foo.",
258
def test_bad_index_value(self):
259
error = errors.BadIndexValue("foo")
260
self.assertEqual("The value 'foo' is not a valid value.",
263
def test_bzrnewerror_is_deprecated(self):
264
class DeprecatedError(errors.BzrNewError):
266
self.callDeprecated(['BzrNewError was deprecated in bzr 0.13; '
267
'please convert DeprecatedError to use BzrError instead'],
270
def test_bzrerror_from_literal_string(self):
271
# Some code constructs BzrError from a literal string, in which case
272
# no further formatting is done. (I'm not sure raising the base class
273
# is a great idea, but if the exception is not intended to be caught
274
# perhaps no more is needed.)
276
raise errors.BzrError('this is my errors; %d is not expanded')
277
except errors.BzrError, e:
278
self.assertEqual('this is my errors; %d is not expanded', str(e))
280
def test_reading_completed(self):
281
error = errors.ReadingCompleted("a request")
282
self.assertEqualDiff("The MediumRequest 'a request' has already had "
283
"finish_reading called upon it - the request has been completed and"
284
" no more data may be read.",
287
def test_writing_completed(self):
288
error = errors.WritingCompleted("a request")
289
self.assertEqualDiff("The MediumRequest 'a request' has already had "
290
"finish_writing called upon it - accept bytes may not be called "
294
def test_writing_not_completed(self):
295
error = errors.WritingNotComplete("a request")
296
self.assertEqualDiff("The MediumRequest 'a request' has not has "
297
"finish_writing called upon it - until the write phase is complete"
298
" no data may be read.",
301
def test_transport_not_possible(self):
302
error = errors.TransportNotPossible('readonly', 'original error')
303
self.assertEqualDiff('Transport operation not possible:'
304
' readonly original error', str(error))
306
def assertSocketConnectionError(self, expected, *args, **kwargs):
307
"""Check the formatting of a SocketConnectionError exception"""
308
e = errors.SocketConnectionError(*args, **kwargs)
309
self.assertEqual(expected, str(e))
311
def test_socket_connection_error(self):
312
"""Test the formatting of SocketConnectionError"""
314
# There should be a default msg about failing to connect
315
# we only require a host name.
316
self.assertSocketConnectionError(
317
'Failed to connect to ahost',
320
# If port is None, we don't put :None
321
self.assertSocketConnectionError(
322
'Failed to connect to ahost',
324
# But if port is supplied we include it
325
self.assertSocketConnectionError(
326
'Failed to connect to ahost:22',
329
# We can also supply extra information about the error
330
# with or without a port
331
self.assertSocketConnectionError(
332
'Failed to connect to ahost:22; bogus error',
333
'ahost', port=22, orig_error='bogus error')
334
self.assertSocketConnectionError(
335
'Failed to connect to ahost; bogus error',
336
'ahost', orig_error='bogus error')
337
# An exception object can be passed rather than a string
338
orig_error = ValueError('bad value')
339
self.assertSocketConnectionError(
340
'Failed to connect to ahost; %s' % (str(orig_error),),
341
host='ahost', orig_error=orig_error)
343
# And we can supply a custom failure message
344
self.assertSocketConnectionError(
345
'Unable to connect to ssh host ahost:444; my_error',
346
host='ahost', port=444, msg='Unable to connect to ssh host',
347
orig_error='my_error')
349
def test_malformed_bug_identifier(self):
350
"""Test the formatting of MalformedBugIdentifier."""
351
error = errors.MalformedBugIdentifier('bogus', 'reason for bogosity')
353
"Did not understand bug identifier bogus: reason for bogosity",
356
def test_unknown_bug_tracker_abbreviation(self):
357
"""Test the formatting of UnknownBugTrackerAbbreviation."""
358
branch = self.make_branch('some_branch')
359
error = errors.UnknownBugTrackerAbbreviation('xxx', branch)
361
"Cannot find registered bug tracker called xxx on %s" % branch,
364
def test_unexpected_smart_server_response(self):
365
e = errors.UnexpectedSmartServerResponse(('not yes',))
367
"Could not understand response from smart server: ('not yes',)",
370
def test_unknown_container_format(self):
371
"""Test the formatting of UnknownContainerFormatError."""
372
e = errors.UnknownContainerFormatError('bad format string')
374
"Unrecognised container format: 'bad format string'",
377
def test_unexpected_end_of_container(self):
378
"""Test the formatting of UnexpectedEndOfContainerError."""
379
e = errors.UnexpectedEndOfContainerError()
381
"Unexpected end of container stream", str(e))
383
def test_unknown_record_type(self):
384
"""Test the formatting of UnknownRecordTypeError."""
385
e = errors.UnknownRecordTypeError("X")
387
"Unknown record type: 'X'",
390
def test_invalid_record(self):
391
"""Test the formatting of InvalidRecordError."""
392
e = errors.InvalidRecordError("xxx")
394
"Invalid record: xxx",
397
def test_container_has_excess_data(self):
398
"""Test the formatting of ContainerHasExcessDataError."""
399
e = errors.ContainerHasExcessDataError("excess bytes")
401
"Container has data after end marker: 'excess bytes'",
404
def test_duplicate_record_name_error(self):
405
"""Test the formatting of DuplicateRecordNameError."""
406
e = errors.DuplicateRecordNameError(u"n\xe5me".encode('utf-8'))
408
"Container has multiple records with the same name: n\xc3\xa5me",
411
def test_check_error(self):
412
# This has a member called 'message', which is problematic in
413
# python2.5 because that is a slot on the base Exception class
414
e = errors.BzrCheckError('example check failure')
416
"Internal check failed: example check failure",
418
self.assertTrue(e.internal_error)
420
def test_repository_data_stream_error(self):
421
"""Test the formatting of RepositoryDataStreamError."""
422
e = errors.RepositoryDataStreamError(u"my reason")
424
"Corrupt or incompatible data stream: my reason", str(e))
426
def test_immortal_pending_deletion_message(self):
427
err = errors.ImmortalPendingDeletion('foo')
429
"Unable to delete transform temporary directory foo. "
430
"Please examine foo to see if it contains any files "
431
"you wish to keep, and delete it when you are done.",
434
def test_unable_create_symlink(self):
435
err = errors.UnableCreateSymlink()
437
"Unable to create symlink on this platform",
439
err = errors.UnableCreateSymlink(path=u'foo')
441
"Unable to create symlink 'foo' on this platform",
443
err = errors.UnableCreateSymlink(path=u'\xb5')
445
"Unable to create symlink u'\\xb5' on this platform",
448
def test_incorrect_url(self):
449
err = errors.InvalidBugTrackerURL('foo', 'http://bug.com/')
451
("The URL for bug tracker \"foo\" doesn't contain {id}: "
456
class PassThroughError(errors.BzrError):
458
_fmt = """Pass through %(foo)s and %(bar)s"""
460
def __init__(self, foo, bar):
461
errors.BzrError.__init__(self, foo=foo, bar=bar)
464
class ErrorWithBadFormat(errors.BzrError):
466
_fmt = """One format specifier: %(thing)s"""
469
class ErrorWithNoFormat(errors.BzrError):
470
"""This class has a docstring but no format string."""
473
class TestErrorFormatting(TestCase):
475
def test_always_str(self):
476
e = PassThroughError(u'\xb5', 'bar')
477
self.assertIsInstance(e.__str__(), str)
478
# In Python str(foo) *must* return a real byte string
479
# not a Unicode string. The following line would raise a
480
# Unicode error, because it tries to call str() on the string
481
# returned from e.__str__(), and it has non ascii characters
483
self.assertEqual('Pass through \xc2\xb5 and bar', s)
485
def test_missing_format_string(self):
486
e = ErrorWithNoFormat(param='randomvalue')
487
s = self.callDeprecated(
488
['ErrorWithNoFormat uses its docstring as a format, it should use _fmt instead'],
492
"This class has a docstring but no format string.")
494
def test_mismatched_format_args(self):
495
# Even though ErrorWithBadFormat's format string does not match the
496
# arguments we constructing it with, we can still stringify an instance
497
# of this exception. The resulting string will say its unprintable.
498
e = ErrorWithBadFormat(not_thing='x')
499
self.assertStartsWith(
500
str(e), 'Unprintable exception ErrorWithBadFormat')
added
removed
bzrlib/tests/test_errors.py
