~bzr-pqm/bzr/bzr.dev

5557.1.15 by John Arbash Meinel
Merge bzr.dev 5597 to resolve NEWS, aka bzr-2.3.txt
1
# Copyright (C) 2006-2011 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,
3200.2.1 by Robert Collins
* The ``register-branch`` command will now use the public url of the branch
28
    urlutils,
1948.1.6 by John Arbash Meinel
Make BzrNewError always return a str object
29
    )
5579.3.1 by Jelmer Vernooij
Remove unused imports.
30
from bzrlib.tests import (
31
    TestCase,
32
    TestCaseWithTransport,
33
    TestSkipped,
34
    )
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.
35
36
37
class TestErrors(TestCaseWithTransport):
38
5050.8.1 by Parth Malwankar
added test to ensure that BzrError subclasses dont use "message" as a name
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]")
5050.8.4 by Parth Malwankar
skip test if __subclasses__ is supported for classes.
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.')
5050.8.3 by Parth Malwankar
use __subclasses__
52
        for c in errors.BzrError.__subclasses__():
53
            init = getattr(c, '__init__', None)
54
            fmt = getattr(c, '_fmt', None)
5050.8.1 by Parth Malwankar
added test to ensure that BzrError subclasses dont use "message" as a name
55
            if init:
56
                args = inspect.getargspec(init)[0]
57
                self.assertFalse('message' in args,
58
                    ('Argument name "message" not allowed for '
5050.8.3 by Parth Malwankar
use __subclasses__
59
                    '"errors.%s.__init__"' % c.__name__))
5050.8.1 by Parth Malwankar
added test to ensure that BzrError subclasses dont use "message" as a name
60
            if fmt and fmt_pattern.search(fmt):
61
                self.assertFalse(True, ('"message" not allowed in '
5050.8.3 by Parth Malwankar
use __subclasses__
62
                    '"errors.%s._fmt"' % c.__name__))
5050.8.1 by Parth Malwankar
added test to ensure that BzrError subclasses dont use "message" as a name
63
3287.20.2 by John Arbash Meinel
Raise a clear error about the offending filename when there is a filename with bad characters.
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
3207.2.1 by jameinel
Add a test that _iter_changes raises a clearer error when we encounter an invalid rename.
71
    def test_corrupt_dirstate(self):
72
        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.
73
        self.assertEqualDiff(
74
            "Inconsistency in dirstate file path/to/dirstate.\n"
75
            "Error: the reason why",
76
            str(error))
3207.2.1 by jameinel
Add a test that _iter_changes raises a clearer error when we encounter an invalid rename.
77
3640.2.5 by John Arbash Meinel
Change from using AssertionError to using DirstateCorrupt in a few places
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
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)
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
2255.7.16 by John Arbash Meinel
Make sure adding a duplicate file_id raises DuplicateFileId.
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
2432.1.19 by Robert Collins
Ensure each HelpIndex has a unique prefix.
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
3445.1.1 by John Arbash Meinel
Start working on a new Graph api to make finding revision numbers faster.
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
2550.2.3 by Robert Collins
Add require_api API.
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
3207.2.2 by John Arbash Meinel
Fix bug #187169, when an invalid delta is supplied to update_basis_by_delta
113
    def test_inconsistent_delta(self):
114
        error = errors.InconsistentDelta('path', 'file-id', 'reason for foo')
115
        self.assertEqualDiff(
3221.1.8 by Martin Pool
Update error format in test_inconsistent_delta
116
            "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
117
            "reason: reason for foo",
118
            str(error))
119
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.
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
2634.1.1 by Robert Collins
(robertc) Reinstate the accidentally backed out external_url patch.
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
3059.2.12 by Vincent Ladeuil
Spiv review feedback.
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
1986.5.3 by Robert Collins
New method ``WorkingTree.flush()`` which will write the current memory
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
4294.2.8 by Robert Collins
Reduce round trips pushing new branches substantially.
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
2255.2.145 by Robert Collins
Support unbreakable locks for trees.
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
4634.161.1 by Andrew Bennetts
Add LockCorrupt error, and use it to provide nicer handling of unparseable lock/held/info files.
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
2535.3.4 by Andrew Bennetts
Simple implementation of Knit.insert_data_stream.
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
3052.2.1 by Robert Collins
Add a new KnitDataStreamUnknown error class for showing formats we can't understand.
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
2171.1.1 by John Arbash Meinel
Knit index files should ignore empty indexes rather than consider them corrupt.
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"
2745.3.2 by Daniel Watkins
Updated tests to reflect new error text.
188
                         " 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.
