/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_errors.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2011-02-09 08:51:29 UTC
  • mfrom: (5638.2.2 537442-annotate-removed)
  • Revision ID: pqm@pqm.ubuntu.com-20110209085129-0qspgtdaj4gfu2qr
(vila) Annotate deleted files if they can be found in the specified
 revision. (Andrew King)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006 by Canonical Ltd
2
 
#   Authors: Robert Collins <robert.collins@canonical.com>
 
1
# Copyright (C) 2006-2011 Canonical Ltd
3
2
#
4
3
# This program is free software; you can redistribute it and/or modify
5
4
# it under the terms of the GNU General Public License as published by
13
12
#
14
13
# You should have received a copy of the GNU General Public License
15
14
# along with this program; if not, write to the Free Software
16
 
# 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
17
16
 
18
17
"""Tests for the formatting and construction of errors."""
19
18
 
20
 
import bzrlib.bzrdir as bzrdir
21
 
import bzrlib.errors as errors
22
 
from bzrlib.tests import TestCaseWithTransport
 
19
import inspect
 
20
import re
 
21
import socket
 
22
import sys
 
23
 
 
24
from bzrlib import (
 
25
    bzrdir,
 
26
    errors,
 
27
    osutils,
 
28
    urlutils,
 
29
    )
 
30
from bzrlib.tests import (
 
31
    TestCase,
 
32
    TestCaseWithTransport,
 
33
    TestSkipped,
 
34
    )
23
35
 
24
36
 
25
37
class TestErrors(TestCaseWithTransport):
26
38
 
 
39
    def test_no_arg_named_message(self):
 
40
        """Ensure the __init__ and _fmt in errors do not have "message" arg.
 
41
 
 
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.
 
45
        See bug #603461
 
46
        """
 
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)
 
55
            if init:
 
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__))
 
63
 
 
64
    def test_bad_filename_encoding(self):
 
65
        error = errors.BadFilenameEncoding('bad/filen\xe5me', 'UTF-8')
 
66
        self.assertEqualDiff(
 
67
            "Filename 'bad/filen\\xe5me' is not valid in your current"
 
68
            " filesystem encoding UTF-8",
 
69
            str(error))
 
70
 
 
71
    def test_corrupt_dirstate(self):
 
72
        error = errors.CorruptDirstate('path/to/dirstate', 'the reason why')
 
73
        self.assertEqualDiff(
 
74
            "Inconsistency in dirstate file path/to/dirstate.\n"
 
75
            "Error: the reason why",
 
76
            str(error))
 
77
 
 
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\"",
 
83
            str(error))
 
84
 
 
85
    def test_disabled_method(self):
 
86
        error = errors.DisabledMethod("class name")
 
87
        self.assertEqualDiff(
 
88
            "The smart server method 'class name' is disabled.", str(error))
 
89
 
 
90
    def test_duplicate_file_id(self):
 
91
        error = errors.DuplicateFileId('a_file_id', 'foo')
 
92
        self.assertEqualDiff('File id {a_file_id} already exists in inventory'
 
93
                             ' as foo', str(error))
 
94
 
 
95
    def test_duplicate_help_prefix(self):
 
96
        error = errors.DuplicateHelpPrefix('foo')
 
97
        self.assertEqualDiff('The prefix foo is in the help search path twice.',
 
98
            str(error))
 
99
 
 
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}",
 
104
                             str(error))
 
105
 
 
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)".',
 
111
            str(error))
 
112
 
 
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",
 
118
            str(error))
 
119
 
 
120
    def test_inconsistent_delta_delta(self):
 
121
        error = errors.InconsistentDeltaDelta([], 'reason')
 
122
        self.assertEqualDiff(
 
123
            "An inconsistent delta was supplied: []\nreason: reason",
 
124
            str(error))
 
125
 
 
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.",
 
130
            str(error))
 
131
 
 
132
    def test_invalid_http_range(self):
 
133
        error = errors.InvalidHttpRange('path',
 
134
                                        'Content-Range: potatoes 0-00/o0oo0',
 
135
                                        'bad range')
 
136
        self.assertEquals("Invalid http range"
 
137
                          " 'Content-Range: potatoes 0-00/o0oo0'"
 
138
                          " for path: bad range",
 
139
                          str(error))
 
140
 
 
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",
 
144
                          str(error))
 
145
 
 
146
    def test_inventory_modified(self):
 
147
        error = errors.InventoryModified("a tree to be repred")
 
