summaryrefslogtreecommitdiffstats
path: root/ipalib/tests/tstutil.py
blob: b9c6e15d9f2f99270d0072f0c2c77d02e99a6391 (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
# 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

"""
Utility functions for the unit tests.
"""

class ExceptionNotRaised(Exception):
	"""
	Exception raised when an *expected* exception is *not* raised during a
	unit test.
	"""
	msg = 'expected %s'

	def __init__(self, expected):
		self.expected = expected

	def __str__(self):
		return self.msg % self.expected.__name__


def yes_raises(exception, callback, *args, **kw):
	"""
	Tests that the expected exception is raised; raises ExceptionNotRaised
	if test fails.
	"""
	raised = False
	try:
		callback(*args, **kw)
	except exception:
		raised = True
	if not raised:
		raise ExceptionNotRaised(exception)


def no_set(obj, name, value='some_new_obj'):
	"""
	Tests that attribute cannot be set.
	"""
	yes_raises(AttributeError, setattr, obj, name, value)


def no_del(obj, name):
	"""
	Tests that attribute cannot be deleted.
	"""
	yes_raises(AttributeError, delattr, obj, name)


def read_only(obj, name, value='some_new_obj'):
	"""
	Tests that attribute is read-only. Returns attribute.
	"""
	# Test that it cannot be set:
	no_set(obj, name, value)

	# Test that it cannot be deleted:
	no_del(obj, name)

	# Return the attribute
	return getattr(obj, name)