189
2196.2.5 by John Arbash Meinel
Add an exception class when the knit index storage method is unknown, and properly test for it
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
2018.2.3 by Andrew Bennetts
Starting factoring out the smart server client "medium" from the protocol.
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))
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
201
3200.2.1 by Robert Collins
* The ``register-branch`` command will now use the public url of the branch
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
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.
209
    def test_no_repo(self):
210
        dir = bzrdir.BzrDir.create(self.get_url())
211
        error = errors.NoRepositoryPresent(dir)
1740.5.6 by Martin Pool
Clean up many exception classes.
212
        self.assertNotEqual(-1, str(error).find((dir.transport.clone('..').base)))
213
        self.assertEqual(-1, str(error).find((dir.transport.base)))
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
214
2018.2.3 by Andrew Bennetts
Starting factoring out the smart server client "medium" from the protocol.
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
2432.1.4 by Robert Collins
Add an explicit error for missing help topics.
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
1988.2.1 by Robert Collins
WorkingTree has a new api ``unversion`` which allow the unversioning of
227
    def test_no_such_id(self):
228
        error = errors.NoSuchId("atree", "anid")
2745.3.2 by Daniel Watkins
Updated tests to reflect new error text.
229
        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.
230
            "atree.",
1988.2.1 by Robert Collins
WorkingTree has a new api ``unversion`` which allow the unversioning of
231
            str(error))
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
232
1908.11.1 by Robert Collins
Add a new method ``Tree.revision_tree`` which allows access to cached
233
    def test_no_such_revision_in_tree(self):
234
        error = errors.NoSuchRevisionInTree("atree", "anid")
2745.3.3 by Daniel Watkins
Changed to remove need for escaping of quotes.
235
        self.assertEqualDiff("The revision id {anid} is not present in the"
236
                             " tree atree.", str(error))
1908.11.1 by Robert Collins
Add a new method ``Tree.revision_tree`` which allows access to cached
237
        self.assertIsInstance(error, errors.NoSuchRevision)
238
3221.11.2 by Robert Collins
Create basic stackable branch facility.
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
1986.5.3 by Robert Collins
New method ``WorkingTree.flush()`` which will write the current memory
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
2872.5.1 by Martin Pool
Avoid internal error tracebacks on failure to lock on readonly transport (#129701).
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
2018.2.4 by Robert Collins
separate out the client medium from the client encoding protocol for the smart server.
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 "
2018.5.134 by Andrew Bennetts
Fix the TooManyConcurrentRequests error message.
260
            "the currently open request.",
2018.2.4 by Robert Collins
separate out the client medium from the client encoding protocol for the smart server.
261
            str(error))
262
3350.3.3 by Robert Collins
Functional get_record_stream interface tests covering full interface.
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
2245.1.3 by Robert Collins
Add install_hook to the BranchHooks class as the official means for installing a hook.
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
3221.11.2 by Robert Collins
Create basic stackable branch facility.
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
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.
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
3221.11.2 by Robert Collins
Create basic stackable branch facility.
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))
301
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
302
    def test_up_to_date(self):
5582.10.51 by Jelmer Vernooij
Remove use of BzrDirFormat4 in test_errors.
303
        error = errors.UpToDateFormat("someformat")
304
        self.assertEqualDiff(
305
            "The branch format someformat is already at the most "
306
            "recent format.", str(error))
1570.1.13 by Robert Collins
Check for incorrect revision parentage in the weave during revision access.
307
308
    def test_corrupt_repository(self):
309
        repo = self.make_repository('.')
310
        error = errors.CorruptRepository(repo)
311
        self.assertEqualDiff("An error has been detected in the repository %s.\n"
312
                             "Please run bzr reconcile on this repository." %
313
                             repo.bzrdir.root_transport.base,
314
                             str(error))
1948.1.6 by John Arbash Meinel
Make BzrNewError always return a str object
315
2052.6.1 by Robert Collins
``Transport.get`` has had its interface made more clear for ease of use.
316
    def test_read_error(self):
317
        # a unicode path to check that %r is being used.
318
        path = u'a path'
319
        error = errors.ReadError(path)
320
        self.assertEqualDiff("Error reading from u'a path'.", str(error))
321
2592.1.7 by Robert Collins
A validate that goes boom.
322
    def test_bad_index_format_signature(self):
323
        error = errors.BadIndexFormatSignature("foo", "bar")