148
        self.assertEqualDiff("The current inventory for the tree 'a tree to "
 
149
            "be repred' has been modified, so a clean inventory cannot be "
 
150
            "read without data loss.",
 
151
            str(error))
 
152
 
 
153
    def test_jail_break(self):
 
154
        error = errors.JailBreak("some url")
 
155
        self.assertEqualDiff("An attempt to access a url outside the server"
 
156
            " jail was made: 'some url'.",
 
157
            str(error))
 
158
 
 
159
    def test_lock_active(self):
 
160
        error = errors.LockActive("lock description")
 
161
        self.assertEqualDiff("The lock for 'lock description' is in use and "
 
162
            "cannot be broken.",
 
163
            str(error))
 
164
 
 
165
    def test_lock_corrupt(self):
 
166
        error = errors.LockCorrupt("corruption info")
 
167
        self.assertEqualDiff("Lock is apparently held, but corrupted: "
 
168
            "corruption info\n"
 
169
            "Use 'bzr break-lock' to clear it",
 
170
            str(error))
 
171
 
 
172
    def test_knit_data_stream_incompatible(self):
 
173
        error = errors.KnitDataStreamIncompatible(
 
174
            'stream format', 'target format')
 
175
        self.assertEqual('Cannot insert knit data stream of format '
 
176
                         '"stream format" into knit of format '
 
177
                         '"target format".', str(error))
 
178
 
 
179
    def test_knit_data_stream_unknown(self):
 
180
        error = errors.KnitDataStreamUnknown(
 
181
            'stream format')
 
182
        self.assertEqual('Cannot parse knit data stream of format '
 
183
                         '"stream format".', str(error))
 
184
 
 
185
    def test_knit_header_error(self):
 
186
        error = errors.KnitHeaderError('line foo\n', 'path/to/file')
 
187
        self.assertEqual("Knit header error: 'line foo\\n' unexpected"
 
188
                         " for file \"path/to/file\".", str(error))
 
189
 
 
190
    def test_knit_index_unknown_method(self):
 
191
        error = errors.KnitIndexUnknownMethod('http://host/foo.kndx',
 
192
                                              ['bad', 'no-eol'])
 
193
        self.assertEqual("Knit index http://host/foo.kndx does not have a"
 
194
                         " known method in options: ['bad', 'no-eol']",
 
195
                         str(error))
 
196
 
 
197
    def test_medium_not_connected(self):
 
198
        error = errors.MediumNotConnected("a medium")
 
199
        self.assertEqualDiff(
 
200
            "The medium 'a medium' is not connected.", str(error))
 
201
 
 
202
    def test_no_public_branch(self):
 
203
        b = self.make_branch('.')
 
204
        error = errors.NoPublicBranch(b)
 
205
        url = urlutils.unescape_for_display(b.base, 'ascii')
 
206
        self.assertEqualDiff(
 
207
            'There is no public branch set for "%s".' % url, str(error))
 
208
 
27
209
    def test_no_repo(self):
28
210
        dir = bzrdir.BzrDir.create(self.get_url())
29
211
        error = errors.NoRepositoryPresent(dir)
30
 
        self.assertNotEqual(-1, str(error).find(repr(dir.transport.clone('..').base)))
31
 
        self.assertEqual(-1, str(error).find(repr(dir.transport.base)))
 
212
        self.assertNotEqual(-1, str(error).find((dir.transport.clone('..').base)))
 
213
        self.assertEqual(-1, str(error).find((dir.transport.base)))
 
214
 
 
215
    def test_no_smart_medium(self):
 
216
        error = errors.NoSmartMedium("a transport")
 
217
        self.assertEqualDiff("The transport 'a transport' cannot tunnel the "
 
218
            "smart protocol.",
 
219
            str(error))
 
220
 
 
221
    def test_no_help_topic(self):
 
222
        error = errors.NoHelpTopic("topic")
 
223
        self.assertEqualDiff("No help could be found for 'topic'. "
 
224
            "Please use 'bzr help topics' to obtain a list of topics.",
 
225
            str(error))
 
226
 
 
227
    def test_no_such_id(self):
 
228
        error = errors.NoSuchId("atree", "anid")
 
229
        self.assertEqualDiff("The file id \"anid\" is not present in the tree "
 
230
            "atree.",
 
231
            str(error))
 
232
 
 
233
    def test_no_such_revision_in_tree(self):
 
