~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_errors.py

[merge] bzr.dev 2255, resolve conflicts, update copyrights

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006 by Canonical Ltd
 
1
# Copyright (C) 2006 Canonical Ltd
2
2
#   Authors: Robert Collins <robert.collins@canonical.com>
3
3
#
4
4
# This program is free software; you can redistribute it and/or modify
24
24
from bzrlib.tests import TestCase, TestCaseWithTransport
25
25
 
26
26
 
 
27
# TODO: Make sure builtin exception class formats are consistent - e.g. should
 
28
# or shouldn't end with a full stop, etc.
 
29
 
 
30
 
27
31
class TestErrors(TestCaseWithTransport):
28
32
 
29
33
    def test_inventory_modified(self):
33
37
            "read without data loss.",
34
38
            str(error))
35
39
 
 
40
    def test_install_failed(self):
 
41
        error = errors.InstallFailed(['rev-one'])
 
42
        self.assertEqual("Could not install revisions:\nrev-one", str(error))
 
43
        error = errors.InstallFailed(['rev-one', 'rev-two'])
 
44
        self.assertEqual("Could not install revisions:\nrev-one, rev-two",
 
45
                         str(error))
 
46
        error = errors.InstallFailed([None])
 
47
        self.assertEqual("Could not install revisions:\nNone", str(error))
 
48
 
 
49
    def test_knit_header_error(self):
 
50
        error = errors.KnitHeaderError('line foo\n', 'path/to/file')
 
51
        self.assertEqual("Knit header error: 'line foo\\n' unexpected"
 
52
                         " for file path/to/file", str(error))
 
53
 
 
54
    def test_knit_index_unknown_method(self):
 
55
        error = errors.KnitIndexUnknownMethod('http://host/foo.kndx',
 
56
                                              ['bad', 'no-eol'])
 
57
        self.assertEqual("Knit index http://host/foo.kndx does not have a"
 
58
                         " known method in options: ['bad', 'no-eol']",
 
59
                         str(error))
 
60
 
 
61
    def test_medium_not_connected(self):
 
62
        error = errors.MediumNotConnected("a medium")
 
63
        self.assertEqualDiff(
 
64
            "The medium 'a medium' is not connected.", str(error))
 
65
        
36
66
    def test_no_repo(self):
37
67
        dir = bzrdir.BzrDir.create(self.get_url())
38
68
        error = errors.NoRepositoryPresent(dir)
39
69
        self.assertNotEqual(-1, str(error).find((dir.transport.clone('..').base)))
40
70
        self.assertEqual(-1, str(error).find((dir.transport.base)))
41
71
        
 
72
    def test_no_smart_medium(self):
 
73
        error = errors.NoSmartMedium("a transport")
 
74
        self.assertEqualDiff("The transport 'a transport' cannot tunnel the "
 
75
            "smart protocol.",
 
76
            str(error))
 
77
 
42
78
    def test_no_such_id(self):
43
79
        error = errors.NoSuchId("atree", "anid")
44
80
        self.assertEqualDiff("The file id anid is not present in the tree "
58
94
            "to be.",
59
95
            str(error))
60
96
 
 
97
    def test_too_many_concurrent_requests(self):
 
98
        error = errors.TooManyConcurrentRequests("a medium")
 
99
        self.assertEqualDiff("The medium 'a medium' has reached its concurrent "
 
100
            "request limit. Be sure to finish_writing and finish_reading on "
 
101
            "the current request that is open.",
 
102
            str(error))
 
103
 
 
104
    def test_unknown_hook(self):
 
105
        error = errors.UnknownHook("branch", "foo")
 
106
        self.assertEqualDiff("The branch hook 'foo' is unknown in this version"
 
107
            " of bzrlib.",
 
108
            str(error))
 
109
        error = errors.UnknownHook("tree", "bar")
 
110
        self.assertEqualDiff("The tree hook 'bar' is unknown in this version"
 
111
            " of bzrlib.",
 
112
            str(error))
 
113
 
61
114
    def test_up_to_date(self):
62
115
        error = errors.UpToDateFormat(bzrdir.BzrDirFormat4())
63
116
        self.assertEqualDiff("The branch format Bazaar-NG branch, "
73
126
                             repo.bzrdir.root_transport.base,
74
127
                             str(error))
75
128
 
76
 
 
77
 
class PassThroughError(errors.BzrNewError):
78
 
    """Pass through %(foo)s and %(bar)s"""
 
129
    def test_bzrnewerror_is_deprecated(self):
 
130
        class DeprecatedError(errors.BzrNewError):
 
131
            pass
 
132
        self.callDeprecated(['BzrNewError was deprecated in bzr 0.13; '
 
133
             'please convert DeprecatedError to use BzrError instead'],
 
134
            DeprecatedError)
 
135
 
 
136
    def test_bzrerror_from_literal_string(self):
 
137
        # Some code constructs BzrError from a literal string, in which case
 
138
        # no further formatting is done.  (I'm not sure raising the base class
 
139
        # is a great idea, but if the exception is not intended to be caught
 
140
        # perhaps no more is needed.)
 
141
        try:
 
142
            raise errors.BzrError('this is my errors; %d is not expanded')
 
143
        except errors.BzrError, e:
 
144
            self.assertEqual('this is my errors; %d is not expanded', str(e))
 
145
 
 
146
    def test_reading_completed(self):
 
147
        error = errors.ReadingCompleted("a request")
 