324
        self.assertEqual("foo is not an index of type bar.",
325
            str(error))
2052.6.2 by Robert Collins
Merge bzr.dev.
326
2592.1.11 by Robert Collins
Detect truncated indices.
327
    def test_bad_index_data(self):
328
        error = errors.BadIndexData("foo")
329
        self.assertEqual("Error in data for index foo.",
330
            str(error))
331
2592.1.15 by Robert Collins
Detect duplicate key insertion.
332
    def test_bad_index_duplicate_key(self):
333
        error = errors.BadIndexDuplicateKey("foo", "bar")
334
        self.assertEqual("The key 'foo' is already in index 'bar'.",
335
            str(error))
336
2592.1.12 by Robert Collins
Handle basic node adds.
337
    def test_bad_index_key(self):
338
        error = errors.BadIndexKey("foo")
339
        self.assertEqual("The key 'foo' is not a valid key.",
340
            str(error))
341
2592.1.10 by Robert Collins
Make validate detect node reference parsing errors.
342
    def test_bad_index_options(self):
343
        error = errors.BadIndexOptions("foo")
344
        self.assertEqual("Could not parse options for index foo.",
345
            str(error))
346
2592.1.12 by Robert Collins
Handle basic node adds.
347
    def test_bad_index_value(self):
348
        error = errors.BadIndexValue("foo")
349
        self.assertEqual("The value 'foo' is not a valid value.",
350
            str(error))
351
2067.3.1 by Martin Pool
Clean up BzrNewError, other exception classes and users.
352
    def test_bzrnewerror_is_deprecated(self):
353
        class DeprecatedError(errors.BzrNewError):
354
            pass
2067.3.6 by Martin Pool
Update deprecation version
355
        self.callDeprecated(['BzrNewError was deprecated in bzr 0.13; '
2067.3.1 by Martin Pool
Clean up BzrNewError, other exception classes and users.
356
             'please convert DeprecatedError to use BzrError instead'],
357
            DeprecatedError)
358
359
    def test_bzrerror_from_literal_string(self):
360
        # Some code constructs BzrError from a literal string, in which case
361
        # no further formatting is done.  (I'm not sure raising the base class
362
        # is a great idea, but if the exception is not intended to be caught
363
        # perhaps no more is needed.)
364
        try:
365
            raise errors.BzrError('this is my errors; %d is not expanded')
366
        except errors.BzrError, e:
367
            self.assertEqual('this is my errors; %d is not expanded', str(e))
368
2018.2.4 by Robert Collins
separate out the client medium from the client encoding protocol for the smart server.
369
    def test_reading_completed(self):
370
        error = errors.ReadingCompleted("a request")
371
        self.assertEqualDiff("The MediumRequest 'a request' has already had "
372
            "finish_reading called upon it - the request has been completed and"
373
            " no more data may be read.",
374
            str(error))
375
376
    def test_writing_completed(self):
377
        error = errors.WritingCompleted("a request")
378
        self.assertEqualDiff("The MediumRequest 'a request' has already had "
379
            "finish_writing called upon it - accept bytes may not be called "
380
            "anymore.",
381
            str(error))
382
383
    def test_writing_not_completed(self):
384
        error = errors.WritingNotComplete("a request")
385
        self.assertEqualDiff("The MediumRequest 'a request' has not has "
386
            "finish_writing called upon it - until the write phase is complete"
387
            " no data may be read.",
388
            str(error))
389
2052.6.1 by Robert Collins
``Transport.get`` has had its interface made more clear for ease of use.
390
    def test_transport_not_possible(self):
391
        error = errors.TransportNotPossible('readonly', 'original error')
392
        self.assertEqualDiff('Transport operation not possible:'
393
                         ' readonly original error', str(error))
2052.4.4 by John Arbash Meinel
Create a SocketConnectionError to make creating nice errors easier
394
395
    def assertSocketConnectionError(self, expected, *args, **kwargs):
396
        """Check the formatting of a SocketConnectionError exception"""
397
        e = errors.SocketConnectionError(*args, **kwargs)
398
        self.assertEqual(expected, str(e))
399
400
    def test_socket_connection_error(self):
401
        """Test the formatting of SocketConnectionError"""
402
403
        # There should be a default msg about failing to connect
404
        # we only require a host name.
405
        self.assertSocketConnectionError(
406
            'Failed to connect to ahost',
407
            'ahost')
408
409
        # If port is None, we don't put :None
410
        self.assertSocketConnectionError(
411
            'Failed to connect to ahost',
412
            'ahost', port=None)