234
        error = errors.NoSuchRevisionInTree("atree", "anid")
 
235
        self.assertEqualDiff("The revision id {anid} is not present in the"
 
236
                             " tree atree.", str(error))
 
237
        self.assertIsInstance(error, errors.NoSuchRevision)
 
238
 
 
239
    def test_not_stacked(self):
 
240
        error = errors.NotStacked('a branch')
 
241
        self.assertEqualDiff("The branch 'a branch' is not stacked.",
 
242
            str(error))
 
243
 
 
244
    def test_not_write_locked(self):
 
245
        error = errors.NotWriteLocked('a thing to repr')
 
246
        self.assertEqualDiff("'a thing to repr' is not write locked but needs "
 
247
            "to be.",
 
248
            str(error))
 
249
 
 
250
    def test_lock_failed(self):
 
251
        error = errors.LockFailed('http://canonical.com/', 'readonly transport')
 
252
        self.assertEqualDiff("Cannot lock http://canonical.com/: readonly transport",
 
253
            str(error))
 
254
        self.assertFalse(error.internal_error)
 
255
 
 
256
    def test_too_many_concurrent_requests(self):
 
257
        error = errors.TooManyConcurrentRequests("a medium")
 
258
        self.assertEqualDiff("The medium 'a medium' has reached its concurrent "
 
259
            "request limit. Be sure to finish_writing and finish_reading on "
 
260
            "the currently open request.",
 
261
            str(error))
 
262
 
 
263
    def test_unavailable_representation(self):
 
264
        error = errors.UnavailableRepresentation(('key',), "mpdiff", "fulltext")
 
265
        self.assertEqualDiff("The encoding 'mpdiff' is not available for key "
 
266
            "('key',) which is encoded as 'fulltext'.",
 
267
            str(error))
 
268
 
 
269
    def test_unknown_hook(self):
 
270
        error = errors.UnknownHook("branch", "foo")
 
271
        self.assertEqualDiff("The branch hook 'foo' is unknown in this version"
 
272
            " of bzrlib.",
 
273
            str(error))
 
274
        error = errors.UnknownHook("tree", "bar")
 
275
        self.assertEqualDiff("The tree hook 'bar' is unknown in this version"
 
276
            " of bzrlib.",
 
277
            str(error))
 
278
 
 
279
    def test_unstackable_branch_format(self):
 
280
        format = u'foo'
 
281
        url = "/foo"
 
282
        error = errors.UnstackableBranchFormat(format, url)
 
283
        self.assertEqualDiff(
 
284
            "The branch '/foo'(foo) is not a stackable format. "
 
285
            "You will need to upgrade the branch to permit branch stacking.",
 
286
            str(error))
 
287
 
 
288
    def test_unstackable_location(self):
 
289
        error = errors.UnstackableLocationError('foo', 'bar')
 
290
        self.assertEqualDiff("The branch 'foo' cannot be stacked on 'bar'.",
 
291
            str(error))
 
292
 
 
293
    def test_unstackable_repository_format(self):
 
294
        format = u'foo'
 
295
        url = "/foo"
 
296
        error = errors.UnstackableRepositoryFormat(format, url)
 
297
        self.assertEqualDiff(
 
298
            "The repository '/foo'(foo) is not a stackable format. "
 
299
            "You will need to upgrade the repository to permit branch stacking.",
 
300
            str(error))
32
301
 
33
302
    def test_up_to_date(self):
34
303
        error = errors.UpToDateFormat(bzrdir.BzrDirFormat4())
35
 
        self.assertEqualDiff("The branch format Bazaar-NG branch, "
36
 
                             "format 0.0.4 is already at the most "
 
304
        self.assertEqualDiff("The branch format All-in-one "
 
305
                             "format 4 is already at the most "
37
306
                             "recent format.",
38
307
                             str(error))
39
308
 
44
313
                             "Please run bzr reconcile on this repository." %
45
314
                             repo.bzrdir.root_transport.base,
46
315
                             str(error))
 
316
 
 
317
    def test_read_error(self):
 
318
        # a unicode path to check that %r is being used.
 
319
        path = u'a path'
 
320
        error = errors.ReadError(path)
 
321
        self.assertEqualDiff("Error reading from u'a path'.", str(error))
 
322
 
 
323
    def test_bad_index_format_signature(self):
 
324
        error = errors.BadIndexFormatSignature("foo", "bar")
 
325
        self.assertEqual("foo is not an index of type bar.",
 
326
            str(error))
 
