summaryrefslogtreecommitdiffstats
path: root/tests/test_ipalib/test_errors.py
blob: b72d6e0286b48421758a6778f54856e147b0091c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
# Authors:
#   Jason Gerard DeRose <jderose@redhat.com>
#
# Copyright (C) 2008  Red Hat
# see file 'COPYING' for use and warranty information
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
# published by the Free Software Foundation; version 2 only
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

"""
Test the `ipalib.errors` module.
"""

from tests.util import raises, ClassChecker
from ipalib import errors


type_format = '%s: need a %r; got %r'


def check_TypeError(f, value, type_, name, **kw):
    e = raises(TypeError, f, value, type_, name, **kw)
    assert e.value is value
    assert e.type is type_
    assert e.name is name
    assert str(e) == type_format % (name, type_, value)


def test_raise_TypeError():
    """
    Test the `ipalib.errors.raise_TypeError` function.
    """
    f = errors.raise_TypeError
    value = 'Hello.'
    type_ = unicode
    name = 'message'

    check_TypeError(f, value, type_, name)

    # name not an str
    fail_name = 42
    e = raises(AssertionError, f, value, type_, fail_name)
    assert str(e) == type_format % ('name', str, fail_name), str(e)

    # type_ not a type:
    fail_type = unicode()
    e = raises(AssertionError, f, value, fail_type, name)
    assert str(e) == type_format % ('type_', type, fail_type)

    # type(value) is type_:
    fail_value = u'How are you?'
    e = raises(AssertionError, f, fail_value, type_, name)
    assert str(e) == 'value: %r is a %r' % (fail_value, type_)


def test_check_type():
    """
    Test the `ipalib.errors.check_type` function.
    """
    f = errors.check_type
    value = 'How are you?'
    type_ = str
    name = 'greeting'

    # Should pass:
    assert value is f(value, type_, name)
    assert None is f(None, type_, name, allow_none=True)

    # Should raise TypeError
    check_TypeError(f, None, type_, name)
    check_TypeError(f, value, basestring, name)
    check_TypeError(f, value, unicode, name)

    # name not an str
    fail_name = unicode(name)
    e = raises(AssertionError, f, value, type_, fail_name)
    assert str(e) == type_format % ('name', str, fail_name)

    # type_ not a type:
    fail_type = 42
    e = raises(AssertionError, f, value, fail_type, name)
    assert str(e) == type_format % ('type_', type, fail_type)

    # allow_none not a bool:
    fail_bool = 0
    e = raises(AssertionError, f, value, type_, name, allow_none=fail_bool)
    assert str(e) == type_format % ('allow_none', bool, fail_bool)


def test_check_isinstance():
    """
    Test the `ipalib.errors.check_isinstance` function.
    """
    f = errors.check_isinstance
    value = 'How are you?'
    type_ = str
    name = 'greeting'

    # Should pass:
    assert value is f(value, type_, name)
    assert value is f(value, basestring, name)
    assert None is f(None, type_, name, allow_none=True)

    # Should raise TypeError
    check_TypeError(f, None, type_, name)
    check_TypeError(f, value, unicode, name)

    # name not an str
    fail_name = unicode(name)
    e = raises(AssertionError, f, value, type_, fail_name)
    assert str(e) == type_format % ('name', str, fail_name)

    # type_ not a type:
    fail_type = 42
    e = raises(AssertionError, f, value, fail_type, name)
    assert str(e) == type_format % ('type_', type, fail_type)

    # allow_none not a bool:
    fail_bool = 0
    e = raises(AssertionError, f, value, type_, name, allow_none=fail_bool)
    assert str(e) == type_format % ('allow_none', bool, fail_bool)