413
        # But if port is supplied we include it
414
        self.assertSocketConnectionError(
415
            'Failed to connect to ahost:22',
416
            'ahost', port=22)
417
418
        # We can also supply extra information about the error
419
        # with or without a port
420
        self.assertSocketConnectionError(
421
            'Failed to connect to ahost:22; bogus error',
422
            'ahost', port=22, orig_error='bogus error')
423
        self.assertSocketConnectionError(
424
            'Failed to connect to ahost; bogus error',
425
            'ahost', orig_error='bogus error')
426
        # An exception object can be passed rather than a string
427
        orig_error = ValueError('bad value')
428
        self.assertSocketConnectionError(
429
            'Failed to connect to ahost; %s' % (str(orig_error),),
430
            host='ahost', orig_error=orig_error)
431
432
        # And we can supply a custom failure message
433
        self.assertSocketConnectionError(
434
            'Unable to connect to ssh host ahost:444; my_error',
435
            host='ahost', port=444, msg='Unable to connect to ssh host',
436
            orig_error='my_error')
437
3535.8.2 by James Westby
Incorporate spiv's feedback.
438
    def test_target_not_branch(self):
439
        """Test the formatting of TargetNotBranch."""
440
        error = errors.TargetNotBranch('foo')
441
        self.assertEqual(
442
            "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.
443
            "order to merge this merge directive and the target "
3535.8.3 by James Westby
Use location instead of branch as suggested by Robert.
444
            "location specified in the merge directive is not a branch: "
3535.8.2 by James Westby
Incorporate spiv's feedback.
445
            "foo.", str(error))
446
2376.4.26 by Jonathan Lange
Tests for MalformedBugIdentifier and new error UnknownBugTrackerAbbreviation.
447
    def test_malformed_bug_identifier(self):
448
        """Test the formatting of MalformedBugIdentifier."""
449
        error = errors.MalformedBugIdentifier('bogus', 'reason for bogosity')
450
        self.assertEqual(
3535.10.1 by James Westby
Point to "bzr help bugs" from MalformedBugIdentifier.
451
            'Did not understand bug identifier bogus: reason for bogosity. '
3535.10.11 by James Westby
Fix test for change in error message.
452
            'See "bzr help bugs" for more information on this feature.',
2376.4.26 by Jonathan Lange
Tests for MalformedBugIdentifier and new error UnknownBugTrackerAbbreviation.
453
            str(error))
454
455
    def test_unknown_bug_tracker_abbreviation(self):
456
        """Test the formatting of UnknownBugTrackerAbbreviation."""
2376.4.27 by Jonathan Lange
Include branch information in UnknownBugTrackerAbbreviation
457
        branch = self.make_branch('some_branch')
458
        error = errors.UnknownBugTrackerAbbreviation('xxx', branch)
2376.4.26 by Jonathan Lange
Tests for MalformedBugIdentifier and new error UnknownBugTrackerAbbreviation.
459
        self.assertEqual(
2376.4.27 by Jonathan Lange
Include branch information in UnknownBugTrackerAbbreviation
460
            "Cannot find registered bug tracker called xxx on %s" % branch,
2376.4.26 by Jonathan Lange
Tests for MalformedBugIdentifier and new error UnknownBugTrackerAbbreviation.
461
            str(error))
2052.4.4 by John Arbash Meinel
Create a SocketConnectionError to make creating nice errors easier
462
2018.5.163 by Andrew Bennetts
Deal with various review comments from Robert.
463
    def test_unexpected_smart_server_response(self):
464
        e = errors.UnexpectedSmartServerResponse(('not yes',))
465
        self.assertEqual(
466
            "Could not understand response from smart server: ('not yes',)",
467
            str(e))
2052.4.4 by John Arbash Meinel
Create a SocketConnectionError to make creating nice errors easier
468
2506.2.1 by Andrew Bennetts
Start implementing container format reading and writing.
469
    def test_unknown_container_format(self):
470
        """Test the formatting of UnknownContainerFormatError."""
471
        e = errors.UnknownContainerFormatError('bad format string')
472
        self.assertEqual(
473
            "Unrecognised container format: 'bad format string'",
474
            str(e))
475
476
    def test_unexpected_end_of_container(self):
477
        """Test the formatting of UnexpectedEndOfContainerError."""
478
        e = errors.UnexpectedEndOfContainerError()
479
        self.assertEqual(
480
            "Unexpected end of container stream", str(e))