327
 
 
328
    def test_bad_index_data(self):
 
329
        error = errors.BadIndexData("foo")
 
330
        self.assertEqual("Error in data for index foo.",
 
331
            str(error))
 
332
 
 
333
    def test_bad_index_duplicate_key(self):
 
334
        error = errors.BadIndexDuplicateKey("foo", "bar")
 
335
        self.assertEqual("The key 'foo' is already in index 'bar'.",
 
336
            str(error))
 
337
 
 
338
    def test_bad_index_key(self):
 
339
        error = errors.BadIndexKey("foo")
 
340
        self.assertEqual("The key 'foo' is not a valid key.",
 
341
            str(error))
 
342
 
 
343
    def test_bad_index_options(self):
 
344
        error = errors.BadIndexOptions("foo")
 
345
        self.assertEqual("Could not parse options for index foo.",
 
346
            str(error))
 
347
 
 
348
    def test_bad_index_value(self):
 
349
        error = errors.BadIndexValue("foo")
 
350
        self.assertEqual("The value 'foo' is not a valid value.",
 
351
            str(error))
 
352
 
 
353
    def test_bzrnewerror_is_deprecated(self):
 
354
        class DeprecatedError(errors.BzrNewError):
 
355
            pass
 
356
        self.callDeprecated(['BzrNewError was deprecated in bzr 0.13; '
 
357
             'please convert DeprecatedError to use BzrError instead'],
 
358
            DeprecatedError)
 
359
 
 
360
    def test_bzrerror_from_literal_string(self):
 
361
        # Some code constructs BzrError from a literal string, in which case
 
362
        # no further formatting is done.  (I'm not sure raising the base class
 
363
        # is a great idea, but if the exception is not intended to be caught
 
364
        # perhaps no more is needed.)
 
365
        try:
 
366
            raise errors.BzrError('this is my errors; %d is not expanded')
 
367
        except errors.BzrError, e:
 
368
            self.assertEqual('this is my errors; %d is not expanded', str(e))
 
369
 
 
370
    def test_reading_completed(self):
 
371
        error = errors.ReadingCompleted("a request")
 
372
        self.assertEqualDiff("The MediumRequest 'a request' has already had "
 
373
            "finish_reading called upon it - the request has been completed and"
 
374
            " no more data may be read.",
 
375
            str(error))
 
376
 
 
377
    def test_writing_completed(self):
 
378
        error = errors.WritingCompleted("a request")
 
379
        self.assertEqualDiff("The MediumRequest 'a request' has already had "
 
380
            "finish_writing called upon it - accept bytes may not be called "
 
381
            "anymore.",
 
382
            str(error))
 
383
 
 
384
    def test_writing_not_completed(self):
 
385
        error = errors.WritingNotComplete("a request")
 
386
        self.assertEqualDiff("The MediumRequest 'a request' has not has "
 
387
            "finish_writing called upon it - until the write phase is complete"
 
388
            " no data may be read.",
 
389
            str(error))
 
390
 
 
391
    def test_transport_not_possible(self):
 
392
        error = errors.TransportNotPossible('readonly', 'original error')
 
393
        self.assertEqualDiff('Transport operation not possible:'
 
394
                         ' readonly original error', str(error))
 
395
 
 
396
    def assertSocketConnectionError(self, expected, *args, **kwargs):
 
397
        """Check the formatting of a SocketConnectionError exception"""
 
398
        e = errors.SocketConnectionError(*args, **kwargs)
 
399
        self.assertEqual(expected, str(e))
 
400
 
 
401
    def test_socket_connection_error(self):
 
402
        """Test the formatting of SocketConnectionError"""
 
403
 
 
404
        # There should be a default msg about failing to connect
 
405
        # we only require a host name.
 
406
        self.assertSocketConnectionError(
 
407
            'Failed to connect to ahost',
 
408
            'ahost')
 
409
 
 
410
        # If port is None, we don't put :None
 
411
        self.assertSocketConnectionError(
 
412
            'Failed to connect to ahost',
 
413
            'ahost', port=None)
 
414
        # But if port is supplied we include it
 
415
        self.assertSocketConnectionError(
 
416
            'Failed to connect to ahost:22',
 
417
            'ahost', port=22)
 
418
 
 
419
        # We can also supply extra information about the error
 
420
        # with or without a port
 
421
        self.assertSocketConnectionError(
 
422
            'Failed to connect to ahost:22; bogus error',
 
423
            'ahost', port=22, orig_error='bogus error')
 