class test_IPAError(ClassChecker):
    """
    Test the `ipalib.errors.IPAError` exception.
    """
    _cls = errors.IPAError

    def test_class(self):
        """
        Test the `ipalib.errors.IPAError` exception.
        """
        assert self.cls.__bases__ == (Exception,)

    def test_init(self):
        """
        Test the `ipalib.errors.IPAError.__init__` method.
        """
        args = ('one fish', 'two fish')
        e = self.cls(*args)
        assert e.args == args
        assert self.cls().args == tuple()

    def test_str(self):
        """
        Test the `ipalib.errors.IPAError.__str__` method.
        """
        f = 'The %s color is %s.'
        class custom_error(self.cls):
            format = f
        for args in [('sexiest', 'red'), ('most-batman-like', 'black')]:
            e = custom_error(*args)
            assert e.args == args
            assert str(e) == f % args


class test_ValidationError(ClassChecker):
    """
    Test the `ipalib.errors.ValidationError` exception.
    """
    _cls = errors.ValidationError

    def test_class(self):
        """
        Test the `ipalib.errors.ValidationError` exception.
        """
        assert self.cls.__bases__ == (errors.IPAError,)

    def test_init(self):
        """
        Test the `ipalib.errors.ValidationError.__init__` method.
        """
        name = 'login'
        value = 'Whatever'
        error = 'Must be lowercase.'
        for index in (None, 3):
            e = self.cls(name, value, error, index=index)
            assert e.name is name
            assert e.value is value
            assert e.error is error
            assert e.index is index
            assert str(e) == 'invalid %r value %r: %s' % (name, value, error)
        # Check that index default is None:
        assert self.cls(name, value, error).index is None
        # Check non str name raises AssertionError:
        raises(AssertionError, self.cls, unicode(name), value, error)
        # Check non int index raises AssertionError:
        raises(AssertionError, self.cls, name, value, error, index=5.0)
        # Check negative index raises AssertionError:
        raises(AssertionError, self.cls, name, value, error, index=-2)


class test_ConversionError(ClassChecker):
    """
    Test the `ipalib.errors.ConversionError` exception.
    """
    _cls = errors.ConversionError

    def test_class(self):
        """
        Test the `ipalib.errors.ConversionError` exception.
        """
        assert self.cls.__bases__ == (errors.ValidationError,)

    def test_init(self):
        """
        Test the `ipalib.errors.ConversionError.__init__` method.
        """
        name = 'some_arg'
        value = '42.0'
        class type_(object):
            conversion_error = 'Not an integer'
        for index in (None, 7):
            e = self.cls(name, value, type_, index=index)
            assert e.name is name
            assert e.value is value
            assert e.type is type_
            assert e.error is type_.conversion_error
            assert e.index is index
            assert str(e) == 'invalid %r value %r: %s' % (name, value,
                type_.conversion_error)
        # Check that index default is None:
        assert self.cls(name, value, type_).index is None


class test_RuleError(ClassChecker):
    """
    Test the `ipalib.errors.RuleError` exception.
    """
    _cls = errors.RuleError

    def test_class(self):
        """
        Test the `ipalib.errors.RuleError` exception.
        """
        assert self.cls.__bases__ == (errors.ValidationError,)

    def test_init(self):
        """
        Test the `ipalib.errors.RuleError.__init__` method.
        """
        name = 'whatever'
        value = 'The smallest weird number.'
        def my_rule(value):
            return 'Value is bad.'
        error = my_rule(value)
        for index in (None, 42):
            e = self.cls(name, value, error, my_rule, index=index)
            assert e.name is name
            assert e.value is value
            assert e.error is error
            assert e.rule is my_rule
        # Check that index default is None:
        assert self.cls(name, value, error, my_rule).index is None


class test_RequirementError(ClassChecker):
    """
    Test the `ipalib.errors.RequirementError` exception.
    """
    _cls = errors.RequirementError

    def test_class(self):
        """
        Test the `ipalib.errors.RequirementError` exception.
        """
        assert self.cls.__bases__ == (errors.ValidationError,)

    def test_init(self):
        """
        Test the `ipalib.errors.RequirementError.__init__` method.
        """
        name = 'givenname'
        e = self.cls(name)
        assert e.name is name
        assert e.value is None
        assert e.error == 'Required'
        assert e.index is None