481
482
    def test_unknown_record_type(self):
483
        """Test the formatting of UnknownRecordTypeError."""
484
        e = errors.UnknownRecordTypeError("X")
485
        self.assertEqual(
486
            "Unknown record type: 'X'",
487
            str(e))
488
2506.3.1 by Andrew Bennetts
More progress:
489
    def test_invalid_record(self):
490
        """Test the formatting of InvalidRecordError."""
491
        e = errors.InvalidRecordError("xxx")
492
        self.assertEqual(
493
            "Invalid record: xxx",
494
            str(e))
495
2506.2.6 by Andrew Bennetts
Add validate method to ContainerReader and BytesRecordReader.
496
    def test_container_has_excess_data(self):
497
        """Test the formatting of ContainerHasExcessDataError."""
498
        e = errors.ContainerHasExcessDataError("excess bytes")
499
        self.assertEqual(
500
            "Container has data after end marker: 'excess bytes'",
501
            str(e))
502
2506.6.1 by Andrew Bennetts
Return a callable instead of a str from read, and add more validation.
503
    def test_duplicate_record_name_error(self):
504
        """Test the formatting of DuplicateRecordNameError."""
505
        e = errors.DuplicateRecordNameError(u"n\xe5me".encode('utf-8'))
506
        self.assertEqual(
2745.3.3 by Daniel Watkins
Changed to remove need for escaping of quotes.
507
            "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.
508
            str(e))
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
509
2854.1.1 by Martin Pool
Fix "unprintable error" message for BzrCheckError and others
510
    def test_check_error(self):
511
        # This has a member called 'message', which is problematic in
512
        # python2.5 because that is a slot on the base Exception class
513
        e = errors.BzrCheckError('example check failure')
514
        self.assertEqual(
515
            "Internal check failed: example check failure",
516
            str(e))
517
        self.assertTrue(e.internal_error)
2506.6.1 by Andrew Bennetts
Return a callable instead of a str from read, and add more validation.
518
2535.3.40 by Andrew Bennetts
Tidy up more XXXs.
519
    def test_repository_data_stream_error(self):
520
        """Test the formatting of RepositoryDataStreamError."""
521
        e = errors.RepositoryDataStreamError(u"my reason")
522
        self.assertEqual(
523
            "Corrupt or incompatible data stream: my reason", str(e))
524
2978.2.1 by Alexander Belchenko
fix formatting of ImmortalPendingDeletion error message.
525
    def test_immortal_pending_deletion_message(self):
526
        err = errors.ImmortalPendingDeletion('foo')
527
        self.assertEquals(
528
            "Unable to delete transform temporary directory foo.  "
529
            "Please examine foo to see if it contains any files "
530
            "you wish to keep, and delete it when you are done.",
531
            str(err))
532
3006.2.2 by Alexander Belchenko
tests added.
533
    def test_unable_create_symlink(self):
534
        err = errors.UnableCreateSymlink()
535
        self.assertEquals(
536
            "Unable to create symlink on this platform",
537
            str(err))
538
        err = errors.UnableCreateSymlink(path=u'foo')
539
        self.assertEquals(
540
            "Unable to create symlink 'foo' on this platform",
541
            str(err))
542
        err = errors.UnableCreateSymlink(path=u'\xb5')
543
        self.assertEquals(
544
            "Unable to create symlink u'\\xb5' on this platform",
545
            str(err))
546
2692.1.1 by Andrew Bennetts
Add translate_client_path method to SmartServerRequest.
547
    def test_invalid_url_join(self):
548
        """Test the formatting of InvalidURLJoin."""
549
        e = errors.InvalidURLJoin('Reason', 'base path', ('args',))
550
        self.assertEqual(
551
            "Invalid URL join request: Reason: 'base path' + ('args',)",
552
            str(e))
553
3035.3.2 by Lukáš Lalinský
Add tests for InvalidBugTrackerURL.
554
    def test_incorrect_url(self):
555
        err = errors.InvalidBugTrackerURL('foo', 'http://bug.com/')
556
        self.assertEquals(
557
            ("The URL for bug tracker \"foo\" doesn't contain {id}: "
558
             "http://bug.com/"),
559
            str(err))
560
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.
561
    def test_unable_encode_path(self):
562
        err = errors.UnableEncodePath('foo', 'executable')
3234.2.8 by Alexander Belchenko
fix grammar in formatting string of UnableEncodePath error.
563
        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.
564
            "user encoding " + osutils.get_user_encoding(),
565
            str(err))