424
        self.assertSocketConnectionError(
 
425
            'Failed to connect to ahost; bogus error',
 
426
            'ahost', orig_error='bogus error')
 
427
        # An exception object can be passed rather than a string
 
428
        orig_error = ValueError('bad value')
 
429
        self.assertSocketConnectionError(
 
430
            'Failed to connect to ahost; %s' % (str(orig_error),),
 
431
            host='ahost', orig_error=orig_error)
 
432
 
 
433
        # And we can supply a custom failure message
 
434
        self.assertSocketConnectionError(
 
435
            'Unable to connect to ssh host ahost:444; my_error',
 
436
            host='ahost', port=444, msg='Unable to connect to ssh host',
 
437
            orig_error='my_error')
 
438
 
 
439
    def test_target_not_branch(self):
 
440
        """Test the formatting of TargetNotBranch."""
 
441
        error = errors.TargetNotBranch('foo')
 
442
        self.assertEqual(
 
443
            "Your branch does not have all of the revisions required in "
 
444
            "order to merge this merge directive and the target "
 
445
            "location specified in the merge directive is not a branch: "
 
446
            "foo.", str(error))
 
447
 
 
448
    def test_malformed_bug_identifier(self):
 
449
        """Test the formatting of MalformedBugIdentifier."""
 
450
        error = errors.MalformedBugIdentifier('bogus', 'reason for bogosity')
 
451
        self.assertEqual(
 
452
            'Did not understand bug identifier bogus: reason for bogosity. '
 
453
            'See "bzr help bugs" for more information on this feature.',
 
454
            str(error))
 
455
 
 
456
    def test_unknown_bug_tracker_abbreviation(self):
 
457
        """Test the formatting of UnknownBugTrackerAbbreviation."""
 
458
        branch = self.make_branch('some_branch')
 
459
        error = errors.UnknownBugTrackerAbbreviation('xxx', branch)
 
460
        self.assertEqual(
 
461
            "Cannot find registered bug tracker called xxx on %s" % branch,
 
462
            str(error))
 
463
 
 
464
    def test_unexpected_smart_server_response(self):
 
465
        e = errors.UnexpectedSmartServerResponse(('not yes',))
 
466
        self.assertEqual(
 
467
            "Could not understand response from smart server: ('not yes',)",
 
468
            str(e))
 
469
 
 
470
    def test_unknown_container_format(self):
 
471
        """Test the formatting of UnknownContainerFormatError."""
 
472
        e = errors.UnknownContainerFormatError('bad format string')
 
473
        self.assertEqual(
 
474
            "Unrecognised container format: 'bad format string'",
 
475
            str(e))
 
476
 
 
477
    def test_unexpected_end_of_container(self):
 
478
        """Test the formatting of UnexpectedEndOfContainerError."""
 
479
        e = errors.UnexpectedEndOfContainerError()
 
480
        self.assertEqual(
 
481
            "Unexpected end of container stream", str(e))
 
482
 
 
483
    def test_unknown_record_type(self):
 
484
        """Test the formatting of UnknownRecordTypeError."""
 
485
        e = errors.UnknownRecordTypeError("X")
 
486
        self.assertEqual(
 
487
            "Unknown record type: 'X'",
 
488
            str(e))
 
489
 
 
490
    def test_invalid_record(self):
 
491
        """Test the formatting of InvalidRecordError."""
 
492
        e = errors.InvalidRecordError("xxx")
 
493
        self.assertEqual(
 
494
            "Invalid record: xxx",
 
495
            str(e))
 
496
 
 
497
    def test_container_has_excess_data(self):
 
498
        """Test the formatting of ContainerHasExcessDataError."""
 
499
        e = errors.ContainerHasExcessDataError("excess bytes")
 
500
        self.assertEqual(
 
501
            "Container has data after end marker: 'excess bytes'",
 
502
            str(e))
 
503
 
 
504
    def test_duplicate_record_name_error(self):
 
505
        """Test the formatting of DuplicateRecordNameError."""
 
506
        e = errors.DuplicateRecordNameError(u"n\xe5me".encode('utf-8'))
 
507
        self.assertEqual(
 
508
            "Container has multiple records with the same name: n\xc3\xa5me",
 
509
            str(e))
 
510
 
 
511
    def test_check_error(self):
 
512
        # This has a member called 'message', which is problematic in
 
