""" TestCases for checking dbShelve objects. """ import os import shutil import tempfile, random import unittest from bsddb import db, dbshelve from bsddb.test.test_all import verbose #---------------------------------------------------------------------- # We want the objects to be comparable so we can test dbshelve.values # later on. class DataClass: def __init__(self): self.value = random.random() def __repr__(self): return "DataClass(%r)" % self.value def __eq__(self, other): value = self.value if isinstance(other, DataClass): other = other.value return value == other def __lt__(self, other): value = self.value if isinstance(other, DataClass): other = other.value return value < other letters = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ' class DBShelveTestCase(unittest.TestCase): def setUp(self): self.filename = tempfile.mktemp() self.do_open() def tearDown(self): self.do_close() try: os.remove(self.filename) except os.error: pass def mk(self, key): """Turn key into an appropriate key type for this db""" # override in child class for RECNO return key.encode("ascii") def populateDB(self, d): for x in letters: d[self.mk('S' + x)] = 10 * x # add a string d[self.mk('I' + x)] = ord(x) # add an integer d[self.mk('L' + x)] = [x] * 10 # add a list inst = DataClass() # add an instance inst.S = 10 * x inst.I = ord(x) inst.L = [x] * 10 d[self.mk('O' + x)] = inst # overridable in derived classes to affect how the shelf is created/opened def do_open(self): self.d = dbshelve.open(self.filename) # and closed... def do_close(self): self.d.close() def test01_basics(self): if verbose: print('\n', '-=' * 30) print("Running %s.test01_basics..." % self.__class__.__name__) self.populateDB(self.d) if verbose: print(1, self.d.keys()) self.d.sync() if verbose: print(2, self.d.keys()) self.do_close() self.do_open() if verbose: print(3, self.d.keys()) d = self.d l = len(d) k = d.keys() s = d.stat() f = d.fd() if verbose: print("length:", l) print("keys:", k) print("stats:", s) self.assertFalse(d.has_key(self.mk('bad key'))) self.assertTrue(d.has_key(self.mk('IA')), d.keys()) self.assertTrue(d.has_key(self.mk('OA'))) d.delete(self.mk('IA')) del d[self.mk('OA')] self.assertFalse(d.has_key(self.mk('IA'))) self.assertFalse(d.has_key(self.mk('OA'))) self.assertEqual(len(d), l-2) values = [] for key in d.keys(): value = d[key] values.append(value) if verbose: print("%s: %s" % (key, value)) self.checkrec(key, value) dbvalues = sorted(d.values(), key=lambda x: (str(type(x)), x)) self.assertEqual(len(dbvalues), len(d.keys())) values.sort(key=lambda x: (str(type(x)), x)) self.assertEqual(values, dbvalues, "%r != %r" % (values, dbvalues)) items = d.items() self.assertEqual(len(items), len(values)) for key, value in items: self.checkrec(key, value) self.assertEqual(d.get(self.mk('bad key')), None) self.assertEqual(d.get(self.mk('bad key'), None), None) self.assertEqual(d.get(self.mk('bad key'), b'a string'), b'a string') self.assertEqual(d.get(self.mk('bad key'), [1, 2, 3]), [1, 2, 3]) d.set_get_returns_none(0) self.assertRaises(db.DBNotFoundError, d.get, self.mk('bad key')) d.set_get_returns_none(1) d.put(self.mk('new key'), b'new data') self.assertEqual(d.get(self.mk('new key')), b'new data') self.assertEqual(d[self.mk('new key')], b'new data') def test02_cursors(self): if verbose: print('\n', '-=' * 30) print("Running %s.test02_cursors..." % self.__class__.__name__) self.populateDB(self.d) d = self.d count = 0 c = d.cursor() rec = c.first() while rec is not None: count = count + 1 if verbose: print(repr(rec)) key, value = rec self.checkrec(key, value) rec = c.next() del c self.assertEqual(count, len(d)) count = 0 c = d.cursor() rec = c.last() while rec is not None: count = count + 1 if verbose: print(rec) key, value = rec self.checkrec(key, value) rec = c.prev() self.assertEqual(count, len(d)) c.set(self.mk('SS')) key, value = c.current() self.checkrec(key, value) del c def test03_append(self): # NOTE: this is overridden in RECNO subclass, don't change its name. if verbose: print('\n', '-=' * 30) print("Running %s.test03_append..." % self.__class__.__name__) self.assertRaises(dbshelve.DBShelveError, self.d.append, b'unit test was here') def checkrec(self, key, value): # override this in a subclass if the key type is different x = key[1:] if key[0:1] == b'S': self.assertEquals(type(value), str) self.assertEquals(value, 10 * x.decode("ascii")) elif key[0:1] == b'I': self.assertEquals(type(value), int) self.assertEquals(value, ord(x)) elif key[0:1] == b'L': self.assertEquals(type(value), list) self.assertEquals(value, [x.decode("ascii")] * 10) elif key[0:1] == b'O': self.assertEquals(value.S, 10 * x.decode("ascii")) self.assertEquals(value.I, ord(x)) self.assertEquals(value.L, [x.decode("ascii")] * 10) else: self.fail('Unknown key type, fix the test') #---------------------------------------------------------------------- class BasicShelveTestCase(DBShelveTestCase): def do_open(self): self.d = dbshelve.DBShelf() self.d.open(self.filename, self.dbtype, self.dbflags) def do_close(self): self.d.close() class BTreeShelveTestCase(BasicShelveTestCase): dbtype = db.DB_BTREE dbflags = db.DB_CREATE class HashShelveTestCase(BasicShelveTestCase): dbtype = db.DB_HASH dbflags = db.DB_CREATE class ThreadBTreeShelveTestCase(BasicShelveTestCase): dbtype = db.DB_BTREE dbflags = db.DB_CREATE | db.DB_THREAD class ThreadHashShelveTestCase(BasicShelveTestCase): dbtype = db.DB_HASH dbflags = db.DB_CREATE | db.DB_THREAD #---------------------------------------------------------------------- class BasicEnvShelveTestCase(DBShelveTestCase): def setUp(self): self.homeDir = tempfile.mkdtemp() self.filename = 'dbshelve_db_file.db' self.do_open() def do_open(self): self.env = db.DBEnv() self.env.open(self.homeDir, self.envflags | db.DB_INIT_MPOOL | db.DB_CREATE) self.d = dbshelve.DBShelf(self.env) self.d.open(self.filename, self.dbtype, self.dbflags) def do_close(self): self.d.close() self.env.close() def tearDown(self): self.do_close() shutil.rmtree(self.homeDir) class EnvBTreeShelveTestCase(BasicEnvShelveTestCase): envflags = 0 dbtype = db.DB_BTREE dbflags = db.DB_CREATE class EnvHashShelveTestCase(BasicEnvShelveTestCase): envflags = 0 dbtype = db.DB_HASH dbflags = db.DB_CREATE class EnvThreadBTreeShelveTestCase(BasicEnvShelveTestCase): envflags = db.DB_THREAD dbtype = db.DB_BTREE dbflags = db.DB_CREATE | db.DB_THREAD class EnvThreadHashShelveTestCase(BasicEnvShelveTestCase): envflags = db.DB_THREAD dbtype = db.DB_HASH dbflags = db.DB_CREATE | db.DB_THREAD #---------------------------------------------------------------------- # test cases for a DBShelf in a RECNO DB. class RecNoShelveTestCase(BasicShelveTestCase): dbtype = db.DB_RECNO dbflags = db.DB_CREATE def setUp(self): BasicShelveTestCase.setUp(self) # pool to assign integer key values out of self.key_pool = list(range(1, 5000)) self.key_map = {} # map string keys to the number we gave them self.intkey_map = {} # reverse map of above def mk(self, key): if key not in self.key_map: self.key_map[key] = self.key_pool.pop(0) self.intkey_map[self.key_map[key]] = key.encode('ascii') return self.key_map[key] def checkrec(self, intkey, value): key = self.intkey_map[intkey] BasicShelveTestCase.checkrec(self, key, value) def test03_append(self): if verbose: print('\n', '-=' * 30) print("Running %s.test03_append..." % self.__class__.__name__) self.d[1] = b'spam' self.d[5] = b'eggs' self.assertEqual(6, self.d.append(b'spam')) self.assertEqual(7, self.d.append(b'baked beans')) self.assertEqual(b'spam', self.d.get(6)) self.assertEqual(b'spam', self.d.get(1)) self.assertEqual(b'baked beans', self.d.get(7)) self.assertEqual(b'eggs', self.d.get(5)) #---------------------------------------------------------------------- def test_suite(): suite = unittest.TestSuite() suite.addTest(unittest.makeSuite(DBShelveTestCase)) suite.addTest(unittest.makeSuite(BTreeShelveTestCase)) suite.addTest(unittest.makeSuite(HashShelveTestCase)) suite.addTest(unittest.makeSuite(ThreadBTreeShelveTestCase)) suite.addTest(unittest.makeSuite(ThreadHashShelveTestCase)) suite.addTest(unittest.makeSuite(EnvBTreeShelveTestCase)) suite.addTest(unittest.makeSuite(EnvHashShelveTestCase)) suite.addTest(unittest.makeSuite(EnvThreadBTreeShelveTestCase)) suite.addTest(unittest.makeSuite(EnvThreadHashShelveTestCase)) suite.addTest(unittest.makeSuite(RecNoShelveTestCase)) return suite if __name__ == '__main__': unittest.main(defaultTest='test_suite')