Python code coverage for Lib/bsddb/test/test_compare.py

#	count	content
1	n/a	"""
2	n/a	TestCases for python DB Btree key comparison function.
3	n/a	"""
4	n/a
5	n/a	import sys, os, re
6	n/a	import test_all
7	n/a	from cStringIO import StringIO
8	n/a
9	n/a	import unittest
10	n/a
11	n/a	from test_all import db, dbshelve, test_support, \
12	n/a	get_new_environment_path, get_new_database_path
13	n/a
14	n/a
15	n/a	# Needed for python 3. "cmp" vanished in 3.0.1
16	n/a	def cmp(a, b) :
17	n/a	if a==b : return 0
18	n/a	if a<b : return -1
19	n/a	return 1
20	n/a
21	n/a	lexical_cmp = cmp
22	n/a
23	n/a	def lowercase_cmp(left, right):
24	n/a	return cmp (left.lower(), right.lower())
25	n/a
26	n/a	def make_reverse_comparator (cmp):
27	n/a	def reverse (left, right, delegate=cmp):
28	n/a	return - delegate (left, right)
29	n/a	return reverse
30	n/a
31	n/a	_expected_lexical_test_data = ['', 'CCCP', 'a', 'aaa', 'b', 'c', 'cccce', 'ccccf']
32	n/a	_expected_lowercase_test_data = ['', 'a', 'aaa', 'b', 'c', 'CC', 'cccce', 'ccccf', 'CCCP']
33	n/a
34	n/a	class ComparatorTests (unittest.TestCase):
35	n/a	if sys.version_info < (2, 4) :
36	n/a	def assertTrue(self, expr, msg=None) :
37	n/a	return self.failUnless(expr,msg=msg)
38	n/a
39	n/a	def comparator_test_helper (self, comparator, expected_data):
40	n/a	data = expected_data[:]
41	n/a
42	n/a	import sys
43	n/a	if sys.version_info < (2, 6) :
44	n/a	if sys.version_info < (2, 4) :
45	n/a	data.sort(comparator)
46	n/a	else :
47	n/a	data.sort(cmp=comparator)
48	n/a	else : # Insertion Sort. Please, improve
49	n/a	data2 = []
50	n/a	for i in data :
51	n/a	for j, k in enumerate(data2) :
52	n/a	r = comparator(k, i)
53	n/a	if r == 1 :
54	n/a	data2.insert(j, i)
55	n/a	break
56	n/a	else :
57	n/a	data2.append(i)
58	n/a	data = data2
59	n/a
60	n/a	self.assertEqual(data, expected_data,
61	n/a	"comparator `%s' is not right: %s vs. %s"
62	n/a	% (comparator, expected_data, data))
63	n/a	def test_lexical_comparator (self):
64	n/a	self.comparator_test_helper (lexical_cmp, _expected_lexical_test_data)
65	n/a	def test_reverse_lexical_comparator (self):
66	n/a	rev = _expected_lexical_test_data[:]
67	n/a	rev.reverse ()
68	n/a	self.comparator_test_helper (make_reverse_comparator (lexical_cmp),
69	n/a	rev)
70	n/a	def test_lowercase_comparator (self):
71	n/a	self.comparator_test_helper (lowercase_cmp,
72	n/a	_expected_lowercase_test_data)
73	n/a
74	n/a	class AbstractBtreeKeyCompareTestCase (unittest.TestCase):
75	n/a	env = None
76	n/a	db = None
77	n/a
78	n/a	if sys.version_info < (2, 4) :
79	n/a	def assertTrue(self, expr, msg=None):
80	n/a	self.failUnless(expr,msg=msg)
81	n/a
82	n/a	if (sys.version_info < (2, 7)) or ((sys.version_info >= (3,0)) and
83	n/a	(sys.version_info < (3, 2))) :
84	n/a	def assertLess(self, a, b, msg=None) :
85	n/a	return self.assertTrue(a<b, msg=msg)
86	n/a
87	n/a	def setUp (self):
88	n/a	self.filename = self.__class__.__name__ + '.db'
89	n/a	self.homeDir = get_new_environment_path()
90	n/a	env = db.DBEnv()
91	n/a	env.open (self.homeDir,
92	n/a	db.DB_CREATE \| db.DB_INIT_MPOOL
93	n/a	\| db.DB_INIT_LOCK \| db.DB_THREAD)
94	n/a	self.env = env
95	n/a
96	n/a	def tearDown (self):
97	n/a	self.closeDB()
98	n/a	if self.env is not None:
99	n/a	self.env.close()
100	n/a	self.env = None
101	n/a	test_support.rmtree(self.homeDir)
102	n/a
103	n/a	def addDataToDB (self, data):
104	n/a	i = 0
105	n/a	for item in data:
106	n/a	self.db.put (item, str (i))
107	n/a	i = i + 1
108	n/a
109	n/a	def createDB (self, key_comparator):
110	n/a	self.db = db.DB (self.env)
111	n/a	self.setupDB (key_comparator)
112	n/a	self.db.open (self.filename, "test", db.DB_BTREE, db.DB_CREATE)
113	n/a
114	n/a	def setupDB (self, key_comparator):
115	n/a	self.db.set_bt_compare (key_comparator)
116	n/a
117	n/a	def closeDB (self):
118	n/a	if self.db is not None:
119	n/a	self.db.close ()
120	n/a	self.db = None
121	n/a
122	n/a	def startTest (self):
123	n/a	pass
124	n/a
125	n/a	def finishTest (self, expected = None):
126	n/a	if expected is not None:
127	n/a	self.check_results (expected)
128	n/a	self.closeDB ()
129	n/a
130	n/a	def check_results (self, expected):
131	n/a	curs = self.db.cursor ()
132	n/a	try:
133	n/a	index = 0
134	n/a	rec = curs.first ()
135	n/a	while rec:
136	n/a	key, ignore = rec
137	n/a	self.assertLess(index, len (expected),
138	n/a	"to many values returned from cursor")
139	n/a	self.assertEqual(expected[index], key,
140	n/a	"expected value `%s' at %d but got `%s'"
141	n/a	% (expected[index], index, key))
142	n/a	index = index + 1
143	n/a	rec = curs.next ()
144	n/a	self.assertEqual(index, len (expected),
145	n/a	"not enough values returned from cursor")
146	n/a	finally:
147	n/a	curs.close ()
148	n/a
149	n/a	class BtreeKeyCompareTestCase (AbstractBtreeKeyCompareTestCase):
150	n/a	def runCompareTest (self, comparator, data):
151	n/a	self.startTest ()
152	n/a	self.createDB (comparator)
153	n/a	self.addDataToDB (data)
154	n/a	self.finishTest (data)
155	n/a
156	n/a	def test_lexical_ordering (self):
157	n/a	self.runCompareTest (lexical_cmp, _expected_lexical_test_data)
158	n/a
159	n/a	def test_reverse_lexical_ordering (self):
160	n/a	expected_rev_data = _expected_lexical_test_data[:]
161	n/a	expected_rev_data.reverse ()
162	n/a	self.runCompareTest (make_reverse_comparator (lexical_cmp),
163	n/a	expected_rev_data)
164	n/a
165	n/a	def test_compare_function_useless (self):
166	n/a	self.startTest ()
167	n/a	def socialist_comparator (l, r):
168	n/a	return 0
169	n/a	self.createDB (socialist_comparator)
170	n/a	self.addDataToDB (['b', 'a', 'd'])
171	n/a	# all things being equal the first key will be the only key
172	n/a	# in the database... (with the last key's value fwiw)
173	n/a	self.finishTest (['b'])
174	n/a
175	n/a
176	n/a	class BtreeExceptionsTestCase (AbstractBtreeKeyCompareTestCase):
177	n/a	def test_raises_non_callable (self):
178	n/a	self.startTest ()
179	n/a	self.assertRaises (TypeError, self.createDB, 'abc')
180	n/a	self.assertRaises (TypeError, self.createDB, None)
181	n/a	self.finishTest ()
182	n/a
183	n/a	def test_set_bt_compare_with_function (self):
184	n/a	self.startTest ()
185	n/a	self.createDB (lexical_cmp)
186	n/a	self.finishTest ()
187	n/a
188	n/a	def check_results (self, results):
189	n/a	pass
190	n/a
191	n/a	def test_compare_function_incorrect (self):
192	n/a	self.startTest ()
193	n/a	def bad_comparator (l, r):
194	n/a	return 1
195	n/a	# verify that set_bt_compare checks that comparator('', '') == 0
196	n/a	self.assertRaises (TypeError, self.createDB, bad_comparator)
197	n/a	self.finishTest ()
198	n/a
199	n/a	def verifyStderr(self, method, successRe):
200	n/a	"""
201	n/a	Call method() while capturing sys.stderr output internally and
202	n/a	call self.fail() if successRe.search() does not match the stderr
203	n/a	output. This is used to test for uncatchable exceptions.
204	n/a	"""
205	n/a	stdErr = sys.stderr
206	n/a	sys.stderr = StringIO()
207	n/a	try:
208	n/a	method()
209	n/a	finally:
210	n/a	temp = sys.stderr
211	n/a	sys.stderr = stdErr
212	n/a	errorOut = temp.getvalue()
213	n/a	if not successRe.search(errorOut):
214	n/a	self.fail("unexpected stderr output:\n"+errorOut)
215	n/a	if sys.version_info < (3, 0) : # XXX: How to do this in Py3k ???
216	n/a	sys.exc_traceback = sys.last_traceback = None
217	n/a
218	n/a	def _test_compare_function_exception (self):
219	n/a	self.startTest ()
220	n/a	def bad_comparator (l, r):
221	n/a	if l == r:
222	n/a	# pass the set_bt_compare test
223	n/a	return 0
224	n/a	raise RuntimeError, "i'm a naughty comparison function"
225	n/a	self.createDB (bad_comparator)
226	n/a	#print "\n* test should print 2 uncatchable tracebacks *"
227	n/a	self.addDataToDB (['a', 'b', 'c']) # this should raise, but...
228	n/a	self.finishTest ()
229	n/a
230	n/a	def test_compare_function_exception(self):
231	n/a	self.verifyStderr(
232	n/a	self._test_compare_function_exception,
233	n/a	re.compile('(^RuntimeError:.* naughty.*){2}', re.M\|re.S)
234	n/a	)
235	n/a
236	n/a	def _test_compare_function_bad_return (self):
237	n/a	self.startTest ()
238	n/a	def bad_comparator (l, r):
239	n/a	if l == r:
240	n/a	# pass the set_bt_compare test
241	n/a	return 0
242	n/a	return l
243	n/a	self.createDB (bad_comparator)
244	n/a	#print "\n* test should print 2 errors about returning an int *"
245	n/a	self.addDataToDB (['a', 'b', 'c']) # this should raise, but...
246	n/a	self.finishTest ()
247	n/a
248	n/a	def test_compare_function_bad_return(self):
249	n/a	self.verifyStderr(
250	n/a	self._test_compare_function_bad_return,
251	n/a	re.compile('(^TypeError:.* return an int.*){2}', re.M\|re.S)
252	n/a	)
253	n/a
254	n/a
255	n/a	def test_cannot_assign_twice (self):
256	n/a
257	n/a	def my_compare (a, b):
258	n/a	return 0
259	n/a
260	n/a	self.startTest()
261	n/a	self.createDB(my_compare)
262	n/a	self.assertRaises (RuntimeError, self.db.set_bt_compare, my_compare)
263	n/a
264	n/a	def test_suite ():
265	n/a	res = unittest.TestSuite ()
266	n/a
267	n/a	res.addTest (unittest.makeSuite (ComparatorTests))
268	n/a	res.addTest (unittest.makeSuite (BtreeExceptionsTestCase))
269	n/a	res.addTest (unittest.makeSuite (BtreeKeyCompareTestCase))
270	n/a	return res
271	n/a
272	n/a	if __name__ == '__main__':
273	n/a	unittest.main (defaultTest = 'suite')