513
        # python2.5 because that is a slot on the base Exception class
 
514
        e = errors.BzrCheckError('example check failure')
 
515
        self.assertEqual(
 
516
            "Internal check failed: example check failure",
 
517
            str(e))
 
518
        self.assertTrue(e.internal_error)
 
519
 
 
520
    def test_repository_data_stream_error(self):
 
521
        """Test the formatting of RepositoryDataStreamError."""
 
522
        e = errors.RepositoryDataStreamError(u"my reason")
 
523
        self.assertEqual(
 
524
            "Corrupt or incompatible data stream: my reason", str(e))
 
525
 
 
526
    def test_immortal_pending_deletion_message(self):
 
527
        err = errors.ImmortalPendingDeletion('foo')
 
528
        self.assertEquals(
 
529
            "Unable to delete transform temporary directory foo.  "
 
530
            "Please examine foo to see if it contains any files "
 
531
            "you wish to keep, and delete it when you are done.",
 
532
            str(err))
 
533
 
 
534
    def test_unable_create_symlink(self):
 
535
        err = errors.UnableCreateSymlink()
 
536
        self.assertEquals(
 
537
            "Unable to create symlink on this platform",
 
538
            str(err))
 
539
        err = errors.UnableCreateSymlink(path=u'foo')
 
540
        self.assertEquals(
 
541
            "Unable to create symlink 'foo' on this platform",
 
542
            str(err))
 
543
        err = errors.UnableCreateSymlink(path=u'\xb5')
 
544
        self.assertEquals(
 
545
            "Unable to create symlink u'\\xb5' on this platform",
 
546
            str(err))
 
547
 
 
548
    def test_invalid_url_join(self):
 
549
        """Test the formatting of InvalidURLJoin."""
 
550
        e = errors.InvalidURLJoin('Reason', 'base path', ('args',))
 
551
        self.assertEqual(
 
552
            "Invalid URL join request: Reason: 'base path' + ('args',)",
 
553
            str(e))
 
554
 
 
555
    def test_incorrect_url(self):
 
556
        err = errors.InvalidBugTrackerURL('foo', 'http://bug.com/')
 
557
        self.assertEquals(
 
558
            ("The URL for bug tracker \"foo\" doesn't contain {id}: "
 
559
             "http://bug.com/"),
 
560
            str(err))
 
561
 
 
562
    def test_unable_encode_path(self):
 
563
        err = errors.UnableEncodePath('foo', 'executable')
 
564
        self.assertEquals("Unable to encode executable path 'foo' in "
 
565
            "user encoding " + osutils.get_user_encoding(),
 
566
            str(err))
 
567
 
 
568
    def test_unknown_format(self):
 
569
        err = errors.UnknownFormatError('bar', kind='foo')
 
570
        self.assertEquals("Unknown foo format: 'bar'", str(err))
 
571
 
 
572
    def test_unknown_rules(self):
 
573
        err = errors.UnknownRules(['foo', 'bar'])
 
574
        self.assertEquals("Unknown rules detected: foo, bar.", str(err))
 
575
 
 
576
    def test_hook_failed(self):
 
577
        # Create an exc_info tuple by raising and catching an exception.
 
578
        try:
 
579
            1/0
 
580
        except ZeroDivisionError:
 
581
            exc_info = sys.exc_info()
 
582
        err = errors.HookFailed('hook stage', 'hook name', exc_info, warn=False)
 
583
        self.assertStartsWith(
 
584
            str(err), 'Hook \'hook name\' during hook stage failed:\n')
 
585
        self.assertEndsWith(
 
586
            str(err), 'integer division or modulo by zero')
 
587
 
 
588
    def test_tip_change_rejected(self):
 
589
        err = errors.TipChangeRejected(u'Unicode message\N{INTERROBANG}')
 
590
        self.assertEquals(
 
591
            u'Tip change rejected: Unicode message\N{INTERROBANG}',
 
592
            unicode(err))
 
593
        self.assertEquals(
 
594
            'Tip change rejected: Unicode message\xe2\x80\xbd',
 
595
            str(err))
 
596
 
 
597
    def test_error_from_smart_server(self):
 
598
        error_tuple = ('error', 'tuple')
 
599
        err = errors.ErrorFromSmartServer(error_tuple)
 
600
        self.assertEquals(
 
601
            "Error received from smart server: ('error', 'tuple')", str(err))
 
602
 
 
603
    def test_untranslateable_error_from_smart_server(self):
 