566
3246.3.4 by Daniel Watkins
Added test.
567
    def test_unknown_format(self):
568
        err = errors.UnknownFormatError('bar', kind='foo')
569
        self.assertEquals("Unknown foo format: 'bar'", str(err))
570
3398.1.29 by Ian Clatworthy
add UnknownRules class & test
571
    def test_unknown_rules(self):
572
        err = errors.UnknownRules(['foo', 'bar'])
573
        self.assertEquals("Unknown rules detected: foo, bar.", str(err))
574
3577.1.1 by Andrew Bennetts
Cherry-pick TipChangeRejected changes from pre-branch-tip-changed-hook loom.
575
    def test_hook_failed(self):
576
        # Create an exc_info tuple by raising and catching an exception.
577
        try:
578
            1/0
579
        except ZeroDivisionError:
580
            exc_info = sys.exc_info()
4943.1.2 by Robert Collins
Adjust errors.py to fix missing references to 'warn'.
581
        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.
582
        self.assertStartsWith(
583
            str(err), 'Hook \'hook name\' during hook stage failed:\n')
584
        self.assertEndsWith(
585
            str(err), 'integer division or modulo by zero')
586
587
    def test_tip_change_rejected(self):
588
        err = errors.TipChangeRejected(u'Unicode message\N{INTERROBANG}')
589
        self.assertEquals(
590
            u'Tip change rejected: Unicode message\N{INTERROBANG}',
591
            unicode(err))
592
        self.assertEquals(
593
            'Tip change rejected: Unicode message\xe2\x80\xbd',
594
            str(err))
595
3690.1.1 by Andrew Bennetts
Unexpected error responses from a smart server no longer cause the client to traceback.
596
    def test_error_from_smart_server(self):
597
        error_tuple = ('error', 'tuple')
598
        err = errors.ErrorFromSmartServer(error_tuple)
599
        self.assertEquals(
600
            "Error received from smart server: ('error', 'tuple')", str(err))
601
602
    def test_untranslateable_error_from_smart_server(self):
603
        error_tuple = ('error', 'tuple')
604
        orig_err = errors.ErrorFromSmartServer(error_tuple)
3690.1.2 by Andrew Bennetts
Rename UntranslateableErrorFromSmartServer -> UnknownErrorFromSmartServer.
605
        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.
606
        self.assertEquals(
607
            "Server sent an unexpected error: ('error', 'tuple')", str(err))
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
608
3883.2.3 by Andrew Bennetts
Add test, tweak traceback formatting.
609
    def test_smart_message_handler_error(self):
610
        # Make an exc_info tuple.
611
        try:
612
            raise Exception("example error")
613
        except Exception:
614
            exc_info = sys.exc_info()
615
        err = errors.SmartMessageHandlerError(exc_info)
616
        self.assertStartsWith(
617
            str(err), "The message handler raised an exception:\n")
618
        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.
619
3983.1.8 by Daniel Watkins
Added MustHaveWorkingTree error and accompanying test.
620
    def test_must_have_working_tree(self):
621
        err = errors.MustHaveWorkingTree('foo', 'bar')
3983.1.10 by Daniel Watkins
Made exception message slightly better.
622
        self.assertEqual(str(err), "Branching 'bar'(foo) must create a"
623
                                   " working tree.")
3983.1.8 by Daniel Watkins
Added MustHaveWorkingTree error and accompanying test.
624
3586.1.1 by Ian Clatworthy
add view-related errors and tests
625
    def test_no_such_view(self):
626
        err = errors.NoSuchView('foo')
627
        self.assertEquals("No such view: foo.", str(err))
628
629
    def test_views_not_supported(self):
630
        err = errors.ViewsNotSupported('atree')
631
        err_str = str(err)
632
        self.assertStartsWith(err_str, "Views are not supported by ")
633
        self.assertEndsWith(err_str, "; use 'bzr upgrade' to change your "
634
            "tree to a later format.")
635
3586.1.9 by Ian Clatworthy
first cut at view command
636
    def test_file_outside_view(self):
637
        err = errors.FileOutsideView('baz', ['foo', 'bar'])
638
        self.assertEquals('Specified file "baz" is outside the current view: '
639
            'foo, bar', str(err))
640
3990.2.2 by Daniel Watkins
Added InvalidShelfId error and accompanying test.
641
    def test_invalid_shelf_id(self):
642
        invalid_id = "foo"
643
        err = errors.InvalidShelfId(invalid_id)
