~bzr-pqm/bzr/bzr.dev

4763.2.4 by John Arbash Meinel
merge bzr.2.1 in preparation for NEWS entry.
1
# Copyright (C) 2006-2010 Canonical Ltd
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
2
#
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
7
#
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
# GNU General Public License for more details.
12
#
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
4183.7.1 by Sabin Iacob
update FSF mailing address
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
16
17
"""Tests for the formatting and construction of errors."""
18
5050.8.1 by Parth Malwankar
added test to ensure that BzrError subclasses dont use "message" as a name
19
import inspect
20
import re
4634.1.2 by Martin Pool
Add test for CannotBindAddress
21
import socket
3577.1.1 by Andrew Bennetts
Cherry-pick TipChangeRejected changes from pre-branch-tip-changed-hook loom.
22
import sys
4634.1.2 by Martin Pool
Add test for CannotBindAddress
23
1948.1.6 by John Arbash Meinel
Make BzrNewError always return a str object
24
from bzrlib import (
25
    bzrdir,
26
    errors,
3234.2.6 by Alexander Belchenko
because every mail client has different rules to compose command line we should encode arguments to 8 bit string only when needed.
27
    osutils,
2872.5.1 by Martin Pool
Avoid internal error tracebacks on failure to lock on readonly transport (#129701).
28
    symbol_versioning,
3200.2.1 by Robert Collins
* The ``register-branch`` command will now use the public url of the branch
29
    urlutils,
1948.1.6 by John Arbash Meinel
Make BzrNewError always return a str object
30
    )
5050.8.4 by Parth Malwankar
skip test if __subclasses__ is supported for classes.
31
from bzrlib.tests import TestCase, TestCaseWithTransport, TestSkipped
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
32
33
34
class TestErrors(TestCaseWithTransport):
35
5050.8.1 by Parth Malwankar
added test to ensure that BzrError subclasses dont use "message" as a name
36
    def test_no_arg_named_message(self):
37
        """Ensure the __init__ and _fmt in errors do not have "message" arg.
38
39
        This test fails if __init__ or _fmt in errors has an argument
40
        named "message" as this can cause errors in some Python versions.
41
        Python 2.5 uses a slot for StandardError.message.
42
        See bug #603461
43
        """
44
        fmt_pattern = re.compile("%\(message\)[sir]")
5050.8.4 by Parth Malwankar
skip test if __subclasses__ is supported for classes.
45
        subclasses_present = getattr(errors.BzrError, '__subclasses__', None)
46
        if not subclasses_present:
47
            raise TestSkipped('__subclasses__ attribute required for classes. '
48
                'Requires Python 2.5 or later.')
5050.8.3 by Parth Malwankar
use __subclasses__
49
        for c in errors.BzrError.__subclasses__():
50
            init = getattr(c, '__init__', None)
51
            fmt = getattr(c, '_fmt', None)
5050.8.1 by Parth Malwankar
added test to ensure that BzrError subclasses dont use "message" as a name
52
            if init:
53
                args = inspect.getargspec(init)[0]
54
                self.assertFalse('message' in args,
55
                    ('Argument name "message" not allowed for '
5050.8.3 by Parth Malwankar
use __subclasses__
56
                    '"errors.%s.__init__"' % c.__name__))
5050.8.1 by Parth Malwankar
added test to ensure that BzrError subclasses dont use "message" as a name
57
            if fmt and fmt_pattern.search(fmt):
58
                self.assertFalse(True, ('"message" not allowed in '
5050.8.3 by Parth Malwankar
use __subclasses__
59
                    '"errors.%s._fmt"' % c.__name__))
5050.8.1 by Parth Malwankar
added test to ensure that BzrError subclasses dont use "message" as a name
60
3287.20.2 by John Arbash Meinel
Raise a clear error about the offending filename when there is a filename with bad characters.
61
    def test_bad_filename_encoding(self):
62
        error = errors.BadFilenameEncoding('bad/filen\xe5me', 'UTF-8')
63
        self.assertEqualDiff(
64
            "Filename 'bad/filen\\xe5me' is not valid in your current"
65
            " filesystem encoding UTF-8",
66
            str(error))
67
3207.2.1 by jameinel
Add a test that _iter_changes raises a clearer error when we encounter an invalid rename.
68
    def test_corrupt_dirstate(self):
69
        error = errors.CorruptDirstate('path/to/dirstate', 'the reason why')
3221.1.3 by Martin Pool
Review cleanups for CorruptDirstate: use the path everywhere rather than the object, and use more standard phrasing.
70
        self.assertEqualDiff(
71
            "Inconsistency in dirstate file path/to/dirstate.\n"
72
            "Error: the reason why",
73
            str(error))
3207.2.1 by jameinel
Add a test that _iter_changes raises a clearer error when we encounter an invalid rename.
74
3640.2.5 by John Arbash Meinel
Change from using AssertionError to using DirstateCorrupt in a few places
75
    def test_dirstate_corrupt(self):
76
        error = errors.DirstateCorrupt('.bzr/checkout/dirstate',
77
                                       'trailing garbage: "x"')
78
        self.assertEqualDiff("The dirstate file (.bzr/checkout/dirstate)"
79
            " appears to be corrupt: trailing garbage: \"x\"",
80
            str(error))
81
2018.5.24 by Andrew Bennetts
Setting NO_SMART_VFS in environment will disable VFS methods in the smart server. (Robert Collins, John Arbash Meinel, Andrew Bennetts)
82
    def test_disabled_method(self):
83
        error = errors.DisabledMethod("class name")
84
        self.assertEqualDiff(
85
            "The smart server method 'class name' is disabled.", str(error))
86
2255.7.16 by John Arbash Meinel
Make sure adding a duplicate file_id raises DuplicateFileId.
87
    def test_duplicate_file_id(self):
88
        error = errors.DuplicateFileId('a_file_id', 'foo')
89
        self.assertEqualDiff('File id {a_file_id} already exists in inventory'
90
                             ' as foo', str(error))
91
2432.1.19 by Robert Collins
Ensure each HelpIndex has a unique prefix.
92
    def test_duplicate_help_prefix(self):
93
        error = errors.DuplicateHelpPrefix('foo')
94
        self.assertEqualDiff('The prefix foo is in the help search path twice.',
95
            str(error))
96
3445.1.1 by John Arbash Meinel
Start working on a new Graph api to make finding revision numbers faster.
97
    def test_ghost_revisions_have_no_revno(self):
98
        error = errors.GhostRevisionsHaveNoRevno('target', 'ghost_rev')
99
        self.assertEqualDiff("Could not determine revno for {target} because"
100
                             " its ancestry shows a ghost at {ghost_rev}",
101
                             str(error))
102
2550.2.3 by Robert Collins
Add require_api API.
103
    def test_incompatibleAPI(self):
104
        error = errors.IncompatibleAPI("module", (1, 2, 3), (4, 5, 6), (7, 8, 9))
105
        self.assertEqualDiff(
106
            'The API for "module" is not compatible with "(1, 2, 3)". '
107
            'It supports versions "(4, 5, 6)" to "(7, 8, 9)".',
108
            str(error))
109
3207.2.2 by John Arbash Meinel
Fix bug #187169, when an invalid delta is supplied to update_basis_by_delta
110
    def test_inconsistent_delta(self):
111
        error = errors.InconsistentDelta('path', 'file-id', 'reason for foo')
112
        self.assertEqualDiff(
3221.1.8 by Martin Pool
Update error format in test_inconsistent_delta
113
            "An inconsistent delta was supplied involving 'path', 'file-id'\n"
3207.2.2 by John Arbash Meinel
Fix bug #187169, when an invalid delta is supplied to update_basis_by_delta
114
            "reason: reason for foo",
115
            str(error))
116
4505.5.1 by Robert Collins
Add more generic InconsistentDeltaDelta error class for use when the exact cause of an inconsistent delta isn't trivially accessible.
117
    def test_inconsistent_delta_delta(self):
118
        error = errors.InconsistentDeltaDelta([], 'reason')
119
        self.assertEqualDiff(
120
            "An inconsistent delta was supplied: []\nreason: reason",
121
            str(error))
122
2634.1.1 by Robert Collins
(robertc) Reinstate the accidentally backed out external_url patch.
123
    def test_in_process_transport(self):
124
        error = errors.InProcessTransport('fpp')
125
        self.assertEqualDiff(
126
            "The transport 'fpp' is only accessible within this process.",
127
            str(error))
128
3059.2.12 by Vincent Ladeuil
Spiv review feedback.
129
    def test_invalid_http_range(self):
130
        error = errors.InvalidHttpRange('path',
131
                                        'Content-Range: potatoes 0-00/o0oo0',
132
                                        'bad range')
133
        self.assertEquals("Invalid http range"
134
                          " 'Content-Range: potatoes 0-00/o0oo0'"
135
                          " for path: bad range",
136
                          str(error))
137
138
    def test_invalid_range(self):
139
        error = errors.InvalidRange('path', 12, 'bad range')
140
        self.assertEquals("Invalid range access in path at 12: bad range",
141
                          str(error))
142
1986.5.3 by Robert Collins
New method ``WorkingTree.flush()`` which will write the current memory
143
    def test_inventory_modified(self):
144
        error = errors.InventoryModified("a tree to be repred")
145
        self.assertEqualDiff("The current inventory for the tree 'a tree to "
146
            "be repred' has been modified, so a clean inventory cannot be "
147
            "read without data loss.",
148
            str(error))
149
4294.2.8 by Robert Collins
Reduce round trips pushing new branches substantially.
150
    def test_jail_break(self):
151
        error = errors.JailBreak("some url")
152
        self.assertEqualDiff("An attempt to access a url outside the server"
153
            " jail was made: 'some url'.",
154
            str(error))
155
2255.2.145 by Robert Collins
Support unbreakable locks for trees.
156
    def test_lock_active(self):
157
        error = errors.LockActive("lock description")
158
        self.assertEqualDiff("The lock for 'lock description' is in use and "
159
            "cannot be broken.",
160
            str(error))
161
4634.161.1 by Andrew Bennetts
Add LockCorrupt error, and use it to provide nicer handling of unparseable lock/held/info files.
162
    def test_lock_corrupt(self):
163
        error = errors.LockCorrupt("corruption info")
164
        self.assertEqualDiff("Lock is apparently held, but corrupted: "
165
            "corruption info\n"
166
            "Use 'bzr break-lock' to clear it",
167
            str(error))
168
2535.3.4 by Andrew Bennetts
Simple implementation of Knit.insert_data_stream.
169
    def test_knit_data_stream_incompatible(self):
170
        error = errors.KnitDataStreamIncompatible(
171
            'stream format', 'target format')
172
        self.assertEqual('Cannot insert knit data stream of format '
173
                         '"stream format" into knit of format '
174
                         '"target format".', str(error))
175
3052.2.1 by Robert Collins
Add a new KnitDataStreamUnknown error class for showing formats we can't understand.
176
    def test_knit_data_stream_unknown(self):
177
        error = errors.KnitDataStreamUnknown(
178
            'stream format')
179
        self.assertEqual('Cannot parse knit data stream of format '
180
                         '"stream format".', str(error))
181
2171.1.1 by John Arbash Meinel
Knit index files should ignore empty indexes rather than consider them corrupt.
182
    def test_knit_header_error(self):
183
        error = errors.KnitHeaderError('line foo\n', 'path/to/file')
184
        self.assertEqual("Knit header error: 'line foo\\n' unexpected"
2745.3.2 by Daniel Watkins
Updated tests to reflect new error text.
185
                         " for file \"path/to/file\".", str(error))
2171.1.1 by John Arbash Meinel
Knit index files should ignore empty indexes rather than consider them corrupt.
186
2196.2.5 by John Arbash Meinel
Add an exception class when the knit index storage method is unknown, and properly test for it
187
    def test_knit_index_unknown_method(self):
188
        error = errors.KnitIndexUnknownMethod('http://host/foo.kndx',
189
                                              ['bad', 'no-eol'])
190
        self.assertEqual("Knit index http://host/foo.kndx does not have a"
191
                         " known method in options: ['bad', 'no-eol']",
192
                         str(error))
193
2018.2.3 by Andrew Bennetts
Starting factoring out the smart server client "medium" from the protocol.
194
    def test_medium_not_connected(self):
195
        error = errors.MediumNotConnected("a medium")
196
        self.assertEqualDiff(
197
            "The medium 'a medium' is not connected.", str(error))
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
198
3200.2.1 by Robert Collins
* The ``register-branch`` command will now use the public url of the branch
199
    def test_no_public_branch(self):
200
        b = self.make_branch('.')
201
        error = errors.NoPublicBranch(b)
202
        url = urlutils.unescape_for_display(b.base, 'ascii')
203
        self.assertEqualDiff(
204
            'There is no public branch set for "%s".' % url, str(error))
205
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
206
    def test_no_repo(self):
207
        dir = bzrdir.BzrDir.create(self.get_url())
208
        error = errors.NoRepositoryPresent(dir)
1740.5.6 by Martin Pool
Clean up many exception classes.
209
        self.assertNotEqual(-1, str(error).find((dir.transport.clone('..').base)))
210
        self.assertEqual(-1, str(error).find((dir.transport.base)))
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
211
2018.2.3 by Andrew Bennetts
Starting factoring out the smart server client "medium" from the protocol.
212
    def test_no_smart_medium(self):
213
        error = errors.NoSmartMedium("a transport")
214
        self.assertEqualDiff("The transport 'a transport' cannot tunnel the "
215
            "smart protocol.",
216
            str(error))
217
2432.1.4 by Robert Collins
Add an explicit error for missing help topics.
218
    def test_no_help_topic(self):
219
        error = errors.NoHelpTopic("topic")
220
        self.assertEqualDiff("No help could be found for 'topic'. "
221
            "Please use 'bzr help topics' to obtain a list of topics.",
222
            str(error))
223
1988.2.1 by Robert Collins
WorkingTree has a new api ``unversion`` which allow the unversioning of
224
    def test_no_such_id(self):
225
        error = errors.NoSuchId("atree", "anid")
2745.3.2 by Daniel Watkins
Updated tests to reflect new error text.
226
        self.assertEqualDiff("The file id \"anid\" is not present in the tree "
2745.3.3 by Daniel Watkins
Changed to remove need for escaping of quotes.
227
            "atree.",
1988.2.1 by Robert Collins
WorkingTree has a new api ``unversion`` which allow the unversioning of
228
            str(error))
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
229
1908.11.1 by Robert Collins
Add a new method ``Tree.revision_tree`` which allows access to cached
230
    def test_no_such_revision_in_tree(self):
231
        error = errors.NoSuchRevisionInTree("atree", "anid")
2745.3.3 by Daniel Watkins
Changed to remove need for escaping of quotes.
232
        self.assertEqualDiff("The revision id {anid} is not present in the"
233
                             " tree atree.", str(error))
1908.11.1 by Robert Collins
Add a new method ``Tree.revision_tree`` which allows access to cached
234
        self.assertIsInstance(error, errors.NoSuchRevision)
235
3221.11.2 by Robert Collins
Create basic stackable branch facility.
236
    def test_not_stacked(self):
237
        error = errors.NotStacked('a branch')
238
        self.assertEqualDiff("The branch 'a branch' is not stacked.",
239
            str(error))
240
1986.5.3 by Robert Collins
New method ``WorkingTree.flush()`` which will write the current memory
241
    def test_not_write_locked(self):
242
        error = errors.NotWriteLocked('a thing to repr')
243
        self.assertEqualDiff("'a thing to repr' is not write locked but needs "
244
            "to be.",
245
            str(error))
246
2872.5.1 by Martin Pool
Avoid internal error tracebacks on failure to lock on readonly transport (#129701).
247
    def test_lock_failed(self):
248
        error = errors.LockFailed('http://canonical.com/', 'readonly transport')
249
        self.assertEqualDiff("Cannot lock http://canonical.com/: readonly transport",
250
            str(error))
251
        self.assertFalse(error.internal_error)
252
2018.2.4 by Robert Collins
separate out the client medium from the client encoding protocol for the smart server.
253
    def test_too_many_concurrent_requests(self):
254
        error = errors.TooManyConcurrentRequests("a medium")
255
        self.assertEqualDiff("The medium 'a medium' has reached its concurrent "
256
            "request limit. Be sure to finish_writing and finish_reading on "
2018.5.134 by Andrew Bennetts
Fix the TooManyConcurrentRequests error message.
257
            "the currently open request.",
2018.2.4 by Robert Collins
separate out the client medium from the client encoding protocol for the smart server.
258
            str(error))
259
3350.3.3 by Robert Collins
Functional get_record_stream interface tests covering full interface.
260
    def test_unavailable_representation(self):
261
        error = errors.UnavailableRepresentation(('key',), "mpdiff", "fulltext")
262
        self.assertEqualDiff("The encoding 'mpdiff' is not available for key "
263
            "('key',) which is encoded as 'fulltext'.",
264
            str(error))
265
2245.1.3 by Robert Collins
Add install_hook to the BranchHooks class as the official means for installing a hook.
266
    def test_unknown_hook(self):
267
        error = errors.UnknownHook("branch", "foo")
268
        self.assertEqualDiff("The branch hook 'foo' is unknown in this version"
269
            " of bzrlib.",
270
            str(error))
271
        error = errors.UnknownHook("tree", "bar")
272
        self.assertEqualDiff("The tree hook 'bar' is unknown in this version"
273
            " of bzrlib.",
274
            str(error))
275
3221.11.2 by Robert Collins
Create basic stackable branch facility.
276
    def test_unstackable_branch_format(self):
277
        format = u'foo'
278
        url = "/foo"
279
        error = errors.UnstackableBranchFormat(format, url)
280
        self.assertEqualDiff(
281
            "The branch '/foo'(foo) is not a stackable format. "
282
            "You will need to upgrade the branch to permit branch stacking.",
283
            str(error))
284
4462.3.2 by Robert Collins
Do not stack on the same branch/repository anymore. This was never supported and would generally result in infinite recursion. Fixes bug 376243.
285
    def test_unstackable_location(self):
286
        error = errors.UnstackableLocationError('foo', 'bar')
287
        self.assertEqualDiff("The branch 'foo' cannot be stacked on 'bar'.",
288
            str(error))
289
3221.11.2 by Robert Collins
Create basic stackable branch facility.
290
    def test_unstackable_repository_format(self):
291
        format = u'foo'
292
        url = "/foo"
293
        error = errors.UnstackableRepositoryFormat(format, url)
294
        self.assertEqualDiff(
295
            "The repository '/foo'(foo) is not a stackable format. "
296
            "You will need to upgrade the repository to permit branch stacking.",
297
            str(error))
298
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
299
    def test_up_to_date(self):
300
        error = errors.UpToDateFormat(bzrdir.BzrDirFormat4())
4032.3.2 by Robert Collins
Create and use a RPC call to create branches on bzr servers rather than using VFS calls.
301
        self.assertEqualDiff("The branch format All-in-one "
302
                             "format 4 is already at the most "
1534.5.9 by Robert Collins
Advise users running upgrade on a checkout to also run it on the branch.
303
                             "recent format.",
304
                             str(error))
1570.1.13 by Robert Collins
Check for incorrect revision parentage in the weave during revision access.
305
306
    def test_corrupt_repository(self):
307
        repo = self.make_repository('.')
308
        error = errors.CorruptRepository(repo)
309
        self.assertEqualDiff("An error has been detected in the repository %s.\n"
310
                             "Please run bzr reconcile on this repository." %
311
                             repo.bzrdir.root_transport.base,
312
                             str(error))
1948.1.6 by John Arbash Meinel
Make BzrNewError always return a str object
313
2052.6.1 by Robert Collins
``Transport.get`` has had its interface made more clear for ease of use.
314
    def test_read_error(self):
315
        # a unicode path to check that %r is being used.
316
        path = u'a path'
317
        error = errors.ReadError(path)
318
        self.assertEqualDiff("Error reading from u'a path'.", str(error))
319
2592.1.7 by Robert Collins
A validate that goes boom.
320
    def test_bad_index_format_signature(self):
321
        error = errors.BadIndexFormatSignature("foo", "bar")
322
        self.assertEqual("foo is not an index of type bar.",
323
            str(error))
2052.6.2 by Robert Collins
Merge bzr.dev.
324
2592.1.11 by Robert Collins
Detect truncated indices.
325
    def test_bad_index_data(self):
326
        error = errors.BadIndexData("foo")
327
        self.assertEqual("Error in data for index foo.",
328
            str(error))
329
2592.1.15 by Robert Collins
Detect duplicate key insertion.
330
    def test_bad_index_duplicate_key(self):
331
        error = errors.BadIndexDuplicateKey("foo", "bar")
332
        self.assertEqual("The key 'foo' is already in index 'bar'.",
333
            str(error))
334
2592.1.12 by Robert Collins
Handle basic node adds.
335
    def test_bad_index_key(self):
336
        error = errors.BadIndexKey("foo")
337
        self.assertEqual("The key 'foo' is not a valid key.",
338
            str(error))
339
2592.1.10 by Robert Collins
Make validate detect node reference parsing errors.
340
    def test_bad_index_options(self):
341
        error = errors.BadIndexOptions("foo")
342
        self.assertEqual("Could not parse options for index foo.",
343
            str(error))
344
2592.1.12 by Robert Collins
Handle basic node adds.
345
    def test_bad_index_value(self):
346
        error = errors.BadIndexValue("foo")
347
        self.assertEqual("The value 'foo' is not a valid value.",
348
            str(error))
349
2067.3.1 by Martin Pool
Clean up BzrNewError, other exception classes and users.
350
    def test_bzrnewerror_is_deprecated(self):
351
        class DeprecatedError(errors.BzrNewError):
352
            pass
2067.3.6 by Martin Pool
Update deprecation version
353
        self.callDeprecated(['BzrNewError was deprecated in bzr 0.13; '
2067.3.1 by Martin Pool
Clean up BzrNewError, other exception classes and users.
354
             'please convert DeprecatedError to use BzrError instead'],
355
            DeprecatedError)
356
357
    def test_bzrerror_from_literal_string(self):
358
        # Some code constructs BzrError from a literal string, in which case
359
        # no further formatting is done.  (I'm not sure raising the base class
360
        # is a great idea, but if the exception is not intended to be caught
361
        # perhaps no more is needed.)
362
        try:
363
            raise errors.BzrError('this is my errors; %d is not expanded')
364
        except errors.BzrError, e:
365
            self.assertEqual('this is my errors; %d is not expanded', str(e))
366
2018.2.4 by Robert Collins
separate out the client medium from the client encoding protocol for the smart server.
367
    def test_reading_completed(self):
368
        error = errors.ReadingCompleted("a request")
369
        self.assertEqualDiff("The MediumRequest 'a request' has already had "
370
            "finish_reading called upon it - the request has been completed and"
371
            " no more data may be read.",
372
            str(error))
373
374
    def test_writing_completed(self):
375
        error = errors.WritingCompleted("a request")
376
        self.assertEqualDiff("The MediumRequest 'a request' has already had "
377
            "finish_writing called upon it - accept bytes may not be called "
378
            "anymore.",
379
            str(error))
380
381
    def test_writing_not_completed(self):
382
        error = errors.WritingNotComplete("a request")
383
        self.assertEqualDiff("The MediumRequest 'a request' has not has "
384
            "finish_writing called upon it - until the write phase is complete"
385
            " no data may be read.",
386
            str(error))
387
2052.6.1 by Robert Collins
``Transport.get`` has had its interface made more clear for ease of use.
388
    def test_transport_not_possible(self):
389
        error = errors.TransportNotPossible('readonly', 'original error')
390
        self.assertEqualDiff('Transport operation not possible:'
391
                         ' readonly original error', str(error))
2052.4.4 by John Arbash Meinel
Create a SocketConnectionError to make creating nice errors easier
392
393
    def assertSocketConnectionError(self, expected, *args, **kwargs):
394
        """Check the formatting of a SocketConnectionError exception"""
395
        e = errors.SocketConnectionError(*args, **kwargs)
396
        self.assertEqual(expected, str(e))
397
398
    def test_socket_connection_error(self):
399
        """Test the formatting of SocketConnectionError"""
400
401
        # There should be a default msg about failing to connect
402
        # we only require a host name.
403
        self.assertSocketConnectionError(
404
            'Failed to connect to ahost',
405
            'ahost')
406
407
        # If port is None, we don't put :None
408
        self.assertSocketConnectionError(
409
            'Failed to connect to ahost',
410
            'ahost', port=None)
411
        # But if port is supplied we include it
412
        self.assertSocketConnectionError(
413
            'Failed to connect to ahost:22',
414
            'ahost', port=22)
415
416
        # We can also supply extra information about the error
417
        # with or without a port
418
        self.assertSocketConnectionError(
419
            'Failed to connect to ahost:22; bogus error',
420
            'ahost', port=22, orig_error='bogus error')
421
        self.assertSocketConnectionError(
422
            'Failed to connect to ahost; bogus error',
423
            'ahost', orig_error='bogus error')
424
        # An exception object can be passed rather than a string
425
        orig_error = ValueError('bad value')
426
        self.assertSocketConnectionError(
427
            'Failed to connect to ahost; %s' % (str(orig_error),),
428
            host='ahost', orig_error=orig_error)
429
430
        # And we can supply a custom failure message
431
        self.assertSocketConnectionError(
432
            'Unable to connect to ssh host ahost:444; my_error',
433
            host='ahost', port=444, msg='Unable to connect to ssh host',
434
            orig_error='my_error')
435
3535.8.2 by James Westby
Incorporate spiv's feedback.
436
    def test_target_not_branch(self):
437
        """Test the formatting of TargetNotBranch."""
438
        error = errors.TargetNotBranch('foo')
439
        self.assertEqual(
440
            "Your branch does not have all of the revisions required in "
3535.8.4 by James Westby
Replace "however" with "and" at John's request.
441
            "order to merge this merge directive and the target "
3535.8.3 by James Westby
Use location instead of branch as suggested by Robert.
442
            "location specified in the merge directive is not a branch: "
3535.8.2 by James Westby
Incorporate spiv's feedback.
443
            "foo.", str(error))
444
2376.4.26 by Jonathan Lange
Tests for MalformedBugIdentifier and new error UnknownBugTrackerAbbreviation.
445
    def test_malformed_bug_identifier(self):
446
        """Test the formatting of MalformedBugIdentifier."""
447
        error = errors.MalformedBugIdentifier('bogus', 'reason for bogosity')
448
        self.assertEqual(
3535.10.1 by James Westby
Point to "bzr help bugs" from MalformedBugIdentifier.
449
            'Did not understand bug identifier bogus: reason for bogosity. '
3535.10.11 by James Westby
Fix test for change in error message.
450
            'See "bzr help bugs" for more information on this feature.',
2376.4.26 by Jonathan Lange
Tests for MalformedBugIdentifier and new error UnknownBugTrackerAbbreviation.
451
            str(error))
452
453
    def test_unknown_bug_tracker_abbreviation(self):
454
        """Test the formatting of UnknownBugTrackerAbbreviation."""
2376.4.27 by Jonathan Lange
Include branch information in UnknownBugTrackerAbbreviation
455
        branch = self.make_branch('some_branch')
456
        error = errors.UnknownBugTrackerAbbreviation('xxx', branch)
2376.4.26 by Jonathan Lange
Tests for MalformedBugIdentifier and new error UnknownBugTrackerAbbreviation.
457
        self.assertEqual(
2376.4.27 by Jonathan Lange
Include branch information in UnknownBugTrackerAbbreviation
458
            "Cannot find registered bug tracker called xxx on %s" % branch,
2376.4.26 by Jonathan Lange
Tests for MalformedBugIdentifier and new error UnknownBugTrackerAbbreviation.
459
            str(error))
2052.4.4 by John Arbash Meinel
Create a SocketConnectionError to make creating nice errors easier
460
2018.5.163 by Andrew Bennetts
Deal with various review comments from Robert.
461
    def test_unexpected_smart_server_response(self):
462
        e = errors.UnexpectedSmartServerResponse(('not yes',))
463
        self.assertEqual(
464
            "Could not understand response from smart server: ('not yes',)",
465
            str(e))
2052.4.4 by John Arbash Meinel
Create a SocketConnectionError to make creating nice errors easier
466
2506.2.1 by Andrew Bennetts
Start implementing container format reading and writing.
467
    def test_unknown_container_format(self):
468
        """Test the formatting of UnknownContainerFormatError."""
469
        e = errors.UnknownContainerFormatError('bad format string')
470
        self.assertEqual(
471
            "Unrecognised container format: 'bad format string'",
472
            str(e))
473
474
    def test_unexpected_end_of_container(self):
475
        """Test the formatting of UnexpectedEndOfContainerError."""
476
        e = errors.UnexpectedEndOfContainerError()
477
        self.assertEqual(
478
            "Unexpected end of container stream", str(e))
479
480
    def test_unknown_record_type(self):
481
        """Test the formatting of UnknownRecordTypeError."""
482
        e = errors.UnknownRecordTypeError("X")
483
        self.assertEqual(
484
            "Unknown record type: 'X'",
485
            str(e))
486
2506.3.1 by Andrew Bennetts
More progress:
487
    def test_invalid_record(self):
488
        """Test the formatting of InvalidRecordError."""
489
        e = errors.InvalidRecordError("xxx")
490
        self.assertEqual(
491
            "Invalid record: xxx",
492
            str(e))
493
2506.2.6 by Andrew Bennetts
Add validate method to ContainerReader and BytesRecordReader.
494
    def test_container_has_excess_data(self):
495
        """Test the formatting of ContainerHasExcessDataError."""
496
        e = errors.ContainerHasExcessDataError("excess bytes")
497
        self.assertEqual(
498
            "Container has data after end marker: 'excess bytes'",
499
            str(e))
500
2506.6.1 by Andrew Bennetts
Return a callable instead of a str from read, and add more validation.
501
    def test_duplicate_record_name_error(self):
502
        """Test the formatting of DuplicateRecordNameError."""
503
        e = errors.DuplicateRecordNameError(u"n\xe5me".encode('utf-8'))
504
        self.assertEqual(
2745.3.3 by Daniel Watkins
Changed to remove need for escaping of quotes.
505
            "Container has multiple records with the same name: n\xc3\xa5me",
2506.6.1 by Andrew Bennetts
Return a callable instead of a str from read, and add more validation.
506
            str(e))
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
507
2854.1.1 by Martin Pool
Fix "unprintable error" message for BzrCheckError and others
508
    def test_check_error(self):
509
        # This has a member called 'message', which is problematic in
510
        # python2.5 because that is a slot on the base Exception class
511
        e = errors.BzrCheckError('example check failure')
512
        self.assertEqual(
513
            "Internal check failed: example check failure",
514
            str(e))
515
        self.assertTrue(e.internal_error)
2506.6.1 by Andrew Bennetts
Return a callable instead of a str from read, and add more validation.
516
2535.3.40 by Andrew Bennetts
Tidy up more XXXs.
517
    def test_repository_data_stream_error(self):
518
        """Test the formatting of RepositoryDataStreamError."""
519
        e = errors.RepositoryDataStreamError(u"my reason")
520
        self.assertEqual(
521
            "Corrupt or incompatible data stream: my reason", str(e))
522
2978.2.1 by Alexander Belchenko
fix formatting of ImmortalPendingDeletion error message.
523
    def test_immortal_pending_deletion_message(self):
524
        err = errors.ImmortalPendingDeletion('foo')
525
        self.assertEquals(
526
            "Unable to delete transform temporary directory foo.  "
527
            "Please examine foo to see if it contains any files "
528
            "you wish to keep, and delete it when you are done.",
529
            str(err))
530
3006.2.2 by Alexander Belchenko
tests added.
531
    def test_unable_create_symlink(self):
532
        err = errors.UnableCreateSymlink()
533
        self.assertEquals(
534
            "Unable to create symlink on this platform",
535
            str(err))
536
        err = errors.UnableCreateSymlink(path=u'foo')
537
        self.assertEquals(
538
            "Unable to create symlink 'foo' on this platform",
539
            str(err))
540
        err = errors.UnableCreateSymlink(path=u'\xb5')
541
        self.assertEquals(
542
            "Unable to create symlink u'\\xb5' on this platform",
543
            str(err))
544
2692.1.1 by Andrew Bennetts
Add translate_client_path method to SmartServerRequest.
545
    def test_invalid_url_join(self):
546
        """Test the formatting of InvalidURLJoin."""
547
        e = errors.InvalidURLJoin('Reason', 'base path', ('args',))
548
        self.assertEqual(
549
            "Invalid URL join request: Reason: 'base path' + ('args',)",
550
            str(e))
551
3035.3.2 by Lukáš Lalinský
Add tests for InvalidBugTrackerURL.
552
    def test_incorrect_url(self):
553
        err = errors.InvalidBugTrackerURL('foo', 'http://bug.com/')
554
        self.assertEquals(
555
            ("The URL for bug tracker \"foo\" doesn't contain {id}: "
556
             "http://bug.com/"),
557
            str(err))
558
3234.2.6 by Alexander Belchenko
because every mail client has different rules to compose command line we should encode arguments to 8 bit string only when needed.
559
    def test_unable_encode_path(self):
560
        err = errors.UnableEncodePath('foo', 'executable')
3234.2.8 by Alexander Belchenko
fix grammar in formatting string of UnableEncodePath error.
561
        self.assertEquals("Unable to encode executable path 'foo' in "
3234.2.6 by Alexander Belchenko
because every mail client has different rules to compose command line we should encode arguments to 8 bit string only when needed.
562
            "user encoding " + osutils.get_user_encoding(),
563
            str(err))
564
3246.3.4 by Daniel Watkins
Added test.
565
    def test_unknown_format(self):
566
        err = errors.UnknownFormatError('bar', kind='foo')
567
        self.assertEquals("Unknown foo format: 'bar'", str(err))
568
3398.1.29 by Ian Clatworthy
add UnknownRules class & test
569
    def test_unknown_rules(self):
570
        err = errors.UnknownRules(['foo', 'bar'])
571
        self.assertEquals("Unknown rules detected: foo, bar.", str(err))
572
3577.1.1 by Andrew Bennetts
Cherry-pick TipChangeRejected changes from pre-branch-tip-changed-hook loom.
573
    def test_hook_failed(self):
574
        # Create an exc_info tuple by raising and catching an exception.
575
        try:
576
            1/0
577
        except ZeroDivisionError:
578
            exc_info = sys.exc_info()
4943.1.2 by Robert Collins
Adjust errors.py to fix missing references to 'warn'.
579
        err = errors.HookFailed('hook stage', 'hook name', exc_info, warn=False)
3577.1.1 by Andrew Bennetts
Cherry-pick TipChangeRejected changes from pre-branch-tip-changed-hook loom.
580
        self.assertStartsWith(
581
            str(err), 'Hook \'hook name\' during hook stage failed:\n')
582
        self.assertEndsWith(
583
            str(err), 'integer division or modulo by zero')
584
585
    def test_tip_change_rejected(self):
586
        err = errors.TipChangeRejected(u'Unicode message\N{INTERROBANG}')
587
        self.assertEquals(
588
            u'Tip change rejected: Unicode message\N{INTERROBANG}',
589
            unicode(err))
590
        self.assertEquals(
591
            'Tip change rejected: Unicode message\xe2\x80\xbd',
592
            str(err))
593
3690.1.1 by Andrew Bennetts
Unexpected error responses from a smart server no longer cause the client to traceback.
594
    def test_error_from_smart_server(self):
595
        error_tuple = ('error', 'tuple')
596
        err = errors.ErrorFromSmartServer(error_tuple)
597
        self.assertEquals(
598
            "Error received from smart server: ('error', 'tuple')", str(err))
599
600
    def test_untranslateable_error_from_smart_server(self):
601
        error_tuple = ('error', 'tuple')
602
        orig_err = errors.ErrorFromSmartServer(error_tuple)
3690.1.2 by Andrew Bennetts
Rename UntranslateableErrorFromSmartServer -> UnknownErrorFromSmartServer.
603
        err = errors.UnknownErrorFromSmartServer(orig_err)
3690.1.1 by Andrew Bennetts
Unexpected error responses from a smart server no longer cause the client to traceback.
604
        self.assertEquals(
605
            "Server sent an unexpected error: ('error', 'tuple')", str(err))
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
606
3883.2.3 by Andrew Bennetts
Add test, tweak traceback formatting.
607
    def test_smart_message_handler_error(self):
608
        # Make an exc_info tuple.
609
        try:
610
            raise Exception("example error")
611
        except Exception:
612
            exc_info = sys.exc_info()
613
        err = errors.SmartMessageHandlerError(exc_info)
614
        self.assertStartsWith(
615
            str(err), "The message handler raised an exception:\n")
616
        self.assertEndsWith(str(err), "Exception: example error\n")
3690.1.1 by Andrew Bennetts
Unexpected error responses from a smart server no longer cause the client to traceback.
617
3983.1.8 by Daniel Watkins
Added MustHaveWorkingTree error and accompanying test.
618
    def test_must_have_working_tree(self):
619
        err = errors.MustHaveWorkingTree('foo', 'bar')
3983.1.10 by Daniel Watkins
Made exception message slightly better.
620
        self.assertEqual(str(err), "Branching 'bar'(foo) must create a"
621
                                   " working tree.")
3983.1.8 by Daniel Watkins
Added MustHaveWorkingTree error and accompanying test.
622
3586.1.1 by Ian Clatworthy
add view-related errors and tests
623
    def test_no_such_view(self):
624
        err = errors.NoSuchView('foo')
625
        self.assertEquals("No such view: foo.", str(err))
626
627
    def test_views_not_supported(self):
628
        err = errors.ViewsNotSupported('atree')
629
        err_str = str(err)
630
        self.assertStartsWith(err_str, "Views are not supported by ")
631
        self.assertEndsWith(err_str, "; use 'bzr upgrade' to change your "
632
            "tree to a later format.")
633
3586.1.9 by Ian Clatworthy
first cut at view command
634
    def test_file_outside_view(self):
635
        err = errors.FileOutsideView('baz', ['foo', 'bar'])
636
        self.assertEquals('Specified file "baz" is outside the current view: '
637
            'foo, bar', str(err))
638
3990.2.2 by Daniel Watkins
Added InvalidShelfId error and accompanying test.
639
    def test_invalid_shelf_id(self):
640
        invalid_id = "foo"
641
        err = errors.InvalidShelfId(invalid_id)
3999.1.1 by Ian Clatworthy
Improve shelf documentation & fix backtrace (Daniel Watkins)
642
        self.assertEqual('"foo" is not a valid shelf id, '
643
            'try a number instead.', str(err))
3990.2.2 by Daniel Watkins
Added InvalidShelfId error and accompanying test.
644
4002.1.7 by Andrew Bennetts
Rename UnresumableWriteGroups to UnresumableWriteGroup.
645
    def test_unresumable_write_group(self):
4002.1.1 by Andrew Bennetts
Implement suspend_write_group/resume_write_group.
646
        repo = "dummy repo"
647
        wg_tokens = ['token']
648
        reason = "a reason"
4002.1.7 by Andrew Bennetts
Rename UnresumableWriteGroups to UnresumableWriteGroup.
649
        err = errors.UnresumableWriteGroup(repo, wg_tokens, reason)
4002.1.1 by Andrew Bennetts
Implement suspend_write_group/resume_write_group.
650
        self.assertEqual(
4002.1.7 by Andrew Bennetts
Rename UnresumableWriteGroups to UnresumableWriteGroup.
651
            "Repository dummy repo cannot resume write group "
4002.1.1 by Andrew Bennetts
Implement suspend_write_group/resume_write_group.
652
            "['token']: a reason", str(err))
653
654
    def test_unsuspendable_write_group(self):
655
        repo = "dummy repo"
656
        err = errors.UnsuspendableWriteGroup(repo)
657
        self.assertEqual(
658
            'Repository dummy repo cannot suspend a write group.', str(err))
659
4734.4.9 by Andrew Bennetts
More tests and comments.
660
    def test_not_branch_no_args(self):
661
        err = errors.NotBranchError('path')
662
        self.assertEqual('Not a branch: "path".', str(err))
663
664
    def test_not_branch_bzrdir_with_repo(self):
665
        bzrdir = self.make_repository('repo').bzrdir
666
        err = errors.NotBranchError('path', bzrdir=bzrdir)
667
        self.assertEqual(
668
            'Not a branch: "path": location is a repository.', str(err))
669
670
    def test_not_branch_bzrdir_without_repo(self):
671
        bzrdir = self.make_bzrdir('bzrdir')
672
        err = errors.NotBranchError('path', bzrdir=bzrdir)
673
        self.assertEqual('Not a branch: "path".', str(err))
674
675
    def test_not_branch_laziness(self):
676
        real_bzrdir = self.make_bzrdir('path')
677
        class FakeBzrDir(object):
678
            def __init__(self):
679
                self.calls = []
680
            def open_repository(self):
681
                self.calls.append('open_repository')
682
                raise errors.NoRepositoryPresent(real_bzrdir)
683
        fake_bzrdir = FakeBzrDir()
684
        err = errors.NotBranchError('path', bzrdir=fake_bzrdir)
685
        self.assertEqual([], fake_bzrdir.calls)
686
        str(err)
687
        self.assertEqual(['open_repository'], fake_bzrdir.calls)
688
        # Stringifying twice doesn't try to open a repository twice.
689
        str(err)
690
        self.assertEqual(['open_repository'], fake_bzrdir.calls)
691
5339.1.1 by Parth Malwankar
fixes errors.InvalidPattern to work on Python2.5
692
    def test_invalid_pattern(self):
693
        error = errors.InvalidPattern('Bad pattern msg.')
694
        self.assertEqualDiff("Invalid pattern(s) found. Bad pattern msg.",
695
            str(error))
696
5050.7.6 by Parth Malwankar
fixed test name
697
    def test_recursive_bind(self):
5050.7.5 by Parth Malwankar
better error message for RecursiveBind
698
        error = errors.RecursiveBind('foo_bar_branch')
699
        msg = ('Branch "foo_bar_branch" appears to be bound to itself. '
700
            'Please use `bzr unbind` to fix.')
701
        self.assertEqualDiff(msg, str(error))
702
2116.3.1 by John Arbash Meinel
Cleanup error tests
703
2067.3.1 by Martin Pool
Clean up BzrNewError, other exception classes and users.
704
class PassThroughError(errors.BzrError):
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
705
2067.3.1 by Martin Pool
Clean up BzrNewError, other exception classes and users.
706
    _fmt = """Pass through %(foo)s and %(bar)s"""
2116.3.1 by John Arbash Meinel
Cleanup error tests
707
708
    def __init__(self, foo, bar):
2067.3.1 by Martin Pool
Clean up BzrNewError, other exception classes and users.
709
        errors.BzrError.__init__(self, foo=foo, bar=bar)
710
711
712
class ErrorWithBadFormat(errors.BzrError):
713
714
    _fmt = """One format specifier: %(thing)s"""
715
716
717
class ErrorWithNoFormat(errors.BzrError):
5131.2.6 by Martin
Fix more tests which were failing under -OO that had been missed earlier
718
    __doc__ = """This class has a docstring but no format string."""
2116.3.1 by John Arbash Meinel
Cleanup error tests
719
720
721
class TestErrorFormatting(TestCase):
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
722
2116.3.1 by John Arbash Meinel
Cleanup error tests
723
    def test_always_str(self):
724
        e = PassThroughError(u'\xb5', 'bar')
725
        self.assertIsInstance(e.__str__(), str)
726
        # In Python str(foo) *must* return a real byte string
727
        # not a Unicode string. The following line would raise a
728
        # Unicode error, because it tries to call str() on the string
729
        # returned from e.__str__(), and it has non ascii characters
730
        s = str(e)
731
        self.assertEqual('Pass through \xc2\xb5 and bar', s)
732
2067.3.1 by Martin Pool
Clean up BzrNewError, other exception classes and users.
733
    def test_missing_format_string(self):
734
        e = ErrorWithNoFormat(param='randomvalue')
2067.3.3 by Martin Pool
merge bzr.dev and reconcile several changes, also some test fixes
735
        s = self.callDeprecated(
736
                ['ErrorWithNoFormat uses its docstring as a format, it should use _fmt instead'],
737
                lambda x: str(x), e)
738
        ## s = str(e)
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
739
        self.assertEqual(s,
2067.3.3 by Martin Pool
merge bzr.dev and reconcile several changes, also some test fixes
740
                "This class has a docstring but no format string.")
2067.3.1 by Martin Pool
Clean up BzrNewError, other exception classes and users.
741
2116.3.1 by John Arbash Meinel
Cleanup error tests
742
    def test_mismatched_format_args(self):
743
        # Even though ErrorWithBadFormat's format string does not match the
744
        # arguments we constructing it with, we can still stringify an instance
745
        # of this exception. The resulting string will say its unprintable.
746
        e = ErrorWithBadFormat(not_thing='x')
747
        self.assertStartsWith(
2067.3.1 by Martin Pool
Clean up BzrNewError, other exception classes and users.
748
            str(e), 'Unprintable exception ErrorWithBadFormat')
4634.1.2 by Martin Pool
Add test for CannotBindAddress
749
750
    def test_cannot_bind_address(self):
5243.1.2 by Martin
Point launchpad links in comments at production server rather than edge
751
        # see <https://bugs.launchpad.net/bzr/+bug/286871>
4634.1.2 by Martin Pool
Add test for CannotBindAddress
752
        e = errors.CannotBindAddress('example.com', 22,
753
            socket.error(13, 'Permission denied'))
754
        self.assertContainsRe(str(e),
755
            r'Cannot bind address "example\.com:22":.*Permission denied')
4976.1.1 by Jelmer Vernooij
Add FileTimestampUnavailable exception.
756
757
    def test_file_timestamp_unavailable(self):            
758
        e = errors.FileTimestampUnavailable("/path/foo")
759
        self.assertEquals("The filestamp for /path/foo is not available.",
760
            str(e))
5186.2.6 by Martin Pool
Add formatting test for TransformRenameFailed
761
            
762
    def test_transform_rename_failed(self):
5186.2.7 by Martin Pool
Update other cases where transform detects failure to rename
763
        e = errors.TransformRenameFailed(u"from", u"to", "readonly file", 2)
5186.2.6 by Martin Pool
Add formatting test for TransformRenameFailed
764
        self.assertEquals(
765
            u"Failed to rename from to to: readonly file",
766
            str(e))