604
        error_tuple = ('error', 'tuple')
 
605
        orig_err = errors.ErrorFromSmartServer(error_tuple)
 
606
        err = errors.UnknownErrorFromSmartServer(orig_err)
 
607
        self.assertEquals(
 
608
            "Server sent an unexpected error: ('error', 'tuple')", str(err))
 
609
 
 
610
    def test_smart_message_handler_error(self):
 
611
        # Make an exc_info tuple.
 
612
        try:
 
613
            raise Exception("example error")
 
614
        except Exception:
 
615
            exc_info = sys.exc_info()
 
616
        err = errors.SmartMessageHandlerError(exc_info)
 
617
        self.assertStartsWith(
 
618
            str(err), "The message handler raised an exception:\n")
 
619
        self.assertEndsWith(str(err), "Exception: example error\n")
 
620
 
 
621
    def test_must_have_working_tree(self):
 
622
        err = errors.MustHaveWorkingTree('foo', 'bar')
 
623
        self.assertEqual(str(err), "Branching 'bar'(foo) must create a"
 
624
                                   " working tree.")
 
625
 
 
626
    def test_no_such_view(self):
 
627
        err = errors.NoSuchView('foo')
 
628
        self.assertEquals("No such view: foo.", str(err))
 
629
 
 
630
    def test_views_not_supported(self):
 
631
        err = errors.ViewsNotSupported('atree')
 
632
        err_str = str(err)
 
633
        self.assertStartsWith(err_str, "Views are not supported by ")
 
634
        self.assertEndsWith(err_str, "; use 'bzr upgrade' to change your "
 
635
            "tree to a later format.")
 
636
 
 
637
    def test_file_outside_view(self):
 
638
        err = errors.FileOutsideView('baz', ['foo', 'bar'])
 
639
        self.assertEquals('Specified file "baz" is outside the current view: '
 
640
            'foo, bar', str(err))
 
641
 
 
642
    def test_invalid_shelf_id(self):
 
643
        invalid_id = "foo"
 
644
        err = errors.InvalidShelfId(invalid_id)
 
645
        self.assertEqual('"foo" is not a valid shelf id, '
 
646
            'try a number instead.', str(err))
 
647
 
 
648
    def test_unresumable_write_group(self):
 
649
        repo = "dummy repo"
 
650
        wg_tokens = ['token']
 
651
        reason = "a reason"
 
652
        err = errors.UnresumableWriteGroup(repo, wg_tokens, reason)
 
653
        self.assertEqual(
 
654
            "Repository dummy repo cannot resume write group "
 
655
            "['token']: a reason", str(err))
 
656
 
 
657
    def test_unsuspendable_write_group(self):
 
658
        repo = "dummy repo"
 
659
        err = errors.UnsuspendableWriteGroup(repo)
 
660
        self.assertEqual(
 
661
            'Repository dummy repo cannot suspend a write group.', str(err))
 
662
 
 
663
    def test_not_branch_no_args(self):
 
664
        err = errors.NotBranchError('path')
 
665
        self.assertEqual('Not a branch: "path".', str(err))
 
666
 
 
667
    def test_not_branch_bzrdir_with_repo(self):
 
668
        bzrdir = self.make_repository('repo').bzrdir
 
669
        err = errors.NotBranchError('path', bzrdir=bzrdir)
 
670
        self.assertEqual(
 
671
            'Not a branch: "path": location is a repository.', str(err))
 
672
 
 
673
    def test_not_branch_bzrdir_without_repo(self):
 
674
        bzrdir = self.make_bzrdir('bzrdir')
 
675
        err = errors.NotBranchError('path', bzrdir=bzrdir)
 
676
        self.assertEqual('Not a branch: "path".', str(err))
 
677
 
 
678
    def test_not_branch_bzrdir_with_recursive_not_branch_error(self):
 
679
        class FakeBzrDir(object):
 
680
            def open_repository(self):
 
681
                # str() on the NotBranchError will trigger a call to this,
 
682
                # which in turn will another, identical NotBranchError.
 
683
                raise errors.NotBranchError('path', bzrdir=FakeBzrDir())
 
684
        err = errors.NotBranchError('path', bzrdir=FakeBzrDir())
 
685
        self.assertEqual('Not a branch: "path".', str(err))
 
686
 
 
687
    def test_not_branch_laziness(self):
 
688
        real_bzrdir = self.make_bzrdir('path')
 
689
        class FakeBzrDir(object):
 