3999.1.1 by Ian Clatworthy
Improve shelf documentation & fix backtrace (Daniel Watkins)
644
        self.assertEqual('"foo" is not a valid shelf id, '
645
            'try a number instead.', str(err))
3990.2.2 by Daniel Watkins
Added InvalidShelfId error and accompanying test.
646
4002.1.7 by Andrew Bennetts
Rename UnresumableWriteGroups to UnresumableWriteGroup.
647
    def test_unresumable_write_group(self):
4002.1.1 by Andrew Bennetts
Implement suspend_write_group/resume_write_group.
648
        repo = "dummy repo"
649
        wg_tokens = ['token']
650
        reason = "a reason"
4002.1.7 by Andrew Bennetts
Rename UnresumableWriteGroups to UnresumableWriteGroup.
651
        err = errors.UnresumableWriteGroup(repo, wg_tokens, reason)
4002.1.1 by Andrew Bennetts
Implement suspend_write_group/resume_write_group.
652
        self.assertEqual(
4002.1.7 by Andrew Bennetts
Rename UnresumableWriteGroups to UnresumableWriteGroup.
653
            "Repository dummy repo cannot resume write group "
4002.1.1 by Andrew Bennetts
Implement suspend_write_group/resume_write_group.
654
            "['token']: a reason", str(err))
655
656
    def test_unsuspendable_write_group(self):
657
        repo = "dummy repo"
658
        err = errors.UnsuspendableWriteGroup(repo)
659
        self.assertEqual(
660
            'Repository dummy repo cannot suspend a write group.', str(err))
661
4734.4.9 by Andrew Bennetts
More tests and comments.
662
    def test_not_branch_no_args(self):
663
        err = errors.NotBranchError('path')
664
        self.assertEqual('Not a branch: "path".', str(err))
665
666
    def test_not_branch_bzrdir_with_repo(self):
667
        bzrdir = self.make_repository('repo').bzrdir
668
        err = errors.NotBranchError('path', bzrdir=bzrdir)
669
        self.assertEqual(
670
            'Not a branch: "path": location is a repository.', str(err))
671
672
    def test_not_branch_bzrdir_without_repo(self):
673
        bzrdir = self.make_bzrdir('bzrdir')
674
        err = errors.NotBranchError('path', bzrdir=bzrdir)
675
        self.assertEqual('Not a branch: "path".', str(err))
676
5050.46.1 by Andrew Bennetts
Suppress unexpected errors during NotBranchError's call to open_repository.
677
    def test_not_branch_bzrdir_with_recursive_not_branch_error(self):
678
        class FakeBzrDir(object):
679
            def open_repository(self):
680
                # str() on the NotBranchError will trigger a call to this,
681
                # which in turn will another, identical NotBranchError.
682
                raise errors.NotBranchError('path', bzrdir=FakeBzrDir())
683
        err = errors.NotBranchError('path', bzrdir=FakeBzrDir())
684
        self.assertEqual('Not a branch: "path".', str(err))
685
4734.4.9 by Andrew Bennetts
More tests and comments.
686
    def test_not_branch_laziness(self):
687
        real_bzrdir = self.make_bzrdir('path')
688
        class FakeBzrDir(object):
689
            def __init__(self):
690
                self.calls = []
691
            def open_repository(self):
692
                self.calls.append('open_repository')
693
                raise errors.NoRepositoryPresent(real_bzrdir)
694
        fake_bzrdir = FakeBzrDir()
695
        err = errors.NotBranchError('path', bzrdir=fake_bzrdir)
696
        self.assertEqual([], fake_bzrdir.calls)
697
        str(err)
698
        self.assertEqual(['open_repository'], fake_bzrdir.calls)
699
        # Stringifying twice doesn't try to open a repository twice.
700
        str(err)
701
        self.assertEqual(['open_repository'], fake_bzrdir.calls)
702
5339.1.1 by Parth Malwankar
fixes errors.InvalidPattern to work on Python2.5
703
    def test_invalid_pattern(self):
704
        error = errors.InvalidPattern('Bad pattern msg.')
705
        self.assertEqualDiff("Invalid pattern(s) found. Bad pattern msg.",
706
            str(error))
707
5050.7.6 by Parth Malwankar
fixed test name
708
    def test_recursive_bind(self):
5050.7.5 by Parth Malwankar
better error message for RecursiveBind
709
        error = errors.RecursiveBind('foo_bar_branch')
710
        msg = ('Branch "foo_bar_branch" appears to be bound to itself. '
711
            'Please use `bzr unbind` to fix.')