148
        self.assertEqualDiff("The MediumRequest 'a request' has already had "
 
149
            "finish_reading called upon it - the request has been completed and"
 
150
            " no more data may be read.",
 
151
            str(error))
 
152
 
 
153
    def test_writing_completed(self):
 
154
        error = errors.WritingCompleted("a request")
 
155
        self.assertEqualDiff("The MediumRequest 'a request' has already had "
 
156
            "finish_writing called upon it - accept bytes may not be called "
 
157
            "anymore.",
 
158
            str(error))
 
159
 
 
160
    def test_writing_not_completed(self):
 
161
        error = errors.WritingNotComplete("a request")
 
162
        self.assertEqualDiff("The MediumRequest 'a request' has not has "
 
163
            "finish_writing called upon it - until the write phase is complete"
 
164
            " no data may be read.",
 
165
            str(error))
 
166
 
 
167
    def test_transport_not_possible(self):
 
168
        e = errors.TransportNotPossible('readonly', 'original error')
 
169
        self.assertEqual('Transport operation not possible:'
 
170
                         ' readonly original error', str(e))
 
171
 
 
172
    def assertSocketConnectionError(self, expected, *args, **kwargs):
 
173
        """Check the formatting of a SocketConnectionError exception"""
 
174
        e = errors.SocketConnectionError(*args, **kwargs)
 
175
        self.assertEqual(expected, str(e))
 
176
 
 
177
    def test_socket_connection_error(self):
 
178
        """Test the formatting of SocketConnectionError"""
 
179
 
 
180
        # There should be a default msg about failing to connect
 
181
        # we only require a host name.
 
182
        self.assertSocketConnectionError(
 
183
            'Failed to connect to ahost',
 
184
            'ahost')
 
185
 
 
186
        # If port is None, we don't put :None
 
187
        self.assertSocketConnectionError(
 
188
            'Failed to connect to ahost',
 
189
            'ahost', port=None)
 
190
        # But if port is supplied we include it
 
191
        self.assertSocketConnectionError(
 
192
            'Failed to connect to ahost:22',
 
193
            'ahost', port=22)
 
194
 
 
195
        # We can also supply extra information about the error
 
196
        # with or without a port
 
197
        self.assertSocketConnectionError(
 
198
            'Failed to connect to ahost:22; bogus error',
 
199
            'ahost', port=22, orig_error='bogus error')
 
200
        self.assertSocketConnectionError(
 
201
            'Failed to connect to ahost; bogus error',
 
202
            'ahost', orig_error='bogus error')
 
203
        # An exception object can be passed rather than a string
 
204
        orig_error = ValueError('bad value')
 
205
        self.assertSocketConnectionError(
 
206
            'Failed to connect to ahost; %s' % (str(orig_error),),
 
207
            host='ahost', orig_error=orig_error)
 
208
 
 
209
        # And we can supply a custom failure message
 
210
        self.assertSocketConnectionError(
 
211
            'Unable to connect to ssh host ahost:444; my_error',
 
212
            host='ahost', port=444, msg='Unable to connect to ssh host',
 
213
            orig_error='my_error')
 
214
 
 
215
 
 
216
 
 
217
class PassThroughError(errors.BzrError):
 
218
    
 
219
    _fmt = """Pass through %(foo)s and %(bar)s"""
79
220
 
80
221
    def __init__(self, foo, bar):
81
 
        errors.BzrNewError.__init__(self, foo=foo, bar=bar)
82
 
 
83
 
 
84
 
class ErrorWithBadFormat(errors.BzrNewError):
85
 
    """One format specifier: %(thing)s"""
 
222
        errors.BzrError.__init__(self, foo=foo, bar=bar)
 
223
 
 
224
 
 
225
class ErrorWithBadFormat(errors.BzrError):
 
226
 
 
227
    _fmt = """One format specifier: %(thing)s"""
 
228
 
 
229
 
 
230
class ErrorWithNoFormat(errors.BzrError):
 
231
    """This class has a docstring but no format string."""
86
232
 
87
233
 
88
234
class TestErrorFormatting(TestCase):
97
243
        s = str(e)
98
244
        self.assertEqual('Pass through \xc2\xb5 and bar', s)
99
245
 
 
246
    def test_missing_format_string(self):
 
247
        e = ErrorWithNoFormat(param='randomvalue')
 
248
        s = self.callDeprecated(
 
249
                ['ErrorWithNoFormat uses its docstring as a format, it should use _fmt instead'],
 
250
                lambda x: str(x), e)
 
251
        ## s = str(e)
 
252
        self.assertEqual(s, 
 
253
                "This class has a docstring but no format string.")
 
254
 
100
255
    def test_mismatched_format_args(self):
101
256
        # Even though ErrorWithBadFormat's format string does not match the
102
257
        # arguments we constructing it with, we can still stringify an instance
103
258
        # of this exception. The resulting string will say its unprintable.
104
259
        e = ErrorWithBadFormat(not_thing='x')
105
260
        self.assertStartsWith(
106
 
            str(e), 'Unprintable exception ErrorWithBadFormat(')
107
 
 
108
 
 
109
 
class TestSpecificErrors(TestCase):
110
 
    
111
 
    def test_transport_not_possible(self):
112
 
        e = errors.TransportNotPossible('readonly', 'original error')
113
 
        self.assertEqual('Transport operation not possible:'
114
 
                         ' readonly original error', str(e))
 
261
            str(e), 'Unprintable exception ErrorWithBadFormat')
 
262