690
            def __init__(self):
 
691
                self.calls = []
 
692
            def open_repository(self):
 
693
                self.calls.append('open_repository')
 
694
                raise errors.NoRepositoryPresent(real_bzrdir)
 
695
        fake_bzrdir = FakeBzrDir()
 
696
        err = errors.NotBranchError('path', bzrdir=fake_bzrdir)
 
697
        self.assertEqual([], fake_bzrdir.calls)
 
698
        str(err)
 
699
        self.assertEqual(['open_repository'], fake_bzrdir.calls)
 
700
        # Stringifying twice doesn't try to open a repository twice.
 
701
        str(err)
 
702
        self.assertEqual(['open_repository'], fake_bzrdir.calls)
 
703
 
 
704
    def test_invalid_pattern(self):
 
705
        error = errors.InvalidPattern('Bad pattern msg.')
 
706
        self.assertEqualDiff("Invalid pattern(s) found. Bad pattern msg.",
 
707
            str(error))
 
708
 
 
709
    def test_recursive_bind(self):
 
710
        error = errors.RecursiveBind('foo_bar_branch')
 
711
        msg = ('Branch "foo_bar_branch" appears to be bound to itself. '
 
712
            'Please use `bzr unbind` to fix.')
 
713
        self.assertEqualDiff(msg, str(error))
 
714
 
 
715
 
 
716
class PassThroughError(errors.BzrError):
 
717
 
 
718
    _fmt = """Pass through %(foo)s and %(bar)s"""
 
719
 
 
720
    def __init__(self, foo, bar):
 
721
        errors.BzrError.__init__(self, foo=foo, bar=bar)
 
722
 
 
723
 
 
724
class ErrorWithBadFormat(errors.BzrError):
 
725
 
 
726
    _fmt = """One format specifier: %(thing)s"""
 
727
 
 
728
 
 
729
class ErrorWithNoFormat(errors.BzrError):
 
730
    __doc__ = """This class has a docstring but no format string."""
 
731
 
 
732
 
 
733
class TestErrorFormatting(TestCase):
 
734
 
 
735
    def test_always_str(self):
 
736
        e = PassThroughError(u'\xb5', 'bar')
 
737
        self.assertIsInstance(e.__str__(), str)
 
738
        # In Python str(foo) *must* return a real byte string
 
739
        # not a Unicode string. The following line would raise a
 
740
        # Unicode error, because it tries to call str() on the string
 
741
        # returned from e.__str__(), and it has non ascii characters
 
742
        s = str(e)
 
743
        self.assertEqual('Pass through \xc2\xb5 and bar', s)
 
744
 
 
745
    def test_missing_format_string(self):
 
746
        e = ErrorWithNoFormat(param='randomvalue')
 
747
        s = self.callDeprecated(
 
748
                ['ErrorWithNoFormat uses its docstring as a format, it should use _fmt instead'],
 
749
                lambda x: str(x), e)
 
750
        ## s = str(e)
 
751
        self.assertEqual(s,
 
752
                "This class has a docstring but no format string.")
 
753
 
 
754
    def test_mismatched_format_args(self):
 
755
        # Even though ErrorWithBadFormat's format string does not match the
 
756
        # arguments we constructing it with, we can still stringify an instance
 
757
        # of this exception. The resulting string will say its unprintable.
 
758
        e = ErrorWithBadFormat(not_thing='x')
 
759
        self.assertStartsWith(
 
760
            str(e), 'Unprintable exception ErrorWithBadFormat')
 
761
 
 
762
    def test_cannot_bind_address(self):
 
763
        # see <https://bugs.launchpad.net/bzr/+bug/286871>
 
764
        e = errors.CannotBindAddress('example.com', 22,
 
765
            socket.error(13, 'Permission denied'))
 
766
        self.assertContainsRe(str(e),
 
767
            r'Cannot bind address "example\.com:22":.*Permission denied')
 
768
 
 
769
    def test_file_timestamp_unavailable(self):            
 
770
        e = errors.FileTimestampUnavailable("/path/foo")
 
771
        self.assertEquals("The filestamp for /path/foo is not available.",
 
772
            str(e))
 
773
            
 
774
    def test_transform_rename_failed(self):
 
775
        e = errors.TransformRenameFailed(u"from", u"to", "readonly file", 2)
 
776
        self.assertEquals(
 
777
            u"Failed to rename from to to: readonly file",
 
778
            str(e))