712
        self.assertEqualDiff(msg, str(error))
713
2116.3.1 by John Arbash Meinel
Cleanup error tests
714
2067.3.1 by Martin Pool
Clean up BzrNewError, other exception classes and users.
715
class PassThroughError(errors.BzrError):
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
716
2067.3.1 by Martin Pool
Clean up BzrNewError, other exception classes and users.
717
    _fmt = """Pass through %(foo)s and %(bar)s"""
2116.3.1 by John Arbash Meinel
Cleanup error tests
718
719
    def __init__(self, foo, bar):
2067.3.1 by Martin Pool
Clean up BzrNewError, other exception classes and users.
720
        errors.BzrError.__init__(self, foo=foo, bar=bar)
721
722
723
class ErrorWithBadFormat(errors.BzrError):
724
725
    _fmt = """One format specifier: %(thing)s"""
726
727
728
class ErrorWithNoFormat(errors.BzrError):
5131.2.6 by Martin
Fix more tests which were failing under -OO that had been missed earlier
729
    __doc__ = """This class has a docstring but no format string."""
2116.3.1 by John Arbash Meinel
Cleanup error tests
730
731
732
class TestErrorFormatting(TestCase):
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
733
2116.3.1 by John Arbash Meinel
Cleanup error tests
734
    def test_always_str(self):
735
        e = PassThroughError(u'\xb5', 'bar')
736
        self.assertIsInstance(e.__str__(), str)
737
        # In Python str(foo) *must* return a real byte string
738
        # not a Unicode string. The following line would raise a
739
        # Unicode error, because it tries to call str() on the string
740
        # returned from e.__str__(), and it has non ascii characters
741
        s = str(e)
742
        self.assertEqual('Pass through \xc2\xb5 and bar', s)
743
2067.3.1 by Martin Pool
Clean up BzrNewError, other exception classes and users.
744
    def test_missing_format_string(self):
745
        e = ErrorWithNoFormat(param='randomvalue')
2067.3.3 by Martin Pool
merge bzr.dev and reconcile several changes, also some test fixes
746
        s = self.callDeprecated(
747
                ['ErrorWithNoFormat uses its docstring as a format, it should use _fmt instead'],
748
                lambda x: str(x), e)
749
        ## s = str(e)
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
750
        self.assertEqual(s,
2067.3.3 by Martin Pool
merge bzr.dev and reconcile several changes, also some test fixes
751
                "This class has a docstring but no format string.")
2067.3.1 by Martin Pool
Clean up BzrNewError, other exception classes and users.
752
2116.3.1 by John Arbash Meinel
Cleanup error tests
753
    def test_mismatched_format_args(self):
754
        # Even though ErrorWithBadFormat's format string does not match the
755
        # arguments we constructing it with, we can still stringify an instance
756
        # of this exception. The resulting string will say its unprintable.
757
        e = ErrorWithBadFormat(not_thing='x')
758
        self.assertStartsWith(
2067.3.1 by Martin Pool
Clean up BzrNewError, other exception classes and users.
759
            str(e), 'Unprintable exception ErrorWithBadFormat')
4634.1.2 by Martin Pool
Add test for CannotBindAddress
760
761
    def test_cannot_bind_address(self):
5243.1.2 by Martin
Point launchpad links in comments at production server rather than edge
762
        # see <https://bugs.launchpad.net/bzr/+bug/286871>
4634.1.2 by Martin Pool
Add test for CannotBindAddress
763
        e = errors.CannotBindAddress('example.com', 22,
764
            socket.error(13, 'Permission denied'))
765
        self.assertContainsRe(str(e),
766
            r'Cannot bind address "example\.com:22":.*Permission denied')
4976.1.1 by Jelmer Vernooij
Add FileTimestampUnavailable exception.
767
768
    def test_file_timestamp_unavailable(self):            
769
        e = errors.FileTimestampUnavailable("/path/foo")
770
        self.assertEquals("The filestamp for /path/foo is not available.",
771
            str(e))
5186.2.6 by Martin Pool
Add formatting test for TransformRenameFailed
772
            
773
    def test_transform_rename_failed(self):
5186.2.7 by Martin Pool
Update other cases where transform detects failure to rename
774
        e = errors.TransformRenameFailed(u"from", u"to", "readonly file", 2)
5186.2.6 by Martin Pool
Add formatting test for TransformRenameFailed
775
        self.assertEquals(
776
            u"Failed to rename from to to: readonly file",
777
            str(e))